Отримати JSON представлення чека
Запит
URI: /api/v2/checks/:id/json?api_token={api_token}
Метод дозволяє отримати JSON представлення чека.
Запит виконується методом GET.
⚠️ Запит повинен містити заголовки Accept: application/json та Content-Type: application/json
Параметри URI
Метод дозволяє передати в рядку запиту наступні параметри:
Ім'я | Тип | Обов'язковий | Опис |
---|---|---|---|
id | string | Так | Ідентифікатор фіскального чека (UUID або ORDER_NUM) |
api_token | string | Так | Токен авторизації, згенерований в ос обистому кабінеті |
Приклад запиту
/api/v2/checks/1fc9e619-3101-44ef-81b7-fb2baa7ccef0/json?api_token=42b5eaccba739f08***e7fe157eba8bf
Параметри відповіді
Ім'я | Тип | Опис |
---|---|---|
check_type | string | Тип чека |
hash | string | Хеш-сума чека |
ORDERNUM | string | Номер чека |
ORDERDATE | string | Дата формування чека |
ORDERTIME | string | Час формування чека |
is_offline | boolean | Ознака офлайн чека |
total_sum | float | Загальна сума чека |
payments | list[object] | Містить параметри методів оплати |
payments.code | integer | Код методу оплати |
payments.name | string | Назва методу оплати |
payments.sum | float | Сума оплати |
payments.sum_provided | integer | Передана сума |
payments.sum_remains | float | Сума решти |
payments.pay_terminal | list[object] | Параметри термінала при оплаті карткою |
payments.pay_terminal.name | string | Назва термінала |
payments.pay_terminal.terminal_id | string | Ідентифікатор термінала |
payments.pay_terminal.epz | string | Маска картки |
payments.pay_terminal.card_type | string | Тип картки |
payments.pay_terminal.auth_code | string | Код авторизації |
payments.pay_terminal.rrn | string | Унікальний ідентифікатор банківської транзакції |
payments.pay_terminal.additional_text | string | Додатковий текст |
tax | list[object] | Дані податку |
tax.name | string | Назва податку |
tax.letter | string | Літера податку |
tax.prc | integer | Відсоток податку |
tax.turnover | float | Оборот |
tax.sum | float | Сума податку |
tax.excise_prc | string | Відсоток акцизного податку |
tax.excise_sum | integer | Сума акцизного податку |
products | list[object] | Містить параметри товарів в чека |
products.code | string | Код товару |
products.uktzed | string | |
products.unit_code | string | Код одиниці виміру кількості товару |
products.unit_name | string | Назва одиниці виміру кількості товару |
products.amount | float | Кількість товару Не більше трьох знаків після коми |
products.name | string | Назва товару |
products.price | float | Ціна за одиницю товару |
products.letters | string | Літера податку |
products.cost | float | Підсумок по даній позиції Не більше двох знаків після коми |
products.sum_discount | integer | Сума знижки |
products.bar_code | string | Штрих-код товару |
products.excise_barcode | string | Акцизний штрих-код |
offline_id | string | |
date | string | Дата формування чека |
local_number | integer | Локальний номер операції, який клієнт передає з кожним чеком |
footer | string | Текст в нижній частині чека |
round_sum | float | Сума округлення |
qr | string | QR код чека |
qr_data | string | Дані для генерації QR кода |
link | string | Посилання на електронний чек |
string | PDF представлення чека | |
text_print | string | Текстове представлення чека |
uuid | string | Ідентифікатор чека |
cash_in_box | float | Поточна кількість грошей в касі |
Приклад успішної відповіді
Отримати JSON представлення чека
200 OK
Відповідь: /api/v2/checks/1fc9e619-3101-44ef-81b7-fb2baa7ccef0/json?api_token=42b5eaccba739f08***e7fe157eba8bf
{
"check_type": "Z_SALE",
"hash": "a520c29c8e27e6ee2b7a044e8a6df53c50de7acab9fd907fd676f2700ea9a75a",
"ORDERNUM": "P1d1pjuMHjA",
"ORDERDATE": "2021-08-10",
"ORDERTIME": "07:30:06",
"is_offline": false,
"total_sum": 50.1,
"payments": [
{
"code": 0,
"name": "ГОТIВКА",
"sum": 25.1,
"sum_provided": 100,
"sum_remains": 74.9,
"pay_terminal": null
},
{
"code": 1,
"name": "KARTKA",
"sum": 25,
"sum_provided": 25,
"sum_remains": 0,
"pay_terminal": {
"name": "Ощадбанк",
"terminal_id": "40904582",
"epz": "4149XXXXXXXX5807",
"card_type": "VISA GOLD",
"auth_code": "538296",
"rrn": "000018706638",
"additional_text": "Тримач ЕПЗ - підпис"
}
}
],
"tax": [
{
"name": "ПДВ А 20%",
"letter": "А",
"prc": 20,
"turnover": 50.06,
"sum": 8.34,
"excise_prc": null,
"excise_sum": 0
}
],
"products": [
{
"code": null,
"uktzed": null,
"unit_code": null,
"unit_name": null,
"amount": 1,
"name": "Води питна ZN",
"price": 50.06,
"letters": "А",
"cost": 50.06,
"sum_discount": 0,
"bar_code": null,
"excise_barcode": null
}
],
"offline_id": null,
"date": null,
"local_number": 10,
"footer": "This is my\n custom footer! Welcome to CashDesk! \n Test \n Next line text!",
"round_sum": 0.04,
"qr": null,
"qr_data": "http://cashdesk.com/wc/P1d1pjuMHjA",
"link": "http://cashdesk.com/check/1fc9e619-3101-44ef-81b7-fb2baa7ccef0/html",
"pdf": null,
"text_print": null,
"uuid": "1fc9e619-3101-44ef-81b7-fb2baa7ccef0",
"cash_in_box": 37212.44
}