Biblioteka do odczytu danych z API białej listy podatników VAT.
Helper library to get data from Polish ministry of finance about VAT Taxpayer.
Biblioteka jest udostępniona w dwóch wersjach:
.NET Core 3 library - korzysta z szybszego i wbudowanego w framework System.Text.Json
.NET Standard 2.1 - standardowa wersja korzysta z Newtonsoft.Json
Cała struktura danych w przestrzeni nazw BialaLista.data - jest w 100% zgodna ze specyfikacją opublikowaną przez ministerstwo.
Zainstaluj bibliotekę z menagera NuGet.
WykazPodatnikow.Core
dotnet add package WykazPodatnikow.Core
WykazPodatnikow.Standard
dotnet add package WykazPodatnikow.Standard
Dodaj:
using WykazPodatnikow.Core;
lub
using WykazPodatnikow.Standard;
Do dyspozycji mamy dwie klasy, pierwsza a nich o nazwie VatWhiteListFlatFile służy do sprawdzania czy para NIP + Nr. konta bankowego są obecnie w pliku płaskim. Klasa przy inicjalizacji jako argument przyjmuje ścieżkę do pliku json którego należy pobrać wcześniej ze strony ministerstwa. Pamiętaj że dane w pliku są ważne tylko na dzień wystawienia pliku. Tak więc to jaki plik podasz determinuje dzień na jaki chcesz dokonać sprawdzenia. Klasa posiada tylko jedną metodę o nazwie IsInFlatFile która hashuje dane i sprawdza według specyfikacji. Metoda obsługuje również sprawdzanie rachunków wirtualnych, dzieje się to automatycznie. Metoda zwraca typ FlatFile który oznacz:
FlatFile.FoundInActiveVatPayer //Para nip + numer konta została znaleziona na liście czynnych podatników VAT
FlatFile.FoundInExemptVatPayer //Para nip + numer konta została znaleziona na liście podatników VAT zwolnionych
FlatFile.InvalidNip //Podany NIP nie ma poprawnego formatu
FlatFile.InvalidBankAccount //Podane konto bankowe nie ma poprawnego formatu
FlatFile.NotFound //Para nip + numer konta nie została odnaleziona w plikuZe względu na ograniczenia API, zaleca się najpierw sprawdzenie rachunku w pliku płaskim. Jeśli rachunek nie zostanie odnaleziony to można przejść do drugiej metody która zwraca już konkretne dane z bazy ministerstwa.
Z uwagi na rozmiar pliku json i ilość obiektów obecnie skupiam się na optymalizacji pamięci. Pierwszym krokiem ku temu jest wydzielenie funkcji ładującej plik. Teraz sama funkcja jest statyczna i ładuje plik w strumieniu. Dzięki czemu można ładować plik raz dziennie a nie za każdym requestem jak poprzenio.
Przykład:
class CheckInFlatFile
{
private readonly VatWhiteListFlatFile vatWhiteListFlatFile;
public CheckInFlatFile()
{
try
{
vatWhiteListFlatFile = new VatWhiteListFlatFile();
}
catch (Exception)//Jeśli plik nie istnieje zostanie rzucony wyjątek
{
throw;
}
}
public void CheckInFlatFile()
{
VatWhiteListFlatFile.LoadFlatFileAsync(@"C:\file\20191021.json");
FlatFile result = vatWhiteListFlatFile.IsInFlatFile("4356579386", "20721233708680000022663112").Wait();
switch (result)
{
case FlatFile.FoundInActiveVatPayer:
//Znaleziono na liście czynnych podatników VAT
break;
case FlatFile.FoundInExemptVatPayer:
//Znaleziono na liście zwolnionych podatników VAT
break;
case FlatFile.InvalidNip:
//Nieprawidłowy format numeru NIP
break;
case FlatFile.InvalidBankAccount:
//Nieprawidłowy format konta bankowego
break;
case FlatFile.NotFound:
//Pary NIP + Numer konta nie odnaleziono w pliku płaskim
break;
default:
break;
}
}
}Drugą klasą jest VatWhiteList która pobiera dane z API ministerstwa. Klasa przy inicjalizacji wymaga przekazania instancji HttpClient. Można to zrobić tworząc nową:
var vatWhiteList = new VatWhiteList(new HttpClient());lub z dependency injection:
public class SomeClass
{
private readonly HttpClient httpClient;
public SomeClass(HttpClient httpClient)
{
this.httpClient = httpClient;
}
public void ReadVatData()
{
var vatWhiteList = new VatWhiteList(httpClient);
}
}Jako drugi argument można podać adres API. Domyślnie jest wpisany produkcyjny https://wl-api.mf.gov.pl Można go nadpisać testowym https://wl-test.mf.gov.pl:9091/wykaz-podatnikow/ lub zmodyfikować gdyby w przyszłości się zmienił.
var vatWhiteList = new VatWhiteList(new HttpClient(), "https://wl-test.mf.gov.pl:9091/wykaz-podatnikow/");Po inicjalizacji można zacząć korzystać ze wszystkich metod.
EntityResponse result = await vatWhiteList.GetDataFromNipAsync("[NIP]", DateTime.Now); //Wyszukiwanie pojedyńczego podmiotu po nip.
EntityListResponse result = await vatWhiteList.GetDataFromNipsAsync("[NIPy]", DateTime.Now); //Wyszukiwanie podmiotów po numerach nip.
EntityResponse result = await vatWhiteList.GetDataFromRegonAsync("[Regon]", DateTime.Now); //Wyszukiwanie pojedyńczego podmiotu po regon.
EntityListResponse result = await vatWhiteList.GetDataFromRegonsAsync("[Regony]", DateTime.Now); //Wyszukiwanie podmiotów po numerach regon.
EntityResponse result = await vatWhiteList.GetDataFromBankAccountAsync("[Konto bankowe]", DateTime.Now); //Wyszukiwanie podmiotuw po numerze konta.
EntityListResponse result = await vatWhiteList.GetDataFromBankAccountsAsync("[Konta bankowe]", DateTime.Now); //Wyszukiwanie podmiotów po numerach kont.
EntityCheckResponse result = await vatWhiteList.CheckFromNipAndBankAccountsAsync("[NIP]","[Konta bankowe]", DateTime.Now); //Sprawdzenie pojedyńczego podmiotu po nip i numerze konta.
EntityCheckResponse result = await vatWhiteList.CheckFromRegonAndBankAccountsAsync("[Regon]","[Konta bankowe]", DateTime.Now); //Sprawdzenie pojedyńczego podmiotu po regon i numerze konta.Wartość DateTime można podać przeszłą, np. DateTime.Now.AddDays(-7) - pokaże dane z przed tygodnia.
Szczegółowy opis API można znaleźć na stronach ministerstwa: https://www.gov.pl/web/kas/api-wykazu-podatnikow-vat
Każda metoda musi być umieszczona w bloku try...catch. W przypadku problemów z serwerem zostanie rzucony wyjątek. W każdym innym przypadku błędy są zgłaszane w klasach:
EntityResponse.Exception
EntityListResponse.Exception
EntityCheckResponse.Exception
Baza ministerstwa jest obecnie w fazie rozwoju i często zdarzają się przerwy w jej działaniu.
private static async System.Threading.Tasks.Task Main(string[] args)
{
string nip = "5270103391";
string regon = "010016565";
string bankaccount = "72103015080000000500217006";
VatWhiteList vatWhiteList = null;
VatWhiteListFlatFile vatWhiteListFlatFile = null;
Console.WriteLine("Start!");
try
{
vatWhiteList = new VatWhiteList(new HttpClient());
vatWhiteListFlatFile = new VatWhiteListFlatFile();
await VatWhiteListFlatFile.LoadFlatFileAsync(@"C:\file\20191021.json");
}
catch (Exception ex)
{
Console.WriteLine($"Error while initialize vatWhiteList or vatWhiteListFlatFile. {ex.Message} | {ex.InnerException?.Message}");
}
try
{
Console.WriteLine("Sprawdzam firmę w pliku płaskim");
FlatFile result = vatWhiteListFlatFile.IsInFlatFile(nip, bankaccount);
switch (result)
{
case FlatFile.FoundInActiveVatPayer:
Console.WriteLine("Znaleziono na liście czynnych podatników VAT");
break;
case FlatFile.FoundInExemptVatPayer:
Console.WriteLine("Znaleziono na liście zwolnionych podatników VAT");
break;
case FlatFile.InvalidNip:
Console.WriteLine("Nieprawidłowy format numeru NIP");
break;
case FlatFile.InvalidBankAccount:
Console.WriteLine("Nieprawidłowy format konta bankoweg");
break;
case FlatFile.NotFound:
Console.WriteLine("Pary NIP + Numer konta nie odnaleziono w pliku płaskim");
break;
default:
break;
}
Console.WriteLine("Rozpoczynam sprawdzanie w API");
Console.WriteLine();
Console.WriteLine($"Sprawdzam firmę na podstawie NIP: {nip}");
var resultNip = await vatWhiteList.GetDataFromNipAsync(nip, DateTime.Now);
if (resultNip.Exception is null)
{
Console.WriteLine($"Id sprawdzenia: {resultNip.Result?.RequestId}");
Console.WriteLine($"Nazwa firmy: {resultNip.Result?.Subject.Name}");
Console.WriteLine($"Regon: {resultNip.Result?.Subject.Regon}");
Console.WriteLine($"Status VAT: {resultNip.Result?.Subject.StatusVat}");
Console.WriteLine($"Konta bankowe:");
foreach (var item in resultNip.Result?.Subject?.AccountNumbers)
{
Console.WriteLine(item);
}
Console.WriteLine();
}
else
{
Console.WriteLine($"Wystąpił błąd podczas sprawdzania: Kod {resultNip.Exception.Code} | Komunikat: {resultNip.Exception.Message}");
}
}
catch (Exception ex)
{
Console.WriteLine($"[Błąd] {ex.Message}");
}
try
{
Console.WriteLine($"Sprawdzam firmę na podstawie Regon: {regon}");
var resultRegon = await vatWhiteList.GetDataFromRegonAsync(regon, DateTime.Now);
if (resultRegon.Exception is null)
{
Console.WriteLine($"Id sprawdzenia: {resultRegon.Result?.RequestId}");
Console.WriteLine($"Nazwa firmy: {resultRegon.Result?.Subject.Name}");
Console.WriteLine($"Regon: {resultRegon.Result?.Subject.Regon}");
Console.WriteLine($"Status VAT: {resultRegon.Result?.Subject.StatusVat}");
Console.WriteLine($"Konta bankowe:");
foreach (var item in resultRegon.Result?.Subject.AccountNumbers)
{
Console.WriteLine(item);
}
}
else
{
Console.WriteLine($"Wystąpił błąd podczas sprawdzania: Kod {resultRegon.Exception.Code} | Komunikat: {resultRegon.Exception.Message}");
}
Console.WriteLine();
}
catch (Exception ex)
{
Console.WriteLine($"[Błąd] {ex.Message}");
}
try
{
Console.WriteLine($"Sprawdzam parę nip: {nip} i numeru konta: {bankaccount}");
var resultCheckNip = await vatWhiteList.CheckFromNipAndBankAccountsAsync(nip, bankaccount, DateTime.Now);
if (resultCheckNip.Exception is null)
{
Console.WriteLine($"Id sprawdzenia: {resultCheckNip.Result?.RequestId}");
Console.WriteLine($"Zwrócony status: {resultCheckNip.Result?.AccountAssigned}");
}
else
{
Console.WriteLine($"Wystąpił błąd podczas sprawdzania: Kod {resultCheckNip.Exception.Code} | Komunikat: {resultCheckNip.Exception.Message}");
}
Console.WriteLine();
}
catch (Exception ex)
{
Console.WriteLine($"[Błąd] {ex.Message}");
}
try
{
Console.WriteLine($"Sprawdzam parę regon: {regon} i numeru konta: {bankaccount}");
var resultCheckRegon = await vatWhiteList.CheckFromRegonAndBankAccountsAsync(regon, bankaccount, DateTime.Now);
if (resultCheckRegon.Exception is null)
{
Console.WriteLine($"Id sprawdzenia: {resultCheckRegon.Result?.RequestId}");
Console.WriteLine($"Zwrócony status: {resultCheckRegon.Result?.AccountAssigned}");
}
else
{
Console.WriteLine($"Wystąpił błąd podczas sprawdzania: Kod {resultCheckRegon.Exception.Code} | Komunikat: {resultCheckRegon.Exception.Message}");
}
}
catch (Exception ex)
{
Console.WriteLine($"[Błąd] {ex.Message}");
}
Console.ReadLine();
}