Dokumentacja API serwisu iMSiG.pl - KRS API, MSIG API (1.0)

Download OpenAPI specification:Download

MGBI sp. z o.o.: info@imsig.pl URL: https://www.imsig.pl

Ogólne informacje

API oparte jest na protokole HTTP, a treść wszystkich żądań i odpowiedzi przekazywana jest w formie obiektów języka JavaScript (JSON).

W nagłówku HTTP Content-Type każdego żądania API przesyłanego metodą POST i zawierającego w treści obiekt JSON należy ustawić wartość application/json.

W żądaniach API przesyłanych metodą GET parametry należy umieścić w query stringu.

Każda metoda API może zwrócić jeden z kilku możliwych kodów odpowiedzi HTTP. Nagłówki i parametry odpowiedzi opisane poniżej dla każdej z metod zwracane są tylko dla kodu 200 (OK).

Autentykacja

api_key

Do uwierzytelniania użytkowników API wykorzystywany jest klucz użytkownika przekazywany w nagłówku HTTP Authorization przy wywoływaniu poszczególnych metod.

Security Scheme Type API Key
Header parameter name: Authorization

Dokumenty

Interfejs programistyczny RDF dostępny w serwisie iMSiG.pl umożliwia wyszukiwanie i pobieranie dokumentów złożonych w Repozytorium Dokumentów Finansowych Krajowego Rejestru Sądowego.

Źródło danych

Począwszy od 15 marca 2018 r. każdy ma dostęp przez Internet do składanych przez podmioty gospodarcze dokumentów finansowych. Ta funkcjonalność dostępna jest bez posiadania konta użytkownika ani logowania na konto w wyszukiwarce na stronie Ministerstwa Sprawiedliwości. Wystarczy podać numer KRS, aby wyszukać dokumenty przypisane do podmiotu z tym numerem.

Masowy dostęp

Wyszukiwarka dokumentów złożonych w RDF nie jest przeznaczona do masowego dostępu do dokumentów. Wyszukiwanie jest zabezpieczone przed działaniem robotów pobierających dokumenty mechanizmem reCAPTCHA v3. Co więcej, część dokumentów udostępniana jest w formie plików XML z podpisem cyfrowym, co uniemożliwia ich odczyt w popularnych programach.

Nasz interfejs programistyczny umożliwia masowe pobieranie dokumentów bez opóźnień związanych z wyszukiwaniem oraz bez problemów, które nierzadko występują przy pobieraniu pojedynczych plików. Wszystkie udostępniane przez nas dokumenty są gotowe do odczytu w popularnych programach.

Podgląd dokumentów

Dla wszystkich dokumentów złożonych w RDF w formacie innym niż PDF udostępniamy dodatkową opcję podglądu takiego dokumentu po konwersji do formatu PDF. Dotyczy to również sprawozdań finansowych sporządzonych w formacie XML, które w surowej postaci nie są czytelne dla odbiorcy. Dla tych sprawozdań udostępniamy ujednolicony oraz łatwy w użytkowaniu podgląd w formacie HTML oraz PDF.

Aby sprawdzić opcje podglądu dokumentów, skorzystaj z wyszukiwarki dokumentów.

get-documents

Pobiera informacje o dokumentach złożonych do Repozytorium Dokumentów Finansowych KRS spełniających podane kryteria.

W przypadku sukcesu w treści odpowiedzi zwracana jest lista dokumentów spełniających kryteria określone w parametrach metody, posortowanych malejąco według daty publikacji w RDF.

W przypadku, gdy żaden dokument nie spełnia podanych kryteriów, zwracana jest pusta lista. W przypadku, gdy liczba dokumentów spełniających kryteria jest większa niż 100, lista zawiera 100 pierwszych dokumentów.

Authorizations:
query Parameters
krs
string 10 characters
Example: krs=0000028860

Numer KRS podmiotu, którego dotyczy dokument

type
string
Example: type=financial_statement

Identyfikator rodzaju dokumentu

