Money accounts
Accounts where the store money comes in and goes out: cash, bank, acquiring, wallet. The balance is in the account currency.
Money accounts
Objects
MoneyAccount
idintegerrequiredID of the record, unique among records of its kind in the store.
namestringrequiredAccount name as the store sees it.
typestringrequiredAccount kind: bank; cash; acquiring — payment provider; ewallet — e-wallet; crypto — crypto wallet; advance — staff advances of a location; transit — cash in transit (collection); group_share — share in a store group account: the money sits with the holder, the balance is a settlement with the group.
- Values:
bankcashacquiringewalletcryptoadvancetransitgroup_share
currencystringrequiredAccount currency: an ISO 4217 code or an asset (USDT). May differ from the store currency.
balancestringrequiredCurrent balance in the account currency, as a decimal string such as "12345.5".
legal_entity_idinteger or nullrequiredID of the legal entity that owns the account; null — a store account without a legal entity.
location_idinteger or nullrequiredID of the account location; null — a store-wide account.
is_defaultbooleanrequiredDefault account for its currency.
is_systembooleanrequiredSystem cash account (advance, transit): moved only by register documents.
archived_atstring (date-time) or nullrequiredWhen the account was archived: it takes no new movements, its history stays. null for an active account.
created_atstring (date-time)requiredWhen the record was created.
updated_atstring (date-time)requiredWhen the record last changed.
Endpoints
List the store money accounts with their current balance: cash, bank, acquiring, wallet
get/money-accounts
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})$
include_deletedbooleantrue — also return deleted records: archived ones with deleted_at set, and records erased from the database as tombstones {id, deleted_at} in the continuation by the sync cursor. Turn it on for a sync.
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/money-accounts" \
-H "Authorization: Bearer $SALEYA_API_TOKEN"{
"data": [
{
"id": 0,
"name": "string",
"type": "bank",
"currency": "string",
"balance": "string",
"legal_entity_id": 0,
"location_id": 0,
"is_default": true,
"is_system": true,
"archived_at": "2026-01-15T12:00:00Z",
"created_at": "2026-01-15T12:00:00Z",
"updated_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"
}Get a money account
get/money-accounts/{account}
Scope: finance:read
Parameters
Path
accountintegerrequiredID of the money account.
Responses
200Success
application/json
Returns MoneyAccount
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/money-accounts/{account}" \
-H "Authorization: Bearer $SALEYA_API_TOKEN"{
"id": 0,
"name": "string",
"type": "bank",
"currency": "string",
"balance": "string",
"legal_entity_id": 0,
"location_id": 0,
"is_default": true,
"is_system": true,
"archived_at": "2026-01-15T12:00:00Z",
"created_at": "2026-01-15T12:00:00Z",
"updated_at": "2026-01-15T12:00:00Z"
}