1. Rejestr.io API

Dostępne żądania

Dokument finansowy organizacji

Pobieranie dokumentu finansowego w KRS dla organizacji.

GET https://rejestr.io/api/v2/org/{id}/krs-dokumenty/{doc_id}

Uwagi:

  • Wymagany plan: dokumenty PDF wymagają planu abonamentowego Rejestr.io Premium lub wyższego, a dokumenty JSON planu Rejestr.io Biznes.
  • Koszt formatu JSON: w przypadku pobierania dokumentu w formacie JSON, to zapytanie ma wyższy koszt niż podstawowa cena żądania API. Zobacz cennik.
  • Format: to zapytanie API może zwrócić odpowiedź w formacie JSON lub PDF.

Obsługiwane parametry GET

id
string ^([0-9]{1,10})|(nip[0-9]{10})$

Id organizacji: albo numer KRS (np. 12345 lub 0000012345), albo NIP organizacji poprzedzony słowem "nip" (np. nip1234567890).

doc_id
integer int64

Id dokumentu finansowego. Można je znaleźć poprzez zapytanie "Pobieranie listy dokumentów finansowych w KRS dla organizacji".

format
string
wartości: json, pdf
domyślnie: pdf

Format w jakim powinien zostać zwrócony dokument.

W przypadku braku podania tego parametru, dokument zostanie zwrócony w formacie PDF.

Jedynie dokumenty, które w odpowiedzi na zapytanie "Pobieranie listy dokumentów finansowych w KRS dla organizacji" zwracają czy_ma_json równe true posiadają postać w formacie JSON. Zapytanie o format JSON dla innych dokumentów zwróci błąd.

Odpowiedź

Dla parametru format ustawionego na pdf - poprawna odpowiedź jest plikiem PDF zawierającym dokument finansowy.

Dla parametru format ustawionego na json - poprawna odpowiedź jest plikiem JSON o następującej strukturze:

id_organizacji
integer

Id organizacji (numer KRS bez początkowych zer).

id_dokumentu
integer

Id dokumentu.

nazwa
string

Nazwa dokumentu

okres_data_start
string

Data początkowa okresu rozliczeniowego, którego dotyczy dokument.

okres_data_koniec
string

Data końcowa okresu rozliczeniowego, którego dotyczy dokument.

Uwaga: ta data jest włączna, czyli zalicza się do tego okresu rozliczeniowego.

zawartosc
object

Hierarchiczna, drzewiasta struktura JSON powstała poprzez przeprocesowanie źródłowego dokumentu XML przy użyciu odpowiedniej schemy.

List obiektów z następującymi kluczami:

nazwa_wezla
string

Techniczna nazwa węzła w źródłowym dokumencie XML.

Uwaga: to pole dla najwyżej w hierarchii położonego węzła wskazuje na typ schemy XML używanej do przetworzenia źródłowego dokumentu XML. Wszystkie schemy są dostępne na stronie Ministerstwa Finansów pod adresem: https://www.gov.pl/web/kas/struktury-e-sprawozdan.

etykieta
string

Opis węzła w terminologii księgowej pochodzący ze schemy XML Ministerstwa Finansów.

podetykieta
string

Opis węzła w terminologii księgowej napisany przez organizację składającą ten dokument.

Zazwyczaj to pole jest niepuste jedynie dla węzłów mających w schemie XML Ministerstwa Finansów opis "Informacja uszczegóławiająca, wynikająca z potrzeb lub specyfiki jednostki".

pln_rok_obrotowy_biezacy
string

Monetarna wartość pozycji reprezentowanej przez ten węzeł w PLN, dla okresu rozliczeniowego, który opisuje ten dokument.

pln_rok_obrotowy_poprzedni
string

Monetarna wartość pozycji reprezentowanej przez ten węzeł w PLN, dla okresu rozliczeniowego poprzedzającego ten, który opisuje ten dokument.

podobiekty
array

List podobiektów JSON, z których każdy ma identyczne pola jak ten obiekt (nazwa_wezla, etykieta, itd).