Службове внесення / Службова видача

Запит

URI: /api/v2/check/service

Метод дозволяє реалізувати службове внесення або службову видачу.

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

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

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

Ім'я	Тип	Обов'язковий	Опис
api_token	string	Так	Токен авторизації, згенерований в особистому кабінеті
action_type	string	Так	Тип дії: SERVICE_INPUT — службове внесення SERVICE_OUTPUT — службова видача
num_fiscal	integer	Так	Фіскальний номер каси
type	integer	Так	Тип оплати
name	string	Так	Назва типу оплати
sum	float	Так	Сума внесення або видачі
open_shift	boolean		Прапор відкриття зміни Якщо зміна закрита і передано значення `True`, тоді зміна буде відкрита
local_number	integer		Локальний номер операції, який клієнт передає з кожним чеком
no_print_text	boolean	Ні	Виключити текстове представлення чека з відповіді
no_pdf	boolean	Ні	Виключити pdf представлення чека з відповіді

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

Запит: /api/v2/check/service
{
    "api_token": "42b5eaccba739f08***e7fe157eba8bf",
    "action_type": "SERVICE_INPUT",
    "num_fiscal": 4000022469,
    "type": 0,
    "name": "ГОТІВКА",
    "sum": 35,
    "open_shift": true,
    "local_number": 123,
    "no_print_text": true,
    "no_pdf": true
}

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

інформація

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

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

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

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

Внесення коштів/Інкасація test example

200 OK

Відповідь: /api/v2/check/service
{
    "ORDERNUM": "iKZgRpY-AJA",
    "ORDERDATE": "2021-01-26",
    "ORDERTIME": "16:05:43",
    "MAC": "ab8d3d75eaca553fd1c8ff7c936f533f146e44028ddbb092125d0af175e8fadc",
    "is_offline": false,
    "text_print": "ICAgICAgICAgINCi0JXQodCi0J7QktCY0Jkg0....",
    "qr": "iVBORw0KGgoAAAANSUhEUgAAAV4AAAFeCAYAAADN...",
    "pdf": "JVBERi0xLjcKMSAwIG9iago8PCAvVHlwZSAvQ2F0YW...",
    "link": "http://cashdesk.com/check/b63ad1dd-b218-465e-9251-b2510de77205/html",
    "uuid": "400fe211-c37b-4710-b19e-74a86f535f78",
    "local_number": "123"
}

Внесення коштів / Інкасація

200 OK

Відповідь: /api/v2/check/service
{
    "ORDERNUM": "V_zGRvPtK2g",
    "ORDERDATE": "2020-12-16",
    "ORDERTIME": "17:54:19",
    "MAC": "36e8013db9c09bbb2b00de530ba3cd8cbf213c2ae3f638b4603671106e73eb40",
    "is_offline": false,
    "local_number": null,
    "qr": null,
    "pdf": "JVBERi0xLjcKMSAwIG9iago8PCAvVHlwZSA....",
    "text_print": "ICAgICAgICAgINCi0JXQodCi0J7QktCY0Jkg0KfQldC....",
    "link": "http://cashdesk.com/check/8758126e-207c-4e67-84de-54d301639a53/html"
}

порада

Postman колекція (Службове внесення/Службова видача): https://documenter.getpostman.com/view/12128952/TVRj5U1d#a2195a48-8fce-4f2d-ba30-75ff9fac980a

Запит​

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

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

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

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

Внесення коштів/Інкасація test example​

Внесення коштів / Інкасація​