Звіти, які доступні в особистому кабінеті checkbox - частково доступні в глобальному API Checkbox. Наразі доступні наступні звіти:
Після виконання команди на створення звіту, якщо ви вказували електронну пошту - після опрацювання запиту ви отримаєте лист від відправника [email protected].
Якщо ви раніше відписались від розсилки - в такому разі лист не буде надіслано. Щоб підписатись знов, будь ласка, зверніться до служби підтримки checkbox зручним для вас способом та надайте електрону адресу, яку необхідно знов включити у список.
Якщо ви не отримуєте звіт на пошту тривалий час, необхідно перевірити статус виконання за допомогою метода api/v1/extended-reports/{report_task_id}. Якщо статус DONE - в такому разі очікуйте листа зі звітом, або ви можете отримати файл або відповідь за допомогою методів /api/v1/extended-reports/{report_task_id}/report.xlsx або /api/v1/extended-reports/{report_task_id}/report.json.
У форматі .json можна отримати тільки Звіт по Z-звітам. Усі інші звіти - тільки у .xlsx
Звертаємо вашу увагу, що перелік стовпців в описі не є постійним. Їх порядок та кількість - залежить від багатьох факторів, такі як індивідуальні способи оплати та ін.
Формат звіту: .xlsx
Звіт по товарам не враховує знижки та надбавки на весь чек, тому загальна сума, порахована за цим звітом, буде відрізнятися від загальної суми, порахованої по Z-звітам на суму знижок і надбавок.
Із прикладом звичайного звіту по товарах ви можете ознайомитись за 📥посиланням.
Із прикладом скороченого звіту по товарах ви можете ознайомитись за 📥посиланням.
accept: application/json
X-Client-Name: <назва інтеграції (обов'язкове для заповнення)>
X-Client-Version: <версія інтеграції (опціонально)>
Content-Type: application/json
{
"from_date": "<фіскальна дата у форматі ISO 8601 за шаблоном YYYY-MM-DDThh:mm:ss.ssssss±hh:mm>",
"to_date": "<фіскальна дата у форматі ISO 8601 за шаблоном YYYY-MM-DDThh:mm:ss.ssssss±hh:mm>",
"cash_register_id": "<унікальний ідентифікатор каси у форматі UUID>",
"branch_id": "<унікальний ідентифікатор торгової точки у форматі UUID>",
"emails": ["<e-mail для відправки звіта 1>","<e-mail для відправки звіта 2>"],
"export_extension": "<формат файлу звіту - "EXCEL"/"JSON"(.xlsx/JSON-відповідь)>",
"custom": <флаг false/true, що визначає, чи це взичайний (false), або скорочений (true) звіт>
}
curl -X 'POST' \ 'https://api.checkbox.ua/api/v1/extended-reports/goods' \ -H 'accept: application/json' \ -H 'Authorization: Bearer token' \ -H 'Content-Type: application/json' \ -d '{ "from_date": "2023-09-01T00:00:00+0300", "to_date": "2023-10-01T00:00:00+0300", "cash_register_id": "c13876dd-e51e-433f-a61c-f2c426311111", "emails": ["[email protected]"], "custom": false}'
{
"id": "0e0a1223-9060-4846-8d2e-360a65111111",
"organization_id": "ac9d69b6-c349-4bc0-857f-eee2d3911111",
"type": "GOODS",
"status": "PENDING",
"created_at": "2023-10-04T18:01:42.276125+00:00",
"updated_at": null
}
"id" - унікальний ідентифікатор операції у форматі UUID (report_task_id).
"organization_id" - унікальний ідентифікатор організації у форматі UUID.
"type" - тип звіту.
"status" - статус виконання операції створення звіту.
"created_at" - час створення операції на виконання звіту у форматі ISO 8601 за шаблоном YYYY-MM-DDThh:mm:ss.ssssss±hh:mm.
"updated_at" - мітка часу останнього оновлення даних про операцію у форматі ISO 8601 за шаблоном YYYY-MM-DDThh:mm:ss.ssssss±hh:mm.
Формат звіту: .json
Із прикладом звіту по Z-звітам ви можете ознайомитись за 📥посиланням.
accept: application/json
X-Client-Name: <назва інтеграції (обов'язкове для заповнення)>
X-Client-Version: <версія інтеграції (опціонально)>
Content-Type: application/json
{
"from_date": "<фіскальна дата у форматі ISO 8601 за шаблоном YYYY-MM-DDThh:mm:ss.ssssss±hh:mm>",
"to_date": "<фіскальна дата у форматі ISO 8601 за шаблоном YYYY-MM-DDThh:mm:ss.ssssss±hh:mm>",
"cash_register_id": "<унікальний ідентифікатор каси у форматі UUID>",
"branch_id": "<унікальний ідентифікатор торгової точки у форматі UUID>",
"emails": ["<e-mail для відправки звіта 1>","<e-mail для відправки звіта 2>"],
"export_extension": "<формат файлу звіту - "EXCEL"/"JSON"(.xlsx/JSON-відповідь)>",
"organization_info": <флаг false/true, що визначає, чи додавати інформацію про назву торгової точки та назву організації>
}
curl -X 'POST' \ 'https://api.checkbox.ua/api/v1/extended-reports/z' \ -H 'accept: application/json' \ -H 'Authorization: Bearer token' \ -H 'Content-Type: application/json' \ -d '{ "from_date": "2023-09-01T00:00:00+0300", "to_date": "2023-10-01T00:00:00+0300", "cash_register_id": "c13876dd-e51e-433f-a61c-f2c426311111", "emails": ["[email protected]"], "export_extension": "EXCEL", "organization_info": false}'
{
"id": "f9a4debf-95aa-46fd-a6d5-5f3a5be11111",
"organization_id": "ac9d69b6-c349-4bc0-857f-eee2d3911111",
"type": "Z_REPORTS",
"status": "PENDING",
"created_at": "2023-10-04T18:24:36.458945+00:00",
"updated_at": null
}
"id" - унікальний ідентифікатор операції у форматі UUID (report_task_id).
"organization_id" - унікальний ідентифікатор організації у форматі UUID.
"type" - тип звіту.
"status" - статус виконання операції створення звіту.
"created_at" - час створення операції на виконання звіту у форматі ISO 8601 за шаблоном YYYY-MM-DDThh:mm:ss.ssssss±hh:mm.
"updated_at" - мітка часу останнього оновлення даних про операцію у форматі ISO 8601 за шаблоном YYYY-MM-DDThh:mm:ss.ssssss±hh:mm.
Формат звіту: .xlsx
Із прикладом звіту по фактичній виручці ви можете ознайомитись за 📥посиланням.
accept: application/json
X-Client-Name: <назва інтеграції (обов'язкове для заповнення)>
X-Client-Version: <версія інтеграції (опціонально)>
Content-Type: application/json
{
"from_date": "<фіскальна дата у форматі ISO 8601 за шаблоном YYYY-MM-DDThh:mm:ss.ssssss±hh:mm>",
"to_date": "<фіскальна дата у форматі ISO 8601 за шаблоном YYYY-MM-DDThh:mm:ss.ssssss±hh:mm>",
"emails": ["<e-mail для відправки звіта 1>","<e-mail для відправки звіта 2>"]
}
curl -X 'POST' \ 'https://api.checkbox.ua/api/v1/extended-reports/actual_revenue' \ -H 'accept: application/json' \ -H 'Authorization: Bearer token' \ -H 'Content-Type: application/json' \ -d '{ "from_date": "2023-09-01T00:00:00+0300", "to_date": "2023-10-01T00:00:00+0300", "emails": ["[email protected]"]}'
{
"id": "1a36ddf3-d649-42a7-a8c5-79366a911111",
"organization_id": "ac9d69b6-c349-4bc0-857f-eee2d3911111",
"type": "ACTUAL_REVENUE",
"status": "PENDING",
"created_at": "2023-10-04T18:28:39.183636+00:00",
"updated_at": null,
"error_message": null,
"payload": {
"from_date": "2023-09-01T00:00:00+03:00",
"to_date": "2023-10-01T00:00:00+03:00",
"mode": null,
"emails": [
"[email protected]"
],
"organization_id": "ac9d69b6-c349-4bc0-857f-eee2d3911111"
},
"execution_time": null
}
"id" - унікальний ідентифікатор операції у форматі UUID (report_task_id).
"organization_id" - унікальний ідентифікатор організації у форматі UUID.
"type" - тип звіту.
"status" - статус виконання операції створення звіту.
"created_at" - час створення операції на виконання звіту у форматі ISO 8601 за шаблоном YYYY-MM-DDThh:mm:ss.ssssss±hh:mm.
"updated_at" - мітка часу останнього оновлення даних про операцію у форматі ISO 8601 за шаблоном YYYY-MM-DDThh:mm:ss.ssssss±hh:mm.
"error_message" - опис помилки виконання операції створення звіту.
"execution_time" - час виконання операції на створення звіту.
"payload" - масив даних із тілом запиту на створення звіту, який містить в собі:
Формат звіту: .xlsx
Із прикладом по даним по чистому обігу ви можете ознайомитись за 📥посиланням.
accept: application/json
X-Client-Name: <назва інтеграції (обов'язкове для заповнення)>
X-Client-Version: <версія інтеграції (опціонально)>
Content-Type: application/json
{
"from_date": "<фіскальна дата у форматі ISO 8601 за шаблоном YYYY-MM-DDThh:mm:ss.ssssss±hh:mm>",
"to_date": "<фіскальна дата у форматі ISO 8601 за шаблоном YYYY-MM-DDThh:mm:ss.ssssss±hh:mm>",
"emails": ["<e-mail для відправки звіта 1>","<e-mail для відправки звіта 2>"]
}
curl -X 'POST' \ 'https://api.checkbox.ua/api/v1/extended-reports/net_turnover' \ -H 'accept: application/json' \ -H 'Authorization: Bearer token' \ -H 'Content-Type: application/json' \ -d '{ "from_date": "2023-09-01T00:00:00+0300", "to_date": "2023-10-01T00:00:00+0300", "emails": ["[email protected]"]}'
{
"id": "0c71af5e-eec1-4781-997a-50fde9c11111",
"organization_id": "ac9d69b6-c349-4bc0-857f-eee2d3911111",
"type": "NET_TURNOVER",
"status": "PENDING",
"created_at": "2023-10-04T18:37:13.425040+00:00",
"updated_at": null,
"error_message": null,
"payload": {
"from_date": "2023-09-01T00:00:00+03:00",
"to_date": "2023-10-01T00:00:00+03:00",
"mode": null,
"emails": [
"[email protected]"
],
"organization_id": "ac9d69b6-c349-4bc0-857f-eee2d3911111"
},
"execution_time": null
}
"id" - унікальний ідентифікатор операції у форматі UUID (report_task_id).
"organization_id" - унікальний ідентифікатор організації у форматі UUID.
"type" - тип звіту.
"status" - статус виконання операції створення звіту.
"created_at" - час створення операції на виконання звіту у форматі ISO 8601 за шаблоном YYYY-MM-DDThh:mm:ss.ssssss±hh:mm.
"updated_at" - мітка часу останнього оновлення даних про операцію у форматі ISO 8601 за шаблоном YYYY-MM-DDThh:mm:ss.ssssss±hh:mm.
"error_message" - опис помилки виконання операції створення звіту.
"execution_time" - час виконання операції на створення звіту.
"payload" - масив даних із тілом запиту на створення звіту, який містить в собі:
Формат звіту: .xlsx
Із прикладом звіту по даних по Z-звітам ви можете ознайомитись за 📥посиланням.
accept: application/json
X-Client-Name: <назва інтеграції (обов'язкове для заповнення)>
X-Client-Version: <версія інтеграції (опціонально)>
Content-Type: application/json
{
"from_date": "<фіскальна дата у форматі ISO 8601 за шаблоном YYYY-MM-DDThh:mm:ss.ssssss±hh:mm>",
"to_date": "<фіскальна дата у форматі ISO 8601 за шаблоном YYYY-MM-DDThh:mm:ss.ssssss±hh:mm>",
"emails": ["<e-mail для відправки звіта 1>","<e-mail для відправки звіта 2>"]
}
curl -X 'POST' \ 'https://api.checkbox.ua/api/v1/extended-reports/bookkeeper_z_report' \ -H 'accept: application/json' \ -H 'Authorization: Bearer token' \ -H 'Content-Type: application/json' \ -d '{ "from_date": "2023-09-01T00:00:00+0300", "to_date": "2023-10-01T00:00:00+0300", "emails": ["[email protected]"]}'
{
"id": "ab568e33-e5d6-4b03-836f-e9a770911111",
"organization_id": "ac9d69b6-c349-4bc0-857f-eee2d3911111",
"type": "BOOKKEEPER_Z_REPORT",
"status": "PENDING",
"created_at": "2023-10-04T18:38:14.760382+00:00",
"updated_at": null,
"error_message": null,
"payload": {
"from_date": "2023-09-01T00:00:00+03:00",
"to_date": "2023-10-01T00:00:00+03:00",
"mode": null,
"emails": [
"[email protected]"
],
"organization_id": "ac9d69b6-c349-4bc0-857f-eee2d3911111"
},
"execution_time": null
}
"id" - унікальний ідентифікатор операції у форматі UUID (report_task_id).
"organization_id" - унікальний ідентифікатор організації у форматі UUID.
"type" - тип звіту.
"status" - статус виконання операції створення звіту.
"created_at" - час створення операції на виконання звіту у форматі ISO 8601 за шаблоном YYYY-MM-DDThh:mm:ss.ssssss±hh:mm.
"updated_at" - мітка часу останнього оновлення даних про операцію у форматі ISO 8601 за шаблоном YYYY-MM-DDThh:mm:ss.ssssss±hh:mm.
"error_message" - опис помилки виконання операції створення звіту.
"execution_time" - час виконання операції на створення звіту.
"payload" - масив даних із тілом запиту на створення звіту, який містить в собі:
Формат звіту: .xlsx
Із прикладом звіту по даних по Z-звітам ви можете ознайомитись за 📥посиланням.
accept: application/json
X-Client-Name: <назва інтеграції (обов'язкове для заповнення)>
X-Client-Version: <версія інтеграції (опціонально)>
Content-Type: application/json
{
"from_date": "фіскальна дата у форматі ISO 8601 за шаблоном YYYY-MM-DD>",
"organization_id": ["<унікальний ідентифікатор організації у форматі UUID 1>","<унікальний ідентифікатор організації у форматі UUID 2>"],
"emails": ["<e-mail для відправки звіта 1>","<e-mail для відправки звіта 2>"]
}
curl -X 'POST' \ 'https://api.checkbox.ua/api/v1/extended-reports/daily_cash_flow' \ -H 'accept: application/json' \ -H 'Authorization: Bearer token' \ -H 'Content-Type: application/json' \ -d '{ "from_date": "2023-10-03", "organization_id": ["ac9d69b6-c349-4bc0-857f-eee2d3911111"], "emails": ["[email protected]"]}'
{
"id": "fbbe7571-6fc3-46b4-80d7-2324a1a11111",
"organization_id": "ac9d69b6-c349-4bc0-857f-eee2d3911111",
"type": "DAILY_CASH_FLOW",
"status": "PENDING",
"created_at": "2023-10-04T18:41:00.194611+00:00",
"updated_at": null,
"error_message": null,
"payload": {
"from_date": "2023-10-03",
"organization_id": [
"ac9d69b6-c349-4bc0-857f-eee2d3911111"
],
"emails": [
"[email protected]"
]
},
"execution_time": null
}
"id" - унікальний ідентифікатор операції у форматі UUID (report_task_id).
"organization_id" - унікальний ідентифікатор організації у форматі UUID.
"type" - тип звіту.
"status" - статус виконання операції створення звіту.
"created_at" - час створення операції на виконання звіту у форматі ISO 8601 за шаблоном YYYY-MM-DDThh:mm:ss.ssssss±hh:mm.
"updated_at" - мітка часу останнього оновлення даних про операцію у форматі ISO 8601 за шаблоном YYYY-MM-DDThh:mm:ss.ssssss±hh:mm.
"error_message" - опис помилки виконання операції створення звіту.
"execution_time" - час виконання операції на створення звіту.
"payload" - масив даних із тілом запиту на створення звіту, який містить в собі:
PENDING, DONE, ERROR. accept: application/json
report_task_id: <унікальний ідентифікатор операції у форматі UUID>
X-Client-Name: <назва інтеграції (обов'язкове для заповнення)>
X-Client-Version: <версія інтеграції (опціонально)>
Content-Type: application/json
Тіло запиту у даному випадку має бути порожнім.
curl -X 'GET' \ 'https://api.checkbox.ua/api/v1/extended-reports/fbbe7571-6fc3-46b4-80d7-2324a1a11111' \ -H 'accept: application/json' \ -H 'Authorization: Bearer tоken'
{
"id": "fbbe7571-6fc3-46b4-80d7-2324a1a11111",
"organization_id": "ac9d69b6-c349-4bc0-857f-eee2d3911111",
"type": "DAILY_CASH_FLOW",
"status": "DONE",
"created_at": "2023-10-04T18:41:00.194611+00:00",
"updated_at": "2023-10-04T18:41:00.576594+00:00"
}
"id" - унікальний ідентифікатор операції у форматі UUID (report_task_id).
"organization_id" - унікальний ідентифікатор організації у форматі UUID.
"type" - тип звіту.
"status" - статус виконання операції створення звіту.
"created_at" - час створення операції на виконання звіту у форматі ISO 8601 за шаблоном YYYY-MM-DDThh:mm:ss.ssssss±hh:mm.
"updated_at" - мітка часу останнього оновлення даних про операцію у форматі ISO 8601 за шаблоном YYYY-MM-DDThh:mm:ss.ssssss±hh:mm.
У форматі .json можна отримати тільки Звіт по Z-звітам. Усі інші звіти - тільки у .xlsx
accept: application/json
report_task_id: <унікальний ідентифікатор операції у форматі UUID>
X-Client-Name: <назва інтеграції (обов'язкове для заповнення)>
X-Client-Version: <версія інтеграції (опціонально)>
Content-Type: application/json
Тіло запиту у даному випадку має бути порожнім.
curl -X 'GET' \ 'https://api.checkbox.ua/api/v1/extended-reports/fbbe7571-6fc3-46b4-80d7-2324a1a11111/report.json' \ -H 'accept: application/json' \ -H 'Authorization: Bearer token'
Файл .xlsx із звітом, або масив даних звіту в форматі JSON.
Якщо у Вас виникли питання, Ви знайшли помилку або хочете запропонувати вказати додаткову інформацію в інструкціях - Ви завжди можете зв'язатись з нами зручним для вас [способом][contacts].