An open API service indexing awesome lists of open source software.

https://github.com/infirsoft/vat-whitelist-api

PHP wrapper for WhiteList API issued by Ministerstwo Finansów
https://github.com/infirsoft/vat-whitelist-api

api client php vat whitelist wl-api wrapper

Last synced: 5 months ago
JSON representation

PHP wrapper for WhiteList API issued by Ministerstwo Finansów

Awesome Lists containing this project

README

          

API Rejestr WL
==============

[![License](https://img.shields.io/packagist/l/infirsoft/whitelistapi?color=blue)](./LICENSE.md)
[![Version](https://img.shields.io/packagist/v/infirsoft/whitelistapi?color=blue)](https://packagist.org/packages/infirsoft/whitelistapi)
[![Downloads](https://img.shields.io/packagist/dt/infirsoft/whitelistapi?color=blue)](https://packagist.org/packages/infirsoft/whitelistapi)
[![StyleCI](https://github.styleci.io/repos/338450280/shield?style=flat&branch=main)](https://github.styleci.io/repos/338450280?branch=main)

White List API / API Wykazu podatników VAT / Biała lista podatników VAT

API Docs
--------

* https://wl-api.mf.gov.pl/
* https://www.gov.pl/web/kas/api-wykazu-podatnikow-vat

Installation
------------

```bash
composer require infirsoft/whitelistapi
```

Supported Versions
------------------

| Version | PHP version | HTTP client |
|---------|-------------|-------------|
| 2.x | \>= 8.0 | cURL |
| 1.x | \>= 7.1 | cURL |

Methods
------------------

```php
searchNip( string $nip , string $date ) : EntityResponse|Error
searchNips( array $nips , string $date ) : EntryListResponse|Error
searchRegon( string $regon , string $date ) : EntityResponse|Error
searchRegons( array $regons , string $date ) : EntryListResponse|Error
searchBankAccount( string $bankAccount , string $date ) : EntityListResponse|Error
searchBankAccounts( array $bankAccounts , string $date ) : EntryListResponse|Error
checkNipBankAccount( string $nip , string $bankAccount , string $date ) : EntityCheckResponse|Error
checkRegonBankAccount( string $regon , string $bankAccount , string $date ) : EntityCheckResponse|Error
```

Usage
------------------

```php
searchNip('5252344078', '2021-01-01');
echo $response->result->subject->name; // GOOGLE POLAND SPÓŁKA Z OGRANICZONĄ ODPOWIEDZIALNOŚCIĄ
```