Чеки

Create Receipt

Створення чека продажу/повернення, його фіскалізація та доставка клієнту по email.

post/api/v1/receipts/sell

Request

  • Base URL: https://api.checkbox.ua (the document declares no server; this is the origin it was published from)
  • URL: https://api.checkbox.ua/api/v1/receipts/sell
  • Auth: HTTP bearer

Headers

X-Client-Namestring

Назва клієнту або сервісу що інтегрується з API, наприклад 'My Custom SDK'

X-Client-Versionstring

Номер версії клієнту що інтегрується з API, наприклад 'v1.2.5'

X-Device-IDstring

ID RRO Agent або мобільного пристрою каси (Для блокування дублікатів)

X-Access-Keystring

Ключ доступу інтеграції (тільки для авторизованих API інтеграцій)

Request body

idstring uuid

Обов'язково вкажіть унікальний UUID чеку!

cashier_namestring
departamentstring
roundingboolean

Застаріле поле, використовуйте rounding_mode

rounding_mode'ROUND_10' | 'ROUND_50'

An enumeration.

headerstring
footerstring
barcodestring
order_idstring uuid
related_receipt_idstring uuid
related_receipt_created_atstring date-time
stock_codestring
technical_returnboolean
is_pawnshopboolean
contextobject
previous_receipt_idstring uuid

id попереднього фіскального чека (використовується опціонально для контролю послідовності)

callback_urlstring uri

Example request

{
  "payments": [
    {
      "type": "CASH",
      "value": 4242
    }
  ]
}

Response

Successful Response

idstring uuid required
serialinteger required
status'CREATED' | 'DONE' | 'ERROR' | 'CANCELLATION' | 'CANCELLED' required

An enumeration.

total_suminteger required

Застаріле поле, використовуйте 'total_sum'

total_paymentinteger required
total_restinteger required

Застаріле поле, використовуйте 'total_rest'

round_suminteger
fiscal_codestring
fiscal_datestring date-time
delivered_atstring date-time
created_atstring date-time required
updated_atstring date-time
is_created_offlineboolean
is_sent_dpsboolean
fiscal_api_type'FSCO_EC' | 'EVPEZ' | 'EVPEZ_EXTERNAL'

An enumeration.

type'SELL' | 'RETURN' | 'SERVICE_IN' | 'SERVICE_OUT' | 'SERVICE_CURRENCY' | 'CURRENCY_EXCHANGE' | 'PAWNSHOP' | 'CASH_WITHDRAWAL' required

An enumeration.

order_idstring uuid
headerstring
footerstring
barcodestring
contextobject
sent_dps_atstring date-time
tax_urlstring
related_receipt_idstring uuid
technical_returnboolean
stock_codestring
pre_payment_relation_idstring
rounding_mode'ROUND_10' | 'ROUND_50'

An enumeration.

is_testboolean
shift_idstring uuid required
transaction_idstring uuid
control_numberstring
cashier_idstring uuid
cash_register_idstring uuid
deliveryobject
processed_counterinteger
organization_idstring uuid

Example response

{
  "payments": [
    {
      "type": "CASH",
      "value": 4242
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.