Pokaż możliwe opcje
Identyfikator Rodzaj dokumentu Nazwa dokumentu
"auditors_opinion" Opinia biegłego rewidenta / sprawozdanie z badania rocznego sprawozdania finansowego
"consolidated_auditors_opinion" Opinia biegłego rewidenta / sprawozdanie z badania skonsolidowanego rocznego sprawozdania finansowego grupy kapitałowej
"balance_sheet" Roczne sprawozdanie finansowe Bilans
"footnotes" Roczne sprawozdanie finansowe Informacja dodatkowa lub inny dokument z art. 48 ustawy o rachunkowości
"cash_flow_statement" Roczne sprawozdanie finansowe Rachunek przepływów pieniężnych
"profit_and_loss_statement" Roczne sprawozdanie finansowe Rachunek zysków i strat
"equity_statement" Roczne sprawozdanie finansowe Zestawienie zmian w kapitale (funduszu) własnym
"financial_statement" Roczne sprawozdanie finansowe
"consolidated_footnotes" Skonsolidowane roczne sprawozdanie finansowe Informacja dodatkowa lub inny dokument z art. 48 ustawy o rachunkowości
"consolidated_equity_statement" Skonsolidowane roczne sprawozdanie finansowe Skonsolidowane zestawienie zmian w kapitale (funduszu) własnym
"consolidated_balance_sheet" Skonsolidowane roczne sprawozdanie finansowe Skonsolidowany bilans
"consolidated_cash_flow_statement" Skonsolidowane roczne sprawozdanie finansowe Skonsolidowany rachunek przepływów pieniężnych
"consolidated_profit_and_loss_statement" Skonsolidowane roczne sprawozdanie finansowe Skonsolidowany rachunek zysków i strat
"consolidated_equity_statement" Skonsolidowane roczne sprawozdanie finansowe Zestawienie zmian w kapitale (funduszu) własnym
"consolidated_financial_statement" Skonsolidowane roczne sprawozdanie finansowe
"activity_report" Sprawozdanie z działalności
"consolidated_and_parent_activity_report" Sprawozdanie z działalności jednostki dominującej oraz sprawozdanie z działalności grupy kapitałowej
"parent_activity_report" Sprawozdanie z działalności jednostki dominującej
"report_on_payments" Sprawozdanie z płatności na rzecz administracji publicznej
"consolidated_report_on_payments" Skonsolidowane sprawozdanie z płatności na rzecz administracji publicznej
"resolution_on_approval" Uchwała lub postanowienie o zatwierdzeniu rocznego sprawozdania finansowego
"consolidated_resolution_on_approval" Uchwała lub postanowienie o zatwierdzeniu skonsolidowanego rocznego sprawozdania finansowego
"resolution_on_profit_distribution" Uchwała o podziale zysku bądź pokryciu straty
period_end_year
integer
Example: period_end_year=2019

Rok z daty końcowej okresu, którego dotyczy dokument

period_major_year
integer
Example: period_major_year=2018

Zasadniczy rok, którego dotyczy dokument

filing_date_from
string <date>
Example: filing_date_from=2020-01-01

Początek zakresu dla daty publikacji dokumentu w RDF

filing_date_to
string <date>
Example: filing_date_to=2020-12-31

Koniec zakresu dla daty publikacji dokumentu w RDF

crawling_date_from
string <date>
Example: crawling_date_from=2020-07-01

Początek zakresu dla daty pobrania dokumentu z RDF

crawling_date_to
string <date>
Example: crawling_date_to=2020-07-31

Koniec zakresu dla daty pobrania dokumentu z RDF

Responses

Request samples

# Wyszukaj dokumenty dla podmiotu z numerem KRS `0000028860`
curl https://api.imsig.pl/v1/rdf/documents?krs=0000028860 --header \"Authorization: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\"

Response samples

Content type
application/json
[]

Dane finansowe

Interfejs programistyczny RDF dostępny w serwisie iMSiG.pl umożliwia pobieranie przetworzonych danych finansowych ze sprawozdań złożonych w Repozytorium Dokumentów Finansowych Krajowego Rejestru Sądowego.

Źródło danych

Począwszy od 1 października 2018 r. sprawozdania finansowe podmiotów prowadzących księgi rachunkowe muszą być sporządzone w ustrukturyzowanym logicznie formacie XML (Extensible Markup Format). Struktury logiczne i format e-sprawozdań został określony i udostępnionych w Biuletynie Informacji Publicznej na stronie internetowej Ministerstwa Finansów.

