smerrill / vat.php

PHP library for dealing with European VAT

vat.php

vat.php is a simple PHP library which helps you to deal with European VAT rules. It helps you...

• Grab up-to-date VAT rates for any European member state
• Validate VAT number format for some non-EU member states
• Validate VAT numbers (by format or existence)
• Work with ISO 3166-1 alpha-2 country codes and determine whether they're part of the EU.
• Geolocate IP addresses

The library uses jsonvat.com to obtain its data for the VAT rates. Full details can be seen here. For VAT number validation, it uses VIES VAT number validation.

Installation

PHP 5.6+ is required. For VAT number existence checking, the PHP SOAP extension is required as well.

To get the latest version of vat.php, simply require the project using Composer:

$ composer require dannyvankooten/vat.php

Usage

This library exposes 3 main classes to interact with, Rates, Countries and Validator.

Fetching VAT rates.

$rates = new DvK\Vat\Rates\Rates();
$rates->country('NL'); // 21
$rates->country('NL', 'standard'); // 21
$rates->country('NL', 'standard', new \Datetime('2010-01-01')); // 19
$rates->country('NL', 'reduced'); // 6
$rates->all(); // array in country code => rates format

Validating a VAT number

$validator = new DvK\Vat\Validator();
$validator->validate('NL50123'); // false
$validator->validateFormat('NL203458239B01'); // true (checks format)
$validator->validateExistence('NL203458239B01'); // false (checks existence)
$validator->validate('NL203458239B01'); // false (checks format + existence)

Dealing with countries & geolocation

$countries = new DvK\Vat\Countries();
$countries->all(); // array of country codes + names
$countries->name('NL') // Netherlands
$countries->europe(); // array of EU country codes + names
$countries->inEurope('NL'); // true
$countries->ip('8.8.8.8'); // US

License

vat.php is licensed under The MIT License (MIT).