Difference between revisions of "How To Guides"

From WHMCS Documentation

(Update Domain Pricing)
(Change Tax Rate)
 
(11 intermediate revisions by 3 users not shown)
Line 1: Line 1:
There are more tips, tricks and how-tos [http://forum.whmcs.com/forumdisplay.php?29-Tips-Tricks-amp-Howto-s in our forum].
+
There are more tips, tricks and how-tos [https://whmcs.community/forum/329-share-your-best-practices-tips/ in our community].
  
 
==Regenerate Historical Invoices==
 
==Regenerate Historical Invoices==
Line 10: Line 10:
 
[[File:change.png|thumb|Bulk Price Updater]]
 
[[File:change.png|thumb|Bulk Price Updater]]
  
Occasionally, it may be necessary to update the price of existing domain names or products in your system (for example, in line with wholesale price increases). There may also be times where it is desirable to increase the price of specific domain addons (for example, if you wish to start charging for ID Protection after previously offering it for free).  
+
Occasionally, you may need to update prices for products or domain addons in your system (for example, for wholesale price increases or to start charging for ID Protection after previously offering it for free).  
  
 
For more information, see [[Bulk Pricing Updater Addon]].
 
For more information, see [[Bulk Pricing Updater Addon]].
Line 16: Line 16:
 
==Change Tax Rate==
 
==Change Tax Rate==
  
Sometimes, governments change the sales tax rates. This is significant, since you must also update your rates accordingly.
+
Sales tax rates generally change over time. When this occurs, you must update the tax rates in WHMCS.
  
For more information, see [[Changing Tax Rates on Existing Invoices]].
+
For more information, see [https://help.whmcs.com/m/payments/l/1271960-changing-tax-rates Changing Tax Rates].
  
 
==Migrate Payment Gateways==
 
==Migrate Payment Gateways==
Sometimes, you may want to stop using one payment gateway and switch to another. This is a general guide to the process:
+
Sometimes, you may want to stop using one payment gateway and switch to another.  
  
#Enable the new payment gateway module under '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Payment Gateways''' or, prior to WHMCS 8.0, '''Setup > Payments > Payment Gateways'''. Configure it per our [[Payment_Gateways|documentation]].
+
For more information, see [[Migrating Payment Gateways]].
#Deactivate the old module by clicking '''Deactivate''' on the Payment Gateways page.
 
#The system will prompt you to choose the payment gateway you wish to reassign all existing services and invoices to. Select the new payment gateway. For more information, see [[Payment_Gateways#Deactivating_Gateway_Modules|Deactivating Gateway Modules]].
 
#Depending upon the type of payment gateway module you're switching to, there may be a third step:
 
##If you are switching between merchant gateways or third party gateway modules, there is no third step and you are finished.
 
##If you are switching to a merchant gateway for the first time, the client will need to log in and enter their card details to the "My Details" page in the client area. The system will charge the card when the next invoice is due.
 
##If you are switching between tokenisation modules, the client will need to log in and pay their first invoice manually, which will store their card details on your processor's servers. The system will attempt subsequent payments automatically. Regrettably, there isn't a way for the migration to be done without client's intervention because the system requires their CVV number for the first payment.
 
##If you are switching from a merchant gateway to a tokenization gateway, typically clients will need to manually pay their next invoice via the client area.  If you store card details or a token for the client, you may wish to delete them via the "Credit Card Information" link on each client's summary page beforehand. There are some exceptions, though, and some payment gateways have card number migration paths:<br/>- [[Stripe#Migrating_to_Stripe|Stripe]]
 
##If you are switching from a merchant or tokenization gateway to a third party gateway, clients will need to manually pay their next invoice via the client area. If you store card details or a token for the client, you may wish to delete them via the "Credit Card Information" link on each client's summary page beforehand.
 
  
 
==Advanced Billing Scenarios==
 
==Advanced Billing Scenarios==
 +
 +
For a tutorial on changing billing cycles for generated invoices and consolidating renewal dates, see the following video:
 +
 
<html><a href="https://www.youtube.com/watch?v=glZv8iZU0mU&hd=1" class="docs-video-tutorial"><em>Watch the video tutorial for this feature</em><span>&nbsp;<img src="https://assets.whmcs.com/icons/youtube.png">&nbsp;</span></a></html>
 
<html><a href="https://www.youtube.com/watch?v=glZv8iZU0mU&hd=1" class="docs-video-tutorial"><em>Watch the video tutorial for this feature</em><span>&nbsp;<img src="https://assets.whmcs.com/icons/youtube.png">&nbsp;</span></a></html>
 
The above video tutorial shows and explains how to handle two advanced billing scenarios:
 
#Change a billing cycle from annual to monthly, with the added complication that the system has already generated an annual renewal invoice.
 
#Consolidate the renewal date of several services onto the same day on a single invoice in the future, even if the client has already renewed some services this month.
 
  
 
==Switching Domain Registrars==
 
==Switching Domain Registrars==
  
Domain prices change frequently. If one finds a chosen registrar's price is no longer competitive, it may be desirable to transfer existing domains to a different registrar without the client's knowledge. WHMCS can make the process easier, saving the need to log in to both provider's control panels:
+
Domain prices change frequently. If a registrar's price is no longer competitive, you may want to transfer existing domains to a different registrar without the client's knowledge.  
  
# Navigate to '''Clients > Domain Registrations''' and select the domain in question.
+
For more information, see [[Transferring Domains to a New Registrar]].
# Uncheck the '''Registrar Lock''' checkbox and click Save Changes.
 
# Click the '''Modify Contact Details''' button.
 
# Change the registrant email address to your own and click Save Changes.
 
# Return to the client's Domains tab and click the '''Get EPP Code''' button.
 
# Note the onscreen EPP Code.
 
# Select the new domain registrar from the Registrar dropdown menu.
 
# Click the '''Transfer''' Module Command button.
 
 
 
You should see a confirmation message stating the transfer initiated  successfully. It is likely that the client's Domains tab will display an error message from the new registrar, but this will disappear once the transfer process is complete.
 
 
 
<div class="docs-alert-info">
 
<span class="title">Note</span><br />
 
Once the transfer process is complete, be sure to use the Modify Contact Details button to change the registrant email address back to the client's own address.
 
</div>
 
  
 
==Convert invoice amounts into a different currency==
 
==Convert invoice amounts into a different currency==
 
It is possible that not every gateway you use will accept all the currencies you offer on your site. Many gateway modules support a '''Convert To For Processing''' option so WHMCS can transparently convert the payment amount into a different currency before sending the client to the payment gateway.
 
It is possible that not every gateway you use will accept all the currencies you offer on your site. Many gateway modules support a '''Convert To For Processing''' option so WHMCS can transparently convert the payment amount into a different currency before sending the client to the payment gateway.
  
For example: Gateway A only operates in USD, but you have configured multi-currency in WHMCS, offering prices in USD, GBP and EUR. When a client places an order for 10GBP and chooses to pay via Gateway A, the system will automatically convert the amount to 15USD before the payment processes. The client is able to make payment via Gateway A where they otherwise would not be able to do so.
+
For more information, see [[Converting Invoices to a New Currency]].
 
 
To configure this feature:
 
# Navigate to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Payment Gateways > Manage Existing Gateways''' or, prior to WHMCS 8.0, '''Setup > Payments > Payment Gateways > Manage Existing Gateways'''.
 
# Under the payment gateway in question, locate the '''Convert to For Processing''' setting.
 
# From the menu, select your desired currency.
 
# Click '''Save Changes'''.
 
 
 
To continue the example from above, one would choose the USD currency from the Gateway A section.
 
The system will send all payments to this gateway in the chosen currency, regardless of which currency the client selected on the order form.
 
 
 
<div class="docs-alert-info">
 
<span class="title">Note</span><br />
 
The Convert to For Processing option will appear once you configure a second currency.
 
</div>
 
 
 
<div class="docs-alert-info">
 
<span class="title">Note</span><br />
 
The system performs the currency conversion using the '''Base Conversion Rate''' in your WHMCS installation at the time of payment.
 
</div>
 
  
 
==Credit a client for money received==
 
==Credit a client for money received==
When you receive money from a client, you should record it in WHMCS as a transaction. But if the payment is not for a specific invoice or the client has accidentally overpaid, the client's credit balance should be increased accordingly. Adding credits via the "Manage Credits" popup would not appear on the transaction record as they are not transactions.  
+
When you receive money from a client, you should record it in WHMCS as a transaction.  
  
To credit a client and create a transaction:
+
For more information, see [[Adding and Working With Credit]].
 
 
* Navigate to '''Billing > Transactions List > Add Transaction''' tab.
 
* Enter the details of the credit.
 
* Check the '''Credit''' checkbox.
 
* Click Add Transaction.
 
 
 
This will ensure your accounting records are accurate and the Account Statement report is balanced.
 
  
 
==Cancel and regenerate invoice==
 
==Cancel and regenerate invoice==
 
Sometimes, you may wish to cancel an unpaid invoice and later need to regenerate an invoice covering the same time period for the service.
 
Sometimes, you may wish to cancel an unpaid invoice and later need to regenerate an invoice covering the same time period for the service.
  
To cancel the original invoice:
+
For more information, see [[Canceling and Regenerating Invoices]].
 
 
* Navigate to Billing > Invoices.
 
* Click on the invoice in question.
 
* Click the "Marked Cancelled" button.
 
 
 
To regenerate the invoice for the same period:
 
 
 
* Navigate to Clients > Products/Services.
 
* Click on the service.
 
* Move the Next Due Date forward by one day. This will ensure the "next invoice date" value in the database resets to match the next due date when using [[Invoice_Tab#Continuous_Invoice_Generation|Continuous Invoicing]].
 
 
 
* Click Save Changes.
 
* Navigate to the Client Summary page.
 
* Click "Generate Due Invoices".
 
  
 
==Skip an invoice==
 
==Skip an invoice==
 
Occasionally you may wish to skip an invoice, giving the customer the invoiced period at no charge, but resume charging on the next due date.
 
Occasionally you may wish to skip an invoice, giving the customer the invoiced period at no charge, but resume charging on the next due date.
  
If an unpaid invoice already exists:
+
For more information, see [[Skipping Invoices]].
 
 
* Navigate to Billing > Invoices.
 
* Click the invoice in question.
 
* Click the "Mark Cancelled" button.
 
 
 
You can now set the Next Due Date for when charging should resume:
 
  
* Navigate to the service that you wish to extend at no charge.
+
==Migrating Clients to another cPanel Server==
* Set the the Next Due Date.
+
Occasionally, you may perform a [https://docs.cpanel.net/knowledge-base/transfers-and-restores/how-to-move-all-cpanel-accounts-from-one-server-to-another/ mass transfer of cPanel accounts] between servers. You must also update the records in WHMCS to reflect the new server.
* Click "Save Changes".
 
  
The system will create the next invoice on the new Next Due Date without charging for the period between the old next due date and the new next due date.
+
For more information, see [https://help.whmcs.com/m/provisioning/l/1464305-migrating-your-clients-to-another-cpanel-server-cpanel-to-cpanel Migrating your Clients to another cPanel Server (cPanel to cPanel)].

Latest revision as of 18:30, 28 November 2022

There are more tips, tricks and how-tos in our community.

Regenerate Historical Invoices

When switching from a manual billing system or software for which an import script is not available, you may want to have a record of past invoices that you issued before you started using WHMCS.

For more information, see Regenerating Historical Invoices.

Update Domain Pricing

Bulk Price Updater

Occasionally, you may need to update prices for products or domain addons in your system (for example, for wholesale price increases or to start charging for ID Protection after previously offering it for free).

For more information, see Bulk Pricing Updater Addon.

Change Tax Rate

Sales tax rates generally change over time. When this occurs, you must update the tax rates in WHMCS.

For more information, see Changing Tax Rates.

Migrate Payment Gateways

Sometimes, you may want to stop using one payment gateway and switch to another.

For more information, see Migrating Payment Gateways.

Advanced Billing Scenarios

For a tutorial on changing billing cycles for generated invoices and consolidating renewal dates, see the following video:

Watch the video tutorial for this feature  

Switching Domain Registrars

Domain prices change frequently. If a registrar's price is no longer competitive, you may want to transfer existing domains to a different registrar without the client's knowledge.

For more information, see Transferring Domains to a New Registrar.

Convert invoice amounts into a different currency

It is possible that not every gateway you use will accept all the currencies you offer on your site. Many gateway modules support a Convert To For Processing option so WHMCS can transparently convert the payment amount into a different currency before sending the client to the payment gateway.

For more information, see Converting Invoices to a New Currency.

Credit a client for money received

When you receive money from a client, you should record it in WHMCS as a transaction.

For more information, see Adding and Working With Credit.

Cancel and regenerate invoice

Sometimes, you may wish to cancel an unpaid invoice and later need to regenerate an invoice covering the same time period for the service.

For more information, see Canceling and Regenerating Invoices.

Skip an invoice

Occasionally you may wish to skip an invoice, giving the customer the invoiced period at no charge, but resume charging on the next due date.

For more information, see Skipping Invoices.

Migrating Clients to another cPanel Server

Occasionally, you may perform a mass transfer of cPanel accounts between servers. You must also update the records in WHMCS to reflect the new server.

For more information, see Migrating your Clients to another cPanel Server (cPanel to cPanel).