Download the PHP package craftcms/commerce-uk-vat-id-validator without Composer
On this page you can find all versions of the php package craftcms/commerce-uk-vat-id-validator. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download craftcms/commerce-uk-vat-id-validator
More information about craftcms/commerce-uk-vat-id-validator
Files in craftcms/commerce-uk-vat-id-validator
Package commerce-uk-vat-id-validator
Short Description Adds a UK VAT ID validator to Craft Commerce
License mit
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package commerce-uk-vat-id-validator
UK VAT ID Validator
Out of the box, Craft Commerce supports basic formatting validation for VAT IDs in the European Union. This plugin provides additional checks to ensure tax rules are correctly applied for customers with UK VAT IDs:
- Tax rules are given a setting that allows merchants to disqualify taxes when a valid UK Tax ID (VAT number) is provided during checkout;
- UK Tax IDs are validated directly with HMRC’s official API;
How it Works
Enabling the validateBusinessTaxIdAsVatId in Craft Commerce 4.8 (globally) or Validate Business Tax ID as VAT ID in Craft Commerce 5.x (in one or more stores) tells Commerce to perform cursory validation of the Organization Tax ID field on addresses used for tax calculation. This functionality is available to all Commerce installations.
As tax rules are evaluated in the process of calculating order totals, UK VAT ID Validator ensures the provided VAT ID is both correctly formatted and actually exists, using the HMRC API.
[!NOTE]
Make sure youruseBillingAddressForTaxconfig setting (Commerce 4.8) or Use Billing Address For Tax store setting (Commerce 5.x) agrees with how you want to handle taxes in each market!
Requirements
- Craft CMS 4.x or 5.x
- Craft Commerce 4.8 or 5.3 and later
- HMRC credentials for Version 2 of the HMRC VAT API
Installation
You can install this plugin from the configuration instructions!
From the Plugin Store
Go to the Plugin Store in your project’s control panel and search for “UK VAT ID Validator.” On the plugin’s page, press Install.
With Composer
Open your terminal and run the following commands:
Configuration
Step 1: Configure Plugin Settings
Navigate to Settings → UK Tax ID Validator in the control panel, and fill in the following fields:
- HMRC Client ID: Obtain this from the HMRC Developer Hub.
- HMRC Client Secret: Provided alongside your HMRC Client ID.
- Sandbox Mode: Enable for testing (disables live API calls).
[!WARNING]
Whenever possible, use an environment variable so that these secrets don’t leak into your project config files!
Optional Step 2: Enable Validation on Tax Rates
- Navigate to Commerce → Tax Rates.
- Edit a tax rate and check UK VAT ID under the Disqualify with valid business tax ID? option.
- Save the tax rate.
When a valid UK tax ID is provided in the address, the tax will not be applied.
Support
Please report any issues on GitHub. Need help or have a question? Email us at [email protected].
:lemon:
All versions of commerce-uk-vat-id-validator with dependencies
craftcms/cms Version ^4.9.4|^5.6.0
craftcms/commerce Version ^4.8.0|^5.3.0