Cash drawer movements
The shift drawer journal: cash sales and refunds, pay-ins, pay-outs, safe drops, change and reversals. Append-only.
Cash drawer movements
Objects
PosCashMovement
idintegerrequiredID of the record, unique among records of its kind in the store.
shift_idintegerrequiredRegister shift ID (/v1/pos-shifts).
typestringrequiredMovement type: sale_cash_in — cash sale; refund_cash_out — cash refund; sale_reversal — cash handed back when an unfinished sale is undone; change_out — change in the store currency for foreign-currency notes; pay_in and pay_out — pay-in and pay-out with a reason; drop_out — safe drop; float_in — float from the safe; waiter_cash_in — cash handed in by a waiter; courier_shortage — courier shortfall; no_sale — drawer opened without a sale; *_reversal — reversals.
- Values:
pay_inpay_outsale_cash_inrefund_cash_outcourier_shortagewaiter_cash_insale_reversalno_salefloat_indrop_outpay_in_reversalpay_out_reversaldrop_out_reversalfloat_in_reversalchange_outchange_out_reversal
directionstringrequiredSign in the drawer's expected cash: in — money went into the drawer; out — it left; none — the drawer was opened without money.
- Values:
inoutnone
amountintegerrequiredAmount in minor units of the movement currency, never negative: direction gives the sign.
currencystringrequiredCurrency of the drawer the movement changes, ISO 4217 code.
- Values:
ARSUSDBRLCLPCOPMXNPENRUB
occurred_atstring (date-time)requiredWhen it happened by the register clock: a movement recorded offline arrives later.
order_idinteger or nullrequiredID of the order.
payment_idinteger or nullrequiredPayment ID (/v1/payments) of the cash sale or refund; null for manual movements.
reverses_movement_idinteger or nullrequiredID of the movement this one reverses; null for a regular movement.
cash_transfer_idinteger or nullrequiredSafe envelope ID — a drop or float: the money journal refers to it with a source of type pos_cash_transfer. null if there is no envelope.
cash_reason_idinteger or nullrequiredPay-in or pay-out reason ID (/v1/pos-cash-reasons); null for other types.
supplier_idinteger or nullrequiredID of the supplier who was paid; null unless the pay-out went to a supplier.
commentstring or nullrequiredCashier comment; null if none.
created_atstring (date-time)requiredWhen the record was created.
Endpoints
Cash drawer journal: cash sales and refunds, pay-ins, pay-outs, safe drops, change and reversals
get/pos-cash-movements
Scope: finance:read
Parameters
Query
limitintegerPage size: up to 250 records; 50 by default.
- Minimum:
- 1
- Maximum:
- 250
cursorstringOpaque cursor: next_cursor of the previous page, or sync_cursor of the last page saved by the previous sync. The list goes in commit order, so the sync cursor later returns only what changed after it.
- Max length:
- 4096
updated_sincestring (date-time)Only records changed after this moment, ISO 8601 with a time zone. A filter for the first sync; continue with the cursor.
- Pattern:
^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,6})?(Z|[+-]\d{2}:\d{2})$
shift_idintegerOnly movements of this register shift.
- Minimum:
- 1
Responses
200Success
application/json
Records of the page.
deletedarray of objectrequiredRecords erased from the database since the cursor, as tombstones: only with include_deleted=true in the continuation by the sync cursor.
Fields · 2
idintegerrequiredID of the erased record.
deleted_atstring (date-time)requiredWhen the record was erased.
next_cursorstring or nullrequiredCursor of the next page; null on the last page.
has_morebooleanrequiredtrue when there is a next page.
sync_cursorstring or nullrequiredOn the last page — the cursor to continue from later: it returns only what changed after this page. null on other pages.
401The token is missing, invalid, expired or revoked
Headers
WWW-AuthenticatestringrequiredAuthentication scheme (RFC 6750).
- Example:
Bearer
application/problem+json
Returns Problem
403The plan, the IP address or the token scopes do not allow the request
Headers
WWW-AuthenticatestringAuthentication scheme (RFC 6750).
- Example:
Bearer error="insufficient_scope", scope="locations:read"
application/problem+json
Returns ForbiddenProblem
410The sync cursor is older than the deletion retention period or was issued before the database was restored
application/problem+json
Returns Problem
422A parameter is invalid or unknown
application/problem+json
Returns ValidationProblem
429The rate limit is exhausted
Headers
Retry-AfterintegerrequiredSeconds to wait before retrying.
- Minimum:
- 0
application/problem+json
Returns RateLimitProblem
503The store is temporarily unavailable
Headers
Retry-AfterintegerSeconds to wait before retrying.
- Minimum:
- 0
application/problem+json
Returns Problem
Errors of this endpoint
Common errors such as token, access, input validation and rate limit can come from any endpoint; they are listed in the catalog: Errors
curl "https://api.saleya.app/v1/pos-cash-movements" \
-H "Authorization: Bearer $SALEYA_API_TOKEN"{
"data": [
{
"id": 0,
"shift_id": 0,
"type": "pay_in",
"direction": "in",
"amount": 0,
"currency": "ARS",
"occurred_at": "2026-01-15T12:00:00Z",
"order_id": 0,
"payment_id": 0,
"reverses_movement_id": 0,
"cash_transfer_id": 0,
"cash_reason_id": 0,
"supplier_id": 0,
"comment": "string",
"created_at": "2026-01-15T12:00:00Z"
}
],
"deleted": [
{
"id": 0,
"deleted_at": "2026-01-15T12:00:00Z"
}
],
"next_cursor": "string",
"has_more": true,
"sync_cursor": "string"
}Cash drawer movement
get/pos-cash-movements/{movement}
Scope: finance:read
Parameters
Path
movementintegerrequiredCash drawer movement ID.
Responses
200Success
application/json
Returns PosCashMovement
401The token is missing, invalid, expired or revoked
Headers
WWW-AuthenticatestringrequiredAuthentication scheme (RFC 6750).
- Example:
Bearer
application/problem+json
Returns Problem
403The plan, the IP address or the token scopes do not allow the request
Headers
WWW-AuthenticatestringAuthentication scheme (RFC 6750).
- Example:
Bearer error="insufficient_scope", scope="locations:read"
application/problem+json
Returns ForbiddenProblem
404The object does not exist or is not available to the app
application/problem+json
Returns Problem
422A parameter is invalid or unknown
application/problem+json
Returns ValidationProblem
429The rate limit is exhausted
Headers
Retry-AfterintegerrequiredSeconds to wait before retrying.
- Minimum:
- 0
application/problem+json
Returns RateLimitProblem
503The store is temporarily unavailable
Headers
Retry-AfterintegerSeconds to wait before retrying.
- Minimum:
- 0
application/problem+json
Returns Problem
Common errors such as token, access, input validation and rate limit can come from any endpoint; they are listed in the catalog: Errors
curl "https://api.saleya.app/v1/pos-cash-movements/{movement}" \
-H "Authorization: Bearer $SALEYA_API_TOKEN"{
"id": 0,
"shift_id": 0,
"type": "pay_in",
"direction": "in",
"amount": 0,
"currency": "ARS",
"occurred_at": "2026-01-15T12:00:00Z",
"order_id": 0,
"payment_id": 0,
"reverses_movement_id": 0,
"cash_transfer_id": 0,
"cash_reason_id": 0,
"supplier_id": 0,
"comment": "string",
"created_at": "2026-01-15T12:00:00Z"
}