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

Z-звіт за період

Запит​

URI: /api/v2/shift/zReport/period

Використовується для отримання Z-звіту за певний період.

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

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

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

Ім'яТипОбов'язковийОпис
api_tokenstringТакТокен авторизації, згенерований в особистому кабінеті
num_fiscalintegerТакФіскальний номер РРО
fromstringТакДата початку періоду отримання Z-звіту
tostringТакДата кінця періоду отримання Z-звіту
no_pdfbooleanНіВиключити pdf представлення чека з відповіді
no_text_printbooleanНіВиключити текстове представлення чека з відповіді
extendedbooleanНіОзнака розширеного звіту
увага

Якщо в період дат (from — to) потрапляє тільки одна зміна, або якщо період дат — це один і той же день, тоді у відповіді на запит буде повертатись список чеків

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

Запит: /api/v2/shift/zReport/period
{
    "api_token": "42b5eaccba739f08***e7fe157eba8bf",
    "num_fiscal": 4000022469,
    "from": "01.05.2021",
    "to": "29.05.2021",
    "no_pdf": false,
    "no_text_print": false,
    "extended": true
}

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

інформація

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

  1. PDF-друк — повне представлення чека у форматі PDF
  2. Текстовий друк (поле text_print) — текстове представлення чека
Ім'яТипОпис
realobjectМістить інформацію по реалізації
real.sumfloatЗагальна сума
real.total_currency_commissionfloatЗагальна сума податків
real.orders_countintegerКількість чеків
real.total_currency_costfloatЗагальна вартість з урахуванням комісії
real.pay_formlist[object]Дані платіжної форми
real.pay_form.pay_form_codestringКод платіжної форми
real.pay_form.pay_form_namestringНазва платіжної форми
real.pay_form.sumfloatСума продажу в платіжній формі
real.taxlist[object]Дані податку
real.tax.namestringНазва податку
real.tax.letterstringЛітера податку
real.tax.prcfloatВідсоток податку
real.tax.turnoverfloatОборот
real.tax.sumfloatСума податку
real.tax.excise_prcfloatВідсоток акцизного податку
real.tax.excise_sumfloatСума акцизного податку
retobjectМістить інформацію по поверненням
ret.total_currency_commissionfloatЗагальна сума податків
ret.orders_countintegerКількість чеків
ret.total_currency_costfloatЗагальна вартість з урахуванням комісії
ret.pay_formlist[object]Дані платіжної форми
ret.pay_form.pay_form_codestringКод платіжної форми
ret.pay_form.pay_form_namestringНазва платіжної форми
ret.pay_form.sumfloatСума повернення в платіжній формі
ret.taxlist[object]Дані податку
ret.tax.namestringНазва податку
ret.tax.letterstringЛітера податку
ret.tax.prcfloatВідсоток податку
ret.tax.turnoverfloatОборот
ret.tax.sumfloatСума податку
ret.tax.excise_prcfloatВідсоток акцизного податку
ret.tax.excise_sumfloatСума акцизного податку
service_inputfloatСлужбове внесення
service_outputfloatСлужбова видача
from_datestringДата з якої формується Z-звіт
to_datestringДата до якої формується Z-звіт
cash_in_boxfloatПоточна кількість грошей в касі
cash_in_box_startfloatКількість грошей в касі на початок зміни
extralist[object]Додаткові параметри
extra.sumfloatПідсумок реалізації
extra.numberintegerНомер Z-звіту
extra.datestringДата чека
shift_stateboolean
text_printstringТекстове представлення чека у форматі Base64. Клієнт самостійно обирає шрифт та спосіб друку
qrstringQR код чека у форматі Base64. Для використання з текстовим чеком — додаткове зображення для друку
pdfstringPDF представлення чека у форматі Base64. Може бути одразу роздруковане без додаткової обробки
linkstringПосилання для перегляду чека на сайті
uuidstringЛокальний uuid номер чека
checks_listlist[object]Список чеків які увійшли до поточної зміни
checks_list.typestringТип чека
checks_list.order_numstringНомер чека
checks_list.datetimestringДата формування чека
checks_list.local_numberstringЛокальний номер операції, який клієнт передає з кожним чеком

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

200 OK

Відповідь: /api/v2/shift/zReport/period
{
    "real": {
        "sum": 19298.8,
        "total_currency_commission": 0,
        "orders_count": 153,
        "total_currency_cost": 0,
        "pay_form": [
            {
                "pay_form_code": "0",
                "pay_form_name": "ГОТІВКА",
                "sum": 16437.6
            },
        ],
        "tax": [
            {
                "name": "ПДВ Б 7%",
                "letter": "Б",
                "prc": 7,
                "turnover": 680.7999999999988,
                "sum": 44.16,
                "excise_prc": null,
                "excise_sum": 0
            },
        ]
    },
    "ret": {
        "sum": 102.33,
        "total_currency_commission": 0,
        "orders_count": 5,
        "total_currency_cost": 0,
        "pay_form": [
            {
                "pay_form_code": "0",
                "pay_form_name": "ГОТIВКА",
                "sum": 75
            },
        ],
        "tax": [
            {
                "name": "ПДВ А 20%",
                "letter": "А",
                "prc": 20,
                "turnover": 10,
                "sum": 1.67,
                "excise_prc": null,
                "excise_sum": 0
            },
        ]
    },
    "service_input": 1626,
    "service_output": 6083,
    "from_date": "2021-05-01T00:00:00+03:00",
    "to_date": "2021-05-29T23:59:59+03:00",
    "cash_in_box": 0,
    "cash_in_box_start": 0,
    "extra": [
        {
            "sum": 7.4,
            "number": 1,
            "date": "2021-05-06T15:09:54+03:00"
        },
        {
            "sum": 0,
            "number": 2,
            "date": "2021-05-07T18:09:52+03:00"
        },
        {
            "sum": 1500,
            "number": 3,
            "date": "2021-05-07T18:18:18+03:00"
        },
        {
            "sum": 1500,
            "number": 4,
            "date": "2021-05-11T12:33:11+03:00"
        },
        {
            "sum": 0,
            "number": 5,
            "date": "2021-05-11T12:35:54+03:00"
        },
    ],
    "shift_state": null,
    "text_print": "ICAgICAgICAgINCi0JXQodCi0J7QktCY0Jkg0....",
    "qr": "iVBORw0KGgoAAAANSUhEUgAAAV4AAAFeCAYAAADN...",
    "pdf": "JVBERi0xLjcKMSAwIG9iago8PCAvVHlwZSAvQ2F0YW...",
    "link": null,
    "uuid": "46915a06-9f31-4bda-948c-fecb77f94a81",
    "checks_list": [
        {
            "type": "SERVICE_INPUT",
            "order_num": "OwleT_hhL5U",
            "datetime": "08.06.2021 11:19:32",
            "local_number": "123"
        },
        {
            "type": "Z_SALE",
            "order_num": "-_RR7p7frCI",
            "datetime": "08.06.2021 11:19:35",
            "local_number": 115
        }
    ]
}
порада

Postman колекція (Отримати Z-звіт за період): https://documenter.getpostman.com/view/12128952/TVRj5U1d#b08718df-5590-42fa-a71b-c20fc129befa