Реалізація/Повернення (Для аптек)

Запит

URI: /api/v2/check/sale

Метод дозволяє зробити реалізацію або повернення для аптек.

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

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

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

Ім'я	Тип	Обов'язковий	Опис
api_token	string	Так	Токен авторизації, згенерований в особистому кабінеті
num_fiscal	integer	Так	Фіскальний номер каси
action_type	string	Так	Тип дії: Z_SALE - реалізація RETURN - повернення
local_number	string	Так	Локальний номер операції, який клієнт передає з кожним чеком
total_sum	string	Так	Загальна сума чека
products	list[object]	Так	Містить список товарів для реалізації/повернення
products.letters	string	Ні	Літера податку
products.tax_prc	string	Ні	Відсоток податку
products.excise_prc	string	Ні	Відсоток акцизного податку
products.excise_letter	string	Ні	Символ для акцизу
products.code	string	Ні	Код товару
products.unit_code	string	Ні	Код одиниці виміру товару
products.unit_name	string	Ні	Назва одиниці виміру товару
products.name	string	Так	Назва товару
products.uktzed	integer	Ні	УКТЗЕД код товару
products.amount	float	Так	Кількість товару Не більше трьох знаків після коми
products.price	string	Так	Вартість однієї одиниці товару
products.cost	string	Так	Підсумок по даній позиції Не більше двох знаків після коми
products.sum_discount	string	Ні	Сума знижки
payments	list[object]	Так	Містить параметри методів оплати
payments.code	string	Так	Код методу оплати: 0 - ГОТІВКА 1 - БЕЗГОТІВКОВА 2 - ІНШЕ
payments.name	string	Так	Назва форми оплати (рядок 18)
payments.payment_method	string	Ні	Засоби оплати у чеку (рядок 19) Якщо форма оплати ГОТІВКА, рядок 19 Засоби оплати НЕ друкується Якщо форма оплати БЕЗГОТІВКОВА - вкажіть засіб оплати. В іншому випадку за замовчуванням буде вказано Засіб оплати - Електронний платіжний засіб Якщо форма оплати ІНШЕ - власне значення, яке клієнт задає самостійно 🛈 Якщо клієнт НЕ передає значення: для кода 0 - в чеку відображається ГОТІВКА для кода 1,2 - в чеку відображається Електронний платіжний засіб
payments.sum	string	Так	Сума оплати
payments.sum_provided	string	Так	Передана сума
payments.pay_terminal	object	Ні	Параметри термінала при оплаті карткою
payments.pay_terminal.name	string	Ні	Ідентифікатор торговця (MID) Приклад: "493084867"
payments.pay_terminal.terminal_id	string	Ні	Ідентифікатор термінала (TID)
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	Ні	Додатковий текст 🛈 Не використовується
payments.pay_terminal.time	string	Ні	Дата та час оплати через термінал (LiqPay та інші) у форматі 25.04.2023 15:49:03 🛈 Клієнти повинні передавати параметр якщо різниця між оплатою і проведенням чека понад 5 хвилин
footer	string	Ні	Текст в нижній частині чека
open_shift	string	Ні	Прапор відкриття зміни Якщо зміна закрита і передано значення True, тоді зміна буде відкрита
print_width	string	Ні	Ширина чека в символах
pdf_width	string	Ні	Ширина чека PDF

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

Запит: /api/v2/check/sale

{
    "api_token": "42b5eaccba739f08***e7fe157eba8bf",
    "num_fiscal": 4000043214,
    "action_type": "Z_SALE",
    "local_number": "88",
    "total_sum": "100",
    "products": [
        {
            "letters": "А",
            "tax_prc": "20",
            "excise_prc": "5",
            "excise_letter": null,
            "code": "821",
            "unit_code": "2009",
            "unit_name": "штука",
            "name": "Вода питна",
            "uktzed": 4823004003572,
            "amount": "1",
            "price": "50",
            "cost": "50",
            "sum_discount": "0"
        }
    ],
    "payments": [
        {
            "code": "0",
            "name": "ГОТІВКА",
            "payment_method": 'готівка',
            "sum": "100",
            "sum_provided": "100"
         },
        {
            "code": 1,
            "name": "KARTKA",
            "payment_method": 'безготівка',
            "sum": 25,
            "sum_provided": 25,
            "pay_terminal": {
                "name": "493084867",
                "terminal_id": "40904582",
                "epz": "4149XXXXXXXX5807",
                "card_type": "VISA GOLD",
                "auth_code": "538296",
                "rrn": "000018706638",
                "additional_text": "Тримач ЕПЗ - підпис",
                "time":  "03.04.2023 15:15:03"
            }
        }
    ],
    "open_shift": "1",
    "print_width": "32",
    "pdf_width": "48"
}

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

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

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

Продаж/Повернення

200 OK

Відповідь: /api/v2/check/sale

{
    "ORDERNUM": "OTbrl4J6zAQ",
    "ORDERDATE": "2020-12-16",
    "ORDERTIME": "09:58:45",
    "MAC": "2baea23fdcfe2f4d1853ec5ad87d5fbdf65ed0fbf48f60623ac92e2e518d1bce",
    "is_offline": false,
    "local_number": 42,
    "qr": "iVBORw0KGgoAAAANSUhEUgAAAV4AAAFeCAYAAADN...",
    "pdf": "JVBERi0xLjcKMSAwIG9iago8PCAvVHlwZSAvQ2F0YW...",
    "text_print": "ICAgICAgICAgINCi0JXQodCi0J7QktCY0Jkg0....",
    "link": "http://cashdesk.com/check/b63ad1dd-b218-465e-9251-b2510de77205/html"
}

порада

Postman колекція (Реалізація/Повернення (Для аптек)): https://documenter.getpostman.com/view/12128952/TVRj5U1d#1af0743e-a2c2-4fc2-91ae-ef96b2c08834