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

Отримати статус ПРРО

Запит​

URI: /api/v2/tax_objects/{num_fiscal}?api_token={api_token}

Метод дозволяє отримати статус обраного ПРРО.

Запит виконується методом GET.

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

Параметри URI​

Метод дозволяє передати в рядку запиту наступні параметри:

Ім'яТипОбов'язковийОпис
num_fiscalintegerТакФіскальний номер каси
api_tokenstringТакТокен авторизації, згенерований в особистому кабінеті

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

/api/v2/tax_objects/4000022469?api_token=42b5eaccba739f08***e7fe157eba8bf

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

Ім'яТипОпис
dataobjectДані каси
data.idstringІдентифікатор каси
data.org_namestringНазва організації
data.addressstringАдреса реєстрації ПРРО
data.is_tasboolean
data.namestringНазва закладу
data.tinstringІдентифікаційний номер платника податків
data.ipnstringРеєстраційний номер облікової картки платника податків
data.num_fiscalintegerФіскальний номер каси
data.shiftobjectДані зміни
data.shift.idstringІдентифікатор зміни
data.shift.statestringОзнака відкритої зміни
data.shift.open_datestringДата відкриття зміни
data.shift.offlinebooleanРежим зміни онлайн або офлайн
data.shift.offline_timelinelist[object]Графік офлайну
data.shift.totalsobjectПідсумки зміни
data.shift.totals.realobjectДані продажу
data.shift.totals.real.sumfloatСума продажу
data.shift.totals.real.total_currency_commissionfloatСума комісії
data.shift.totals.real.orders_countintegerКількість замовлень
data.shift.totals.real.total_currency_costfloatЗагальна сума усіх замовлень
data.shift.totals.real.pay_formlist[object]Дані платіжної форми
data.shift.totals.real.pay_form.pay_form_codestringКод платіжної форми
data.shift.totals.real.pay_form.pay_form_namestringНазва платіжної форми
data.shift.totals.real.pay_form.sumfloatСума продажу в платіжній формі
data.shift.totals.real.taxlist[object]Дані податку
data.shift.totals.real.tax.namestringНазва податку
data.shift.totals.real.tax.letterstringЛітера податку
data.shift.totals.real.tax.prcfloatВідсоток податку
data.shift.totals.real.tax.turnoverfloatОборот
data.shift.totals.real.tax.sumfloatСума податку
data.shift.totals.real.tax.excise_prcfloatВідсоток акцизного податку
data.shift.totals.real.tax.excise_sumfloatСума акцизного податку
data.shift.totals.retobjectДані повернення
data.shift.totals.ret.sumfloatСума повернення
data.shift.totals.ret.total_currency_commissionfloatСума комісії
data.shift.totals.ret.orders_countintegerКількість повернень
data.shift.totals.ret.total_currency_costfloatЗагальна сума усіх повернень
data.shift.totals.ret.pay_formlist[object]Дані платіжної форми
data.shift.totals.ret.pay_form.pay_form_codestringКод платіжної форми
data.shift.totals.ret.pay_form.pay_form_namestringНазва платіжної форми
data.shift.totals.ret.pay_form.sumfloatСума повернення в платіжній формі
data.shift.totals.ret.taxlist[object]Дані податку
data.shift.totals.ret.tax.namestringНазва податку
data.shift.totals.ret.tax.letterstringЛітера податку
data.shift.totals.ret.tax.prcfloatВідсоток податку
data.shift.totals.ret.tax.turnoverfloatОборот
data.shift.totals.ret.tax.sumfloatСума податку
data.shift.totals.ret.tax.excise_prcfloatВідсоток акцизного податку
data.shift.totals.ret.tax.excise_sumfloatСума акцизного податку
data.shift.totals.service_inputfloatСлужбове внесення
data.shift.totals.service_outputfloatСлужбова видача
data.shift.totals.cash_in_boxfloatПоточна кількість грошей в касі
data.shift.totals.from_datestringЧас початку зміни
data.shift.totals.to_datestringЧас завершення зміни
data.shift.totals.cash_in_box_startfloatКількість грошей в касі на початок зміни
data.shift.totals.numberfloat
data.shift.totals.extrafloat
data.shift.totals.offline_idstring
data.shift.totals.datestring
data.shift.cashierobjectДані касира
data.shift.cashier.idstringІдентифікатор касира
data.shift.cashier.full_namestringПовне ім'я касира
data.shift.cashier.emailstringЕлектронна пошта касира
data.shift.cashier.phonestringНомер телефона касира
data.shift.cashier.edrpoustringЄДРПОУ касира
data.shift.cashier.positionstringПосада касира
data.shift.cashier.drfostringРеєстраційний номер облікової картки платника податків касира
data.shift.cashier.last_onlinestringДата останнього запиту до сервера поточним касиром
data.shift.cashier.last_online_levelinteger
data.shift.cashier.subject_key_idstring
data.shift.cashier.tax_objects_countinteger
data.shift.cashier.created_atstringДата створення касира
data.advertisinglist[object]Параметри реклами
data.offlinebooleanРежим каси онлайн або офлайн
data.last_onlinestringОстаннє використання API даним ПРРО
data.last_online_levelintegerРівень останнього використання API даним ПРРО
data.created_atstringДата створення ПРРО
data.manual_attachedstring
data.subscr_expire_atstringДата закінчення підписки
data.subscr_endedbooleanОзнака закінчення підписки
data.subscr_will_endbooleanОзнака що підписка завершиться ближчим часом
data.subscr_days_leftintegerКількість днів підписки, що залишилися
data.required_fieldsobjectОбов'язкові поля
data.required_fields.productslist[object]Параметри товарів
data.required_fields.products.distributor_edrpoustringЄДРПОУ постачальника товару
data.required_fields.products.amount_leftstringКількість товару, що залишився
data.required_fields.products.price_retailstringВартість продажу товару роздріб
data.required_fields.products.price_onlinestringВартість продажу товару онлайн
data.required_fields.products.price_buystringВартість закупки товару
data.settingslist[object]Перелік налаштувань

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

