Skip to content

Latest commit

 

History

History
103 lines (69 loc) · 2.85 KB

README.md

File metadata and controls

103 lines (69 loc) · 2.85 KB
Raw

PHP EU VAT Number Validation

SunVatChecker is a simple and fast PHP dynamic EU VAT Number Validation class that validates a business EU VAT Number using the EU VIES system.

To use SunVatChecker class, you need to define the country and vat number parameters you want to verify. If the Country you are sending to is an EU member, the VAT verification step starts, otherwise, a false response is sent to the user. If the sent VAT Number is in the correct format, an inquiry is made from the EU VIES system, and a true or false response is sent to the user depending on the response. If it is in the wrong format or is not a member of the EU, a false response is sent to the user.

Table of Contents

Installation

Download all files (except Test directory).

To utilize this class, first import SunVatChecker.php into your project, and require it. SunVatChecker requires PHP 5.5+ to work.

require_once ('SunVatChecker.php');

Initialization

Simple initialization:

$vatChecker = new SunVatChecker();

VAT Validation

Validate VAT Number using Country and VAT ID parameters

$vatChecker = new SunVatChecker();

$country = 'Estonia';
$vatId = '123456789';

if ($vatChecker->validate($country, $vatId) === true) {
    echo "VAT Number is valid!";
} else {
    echo "VAT Number is invalid!";
}

VAT ID is valid if the validation result is true, invalid if false

Company Details

Get intra-EU company details if has a valid VAT Number

$vatChecker = new SunVatChecker();

$country = 'Estonia';
$vatId = '123456789';

$details = $vatChecker->getDetails($country, $vatId);

details variable is an array and you can check its content

var_dump($details);

or you can parse and use it as key and value

foreach ($details as $key => $value) {
    echo $key . ' = ' . $value . '<br>';
}

If you use SOAP, the keys and types are countryCode (string), vatNumber (string), requestDate (datetime), valid (boolean), name (string), and address (string).

echo 'VAT Number: ' . $details['vatNumber'] . '<br>';
echo 'Company Name: ' . $details['name'] . '<br>';
echo 'Company Address: ' . $details['address'];

If you use API, the keys and types are isValid (boolean), requestDate (datetime), userError (string), name (string), address (string), requestIdentifier (string), originalVatNumber (string), vatNumber (string), and viesApproximate (array).

echo 'VAT Number: ' . $details['originalVatNumber'] . '<br>';
echo 'Company Name: ' . $details['name'] . '<br>';
echo 'Company Address: ' . $details['address'];

Error Printing

Print the last error if occurred

echo $vatChecker->getError();