Difference between revisions of "EU VAT Addon"

From WHMCS Documentation

Line 1: Line 1:
 
<div class="docs-alert-warning">
 
<div class="docs-alert-warning">
 
<span class="title">Note</span><br />
 
<span class="title">Note</span><br />
This page describes features in version 7.6 and below. In version 7.7 and above this functionality is in '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Tax Configuration]]''' or, prior to WHMCS 8.0, '''Setup > Payments > Tax Configuration''' as such the addon is discontinued.
+
This page describes deprecated features in version 5.1 through 7.6. In version 7.7 and above, this functionality is in '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Tax Configuration]]''' or, prior to WHMCS 8.0, '''Setup > Payments > Tax Configuration'''.
 
</div>
 
</div>
  
The EU VAT Addon allows you to configure a number of additional invoice/billing related options specific to EU invoicing and VAT requirements.  One of the key features is that utilities VIES, the VAT Number Validation service of the European Commission, the order form is able to validate and then automatically make tax exempt those users in an EU country who supply a valid VAT Number to you.  This helps keep you compliant with VAT regulations.
+
The EU VAT Addon allows you to configure a additional invoice and billing-related options for EU invoicing and VAT requirements.
  
Functionality includes...
+
This functionality includes:
 +
* The ability to automatically set up EU tax rules.
 +
* Automatic validation of VAT numbers when ordering.
 +
* The ability to assign custom invoice number formats when generating invoices based on the month and year.
 +
* The ability to configure proforma or sequential paid invoice numbering.
 +
* The ability to configure automatic resetting of the sequential paid invoice numbers monthly or annually.
 +
* The ability to have invoice dates automatically updated when invoices are paid.
  
*The ability to automatically setup EU tax rules
+
== Requirements ==
*Automatic validation of VAT Number input at order time
 
*The ability to assign custom invoice number formats when invoices are generated based on Year/Month
 
*The ability to configure proforma/sequential paid invoice numbering
 
*The ability to configure automatic resetting of the sequential paid invoice numbers Monthly or Annually
 
*The ability to have invoice dates automatically updated when invoices are paid
 
  
''This addon has been included in WHMCS by default since version 5.1.''
+
This addon uses VIES, the Vat Number Validation service of the European Commission, which requires the '''PHP SOAP Extension'''.
  
==Requirements==
+
The PHP SOAP extension is required to communicate with this service. If you do not have the SOAP extension already compiled and available in your PHP binary, you will need to recompile PHP to add this extension. For more information, contact your hosting provider or system administrator.
  
*'''PHP SOAP Extension''' - The EU VAT Addon utilizes VIES, the Vat Number Validation service of the European Commission. The PHP SOAP extension is required to communicate with this service. If you do not have the SOAP extension already compiled and available in your PHP binary, you will need to recompile PHP to add this extension. Your System Administrator or Hosting Provider should be able to this on your behalf if you require assistance.
+
<div class="docs-alert-warning">
*'''Please Note:''' EUROPA, the service through which VAT numbers are validated, may not accept connections on IPv6
+
<span class="title">Note</span><br />
 +
EUROPA, the service through which VAT numbers are validated, may not accept connections on IPv6.
 +
</div>
  
Not sure if you have the SOAP Extension? Don't worry, the EU VAT addon will notify you if SOAP is unavailable in your environment (V5.3.0 and later).
+
== Setup Instructions ==
  
==Setup Instructions==
+
To set this addon up:
  
*Login to the Admin Area
+
* Log in to the Admin Area.
*Navigate to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Addon Modules''' or, prior to WHMCS 8.0, '''Setup > Addon Modules'''.
+
* Navigate to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Addon Modules''' or, prior to WHMCS 8.0, '''Setup > Addon Modules'''.
*Click the Activate button for the EU VAT Addon.
+
* Click '''Activate''' for the EU VAT Addon.
*Tick to enable access for your admin role group and then save.
+
* Enable access for your admin role group and then click '''Save'''.
*Go to '''Addons > EU VAT Addon''' to access and use the module.
+
* Go to '''Addons > EU VAT Addon''' to access and use the module.
  
'''Note:''' If you have used the VAT Number Validation Hook previously, you should delete that from the /includes/hooks/ folder
+
<div class="docs-alert-warning">
 +
<span class="title">Note</span><br />
 +
If you have used the VAT number validation hook previously, delete it from the <tt>/includes/hooks/</tt> folder.
 +
</div>
  
 
==Usage Notes==
 
==Usage Notes==
  
The automatic invoice numbering reset occurs when the automation cron runs on the last day of the month, so if you wish to use this feature we recommend that you configure the cron to run late at night on the last day of the month
+
The automatic invoice numbering reset occurs when the automation cron runs on the last day of the month. To use this feature, we recommend configuring the cron job to run late at night on the last day of the month.

Revision as of 16:58, 9 September 2021

Note
This page describes deprecated features in version 5.1 through 7.6. In version 7.7 and above, this functionality is in Configuration () > System Settings > Tax Configuration or, prior to WHMCS 8.0, Setup > Payments > Tax Configuration.

The EU VAT Addon allows you to configure a additional invoice and billing-related options for EU invoicing and VAT requirements.

This functionality includes:

  • The ability to automatically set up EU tax rules.
  • Automatic validation of VAT numbers when ordering.
  • The ability to assign custom invoice number formats when generating invoices based on the month and year.
  • The ability to configure proforma or sequential paid invoice numbering.
  • The ability to configure automatic resetting of the sequential paid invoice numbers monthly or annually.
  • The ability to have invoice dates automatically updated when invoices are paid.

Requirements

This addon uses VIES, the Vat Number Validation service of the European Commission, which requires the PHP SOAP Extension.

The PHP SOAP extension is required to communicate with this service. If you do not have the SOAP extension already compiled and available in your PHP binary, you will need to recompile PHP to add this extension. For more information, contact your hosting provider or system administrator.

Note
EUROPA, the service through which VAT numbers are validated, may not accept connections on IPv6.

Setup Instructions

To set this addon up:

  • Log in to the Admin Area.
  • Navigate to Configuration () > System Settings > Addon Modules or, prior to WHMCS 8.0, Setup > Addon Modules.
  • Click Activate for the EU VAT Addon.
  • Enable access for your admin role group and then click Save.
  • Go to Addons > EU VAT Addon to access and use the module.

Note
If you have used the VAT number validation hook previously, delete it from the /includes/hooks/ folder.

Usage Notes

The automatic invoice numbering reset occurs when the automation cron runs on the last day of the month. To use this feature, we recommend configuring the cron job to run late at night on the last day of the month.