200 OK

Відповідь: /api/v2/tax_objects/4000022469?api_token=42b5eaccba739f08***e7fe157eba8bf
{
    "data": {
        "id": "60216fd4794c4d16073afea3",
        "org_name": "Тестовий платник 4",
        "address": "УКРАЇНА, ХАРКІВСЬКА ОБЛ., М. ХАРКІВ СЛОБІДСЬКИЙ Р-Н, проспект Льва Ландау, 1а",
        "is_tas": false,
        "name": "Bro Store",
        "tin": "12345678",
        "ipn": "123456789020",
        "num_fiscal": 4000070440,
        "shift": {
            "id": "607d9850626e8c2e22609fc4",
            "state": true,
            "open_date": "19.04.2021 17:48:48",
            "offline": false,
            "offline_timeline": [],
            "totals": {
                "real": null,
                "ret": {
                    "sum": 30,
                    "total_currency_commission": 0,
                    "orders_count": 1,
                    "total_currency_cost": 0,
                    "pay_form": [
                        {
                            "pay_form_code": "0",
                            "pay_form_name": "ГОТІВКА",
                            "sum": 30
                        }
                    ],
                    "tax": [
                        {
                            "name": "ПДВ Б 0%",
                            "letter": "Б",
                            "prc": 0,
                            "turnover": 30,
                            "sum": 0,
                            "excise_prc": null,
                            "excise_sum": 0
                        }
                    ]
                },
                "service_input": 0,
                "service_output": 0,
                "cash_in_box": -10,
                "from_date": null,
                "to_date": null,
                "cash_in_box_start": 20,
                "number": null,
                "extra": null,
                "offline_id": null,
                "date": null
            },
            "cashier": {
                "id": "5f9ab530314a9c068c619d5f",
                "full_name": "ІВАНОВ ІВАН ІВАНОВИЧ",
                "email": "[email protected]",
                "phone": "380111111177",
                "edrpou": "",
                "position": "SHEF222",
                "drfo": "1234567890",
                "last_online": "20.04.2021 14:33:07",
                "last_online_level": 1,
                "subject_key_id": "73cf9d10e7df3b6e5b763b36ea830dc95d3ad3a0d4074a8b68aff7fc87655011",
                "tax_objects_count": 1733,
                "created_at": "29.10.2020 14:27:28"
            }
        },
        "advertising": [],
        "offline": false,
        "last_online": "20.04.2021 14:33:07",
        "last_online_level": 1,
        "created_at": "08.02.2021",
        "manual_attached": null,
        "subscr_expire_at": "20.02.2021",
        "subscr_ended": true,
        "subscr_will_end": true,
        "subscr_days_left": 0,
        "required_fields": {
            "products": [
                "distributor_edrpou",
                "amount_left",
                "price_retail",
                "price_online",
                "price_buy"
            ]
        },
        "settings": []
    }
}
порада

Postman колекція (Отримати статус РРО): https://documenter.getpostman.com/view/12128952/TVRj5U1d#ae44db54-ab15-4994-9a5e-3e5c3d7c37e17