Laravel VAT
See ibericode/vat-bundle for a Symfony version of this package.
laravel-vat is a package that contains the Laravel related wiring code for ibericode/vat, helping you deal with VAT legislation for businesses based in the EU.
- Fetch (historical) VAT rates for any European member state using jsonvat.com
- Validate VAT numbers (by format, existence or both)
- Validate ISO-3316 alpha-2 country codes
- Determine whether a country is part of the EU
- Geolocate IP addresses
Installation
You can install this package via Composer:
composer require dannyvankooten/laravel-vat
The package will automatically register itself.
Usage
Check out the ibericode/vat README for general usage of this package.
Facades
You can use facades to retrieve an instance of the classes provided by ibericode/vat.
use DvK\Laravel\Vat\Facades\Rates;
use DvK\Laravel\Vat\Facades\Validator;
use DvK\Laravel\Vat\Facades\Countries;
// Get current standard VAT rate for a country
Rates::country('NL'); // 21.00
// Get reduced VAT rate
Rates::country('NL', 'reduced'); // 6.00
// Get reduced VAT rate on a given Date
Rates::country('NL', 'reduced', new \DateTime('2005-01-01')); // 19.00
// Get an array of rates in country code => rates format
Rates::all();
// Validate a VAT number by both format and existence
Validator::validate('NL50123'); // false
// Validate VAT number by format only
Validator::validateFormat('NL203458239B01'); // true
// Validate VAT number by existence (uses a remote HTTP service)
Validator::validateExistence('NL203458239B01') // false
// Get array of ISO-3316 country codes and country names
Countries::all(); // array of country codes + names
// Get name of country by ISO-3316 code
Countries::name('NL') // Netherlands
// Get array of EU country codes + names
Countries::europe(); // array of EU country codes + names
// Check if ISO-3316 code is in EU
Countries::inEurope('NL'); // true
// Get ISO-3316 code by IP address geo-location
Countries::ip('8.8.8.8'); // US
By default, VAT rates are cached for 24 hours using the default cache driver.
Validation
The package registers two new validation rules.
vat_number
The field under validation must be a valid and existing VAT number.
country_code
The field under validation must be a valid ISO-3316 alpha-2 country code.
use Illuminate\Http\Request;
class Controller {
public function foo(Request $request)
{
$request->validate([
'vat_number_field' => ['vat_number'],
'country_code_field' => [ 'country_code' ],
]);
}
}
Alternatively, you can also use the Rule objects directly.
use Illuminate\Http\Request;
use DvK\Laravel\Vat\Rules;
class Controller {
public function foo(Request $request)
{
$request->validate([
'vat_number_field' => [ new Rules\VatNumber() ],
'country_code_field' => [ new Rules\Country() ],
]);
}
}
Localization
You can translate the validation error message by Using Translation Strings As Keys for the following strings:
resources/lang/de.json
{
"The :attribute must be a valid VAT number.": "Your translation for the VatNumber Rule",
"The :attribute must be a valid country.": "Your translation for the Country Rule"
}
1.1k Jan 7, 2023
128 Oct 27, 2022
1 Jan 16, 2022
5 Dec 15, 2022
1.3k Dec 27, 2022
131 Oct 30, 2022
1 May 3, 2022
938 Dec 24, 2022
1 Jun 21, 2022
347 Dec 25, 2022
5 Jun 13, 2022
686 Dec 28, 2022
931 Dec 24, 2022
264 Dec 23, 2022
1.9k Dec 29, 2022
15 Dec 19, 2022
4 Dec 8, 2022
2.7k Jan 3, 2023
67 Dec 14, 2022