Отримати список ПРРО

Запит

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

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

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

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

Параметри URI

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

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

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

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

Якщо токен не переданий, буде отримана відповідь 404.

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

Ім'я	Тип	Опис
data	object	Дані ПРРО
data.org_name	string	Назва організації
data.address	string	Адреса організації
data.name	string	Назва точки продажу
data.tin	string	Ідентифікаційний номер платника податків
data.ipn	string	Реєстраційний номер облікової картки платника податків
data.num_fiscal	integer	Фіскальний номер ПРРО
data.shift	object	Дані про відкриту зміну
data.shift.state	boolean	Ознака відкритої зміни
data.shift.open_date	string	Дата відкриття зміни
data.shift.offline	boolean	Режим зміни онлайн або офлайн
data.shift.offline_timeline	list[object]	Графік офлайну
data.shift.totals	string	Підсумки зміни
data.shift.cashier	string	Параметри касира
advertising	list[object]	Параметри реклами
offline	string	Режим каси онлайн або офлайн
last_online	string	Останнє використання API даним ПРРО
last_online_level	string	Рівень останнього використання API даним ПРРО
blocked_at	string	Дата блокування каси

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

200 OK

Відповідь: /api/v2/tax_objects?api_token=42b5eaccba739f08***e7fe157eba8bf

{
    "data": [
        {
            "org_name": "Тестовий платник 3",
            "address": "УКРАЇНА, АР КРИМ.",
            "name": "Checkbox 2",
            "tin": "12345678",
            "ipn": "123456789019",
            "num_fiscal": 4000026515,
            "shift": {
                "state": true,
                "open_date": "25-08-2020 14:12:07",
                "offline": false,
                "offline_timeline": [],
                "totals": null,
                "cashier": null
            },
            "advertising": [],
            "offline": false,
            "last_online": "27-10-2020 10:12:17",
            "last_online_level": 3,
            "blocked_at": "30.04.2024 15:38"
        },
    ]
}

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

Не активований Агент Підпису

403 Forbidden

Відповідь: /api/v2/tax_objects?api_token=42b5eaccba739f08***e7fe157eba8bf

{
    "message": "Агент підпису не активовано"
}