Перейти до основного вмісту

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

Запит​

URI: /api/v2/check/sale

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

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

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

Правила заокруглення сум при готівкових розрахунках (зміни з 1 жовтня 2025 року).

В запиті необхідно передавати параметри round_sum та round_rule. Детальну інформацію можна переглянути за посиланням

Округленню підлягає лише форма оплати готівкою. В масиві payments передаються округлені значення.

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

Ім'яТипОбов'язковийОпис
api_tokenstringТакТокен авторизації, згенерований в особистому кабінеті
num_fiscalintegerТакФіскальний номер каси
action_typestringТакТип дії:
Z_SALE — реалізація
RETURN — повернення
local_numberstringТакЛокальний номер операції, який клієнт передає з кожним чеком
total_sumstringТакЗагальна сума чека
round_sumfloatНіСума округлення
Вказується різниця в копійках між округленим і не округленим значенням (зі знаком -(знижка) або +(надбавка) відповідно)
round_rulestringНіПравило заокруглення
🛈 за замовчуванням 10
Можливі значення:
  • 0 - заокруглення вимкнено
  • 10 - до 10 копійок
  • 50 - до 50 копійок
  • 100 - до 1 гривні
productslist[object]ТакМістить список товарів для реалізації / повернення
products.lettersstringНіЛітера податку
products.tax_prcstringНіВідсоток податку
products.excise_prcstringНіВідсоток акцизного податку
products.excise_letterstringНіСимвол для акцизу
products.codestringНіКод товару
products.unit_codestringНіКод одиниці виміру товару
products.unit_namestringНіНазва одиниці виміру товару
products.namestringТакНазва товару
products.uktzedintegerНіУКТЗЕД код товару
products.amountfloatТакКількість товару
Не більше трьох знаків після коми
products.pricestringТакВартість однієї одиниці товару без урахування знижки
products.coststringТакВартість товарної позиції без урахування знижки. Відображає базову суму до застосування дисконтних програм.
🛈 Розраховується як добуток ціни products.price та кількості products.amount
Значення повинно містити не більше двох знаків після коми
products.sum_discountstringНіСума знижки для товарної позиції.
🛈 Віднімається від products.cost
paymentslist[object]ТакМістить параметри методів оплати
payments.codestringТакКод методу оплати:
0 — ГОТІВКА
1 — БЕЗГОТІВКОВА
2 — ІНШЕ
payments.namestringТакНазва форми оплати (Реквізити чека рядок 18):
  • ГОТІВКА
  • БЕЗГОТІВКОВА
  • ІНШЕ
payments.payment_methodstringНіЗасоби оплати у чеку (Реквізити чека рядок 19)
  • Якщо форма оплати (payments.name) ГОТІВКА, рядок 19 фіскального касового чека Засоби оплати (payments.payment_method) НЕ друкується
  • Якщо форма оплати (payments.name) БЕЗГОТІВКОВА — вкажіть засіб оплати. В іншому випадку за замовчуванням буде вказано Засіб оплати (payments.payment_method) — Електронний платіжний засіб
  • Якщо форма оплати (payments.name) ІНШЕ — вкажіть власне значення (клієнт задає самостійно)
🛈 Якщо клієнт НЕ передає значення:
  • для payments.code = 0 — в чеку відображається ГОТІВКА
  • для payments.code = 1 або 2 — в чеку відображається Електронний платіжний засіб
payments.sumstringТакСума оплати
payments.sum_providedstringТакПередана сума
payments.sum_remainsfloatНіСума решти
🛈 Вказується лише у випадку, якщо payments.code = 0 (код методу оплати) — ГОТІВКА
payments.pay_terminalobjectНіПараметри термінала при оплаті карткою
payments.pay_terminal.comissionfloatНіРозмір комісії, що стягується при оплаті через платіжний термінал
Може бути відсутнім або дорівнювати 0, якщо комісія не застосовується
🛈Якщо значення більше 0, ця сума буде виводитись у чеку
payments.pay_terminal.namestringНіІдентифікатор торговця (MID)
Приклад: "493084867"
payments.pay_terminal.terminal_idstringНіІдентифікатор термінала (TID)
payments.pay_terminal.epzstringНіМаска картки
payments.pay_terminal.card_typestringНіТип картки
payments.pay_terminal.auth_codestringНіКод авторизації
payments.pay_terminal.rrnstringНіУнікальний ідентифікатор банківської транзакції
payments.pay_terminal.additional_textstringНіДодатковий текст
🛈 Не використовується
payments.pay_terminal.timestringНіДата та час оплати через термінал (LiqPay та інші) у форматі 25.04.2023 15:49:03
🛈 Клієнти повинні передавати параметр якщо різниця між оплатою і проведенням чека понад 5 хвилин
footerstringНіТекст в нижній частині чека
open_shiftstringНіПрапор відкриття зміни
Якщо зміна закрита і передано значення True, тоді зміна буде відкрита
print_widthstringНіШирина чека в символах
pdf_widthstringНіШирина чека PDF

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

Запит: /api/v2/check/sale
{
    "api_token": "42b5eaccba739f08***e7fe157eba8bf",
    "num_fiscal": 4000043214,
    "action_type": "Z_SALE",
    "local_number": "88",
    "total_sum": "100",
    "round_rule": 10,
    "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",
            "sum_remains": 0
         },
        {
            "code": 1,
            "name": "KARTKA",
            "payment_method": "Безготівка",
            "sum": 25,
            "sum_provided": 25,
            "pay_terminal": {
                "comission": 0.5,
                "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"
}

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

інформація

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

  1. PDF-друк — повне представлення чека у форматі PDF
  2. Текстовий друк (поле text_print) — текстове представлення чека та QR код чека (поле qr)
Ім'яТипОпис
ORDERNUMstringНомер чека реалізації / повернення
ORDERDATEstringДата формування чека
ORDERTIMEstringЧас формування чека
MACstringКод аутентифікації повідомлення чека
is_offlinebooleanОзнака офлайн чека
local_numberintegerЛокальний номер операції, який клієнт передає з кожним чеком
text_printstringТекстове представлення чека у форматі Base64. Клієнт самостійно обирає шрифт та спосіб друку
qrstringQR код чека форматі Base64. Для використання з текстовим чеком — додаткове зображення для друку
pdfstringPDF представлення чека у форматі Base64. Може бути одразу роздруковане без додаткової обробки
linkstringПосилання для перегляду чека на сайті

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

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

200 OK

Відповідь: /api/v2/check/sale
{
    "ORDERNUM": "OTbrl4J6zAQ",
    "ORDERDATE": "2020-12-16",
    "ORDERTIME": "09:58:45",
    "MAC": "2baea23fdcfe2f4d1853ec5ad87d5fbdf65ed0fbf48f60623ac92e2e518d1bce",
    "is_offline": false,
    "local_number": 42,
    "text_print": "ICAgICAgICAgINCi0JXQodCi0J7QktCY0Jkg0....",
    "qr": "iVBORw0KGgoAAAANSUhEUgAAAV4AAAFeCAYAAADN...",
    "pdf": "JVBERi0xLjcKMSAwIG9iago8PCAvVHlwZSAvQ2F0YW...",
    "link": "http://cashdesk.com/check/b63ad1dd-b218-465e-9251-b2510de77205/html"
}
порада

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