Отримати інформацію з фіскальних реєстрів для ЮО/ФОП

Повертає інформацію з вказаних в query_registry фіскальних реєстрів (або з усіх, в яких наявна інформація по відповідним персонам - фізичним або юридичним). В query_registry передається перелік ідентифікаторів реєстрів по яким потрібна інформація.

Масив items містить по одному елементу для кожного реєстру в котрому відбувався пошук. Кожен елемент обов'язково має поля registry_id, registry_name, updated_datetime. В кожному елементі присутнє поле data або data_list. Одночасно поля data та data_list не повертаються. Якщо в реєстрі тільки один запис - повертається поле data, якщо декілька - повертається data_list. Якщо даних в реєстрі не знайдено - поле message буде заповнено текстом "дані відсутні", поле data буде null, поле data_list буде відсутнє. В структурі data/data_list[i] подається вся інформація отримана з реєстру.

Якщо localize_field_name = true - назви полів будуть перекладені на language.

ensure_valid_on_date може бути "today", "now", "none", дата в форматі "yyyy-mm-dd" - див. опис ensureValidOnDate для ф-ції /person/detail/information

only_check_updated - якщо true - не повертає член items, але дані будуть поставлені на оновлення, якщо цього потребують інші параметри.

wait_data_timeout - якщо передано і більше 0 - функція поставить дані на збір та буде чекати результату не більше ніж вказаний час. інакше відразу поверне дані які є в базі та ознаку чи було ініційовано оновлення даних. Максимальне значення - 30.

short_info - коротка інформація з датами внесення в реєстр/вилучення, для реєстру “Бізнес-партнер” - наявність/відсутність даних в контролюючих органах, наявність боргу.

Request

Authorization

Add parameter in query

key

Example:

key: ********************

Query Params

code

string

required

ІПН / ЄДРПОУ (8/10 знаків) або dbid

query_registry[]

array[string]

optional

id реєстрів, з яких потрібна інформація (якщо null або порожній - інформація з усіх реєстрів)

ensure_valid_on_date

string

optional

чи ставити дані на оновлення (за вмовчанням - today)

localize_field_name

boolean

optional

чи перекладати назви полів даних з реєстру

only_check_updated

boolean

optional

тільки перевірити стан оновлення даних (за вмовчанням - false)

wait_data_timeout

integer

optional

час в секундах очікування даних (за вмовчанням - 3с. не більше ніж 30с.)

language

string

optional

3 літ. ISO 639-1

key

string

optional

ключ доступу

Responses

🟢200Success

application/json

Body

status

enum<string>

required

Allowed values:

SuccessWarningError

statusCode

integer

required

message

string

optional

answer

object

required

items

array [object {8}]

required

is_updating

boolean

optional

чи перебуває в процесі оновлення

data_state

string

optional

стан даних - ready/updating/absent

updated_datetime

string <date-time>

optional

час останнього оновлення

data_checkvalue

string

optional

якщо значення змінюється - дані були змінені

Example

{
    "status": "Warning",
    "statusCode": 205,
    "message": "Дані не актуальні. Дані оновлюються.",
    "answer": {
        "items": [
            {
                "registry_id": "edvnes",
                "registry_name": "Реєстр платників єдиного внеску (страхувальників)",
                "updated_datetime": "2024-03-12 14:20:24.807",
                "short_info": "Зареєстровано 25.03.2013",
                "short_info_color": "green",
                "message": "",
                "data": {
                    "TIN_S": "14291113",
                    "FULL_NAME": "ТОВАРИСТВО З ОБМЕЖЕНОЮ ВІДПОВІДАЛЬНІСТЮ СІЛЬСЬКОГОСПОДАРСЬКЕ ПІДПРИЄМСТВО \"НІБУЛОН\"",
                    "DATE_ACC_ERS": "25.03.2013",
                    "ID_ERS": "1403023567",
                    "C_STI_MAIN_NAME": "3400, Південне МУ ДПС по роботі з ВПП",
                    "DATE_DCC_ERS": null
                }
            },
            {
                "registry_id": "edpod",
                "registry_name": "Реєстр платників єдиного податку",
                "updated_datetime": null,
                "short_info": "Дані ще не оновлено",
                "short_info_color": "gray",
                "message": "Дані ще не оновлено",
                "data": null
            },
            {
                "registry_id": "nonprof",
                "registry_name": "Реєстр неприбуткових установ та організацій",
                "updated_datetime": "2024-03-12 14:20:24.267",
                "short_info": "Дані відсутні",
                "short_info_color": "gray",
                "message": "Дані відсутні",
                "data": null
            }
        ],
        "is_updating": true,
        "data_state": "updating",
        "updated_datetime": "2024-03-12 14:20:24.807",
        "data_checkvalue": "4E9C9DBFEC8028DA38E310554558D55F"
    }
}