Aplikacja kliencka nip24client.exe pozwala na szybkie i automatyczne wykonanie sprawdzenia podmiotów (kontrahentów) z poziomu linii komend (CLI/CMD) pod kątem ich bieżącego statusu: w rejestrze VAT, w systemie VIES, rejestrze REGON oraz umożliwia sprawdzanie rachunków bankowych kontrahentów opublikowanych na tzw. białej liście podatników VAT. Za pomocą aplikacji możliwe jest również pobieranie szczegółowych danych firm bezpośrednio z rejestru państwowego REGON. Aplikacja umożliwia również zapisanie do pliku pobranych danych w 3 formatach:
JSON(domyślny format wyświetlania na stdout)XMLMAP(mapa atrybutów klucz=wartość)
Aplikacja została pomyślnie przetestowana w następujących wersjach systemu MS Windows: XP, 7, oraz 10.
Najnowsza wersja aplikacji dostępna jest zawsze do pobrania ze strony Pobierz.
Pełną funkcjonalności aplikacji można sprawdzić – bez konieczności zakładania konta – korzystając z udostępnionego Testowego API.
Korzystanie z dodatku w produkcyjnym API wymaga założenia konta w serwisie nip24.pl, wykupienia minimum planu Biznes oraz wygenerowania klucza API i identyfikatora klucza API. Proces rejestracji i zakładania konta oraz generowania kluczy został opisany na stronie Dokumentacja.
Uruchomienie
Udostępniony program wykonywalny nip24client.exe nie wymaga instalacji oraz nie musi być uruchamiany z konta o uprawnieniach administracyjnych. W celu uruchomienia programu należy z menu Start wybrać aplikację Wiersz polecenia lub w polu „Wyszukaj programy i pliki” wpisać cmd i wcisnąć klawisz Enter:
Po uruchomieniu konsoli, należy przejść do katalogu w którym został pobrany i rozpakowany plik ZIP z plikiem nip24client.exe.
Uruchomienie programu bez podania parametrów powoduje wyświetlenie pomocy.
Konfiguracja
Uruchomienie aplikacji nip24client.exe bez podania identyfikatora klucza API oraz klucza API umożliwia wykonanie zapytań na środowisko testowe (więcej szczegółów na zakładce Testowe API).
W celu połączenia się ze środowiskiem produkcyjnym niezbędne jest wywołanie aplikacji nip24client.exe z parametrami uwierzytelniającymi, którymi są:
- „
keyid” – parametr powinien zawierać wygenerowany na koncie w serwisie nip24.pl identyfikator klucza API (ID), - „
key” – parametr powinien zawierać wygenerowany na koncie w serwisie nip24.pl klucz API (Key).
Szczegóły dotyczące generowania identyfikatora oraz klucza opisane zostały na stronie Dokumentacja. Poniżej przykład wywołania aplikacji z parametrami uwierzytelniającymi (keyid oraz key):
nip24client.exe -keyid XXXXXXXXXXXX -key YYYYYYYYYYYY -activity -nip 1234567890
Opis składni wywołania
Składnia wywołania programu nip24client.exe:
nip24client.exe <action> [options]
Akcje <action>:
-help - opis parametrów wywołania programu -account - zwraca informacje o aktualnym stanie konta nip24 -activity - sprawdzenie czy firma prowadzi aktywną działalność -invoice - pobranie danych firmy do faktury z REGON -all - pobranie wszystkich danych firmy z REGON -vies - pobranie danych firmy z VIES -vat - sprawdzenie czy firma jest płatnikiem VAT -bank - sprawdzenie rachunku bankowego firmy w rejestrze VAT -whitelist - sprawdzenie rachunku bankowego i statusu VAT na białej liście
Opcje [options]:
-keyid string - identyfikator klucza API -key string - klucz API -nip number - numer NIP -regon number - numer REGON -krs number - numer KRS -euvat number - numer EU VAT ID -iban number - numer IBAN rachunku bankowego -date yyyy-mm-dd - data przeszła do sprawdzenia statusu, domyślna: bieżąca -format type - format zwracanych danych (JSON, MAP, XML), domyślny: JSON -file path - nazwa i ścieżka do pliku wynikowego, domyślnie: katalog uruchomienia nip24client.exe -proxy url - konfiguracja HTTP proxy (jako URL https://user:password@hostname:port)
Przykłady
UWAGA! Poniższe przykłady dostosowane są do danych zgromadzonych na środowisku testowym. W celu wykonania sprawdzeń na środowisku produkcyjnym do każdego zapytania należy dodać parametry –keyid oraz –key wraz z odpowiednimi wartościami.
Sprawdzenie po numerze NIP czy firma prowadzi aktywną działalność
nip24client.exe -activity -nip 7272445205
Pobranie danych do faktury dla numeru NIP i zapis wyniku do pliku w formacie JSON
nip24client.exe -invoice -regon 010168068 -format json -file regon-010168068-invoice.json
Pobranie wszystkich danych dla numeru KRS i zapis wyniku do pliku w formacie XML
nip24client.exe -all -krs 0000070444 -format xml -file krs-0000070444-all.xml
Pobranie danych firmy z VIES i wyświetlenie wyniku na konsoli w formacie MAP
nip24client.exe -vies -euvat PL5213003700 -format map
Sprawdzenie czy firma jest płatnikiem VAT i wyświetlenie wyniku w formacie JSON
nip24client.exe -vat -nip 7171642051
Sprawdzenie rachunku bankowego firmy i wyświetlenie wyniku w formacie XML
nip24client.exe -bank -nip 5252242171 -iban PL63124000017766964359303930 -format xml
Sprawdzenie rachunku bankowego firmy i wyświetlenie wyniku w formacie MAP
nip24client.exe -whitelist -regon 017461044 -iban PL63124000017766964359303930 -format map
Wyświetlenie informacji o aktualnym stanie konta
nip24client.exe -account
Ustawienie HTTP Proxy
nip24client.exe -activity -nip 7272445205 -proxy https://uzytkownik:haslo@10.0.0.1:8080
Polski 
English (UK)