VatCalculator

When upgrading from v1 to v2, it is recommended to switch from getTaxRateForCountry to the more precise getTaxRateForLocation method.

getTaxRateForLocation accepts three arguments:

1. country code: The country code of the customer.
2. postal code: The postal code of the customer.
3. company: A boolean flag indicating if the customer is a company.

Install the package using Composer to add it to your PHP project:

composer require mpociot/vat-calculator

Requirements:

• PHP 7.3 or higher
• (Optional) Laravel 6.0 or higher

In v3, VAT calculations for GB (United Kingdom), NO (Norway), and TR (Turkey) were removed because they are not EU members. If your application requires support for these countries, you must manually re-add them to your config.php file.

return [
    'rules' => [
         'GB' => [
             'rate' => 0.20,
             'exceptions' => [
                 'Akrotiri' => 0.19,
                 'Dhekelia' => 0.19,
             ],
         ],
         'TR' => [
             'rate' => 0.18,
         ],
         'NO' => [
             'rate' => 0.25,
         ],
    ],
];

The internal validation rule for VAT numbers has been refactored into a dedicated rule object. In v3, instead of using the string 'vat_number' in your Laravel validation array, you must instantiate the Mpociot\VatCalculator\Rules\ValidVatNumber class.

// After v3 upgrade...
use Mpociot\VatCalculator\Rules\ValidVatNumber;

$validator = Validator::make(
    ['vat_number' => $vatNumber],
    ['vat_number' => ['required', new ValidVatNumber]]
);

If you are not using Laravel, you must instantiate the VatCalculator class manually. Do not call methods statically as you would with the Laravel Facade.

use Mpociot\
VatCalculator
vatCalculator = new VatCalculator();
$vatCalculator->setBusinessCountryCode('DE');
$grossPrice = $vatCalculator->calculate(49.99, 'LU');

use Mpociot\VatCalculator\VatCalculator;

$vatCalculator = new VatCalculator();
$vatCalculator->setBusinessCountryCode('DE');
$grossPrice = $vatCalculator->calculate(49.99, 'LU');

To use UK VAT validation, you must register your application with the HMRC Developer Hub and add the following environment variables to your .env file:

HMRC_CLIENT_ID="your-client-id"
HMRC_CLIENT_SECRET="your-client-secret"

To customize VAT rates or settings in Laravel, publish the configuration file:

php artisan vendor:publish --provider="Mpociot\VatCalculator\VatCalculatorServiceProvider"

This creates config/vat_calculator.php. Key options include:

• forward_soap_faults (bool): If true, SOAP faults from the VIES API will be thrown as VATCheckUnavailableException instead of returning false.
• soap_timeout (int): The timeout in seconds for the SOAP client (default is 30).

Warning: Ensure you set your business country code in the config to ensure correct calculations when selling to business customers in your own country.

The VatCalculatorServiceProvider automatically handles the integration of the package into your Laravel application.

Configuration

To customize the package settings, you can publish the configuration file to your application's config directory using the following Artisan command:

php artisan vendor:publish --provider="Mpociot\VatCalculator\VatCalculatorServiceProvider"

This will create a config/vat_calculator.php file.

Dependency Injection

You can resolve the VatCalculator instance from the Laravel Service Container using either the class name or the string alias vatcalculator.

Use getVATDetails($vatNumber) to retrieve detailed information about a VAT number from the VIES service. This returns an stdClass object containing the country code, VAT number, request date, validity status, company name, and address.

Note: This method throws VATCheckUnavailableException if the VIES API is unavailable.

try {
    $vat_details = VatCalculator::getVATDetails('NL 123456789 B01');
    // $vat_details->name, $vat_details->address, etc.
} catch (VATCheckUnavailableException $e) {
    // Handle API unavailability
}

try {
    $vat_details = VatCalculator::getVATDetails('NL 123456789 B01');
    print_r($vat_details);
} catch (VATCheckUnavailableException $e) {
    // The VAT check API is unavailable...
}

The package provides a ValidVatNumber rule for use in Laravel Form Requests or manual validation.

Note: This rule returns false if the VAT ID Check SOAP API is unavailable.

use Mpociot\VatCalculator\Rules\ValidVatNumber;

$validator = Validator::make($input, [
    'company_vat' => ['required', new ValidVatNumber],
]);

use Mpociot\VatCalculator\Rules\ValidVatNumber;

$validator = Validator::make(Input::all(), [
    'first_name' => 'required',
    'last_name' => 'required',
    'company_vat' => ['required', new ValidVatNumber],
]);