GetDataFromGUS
Zastosowanie
Funkcja GetDataFromGUS() pobiera dane dotyczące podmiotu gospodarczego z bazy Głównego Urzędu Statystycznego. Korzysta z publicznego API udostępnionego przez GUS.
UWAGA! Astrafox nie odpowiada za aktualność i poprawność danych.
Składnia
GetDataFromGUS (contractorIdentityNumber, [parameter], [separator])
Argumenty funkcji
- contractorIdentityNumber – (String) numer NIP, Regon albo KRS podmiotu;
- parameter – (String) [Opcjonalnie] parametr zawiera nazwę pola (atrybutu) lub kilku pól oddzielonych przecinkiem, których wartość zostanie zwrócona. Dozwolone wartości: regon, nip, nazwa, wojewodztwo, powiat, gmina, miejscowosc, kodpocztowy, ulica, nrNieruchomosci, nrLokalu, typ, silosID. Nazwy parametrów nie mogą zawierać polskich znaków np. tak jak w słowie „wojewodztwo”.
- separator – (String) [Opcjonalnie] separator zawiera znak, który zostanie użyty do rozdzielenia wyników. Domyślnie używany jest średnik „;”.
Zwracana wartość
Ta funkcja zwraca String.
Jeżeli funkcja zostanie wywołana tylko z parametrem contractorIdentityNumber, to zwróci wszystkie dane o podmiocie gospodarczym w postaci XML. Plik będzie miał postać:
<root> <dane> <Regon>016263968</Regon> <Nip>5252171560</Nip> <StatusNip /> <Nazwa>ASTRAFOX SPÓŁKA Z OGRANICZONĄ ODPOWIEDZIALNOŚCIĄ</Nazwa> <Wojewodztwo>MAZOWIECKIE</Wojewodztwo> <Powiat>m. st. Warszawa</Powiat> <Gmina>Ursynów</Gmina> <Miejscowosc>Warszawa</Miejscowosc> <KodPocztowy>02-699</KodPocztowy> <Ulica>ul. Taborowa</Ulica> <NrNieruchomosci>8</NrNieruchomosci> <NrLokalu /> <Typ>P</Typ> <SilosID>6</SilosID> <DataZakonczeniaDzialalnosci /> <MiejscowoscPoczty>Warszawa</MiejscowoscPoczty> </dane> </root>
Pole Typ może przyjąć wartości:
P | jednostka prawna | osoba prawna lub jednostka organizacyjna nieposiadająca osobowości prawnej, np. spółka cywilna |
F | jednostka fizyczna | osoba fizyczna prowadząca działalność gospodarczą |
LP | jednostka lokalna jednostki prawnej | |
LF | jednostka lokalna jednostki fizycznej |
Pole SilosID może przyjąć wartości
1 | Miejsce wykonywania działalności podlegającej wpisowi do CEIDG (tylko typy F i LF) |
2 | Miejsce prowadzenia działalności rolniczej (gospodarstwo rolne, działy specjalne produkcji rolnej, tylko typy F i LF) |
3 | Miejsce prowadzenia działalności pozostałej – innej niż silosID 1 lub 2, tj. komornik, notariusz, agroturystyka, o ile nie zostały wpisane do CEIDG (tylko typy F i LF) |
4 | Miejsce prowadzenia działalności skreślonej z rejestru REGON przed 2014.11.08 (tylko typy F i LF) |
6 | Miejsce prowadzenia działalności jednostki prawnej (tylko typy P i LP) |
Gdy funkcja zostanie wywołana z podaniem nazw pól, to zwróci string zwierający wartości dla wskazanych parametrów.
Przykłady
Przykład 1:
GetDataFromGUS("5252171560")
Pobierze wszystkie dane z GUS API dla podmiotu, którego NIP przyjmuje wartość 5252171560. Format danych to XML.
Zwrócone dane w formacie XML zaprezentowano wyżej.
Przykład 2:
GetDataFromGUS("5252171560", "Nazwa")
Pobierze nazwę podmiotu gospodarczego z GUS, którego NIP przyjmuje wartość 5252171560.
Zwrócona wartość to: ASTRAFOX SPÓŁKA Z OGRANICZONĄ ODPOWIEDZIALNOŚCIĄ
Przykład 3:
GetDataFromGUS("5252171560", "Nazwa, Miejscowosc")
Pobierze nazwę podmiotu i miejscowość z GUS dla podmiotu, którego NIP przyjmuje wartość 5252171560.
Zwrócone zostaną dane w jednym ciągu oddzielone znakiem średnika ’;’.
ASTRAFOX SPÓŁKA Z OGRANICZONĄ ODPOWIEDZIALNOŚCIĄ;Warszawa
Przykład 4:
GetDataFromGUS("5252171560", "Nazwa, Miejscowosc","##")
Pobierze nazwę podmiotu i miejscowość z GUS dla podmiotu, którego NIP przyjmuje wartość 5252171560, a zwracane wartości oddzieli znakami ##.
Zwrócone zostaną dane w jednym ciągu oddzielone znakami '##’.
ASTRAFOX SPÓŁKA Z OGRANICZONĄ ODPOWIEDZIALNOŚCIĄ##Warszawa