Як за допомогою API отримати вибрані поля фінансового звіту суб’єкта господарювання з Реєстру судових справ?

MGBI надає комплексний API для отримання даних із державних реєстрів та облікових баз, зокрема з Національного судового реєстру (KRS). Перелік джерел даних, доступних у цій службі, можна знайти на сайті:
👉 Державні реєстри API

Цей посібник стосується API для Репозиторію фінансових документів KRS, який ми надаємо в рамках продукту:
👉 API Національного судового реєстру (KRS API) — Репозиторій фінансових документів

Нижче ми описали, як за допомогою API можна завантажити вибрані поля фінансового звіту зазначеного суб’єкта з реєстру KRS на основі його номера KRS та інших параметрів.

Крок 1: Отримати ключ авторизації в API

Щоб отримати ключ авторизації, необхідний для виклику ендпоінтів, доступних в MGBI API, зв’яжіться з нами за допомогою контактної форми на сторінці продукту:
👉 API Національного судового реєстру (KRS API) — Репозиторій фінансових документів

Крок 2: Викличте кінцеву точку Get Records

Дані, доступні в Репозиторії фінансових документів KRS, ми надаємо в MGBI API у вигляді моделі даних з ідентифікатором pl-krs-rdf-record.

API надає для цієї моделі кінцеву точку Get Records, яка повертає записи, що містять інформацію про окремі фінансові документи, які відповідають заданим критеріям.
👉 Документація кінцевої точки Get Records для моделі pl-krs-rdf-record

Щоб завантажити запис із фінансовою звітністю з Репозиторію фінансових документів KRS для обраного суб’єкта господарювання, у кінцевій точці Get Records необхідно вказати його реєстраційний номер: KRS, NIP або REGON, а також додаткові параметри, такі як:

• type — тип документа (наприклад, річний фінансовий звіт, звіт правління про діяльність суб’єкта господарювання),
• period_major_year — рік, на який припадає більша частина періоду, що охоплюється документом.

У наведеному нижче прикладі для пошуку фінансового звіту за 2025 рік для суб’єкта господарювання із вказаним номером KRS було використано ендпойнт Get Records.

Приклад виклику ендпойнту Get Records із номером KRS, типом документа та фінансовим роком:

GET /v1/models/pl-krs-rdf-record/records?identifiers.pl_krs=[номер KRS]&type=financial_statement._major_year=2025 HTTP/1.1
Host: api.mgbi.pl
Authorization: [ключ авторизації]

Крок 3: Визначте у відповідях необхідні поля звіту

При правильному виклику кінцевої точки Get Records у відповідь повертається список документів, що відповідають заданим критеріям.

У попередньому прикладі кінцева точка повинна повернути список результатів, що містить один запис:

{
    "count": 1,
    "pages": 1,
    "results": [
        {
            "id": [identyfikator rekordu],
            "identifiers": [identyfikatory podmiotu],
            "document": [informacje o dokumencie]
            "content": [zawartość dokumentu],
            "files": [pliki z treścią dokumentu],
            "meta": [metadane rekordu]
        }
    ]
}

Поля, доступні у фінансових звітах у форматі XML, що відповідає логічним структурам Міністерства фінансів Польщі, зберігаються у двох словниках:

• content.extracted_fields,
• content.standardized_fields.

Словник content.extracted_fields містить усі поля, доступні у звіті відповідно до застосованої логічної структури.

Повний перелік полів, доступних у цьому словнику, ми надаємо у файлі Excel. Зв’яжіться з нами за допомогою форми на сторінці продукту, щоб отримати посилання для завантаження файлу.

Приклад вмісту словника content.extracted_fields:

{
    "bs": {
        "a_ca_cfy": 0,
        "a_ca_pfy": 0,
        "a_fa_cfy": 0,
        "a_fa_pfy": 0,
        "a_ta_cfy": 0,
        "a_ta_pfy": 0,
        ...
    }
}

Якщо вам потрібен доступ до всіх фінансових полів у звіті, скористайтеся словником content.extracted_fields. Якщо ж вам достатньо найважливіших полів з балансу або звіту про прибутки та збитки, скористайтеся словником content.standardized_fields.

Дізнайтеся більше:
👉 Структура даних у моделі pl-krs-rdf-record
👉 Документація щодо кінцевих точок для моделі pl-krs-rdf-record