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

Запит

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

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

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

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

Параметри URI

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

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

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

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

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

Ім'я	Тип	Опис
data	object	Дані каси
data.id	string	Ідентифікатор каси
data.org_name	string	Назва організації
data.address	string	Адреса реєстрації ПРРО
data.is_tas	boolean
data.name	string	Назва закладу
data.tin	string	Ідентифікаційний номер платника податків
data.ipn	string	Реєстраційний номер облікової картки платника податків
data.num_fiscal	integer	Фіскальний номер каси
data.shift	object	Дані зміни
data.shift.id	string	Ідентифікатор зміни
data.shift.state	string	Ознака відкритої зміни
data.shift.open_date	string	Дата відкриття зміни
data.shift.offline	boolean	Режим зміни онлайн або офлайн
data.shift.offline_timeline	list[object]	Графік офлайну
data.shift.totals	object	Підсумки зміни
data.shift.totals.real	object	Дані продажу
data.shift.totals.real.sum	float	Сума продажу
data.shift.totals.real.total_currency_commission	float	Сума комісії
data.shift.totals.real.orders_count	integer	Кількість замовлень
data.shift.totals.real.total_currency_cost	float	Загальна сума усіх замовлень
data.shift.totals.real.pay_form	list[object]	Дані платіжної форми
data.shift.totals.real.pay_form.pay_form_code	string	Код платіжної форми
data.shift.totals.real.pay_form.pay_form_name	string	Назва платіжної форми
data.shift.totals.real.pay_form.sum	float	Сума продажу в платіжній формі
data.shift.totals.real.tax	list[object]	Дані податку
data.shift.totals.real.tax.name	string	Назва податку
data.shift.totals.real.tax.letter	string	Літера податку
data.shift.totals.real.tax.prc	float	Відсоток податку
data.shift.totals.real.tax.turnover	float	Оборот
data.shift.totals.real.tax.sum	float	Сума податку
data.shift.totals.real.tax.excise_prc	float	Відсоток акцизного податку
data.shift.totals.real.tax.excise_sum	float	Сума акцизного податку
data.shift.totals.ret	object	Дані повернення
data.shift.totals.ret.sum	float	Сума повернення
data.shift.totals.ret.total_currency_commission	float	Сума комісії
data.shift.totals.ret.orders_count	integer	Кількість повернень
data.shift.totals.ret.total_currency_cost	float	Загальна сума усіх повернень
data.shift.totals.ret.pay_form	list[object]	Дані платіжної форми
data.shift.totals.ret.pay_form.pay_form_code	string	Код платіжної форми
data.shift.totals.ret.pay_form.pay_form_name	string	Назва платіжної форми
data.shift.totals.ret.pay_form.sum	float	Сума повернення в платіжній формі
data.shift.totals.ret.tax	list[object]	Дані податку
data.shift.totals.ret.tax.name	string	Назва податку
data.shift.totals.ret.tax.letter	string	Літера податку
data.shift.totals.ret.tax.prc	float	Відсоток податку
data.shift.totals.ret.tax.turnover	float	Оборот
data.shift.totals.ret.tax.sum	float	Сума податку
data.shift.totals.ret.tax.excise_prc	float	Відсоток акцизного податку
data.shift.totals.ret.tax.excise_sum	float	Сума акцизного податку
data.shift.totals.service_input	float	Службове внесення
data.shift.totals.service_output	float	Службова видача
data.shift.totals.cash_in_box	float	Поточна кількість грошей в касі
data.shift.totals.from_date	string	Час початку зміни
data.shift.totals.to_date	string	Час завершення зміни
data.shift.totals.cash_in_box_start	float	Кількість грошей в касі на початок зміни
data.shift.totals.number	float
data.shift.totals.extra	float
data.shift.totals.offline_id	string
data.shift.totals.date	string
data.shift.cashier	object	Дані касира
data.shift.cashier.id	string	Ідентифікатор касира
data.shift.cashier.full_name	string	Повне ім'я касира
data.shift.cashier.email	string	Електронна пошта касира
data.shift.cashier.phone	string	Номер телефона касира
data.shift.cashier.edrpou	string	ЄДРПОУ касира
data.shift.cashier.position	string	Посада касира
data.shift.cashier.drfo	string	Реєстраційний номер облікової картки платника податків касира
data.shift.cashier.last_online	string	Дата останнього запиту до сервера поточним касиром
data.shift.cashier.last_online_level	integer
data.shift.cashier.subject_key_id	string
data.shift.cashier.tax_objects_count	integer
data.shift.cashier.created_at	string	Дата створення касира
data.advertising	list[object]	Параметри реклами
data.offline	boolean	Режим каси онлайн або офлайн
data.last_online	string	Останнє використання API даним ПРРО
data.last_online_level	integer	Рівень останнього використання API даним ПРРО
data.created_at	string	Дата створення ПРРО
data.manual_attached	string
data.subscr_expire_at	string	Дата закінчення підписки
data.subscr_ended	boolean	Ознака закінчення підписки
data.subscr_will_end	boolean	Ознака що підписка завершиться ближчим часом
data.subscr_days_left	integer	Кількість днів підписки, що залишилися
data.required_fields	object	Обов'язкові поля
data.required_fields.products	list[object]	Параметри товарів
data.required_fields.products.distributor_edrpou	string	ЄДРПОУ постачальника товару
data.required_fields.products.amount_left	string	Кількість товару, що залишився
data.required_fields.products.price_retail	string	Вартість продажу товару роздріб
data.required_fields.products.price_online	string	Вартість продажу товару онлайн
data.required_fields.products.price_buy	string	Вартість закупки товару
data.settings	list[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": []
    }
}