Post Stream Records - Dokumentacja MGBI API

Pobiera rekordy używając parametrów z ciała zapytania -NEW-.

W przypadku sukcesu w odpowiedzi zwraca listę rekordów.

W przypadku braku rekordów spełniających podane kryteria zwraca pustą listę.

Poprawne wywołanie endpointu zwiększa liczniki:

api i api_search o 1

api_search_results o 1 jeśli zwrócono co najmniej jeden rekord

records i records_api_search o liczbę zwróconych rekordów

Request

Query Params

Header Params

Body Params application/jsonRequired

Example

{
    "meta.last_update_datetime_from": "2019-08-24T14:15:22.123Z",
    "meta.last_update_datetime_to": "2019-08-24T14:15:22.123Z",
    "document.type": {},
    "identifiers.pl_krs": "string",
    "identifiers.pl_nip": "string",
    "identifiers.pl_regon": "string",
    "document.period_from_date": "2019-08-24",
    "document.period_to_date": "2019-08-24",
    "document.period_end_year": 0,
    "document.period_major_year": 0,
    "document.is_correction": true,
    "document.is_ias_compliant": true,
    "content.extracted_fields.is_available": true,
    "content.standardized_fields.is_available": true,
    "projection": "string",
    "content": [
        "string"
    ]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Successful Response

application/json

Successful Response

Bodyapplication/json

Example

[
    {
        "content": {
            "extracted_fields": {
                "@ns1": "http://www.mf.gov.pl/schematy/SF/DefinicjeTypySprawozdaniaFinansowe/2018/07/09/DefinicjeTypySprawozdaniaFinansowe/",
                "@ns2": "http://www.mf.gov.pl/schematy/SF/DefinicjeTypySprawozdaniaFinansowe/2018/07/09/JednostkaMikroStruktury",
                "@ns3": "http://crd.gov.pl/xml/schematy/dziedzinowe/mf/2016/01/25/eD/DefinicjeTypy/",
                "@ns4": "http://www.mf.gov.pl/schematy/SF/DefinicjeTypySprawozdaniaFinansowe/2018/07/09/JednostkaInnaStruktury",
                "@p5": "http://www.w3.org/2001/XMLSchema-instance",
                "@schemaLocation": "http://www.mf.gov.pl/schematy/SF/DefinicjeTypySprawozdaniaFinansowe/2018/07/09/JednostkaMikroWZlotych https://www.gov.pl/attachment/0411ed25-ba82-4233-a92f-f380f5d0605b",
                "@xmlns": "http://www.mf.gov.pl/schematy/SF/DefinicjeTypySprawozdaniaFinansowe/2018/07/09/JednostkaMikroWZlotych",
                "InformacjeOgolneJednostkaMikro>P_1>P_1A>NazwaFirmy": "VOSS COMPANY SPÓŁKA Z OGRANICZONĄ ODPOWIEDZIALNOŚCIĄ",
                "InformacjeOgolneJednostkaMikro>P_1>P_1A>Siedziba>Wojewodztwo": "WIELKOPOLSKIE",
                "Naglowek>DataSporzadzenia": "2020-11-04",
                "Naglowek>KodSprawozdania": "SprFinJednostkaMikroWZlotych",
                "Naglowek>KodSprawozdania>@kodSystemowy": "SFJMIZ (1)",
                "Naglowek>KodSprawozdania>@wersjaSchemy": "1-2",
                "Naglowek>OkresDo": "2020-11-01",
                "Naglowek>OkresOd": "2020-01-10",
                "Naglowek>WariantSprawozdania": "1"
            },
            "schema": {
                "name": "JednostkaMikroWZlotych",
                "version": "1-2"
            },
            "standardized_fields": {
                "bs": {
                    "a_ca_cfy": 3309.75,
                    "a_ca_pfy": 0,
                    "lae_nc_cfy": 5000,
                    "lae_nc_pfy": 0
                },
                "pala": {
                    "it_cfy": 1456,
                    "it_pfy": 0,
                    "npl_cfy": -1690.25,
                    "npl_pfy": 0,
                    "oor_cfy": 0,
                    "oor_pfy": 0
                }
            }
        },
        "document": {
            "document_id": 1,
            "filing_date": "2021-08-09",
            "is_correction": false,
            "is_ias_compliant": false,
            "language": "pl",
            "period_end_year": 2020,
            "period_from_date": "2021-01-10",
            "period_major_year": 2020,
            "period_to_date": "2020-11-01",
            "preparation_date": "2021-01-18",
            "submission_id": 111,
            "type": "activity_report"
        },
        "files": {
            "main_document": {
                "html_preview": {
                    "content_type": "text/html",
                    "url": "https://api.mgbi.pl/v1/pl-krs-rdf-record/records/66224f432af717a81b7caf8f/files/main_document_uri:html"
                },
                "original": {
                    "content_type": "application/pdf",
                    "url": "https://api.mgbi.pl/v1/pl-krs-rdf-record/records/66224f432af717a81b7caf8f/files/main_document_uri"
                },
                "pdf_preview": {
                    "content_type": "application/pdf",
                    "url": "https://api.mgbi.pl/v1/pl-krs-rdf-record/records/66224f432af717a81b7caf8f/files/main_document_uri:pdf"
                }
            }
        },
        "id": "66224f432af717a81b7caf8f",
        "identifiers": {
            "pl_krs": "0000009723",
            "pl_nip": "1111111111",
            "pl_regon": "222222222"
        },
        "meta": {
            "first_update_datetime": "2024-04-01T00:00:00.000",
            "last_update_datetime": "2024-04-03T00:00:00.000"
        }
    }
]

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Not Found

🟠429Too Many Requests