VatCalculator
Handle all the hard stuff related to EU MOSS tax/vat regulations, the way it should be. Integrates with Laravel and Cashier — or in a standalone PHP application. Originally created by Marcel Pociot.
// Easy to use!
VatCalculator::calculate(24.00, $countryCode = 'DE');
VatCalculator::calculate(24.00, $countryCode, $postalCode);
VatCalculator::calculate(71.00, 'DE', '41352', $isCompany = true);
VatCalculator::getTaxRateForLocation('NL');
// Check validity of a VAT number
VatCalculator::isValidVATNumber('NL123456789B01');
Requirements
- PHP 7.3 or higher
- (optional) Laravel 6.0 or higher
Installation
Install the package with composer:
composer require mpociot/vat-calculator
Standalone
You can also use this package without Laravel. Simply create a new instance of the VatCalculator and use it. All documentation examples use the Laravel Facade code, so make sure not to call the methods as if they were static methods.
use Mpociot\VatCalculator\VatCalculator;
$vatCalculator = new VatCalculator();
$vatCalculator->setBusinessCountryCode('DE');
$grossPrice = $vatCalculator->calculate(49.99, $countryCode = 'LU');
Upgrading
Please refer to the upgrade guide when upgrading the library.
Usage
Calculate the gross price
To calculate the gross price use the calculate method with a net price and a country code as parameters.
$grossPrice = VatCalculator::calculate(24.00, 'DE');
The third parameter is the postal code of the customer.
As a fourth parameter, you can pass in a boolean indicating whether the customer is a company or a private person. If the customer is a company, which you should check by validating the VAT number, the net price gets returned.
$grossPrice = VatCalculator::calculate(24.00, 'DE', '12345', $isCompany = true);
Receive more information
After calculating the gross price you can extract more information from the VatCalculator.
$grossPrice = VatCalculator::calculate(24.00, 'DE'); // 28.56
$taxRate = VatCalculator::getTaxRate(); // 0.19
$netPrice = VatCalculator::getNetPrice(); // 24.00
$taxValue = VatCalculator::getTaxValue(); // 4.56
Validate EU VAT numbers
Prior to validating your customers VAT numbers, you can use the shouldCollectVAT method to check if the country code requires you to collect VAT in the first place.
if (VatCalculator::shouldCollectVAT('DE')) {
// This country code requires VAT collection...
}
To validate your customers VAT numbers, you can use the isValidVATNumber method. The VAT number should be in a format specified by the VIES. The given VAT numbers will be truncated and non relevant characters / whitespace will automatically be removed.
This service relies on a third party SOAP API provided by the EU. If, for whatever reason, this API is unavailable a VATCheckUnavailableException will be thrown.
try {
$validVAT = VatCalculator::isValidVATNumber('NL 123456789 B01');
} catch (VATCheckUnavailableException $e) {
// The VAT check API is unavailable...
}
Get EU VAT number details
To get the details of a VAT number, you can use the getVATDetails method. The VAT number should be in a format specified by the VIES. The given VAT numbers will be truncated and non relevant characters / whitespace will automatically be removed.
This service relies on a third party SOAP API provided by the EU. If, for whatever reason, this API is unavailable a VATCheckUnavailableException will be thrown.
try {
$vat_details = VatCalculator::getVATDetails('NL 123456789 B01');
print_r($vat_details);
/* Outputs
stdClass Object
(
[countryCode] => NL
[vatNumber] => 123456789B01
[requestDate] => 2017-04-06+02:00
[valid] => false
[name] => Name of the company
[address] => Address of the company
)
*/
} catch (VATCheckUnavailableException $e) {
// The VAT check API is unavailable...
}
UK VAT Numbers
UK VAT numbers are formatted a little differently:
try {
$vat_details = VatCalculator::getVATDetails('GB 553557881');
print_r($vat_details);
/* Outputs
array(3) {
["name"]=>
string(26) "Credite Sberger Donal Inc."
["vatNumber"]=>
string(9) "553557881"
["address"]=>
array(3) {
["line1"]=>
string(18) "131B Barton Hamlet"
["postcode"]=>
string(8) "SW97 5CK"
["countryCode"]=>
string(2) "GB"
}
}
*/
} catch (VATCheckUnavailableException $e) {
// The VAT check API is unavailable...
}
Laravel
Configuration
By default, the VatCalculator has all EU VAT rules predefined, so that it can easily be updated, if it changes for a specific country.
If you need to define other VAT rates, you can do so by publishing the configuration and add more rules.
⚠️ Be sure to set your business country code in the configuration file, to get correct VAT calculation when selling to business customers in your own country.
To publish the configuration files, run the vendor:publish command
php artisan vendor:publish --provider="Mpociot\VatCalculator\VatCalculatorServiceProvider"
This will create a vat_calculator.php in your config directory.
ValidVatNumber Validation Rule
VatCalculator also ships with a ValidVatNumber validation rule for VAT Numbers. You can use this when validation input from a form request or a standalone validator instance:
use Mpociot\VatCalculator\Rules\ValidVatNumber;
$validator = Validator::make(Input::all(), [
'first_name' => 'required',
'last_name' => 'required',
'company_vat' => ['required', new ValidVatNumber],
]);
if ($validator->passes()) {
// Input is correct...
}
⚠️ The validator extension returnsfalsewhen the VAT ID Check SOAP API is unavailable.
Cashier Stripe Integration
⚠️ Note that at the moment this package is not compatible with Cashier Stripe v13 because it still relies on the oldtaxPercentagemethod which has been removed from Cashier v13. You can still use it on older Cashier Stripe versions in the meantime.
If you want to use this package in combination with Laravel Cashier Stripe you can let your billable model use the BillableWithinTheEU trait. Because this trait overrides the taxPercentage method of the Billable trait, we have to explicitly tell our model to do so.
use Laravel\Cashier\Billable;
use Mpociot\VatCalculator\Traits\BillableWithinTheEU;
use Laravel\Cashier\Contracts\Billable as BillableContract;
class User extends Model implements BillableContract
{
use Billable, BillableWithinTheEU {
BillableWithinTheEU::taxPercentage insteadof Billable;
}
protected $dates = ['trial_ends_at', 'subscription_ends_at'];
}
By using the BillableWithinTheEU trait, your billable model has new methods to set the tax rate for the billable model.
Set everything in one command:
setTaxForCountry($countryCode, $company = false)
Or use the more readable, chainable approach:
useTaxFrom($countryCode)— Use the given countries tax rateasIndividual()— The billable model is not a company (default)asBusiness()— The billable model is a valid company
So in order to set the correct tax percentage prior to subscribing your customer, consider the following workflow:
$user = User::find(1);
// For individuals use:
$user->useTaxFrom('NL');
// For business customers with a valid VAT ID, use:
$user->useTaxFrom('NL')->asBusiness();
$user->subscription('monthly')->create($creditCardToken);
Changelog
Check out the CHANGELOG in this repository for all the recent changes.
Maintainers
VatCalculator is maintained by Dries Vints. Originally created by Marcel Pociot.
License
VatCalculator is open-sourced software licensed under the MIT license.
![Method [validateVatNumber] does not exist.](https://avatars.githubusercontent.com/u/882397?v=4)
1 Oct 31, 2021
36 Jul 15, 2022
916 Dec 14, 2022
71 Nov 5, 2022
1 May 3, 2022
632 Dec 14, 2022
18 Jun 28, 2022
103 Dec 22, 2022
1 Dec 7, 2021
1.1k Dec 21, 2022
11 Dec 2, 2022
5 Dec 4, 2022
23 Dec 15, 2022
11 Nov 24, 2022
6 Oct 11, 2021
2 Dec 31, 2021
7 Dec 11, 2022
5 Sep 22, 2022