Models are listed once here and can also be expanded directly from the endpoints that use them.
Receipt14 fields
idinteger · int64
Id.
read-only
clientIdinteger · int64
Client Id.
read-only
orderIdinteger · int64
Order Id.
read-only
organizationIdinteger · int64
Organization Id.
read-only
externalReceiptIdstring
External Receipt Id.
fiscalNumberstring
Fiscal Number.
cashRegisterServicestring
Cash Register Service.
fnsUrlstring
Fns Url.
statusstring
Status.
receiptTypestring
Receipt Type.
totalAmountnumber · double
Total Amount.
createdDatestring · date-time
Created Date.
read-only
completedDatestring · date-time
Completed Date.
errorMessagestring
Error Message.
Error contract
How application errors are returned
The error code is identical in every locale, while the user-facing message is translated by the server. Build application logic around error and use localMessage for display only.
error
Stable machine-readable code for integration logic.
localMessage
Display-ready message in the API token user's language.
params
Values interpolated by the server into the localized message template.
文
localMessage uses the lang field of the user who owns the API token. The documentation language and Accept-Language header do not change it; Russian is used when the user has no language configured.
RUUser locale is ru
{
"error": "error_brand_already_exists",
"localMessage": "Бренд Base уже существует",
"params": {
"name": "Base"
}
}
Application errors are normally returned as JSON with error, localMessage, and params. Branch on error; localized text may change. How application errors are returned ↑
401auth_required
Authentication required
Authorization is missing, empty, or contains an invalid token.
400error_access_denied
Insufficient permissions
The token exists, but its role cannot perform this operation.
500error_unknown
Unexpected error
Internal failure. Save the request time and contact support; do not blindly retry a mutation.
POST
Create Receipt For Order
/api/receipt/order/{orderId}
Token with write access
Create Receipt For Order using POST /api/receipt/order/{orderId}.
Path parameters
Field
Type
Required
Description
orderId
integer · int64
Yes
Order Id.
Query parameters
Field
Type
Required
Description
typeDefault: INCOME
stringINCOME, EXPENSE, REFUND, EXPENSE_REFUND
No
Type.
curl --request POST 'https://api.selsup.ru/api/receipt/order/1001' \
--header 'Authorization: YOUR_API_TOKEN'
Application errors are normally returned as JSON with error, localMessage, and params. Branch on error; localized text may change. How application errors are returned ↑
401auth_required
Authentication required
Authorization is missing, empty, or contains an invalid token.
400error_access_denied
Insufficient permissions
The token exists, but its role cannot perform this operation.
500error_unknown
Unexpected error
Internal failure. Save the request time and contact support; do not blindly retry a mutation.
GET
Get Receipt
/api/receipt/{receiptId}
Token with read access
Get Receipt using GET /api/receipt/{receiptId}.
Path parameters
Field
Type
Required
Description
receiptId
integer · int64
Yes
Receipt Id.
curl --request GET 'https://api.selsup.ru/api/receipt/1001' \
--header 'Authorization: YOUR_API_TOKEN'
Application errors are normally returned as JSON with error, localMessage, and params. Branch on error; localized text may change. How application errors are returned ↑
401auth_required
Authentication required
Authorization is missing, empty, or contains an invalid token.
400error_access_denied
Insufficient permissions
The token exists, but its role cannot perform this operation.
500error_unknown
Unexpected error
Internal failure. Save the request time and contact support; do not blindly retry a mutation.
GET
Update Receipt Status
/api/receipt/{receiptId}/update
Token with read access
Update Receipt Status using GET /api/receipt/{receiptId}/update.
Path parameters
Field
Type
Required
Description
receiptId
integer · int64
Yes
Receipt Id.
curl --request GET 'https://api.selsup.ru/api/receipt/1001/update' \
--header 'Authorization: YOUR_API_TOKEN'
Application errors are normally returned as JSON with error, localMessage, and params. Branch on error; localized text may change. How application errors are returned ↑
401auth_required
Authentication required
Authorization is missing, empty, or contains an invalid token.
400error_access_denied
Insufficient permissions
The token exists, but its role cannot perform this operation.
500error_unknown
Unexpected error
Internal failure. Save the request time and contact support; do not blindly retry a mutation.