Відкрити / Закрити зміну (Z-звіт)

Запит

URI: /api/v2/shift

Метод дозволяє відкрити або закрити зміну та сформувати Z-звіт.

Запит виконується методом POST з тілом запиту у JSON форматі.

⚠️ Запит повинен містити заголовки Accept: application/json та Content-Type: application/json

Параметри запиту

Ім'я	Тип	Обов'язковий	Опис
api_token	string	Так	Токен авторизації, згенерований в особистому кабінеті
num_fiscal	integer	Так	Фіскальний номер каси
action_type	string	Так	Тип дії: OPEN_SHIFT — Відкрити зміну Z_REPORT — Закрити зміну (Z-звіт)

Приклад запиту

Запит: /api/v2/shift

{
    "api_token": "42b5eaccba739f08***e7fe157eba8bf",
    "num_fiscal": 4000022469,
    "action_type": "OPEN_SHIFT"
}

Параметри відповіді

інформація

Існує два способи друку чека:

1. PDF-друк — повне представлення чека у форматі PDF
2. Текстовий друк (поле text_print) — текстове представлення чека

Ім'я	Тип	Опис
ORDERNUM	string	Номер чека зі Z-звітом
ORDERDATE	string	Дата формування чека зі Z-звітом
ORDERTIME	string	Час формування чека зі Z-звітом
MAC	string	Код аутентифікації повідомлення чека
is_offline	boolean	Ознака офлайн чека
local_number	string	Локальний номер операції, який клієнт передає з кожним чеком
text_print	string	Текстове представлення чека у форматі Base64. Клієнт самостійно обирає параметри шрифту та спосіб друку
qr	string	QR код чека у форматі Base64. Для використання з текстовим чеком – додаткове зображення для друку
pdf	string	PDF представлення чека у форматі Base64. Може бути одразу роздруковане без додаткової обробки
link	string	Посилання для перегляду чека на сайті

Приклади успішних відповідей

Закрити зміну та сформувати Z-звіт

200 OK

Відповідь: /api/v2/shift

{
    "ORDERNUM": "p1ouE8yMJjc",
    "ORDERDATE": "2020-12-16",
    "ORDERTIME": "16:56:06",
    "MAC": "2c99b1080924dd08e7671f48f0f800b3c01ff570083e5ee6fca6e65e36cb1964",
    "is_offline": false,
    "local_number": null,
    "text_print": "ICAgICAgICAgINCi0JXQodCi0J7QktCY0Jkg0....",
    "qr": "iVBORw0KGgoAAAANSUhEUgAAAV4AAAFeCAYAAADN...",
    "pdf": "JVBERi0xLjcKMSAwIG9iago8PCAvVHlwZSAvQ2F0YW...",
    "link": "http://cashdesk.com/check/b63ad1dd-b218-465e-9251-b2510de77205/html"
}

Відкрити зміну

200 OK

Відповідь: /api/v2/shift

{
    "ORDERNUM": "lpiU0OluPKk",
    "ORDERDATE": "2020-12-16",
    "ORDERTIME": "16:55:41",
    "MAC": "b485c4450d8fc6742c8a9ab5e0550d8c37ee40349942627af7d48e2c82f9a297",
    "is_offline": false,
    "local_number": null,
    "qr": null,
    "pdf": null,
    "text_print": null,
    "link": null
}

Приклад неуспішної відповіді

Зміна вже відкрита

400 Bad Request

Відповідь: 400 Bad Request

{
    "message": "ДФС зміна вже відкрита"
}

порада

Postman колекція (Відкрити/Закрити зміну (Z-звіт)): https://documenter.getpostman.com/view/12128952/TVRj5U1d#debd20ba-7025-4c6f-9297-b6e804075252