Difference between revisions of "EU VAT Addon"

From WHMCS Documentation
 
(3 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
== About this Addon Module ==
 +
 
<div class="docs-alert-warning">
 
<div class="docs-alert-warning">
−
<span class="title">Note</span><br />
+
We deprecated this addon in WHMCS 7.6. In WHMCS 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'''.
−
This page describes features in version 7.6 and below. In version 7.7 and above this functionality is included in the core under [[Tax_Configuration|Setup > Tax Configuration]] as such the addon is discontinued
 
 
</div>
 
</div>
  
−
The EU VAT Addon allows you to configure a number of additional invoice/billing related options specific to EU invoicing & 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.
 +
 
 +
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.
  
−
Functionality includes...
+
<table class="table" style="text-align:center;margin:1em 1em 1em 0;background:#F9F9F9;border:1px #AAA solid;border-collapse:collapse;width:100%;">
 +
<tr>
 +
<th style="border:1px #AAA solid;padding:0.2em;background:#F2F2F2;text-align:center;">Addon Name</th>
 +
<th style="border:1px #AAA solid;padding:0.2em;background:#F2F2F2;text-align:center;">Latest Release</th>
 +
<th style="border:1px #AAA solid;padding:0.2em;background:#F2F2F2;text-align:center;">Current Version</th>
 +
<th style="border:1px #AAA solid;padding:0.2em;background:#F2F2F2;text-align:center;">Compatible With</th>
 +
<th style="border:1px #AAA solid;padding:0.2em;background:#F2F2F2;text-align:center;">Included in WHMCS</th>
 +
</tr>
 +
<tr>
 +
<td style="border:1px #AAA solid;padding:0.2em;">EU VAT Addon</td>
 +
<td style="border:1px #AAA solid;padding:0.2em;">N/A</td>
 +
<td style="border:1px #AAA solid;padding:0.2em;">N/A</td>
 +
<td style="border:1px #AAA solid;padding:0.2em;">WHMCS 5.1 through 7.6</td>
 +
<td style="border:1px #AAA solid;padding:0.2em;">N/A</td>
 +
</tr>
 +
</table>
  
−
*The ability to automatically setup EU tax rules
+
== Activating EU VAT Addon ==
−
*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.''
+
Because this addon ships with WHMCS by default, you only need to activate the addon through the Admin Area.
 +
 +
To do this:
 +
 +
# Make certain that you meet the requirements for the addon below.
 +
# Go 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 '''Activate''' for '''EU VAT Addon'''.
 +
# Click '''Configure'''.
 +
# Select the admin role groups who will have access to this addon.
 +
# Click '''Save Changes'''. 
 +
# If you have used the VAT number validation hook previously, delete it from the <tt>/includes/hooks/</tt> folder.
  
−
==Requirements==
+
=== Requirements ===
  
−
*'''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.
+
This addon uses VIES, the Vat Number Validation service of the European Commission, which requires the '''PHP SOAP Extension'''.
−
*'''Please Note:''' EUROPA, the service through which VAT numbers are validated, may not accept connections on IPv6
 
  
−
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).
+
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.
  
−
==Setup Instructions==
+
<div class="docs-alert-warning">
 +
<span class="title">Note</span><br />
 +
EUROPA, the service through which VAT numbers are validated, may not accept connections on IPv6.
 +
</div>
  
−
*Login to the Admin Area
+
== Automatic Invoice Numbering ==
−
*Navigate to '''Setup > Addon Modules'''
 
−
*Click the Activate button for the EU VAT Addon
 
−
*Tick to enable access for your admin role group and then save
 
−
*Finally navigate 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
+
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.
  
−
==Usage Notes==
+
== Troubleshooting ==
 +
 +
''N/A''
 +
 +
== Change Log ==
  
−
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
+
''N/A''

Latest revision as of 20:55, 16 March 2022

About this Addon Module

We deprecated this addon in WHMCS 7.6. In WHMCS 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.
Addon Name Latest Release Current Version Compatible With Included in WHMCS
EU VAT Addon N/A N/A WHMCS 5.1 through 7.6 N/A

Activating EU VAT Addon

Because this addon ships with WHMCS by default, you only need to activate the addon through the Admin Area.

To do this:

  1. Make certain that you meet the requirements for the addon below.
  2. Go to Configuration () > System Settings > Addon Modules or, prior to WHMCS 8.0, Setup > Addon Modules.
  3. Click Activate for EU VAT Addon.
  4. Click Configure.
  5. Select the admin role groups who will have access to this addon.
  6. Click Save Changes.
  7. If you have used the VAT number validation hook previously, delete it from the /includes/hooks/ folder.

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.

Automatic Invoice Numbering

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.

Troubleshooting

N/A

Change Log

N/A

Retrieved from "http://3.17.75.209/index.php?title=EU_VAT_Addon&oldid=31692"