Sprawozdania finansowe sporządzone w formacie XML nie są czytelne dla odbiorcy – są one przygotowywane oraz odczytywane przez dedykowane oprogramowanie. Aby podejrzeć tak przygotowane sprawozdanie, skorzystaj z [wyszukiwarki dokumentów] (https://www.imsig.pl/sprawozdania-finansowe).

Struktury logiczne sprawozdań w XML

Aby przygotować albo przetworzyć sprawozdaniu finansowe, należy wziąć pod uwagę zastosowany rodzaj struktury logicznej, który zależy od typu podmiotu. Inną formę mają sprawozdania przygotowane dla jednostek mikro, inną dla jednostek małych, jednostek pożytku publicznego, domów maklerskich czy banków. Dodatkowo struktury logiczne sprawozdań finansowych są obecnie dostępne są w dwóch wersjach: 1-0 oraz 1-2.

Wszystkie rodzaje struktur w obydwu wersjach są obsługiwane przez nasze oprogramowanie, co zapewnia pełną dostępność danych.

Sprawozdania zgodne z MSR oraz MSSF

Polskie spółki kapitałowe, co do zasady, sporządzają sprawozdania finansowe zgodnie z ustawą o rachunkowości. Ustawa dopuszcza, bądź wręcz czasem nakłada obowiązek, sporządzania sprawozdań zgodnych z Międzynarodowymi Standardami Rachunkowości (MSR) i Międzynarodowymi Standardami Sprawozdawczości Finansowej (MSSF).

Takie sprawozdania występują w dowolnym nieustrukturyzowanym formacie, najczęściej jest to PDF (Portable Document Format). Oznacza to konieczność na wpół automatycznego przetwarzania dokumentów, który to proces nadzorowany jest przez naszego wykwalifikowanego pracownika.

Weryfikacja danych

Ze względu na mnogość rodzajów struktur sprawozdań, odczytywanie danych finansowych dla każdego typu podmiotu jest utrudnione. Dodatkowo, część dokumentów została wyeksportowana z programu księgowego z błędami. Nasze oprogramowanie naprawia uszkodzone struktury, aby odczytać dane z prawie każdego dokumentu.

Oprócz błędów związanych z formatem danych, przy przetwarzaniu sprawozdań napotkamy na błędy wynikające z pomyłki człowieka. Należy do nich między innymi niepoprawne wskazanie rzędu wielkości do kwot występujących w sprawozdaniu – struktura pliku nie wskazuje, że zostało ono przygotowane w tysiącach a po ręcznej weryfikacji widać, że wartości występujące w sprawozdaniu powinny być interpretowane jako tysiące. Ma również miejsce sytuacja odwrotna, gdzie struktura pliku wskazuje na przygotowanie sprawozdania w tysiącach, co nie jest zgodne z rzeczywistością. Tego typu błędy są ręcznie poprawiane przez naszych pracowników.

Zarówno dla dokumentów w formacie PDF jak i XML mogą pojawić się korekty. Nasze oprogramowanie uwzględnia aktualne zmiany i udostępniane przez nas dane zawsze pochodzą z najnowszej wersji sprawozdania finansowego.

get-financial-data

Pobiera przetworzone dane finansowe ze sprawozdań złożonych do Repozytorium Dokumentów Finansowych KRS spełniających podane kryteria.

W przypadku sukcesu w treści odpowiedzi zwracana jest lista danych finansowych ze sprawozdań spełniających kryteria określone w parametrach metody, posortowanych malejąco według daty publikacji w RDF.

W przypadku, gdy żadne sprawozdanie nie spełnia podanych kryteriów, zwracana jest pusta lista. W przypadku, gdy liczba sprawozdań spełniających kryteria jest większa niż 100, lista zawiera dane finansowe ze 100 pierwszych dokumentów.

Authorizations:
query Parameters
krs
string 10 characters
Example: krs=0000019193

Numer KRS podmiotu, którego dotyczy sprawozdanie

type
string
Example: type=financial_statement

Identyfikator rodzaju dokumentu

Pokaż możliwe opcje
Identyfikator Rodzaj dokumentu Nazwa dokumentu
"auditors_opinion" Opinia biegłego rewidenta / sprawozdanie z badania rocznego sprawozdania finansowego
"consolidated_auditors_opinion" Opinia biegłego rewidenta / sprawozdanie z badania skonsolidowanego rocznego sprawozdania finansowego grupy kapitałowej
"balance_sheet" Roczne sprawozdanie finansowe Bilans
"footnotes" Roczne sprawozdanie finansowe Informacja dodatkowa lub inny dokument z art. 48 ustawy o rachunkowości
"cash_flow_statement" Roczne sprawozdanie finansowe Rachunek przepływów pieniężnych
"profit_and_loss_statement" Roczne sprawozdanie finansowe Rachunek zysków i strat
"equity_statement" Roczne sprawozdanie finansowe Zestawienie zmian w kapitale (funduszu) własnym
"financial_statement" Roczne sprawozdanie finansowe
"consolidated_footnotes" Skonsolidowane roczne sprawozdanie finansowe Informacja dodatkowa lub inny dokument z art. 48 ustawy o rachunkowości
"consolidated_equity_statement" Skonsolidowane roczne sprawozdanie finansowe Skonsolidowane zestawienie zmian w kapitale (funduszu) własnym
"consolidated_balance_sheet" Skonsolidowane roczne sprawozdanie finansowe Skonsolidowany bilans
"consolidated_cash_flow_statement" Skonsolidowane roczne sprawozdanie finansowe Skonsolidowany rachunek przepływów pieniężnych
"consolidated_profit_and_loss_statement" Skonsolidowane roczne sprawozdanie finansowe Skonsolidowany rachunek zysków i strat
"consolidated_equity_statement" Skonsolidowane roczne sprawozdanie finansowe Zestawienie zmian w kapitale (funduszu) własnym
"consolidated_financial_statement" Skonsolidowane roczne sprawozdanie finansowe
"activity_report" Sprawozdanie z działalności
"consolidated_and_parent_activity_report" Sprawozdanie z działalności jednostki dominującej oraz sprawozdanie z działalności grupy kapitałowej
"parent_activity_report" Sprawozdanie z działalności jednostki dominującej
"report_on_payments" Sprawozdanie z płatności na rzecz administracji publicznej
"consolidated_report_on_payments" Skonsolidowane sprawozdanie z płatności na rzecz administracji publicznej
"resolution_on_approval" Uchwała lub postanowienie o zatwierdzeniu rocznego sprawozdania finansowego
"consolidated_resolution_on_approval" Uchwała lub postanowienie o zatwierdzeniu skonsolidowanego rocznego sprawozdania finansowego
"resolution_on_profit_distribution" Uchwała o podziale zysku bądź pokryciu straty
period_end_year
integer
Example: period_end_year=2019

Rok z daty końcowej okresu, którego dotyczy dokument

period_major_year
integer
Example: period_major_year=2018

Zasadniczy rok, którego dotyczy dokument

filing_date_from
string <date>
Example: filing_date_from=2019-01-01

Początek zakresu dla daty publikacji sprawozdania w RDF

filing_date_to
string <date>
Example: filing_date_to=2019-12-31

Koniec zakresu dla daty publikacji sprawozdania w RDF

crawling_date_from
string <date>
Example: crawling_date_from=2020-07-01

Początek zakresu dla daty pobrania dokumentu z RDF

crawling_date_to
string <date>
Example: crawling_date_to=2020-07-31

Koniec zakresu dla daty pobrania dokumentu z RDF

consolidated
boolean
Example: consolidated=false

Informacja, czy sprawozdanie jest skonsolidowane

ias_standard
boolean
Example: ias_standard=false

Informacja, czy sprawozdanie zostało sporządzone zgodnie z Międzynarodowymi Standardami Rachunkowości

Responses

Request samples

# Wyszukaj dane finansowe ze sprawozdania dla podmiotu z numerem KRS `0000019193`
curl https://api.imsig.pl/v1/rdf/financialData?krs=0000019193 --header \"Authorization: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\"

Response samples

Content type
application/json
[
  • {