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

Отримати Х-звіт

Запит​

URI: /api/v2/shift/xReport

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

У випадку якщо зміна не відкрита, звіт буде згенеровано з нульовими значеннями.

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

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

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

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

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

Запит: /api/v2/shift/xReport
{
    "api_token": "42b5eaccba739f08***e7fe157eba8bf",
    "num_fiscal": 4000022469,
    "no_pdf": true,
    "no_text_print": true,
    "include_checks": false
}

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

інформація

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

  1. PDF-друк - повне представлення чека у форматі PDF
  2. Текстовий друк (поле text_print) — текстове представлення чека
Ім'яТипОпис
text_printstringТекстове представлення чека у форматі Base64. Клієнт самостійно обирає шрифт та спосіб друку
qrstringQR код чека у форматі Base64. Для використання з текстовим чеком – додаткове зображення для друку
pdfstringPDF представлення чека у форматі Base64. Може бути одразу роздруковане без додаткової обробки
linkstringПосилання для перегляду чека на сайті
uuidstringЛокальний uuid номер чека
local_numberintegerЛокальний номер операції, який клієнт передає з кожним чеком
cash_in_boxfloatПоточна кількість грошей в касі
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.nameintegerНазва податку
real.tax.letterintegerЛітера податку
real.tax.prcfloatВідсоток податку
real.tax.turnoverfloatОборот
real.tax.sumfloatСума податку
real.tax.excise_prcfloatВідсоток акцизного податку
real.tax.excise_sumfloatСума акцизного податку
retobjectМістить інформацію по поверненням
ret.sumfloatЗагальна сума
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.nameintegerНазва податку
ret.tax.letterintegerЛітера податку
ret.tax.prcfloatВідсоток податку
ret.tax.turnoverfloatОборот
ret.tax.sumfloatСума податку
ret.tax.excise_prcfloatВідсоток акцизного податку
ret.tax.excise_sumfloatСума акцизного податку
service_inputfloatСлужбове внесення
service_outputfloatСлужбове видача
from_datestringДата з якої формується X-звіт
to_datestringДата до якої формується X-звіт
cash_in_box_startfloatКількість грошей в касі на початок зміни
number
extra
offline_id
datestringДата чека
shift_stateboolean
checks_listlist[object]Список чеків які увійшли до поточної зміни
checks_list.typestringТип чека
checks_list.order_numstringНомер чека
checks_list.datetimestringДата формування чека
checks_list.local_numberstringЛокальний номер операції, який клієнт передає з кожним чеком
checks_list.sumfloatСума чека
checks_list.taxlist[object]Містить інформацію про податки у чека
checks_list.tax.letterstringЛітера податку
checks_list.tax.prcfloatВідсоток податку
is_offlinebooleanОзнака офлайн чека
shift_durationinteger | nullТривалість зміни в годинах (null — якщо зміна не відкрита)

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

200 OK

Відповідь: /api/v2/shift/xReport
{
    "text_print": "ICAgICAgICAgINCi0JXQodCi0J7QktCY0Jkg0....",
    "qr": "iVBORw0KGgoAAAANSUhEUgAAAV4AAAFeCAYAAADN...",
    "pdf": "JVBERi0xLjcKMSAwIG9iago8PCAvVHlwZSAvQ2F0YW...",
    "link": "http://cashdesk.com/check/b63ad1dd-b218-465e-9251-b2510de77205/html",
    "uuid": "2a96912f-0790-4049-8642-93019dc8090b",
    "local_number": null,
    "cash_in_box": 7524.47,
    "real": {
        "sum": 150,
        "total_currency_commission": 0,
        "orders_count": 2,
        "total_currency_cost": 0,
        "pay_form": [
            {
                "pay_form_code": "0",
                "pay_form_name": "ГОТІВКА",
                "sum": 150
            }
        ],
        "tax": [
            {
                "name": "ПДВ А 20%",
                "letter": "А",
                "prc": 20,
                "turnover": 20,
                "sum": 3.34,
                "excise_prc": null,
                "excise_sum": 0
            },
            {
                "name": "БЕЗ ПДВ",
                "letter": null,
                "prc": 0,
                "turnover": 30,
                "sum": 0,
                "excise_prc": null,
                "excise_sum": 0
            },
            {
                "name": "Звільнений від оподаткування",
                "letter": "-Н",
                "prc": 0,
                "turnover": 100,
                "sum": 0,
                "excise_prc": null,
                "excise_sum": 0
            }
        ]
    },
    "ret": {
        "sum": 75,
        "total_currency_commission": 0,
        "orders_count": 1,
        "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
            },
            {
                "name": "БЕЗ ПДВ",
                "letter": null,
                "prc": 0,
                "turnover": 15,
                "sum": 0,
                "excise_prc": null,
                "excise_sum": 0
            },
            {
                "name": "Звільнений від оподаткування",
                "letter": "-Н",
                "prc": 0,
                "turnover": 50,
                "sum": 0,
                "excise_prc": null,
                "excise_sum": 0
            }
        ]
    },
    "service_input": 35,
    "service_output": 35,
    "from_date": null,
    "to_date": null,
    "cash_in_box_start": 7449.47,
    "number": null,
    "extra": null,
    "offline_id": null,
    "date": null,
    "shift_state": true,
    "checks_list": [
        {
            "type": "SERVICE_INPUT",
            "order_num": "XYZGat8Txf8",
            "datetime": "17.06.2021 18:22:53",
            "local_number": "123",
            "sum": 35
        },
        {
            "type": "SERVICE_OUTPUT",
            "order_num": "40tXmFE-tE0",
            "datetime": "17.06.2021 18:22:57",
            "local_number": "123",
            "sum": 35
        },
        {
            "type": "Z_SALE",
            "order_num": "bXpdvJbJ1dw",
            "datetime": "17.06.2021 18:23:02",
            "local_number": 115,
            "sum": 75,
            "tax": [
                {
                    "letter": "А",
                    "prc": 20
                }
            ]
        },
        {
            "type": "Z_SALE",
            "order_num": "lc3eqpyI5VM",
            "datetime": "17.06.2021 18:23:10",
            "local_number": 116,
            "sum": 75,
            "tax": [
                {
                    "letter": "А",
                    "prc": 20
                }
            ]
        },
        {
            "type": "RETURN",
            "order_num": "6o3hR_mNEY0",
            "datetime": "17.06.2021 18:23:17",
            "local_number": 117,
            "sum": 75,
            "tax": [
                {
                    "letter": "А",
                    "prc": 20
                }
            ]
        }
    ],
    "is_offline": false,
    "shift_duration": 3
}
порада

Postman колекція (Отримати Х-звіт): https://documenter.getpostman.com/view/12128952/TVRj5U1d#604e6a11-a7ec-4aa4-a148-aa19be663b72