SelSup Developers

Public API · API Reference

Receipt

Endpoints for Receipt, including exact routes, parameters, request bodies, and expandable response schemas.

4 endpoints/api/receiptStableMachine-readable description ↗
{ }

This page is backed by an editable standalone contract. Validate write operations with test data before production use.

/api/receipt

Ready-to-use workflows

Ready-to-use workflows

01

Start using Receipt

Use a dedicated API token and validate read operations with test data first.

  1. Keep the token server-side and send it in the Authorization header.
  2. Check required parameters and expand the request or response schema.
  3. Handle the HTTP status and the stable error field in application errors.

Data model

Data structures

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"
  }
}
ENUser locale is en
{
  "error": "error_brand_already_exists",
  "localMessage": "Brand Base already exists",
  "params": {
    "name": "Base"
  }
}

Endpoints

Endpoints

GET

Get Receipts By Order

/api/receipt/order/{orderId}
Token with read access

Get Receipts By Order using GET /api/receipt/order/{orderId}.

Path parameters

FieldTypeRequiredDescription
orderId integer · int64 Yes Order Id.
curl --request GET 'https://api.selsup.ru/api/receipt/order/1001' \
  --header 'Authorization: YOUR_API_TOKEN'

Success response

200
Array item structure Receipt[]
FieldTypeRequiredDescription
id integer · int64 No Id.
clientId integer · int64 No Client Id.
orderId integer · int64 No Order Id.
organizationId integer · int64 No Organization Id.
externalReceiptId string No External Receipt Id.
fiscalNumber string No Fiscal Number.
cashRegisterService stringNONE, EVOTOR, ATOL No Cash Register Service.
fnsUrl string No Fns Url.
status stringCREATED, PENDING, COMPLETED, FAILED, CANCELLED No Status.
receiptType stringINCOME, EXPENSE, REFUND, EXPENSE_REFUND No Receipt Type.
totalAmount number · double No Total Amount.
createdDate string · date-time No Created Date.
completedDate string · date-time No Completed Date.
errorMessage string No Error Message.
[
  "string"
]
Errors3

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

FieldTypeRequiredDescription
orderId integer · int64 Yes Order Id.

Query parameters

FieldTypeRequiredDescription
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'

Success response

200
Object fields Receipt
FieldTypeRequiredDescription
id integer · int64 No Id.
clientId integer · int64 No Client Id.
orderId integer · int64 No Order Id.
organizationId integer · int64 No Organization Id.
externalReceiptId string No External Receipt Id.
fiscalNumber string No Fiscal Number.
cashRegisterService stringNONE, EVOTOR, ATOL No Cash Register Service.
fnsUrl string No Fns Url.
status stringCREATED, PENDING, COMPLETED, FAILED, CANCELLED No Status.
receiptType stringINCOME, EXPENSE, REFUND, EXPENSE_REFUND No Receipt Type.
totalAmount number · double No Total Amount.
createdDate string · date-time No Created Date.
completedDate string · date-time No Completed Date.
errorMessage string No Error Message.
{
  "id": 1001,
  "clientId": 1001,
  "orderId": 1001,
  "organizationId": 1001,
  "externalReceiptId": "string",
  "fiscalNumber": "string"
}
Errors3

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

FieldTypeRequiredDescription
receiptId integer · int64 Yes Receipt Id.
curl --request GET 'https://api.selsup.ru/api/receipt/1001' \
  --header 'Authorization: YOUR_API_TOKEN'

Success response

200
Object fields Receipt
FieldTypeRequiredDescription
id integer · int64 No Id.
clientId integer · int64 No Client Id.
orderId integer · int64 No Order Id.
organizationId integer · int64 No Organization Id.
externalReceiptId string No External Receipt Id.
fiscalNumber string No Fiscal Number.
cashRegisterService stringNONE, EVOTOR, ATOL No Cash Register Service.
fnsUrl string No Fns Url.
status stringCREATED, PENDING, COMPLETED, FAILED, CANCELLED No Status.
receiptType stringINCOME, EXPENSE, REFUND, EXPENSE_REFUND No Receipt Type.
totalAmount number · double No Total Amount.
createdDate string · date-time No Created Date.
completedDate string · date-time No Completed Date.
errorMessage string No Error Message.
{
  "id": 1001,
  "clientId": 1001,
  "orderId": 1001,
  "organizationId": 1001,
  "externalReceiptId": "string",
  "fiscalNumber": "string"
}
Errors3

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

FieldTypeRequiredDescription
receiptId integer · int64 Yes Receipt Id.
curl --request GET 'https://api.selsup.ru/api/receipt/1001/update' \
  --header 'Authorization: YOUR_API_TOKEN'

Success response

200
Object fields Receipt
FieldTypeRequiredDescription
id integer · int64 No Id.
clientId integer · int64 No Client Id.
orderId integer · int64 No Order Id.
organizationId integer · int64 No Organization Id.
externalReceiptId string No External Receipt Id.
fiscalNumber string No Fiscal Number.
cashRegisterService stringNONE, EVOTOR, ATOL No Cash Register Service.
fnsUrl string No Fns Url.
status stringCREATED, PENDING, COMPLETED, FAILED, CANCELLED No Status.
receiptType stringINCOME, EXPENSE, REFUND, EXPENSE_REFUND No Receipt Type.
totalAmount number · double No Total Amount.
createdDate string · date-time No Created Date.
completedDate string · date-time No Completed Date.
errorMessage string No Error Message.
{
  "id": 1001,
  "clientId": 1001,
  "orderId": 1001,
  "organizationId": 1001,
  "externalReceiptId": "string",
  "fiscalNumber": "string"
}
Errors3

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.

Authorization

Token for test requests

The token stays in this browser's localStorage and is sent only in the Authorization header of requests to api.selsup.ru.

Try it

Real request parameters

Live API response

Send a request to see the SelSup response.