Періодичний звіт – звіт, який містить підсумкову контрольно-звітну інформацію за будь-який період, сформовану на основі даних Z-звітів.
Періодичний звіт містить:
Для отримання періодичного звіту використовується метод /api/v1/reports/periodical. Звіт доступний лише в текстовому форматі без перегляду за посиланням.
Параметри запиту регулюються ключами:
accept: text/plain
X-Client-Name: <назва інтеграції (обов`язково)>
X-Client-Version: <версія інтеграції (обов`язково)>
X-License-Key: <ключ ліцензії каси (обов`язково)>
Тіло запиту у даному випадку має бути порожнім.
curl -X 'GET' \ 'https://api.checkbox.ua/api/v1/reports/periodical?from_date=2023-11-01T00%3A00%3A00%2B0200&to_date=2023-11-30T00%3A00%3A00%2B0200&width=42&is_short=false' \ -H 'accept: text/plain' \ -H 'X-Client-Name: Test-Client-Name' \ -H 'X-Client-Version: Test-Client-Version' \ -H 'X-License-Key: test3a544a54373a9cb3f2711111'
txt представлення звіту з деталями фіскальних операцій, оборотів, операцій з готівковими коштами та іншою інформацією, яка складається з різних розділів та підсекцій
Х-звіт – це не фіскальний звіт, призначений для контролю роботи каси. Показує всі операції (підсумкові суми), проведені протягом зміни. Х-звіт можна знімати в будь-який час і в будь-якій кількості протягом робочого часу (відкритої касової зміни).
accept: application/json
X-Client-Name: <назва інтеграції (обов`язково)>
X-Client-Version: <версія інтеграції (обов`язково)>
Authorization: <токен авторизації>
Content-Type: application/json
Тіло запиту у даному випадку має бути порожнім.
curl -X 'POST' \ 'https://api.checkbox.ua/api/v1/reports' \ -H 'accept: application/json' \ -H 'X-Client-Name: Test-Client-Name' \ -H 'X-Client-Version: Test-Client-Version' \ -H 'Authorization: Bearer token' \ -d ''
{
"id": "860e6c37-43bc-498a-b801-58a927511111",
"serial": 16,
"is_z_report": false,
"payments": [
{
"id": "601194e1-1267-4012-9736-f7ccea711111",
"code": null,
"type": "CASH",
"provider_type": null,
"label": "Готівка",
"sell_sum": 16420,
"return_sum": 0,
"service_in": 10000,
"service_out": 0,
"cash_withdrawal": 0,
"cash_withdrawal_commission": 0
},
{
"id": "a927bd11-a885-43fd-8fed-cefba0011111",
"code": null,
"type": "CASHLESS",
"provider_type": null,
"label": "Картка",
"sell_sum": 56300,
"return_sum": 0,
"service_in": 0,
"service_out": 20000,
"cash_withdrawal": 20000,
"cash_withdrawal_commission": 0
}
],
"taxes": [
{
"id": "4cce63e6-3aa1-4341-a0e2-1372e9e11111",
"code": 1,
"label": "ПДВ + Акцизний збір",
"symbol": "А",
"rate": 20,
"sell_sum": 11617,
"return_sum": 0,
"sales_turnover": 56300,
"returns_turnover": 0,
"no_vat": false,
"advanced_code": null,
"created_at": "2023-09-27T07:57:17.436553+00:00",
"setup_date": "2023-09-27T07:57:17.436553+00:00"
},
{
"id": "613406bb-1c12-40db-8e06-21a874d11111",
"code": 2,
"label": "Акцизний збір",
"symbol": "Б",
"rate": 0,
"sell_sum": 0,
"return_sum": 0,
"sales_turnover": 0,
"returns_turnover": 0,
"no_vat": false,
"advanced_code": null,
"created_at": "2023-11-03T10:19:06.625503+00:00",
"setup_date": "2023-11-03T10:19:06.625503+00:00"
},
{
"id": "3785ce91-ee57-465b-8689-fff521011111",
"code": 5,
"label": "ПДВ 20%",
"symbol": "Є",
"rate": 20,
"sell_sum": 0,
"return_sum": 0,
"sales_turnover": 0,
"returns_turnover": 0,
"no_vat": false,
"advanced_code": null,
"created_at": "2023-09-27T07:57:32.979471+00:00",
"setup_date": "2023-09-27T07:57:32.979471+00:00"
},
{
"id": "2c5a16da-c101-444a-bb88-17d6dae11111",
"code": 8,
"label": "Без ПДВ",
"symbol": "З",
"rate": 0,
"sell_sum": 0,
"return_sum": 0,
"sales_turnover": 16417,
"returns_turnover": 0,
"no_vat": true,
"advanced_code": null,
"created_at": "2023-09-27T07:57:34.983722+00:00",
"setup_date": "2023-09-27T07:57:34.983722+00:00"
}
],
"sell_receipts_count": 2,
"return_receipts_count": 0,
"cash_withdrawal_receipts_count": 1,
"transfers_count": 0,
"transfers_sum": 0,
"balance": 6420,
"initial": 0,
"sales_round_up": 3,
"sales_round_down": 0,
"returns_round_up": 0,
"returns_round_down": 0,
"created_at": "2023-11-06T15:38:45.775429+00:00",
"updated_at": null,
"discounts_sum": 5583,
"extra_charge_sum": 0,
"transaction_fail": false
}
Звіт:
"id" - унікальний ідентифікатор звіту у форматі UUID.
"serial" - порядковий номер звіту.
"is_z_report" - флаг, що визначає, чи є даний звіт Z-звітом. Для X-звіту завжди false.
"payments" - масив із списком способів оплати.
Способи оплати (payments):
"id" - унікальний ідентифікатор способу оплати у форматі UUID.
"code" - код способу оплати.
"type" - тип способу оплати (CASH/CASHLESS).
"provider_type" - тип постачальника (може бути null).
"label" - текстовий опис способу оплати.
"sell_sum" - сума продажів з даною формою оплати у копійках.
"return_sum" - сума повернень з даною формою оплати у копійках.
"service_in" - сума службових внесень з даною формою оплати у копійках.
"service_out" - сума службових винесень з даною формою оплати у копійках.
"cash_withdrawal" - сума операцій з видачі готівкових коштів у копійках.
"cash_withdrawal_commission" - сума комісійних нарахувань по операціям з видачі готівкових коштів у копійках.
Податкові ставки (taxes):
"id" - унікальний ідентифікатор податкової ставки у форматі UUID.
"code" - цифровий код податкової ставки.
"label" - назва податкової ставки.
"symbol" - літерний код податкової ставки.
"rate" - розмір податкової ставки у відсотках.
"sell_sum" - загальний оборот по податку усіх чеків продажу в копійках у рамках зміни.
"return_sum" - загальний оборот по податку усіх чеків повернення в копійках у рамках зміни.
"sales_turnover" - сума продажів з цією податковою ставкою (оборот) у копійках.
"returns_turnover" - сума повернень з цією податковою ставкою (оборот) у копійках.
"no_vat" - флаг, який позначає, чи є ця податкова ставка без ПДВ.
"advanced_code" - додатковий код (може бути null).
"created_at" - мітка часу створення податкової ставки у форматі ISO 8601.
"setup_date" - мітка часу встановлення податкової ставки у форматі ISO 8601.
Інші параметри:
"sell_receipts_count" - кількість чеків продажу.
"return_receipts_count" - кількість чеків повернення.
"cash_withdrawal_receipts_count" - кількість чеків по операціям з видачі готівкових коштів.
"transfers_count" - кількість переказів.
"transfers_sum" - сума переказів.
"balance" - баланс каси у копійках на момент створення звіту.
"initial" - початковий баланс каси у копійках на момент відкриття зміни.
"sales_round_up" - кількість округлень вгору для продажів.
"sales_round_down" - кількість округлень вниз для продажів.
"returns_round_up" - кількість округлень вгору для повернень.
"returns_round_down" - кількість округлень вниз для повернень.
"created_at" - мітка часу створення звіту у форматі ISO 8601.
"updated_at" - мітка часу останнього оновлення даних звіту у форматі ISO 8601 (може бути null).
"discounts_sum" - сума знижок.
"extra_charge_sum" - сума додаткових зборів.
"transaction_fail" - флаг, який вказує, чи були виявлені невдачі транзакцій (false - немає невдач).
Візуалізація звітів доступна в текстовому та графчному форматі. Для отримання текстового представлення звіту, після виконання запиту на його створення необхідно виконати метод /api/v1/reports/{report_id}/txt. Для отримання зображення звіту - /api/v1/reports/{report_id}/png.
accept: text/plain або accept: */*
X-Client-Name: <назва інтеграції (обов`язково)>
X-Client-Version: <версія інтеграції (обов`язково)>
Тіло запиту у даному випадку має бути порожнім.
або txt
curl -X 'GET' \ 'https://api.checkbox.ua/api/v1/reports/1ec62f49-c35f-4ff9-ab46-8d2e83111111/text?width=42' \ -H 'accept: text/plain' \ -H 'X-Client-Name: Test-Client-Name' \ -H 'X-Client-Version: Test-Client-Version'
або png
curl -X 'GET' \ 'https://api.checkbox.ua/api/v1/reports/1ec62f49-c35f-4ff9-ab46-8d2e83111111/png?width=30&paper_width=58' \ -H 'accept: */*' \ -H 'X-Client-Name: Test-Client-Name' \ -H 'X-Client-Version: Test-Client-Version'
або txt представлення звіту з деталями фіскальних операцій, оборотів, операцій з готівковими коштами та іншою інформацією, яка складається з різних розділів та підсекцій
або png зображення звіту за вказаними параметрами ширини і ширини паперу.