WHMCS Documentation - User contributions [en]

Custom Fields

2014-12-11T21:10:16Z

Samcraven: /* Regular Expression Validation */

Custom fields allow you to collect additional information from your clients. WHMCS allows you to setup an unlimited number of customer fields which apply to clients, individual products & services and/or support departments. They can be set as either public or admin only for private use.

Common examples are questions like how did you find out site, do you want to join the mailing list, VAT/Tax Number, etc...

==Supported Field Types==

*Text Box - for text entry
*Dropdown Menu - for a selection of options to choose from
*Tick Box - for a yes/no answer
*Textarea - for a long text entry of multiple lines

==Types of Custom Fields==

===Client Custom Fields===

You can create client profile related fields in '''Setup > Custom Client Fields'''. These can be set to '''Show on Order Form''' if you want the client to enter them or left as admin area only for private entries. The client can view and edit the field values from the client area unless they are set to admin only.

===Product Custom Fields===

Products you create can also have custom fields added to them which are then shown to the user during the order process. This allows you to collect further information specific to an individual product. These are set when configuring a product in '''Setup > Products/Services > Products/Services > Edit > Custom Fields tab '''. Some modules require specific fields are setup and will be explained in the documentation for that module.

===Support Custom Fields===

Custom fields for support are set per department and allow you to ask users for additional information when opening tickets. This is often used for things such as current usernames & passwords, etc... These are configured in '''Setup > Support > Support Departments > Edit > Custom Fields tab'''

==Displaying Custom Fields on Invoices==

There are times when you might want custom fields to appear on invoices. Just 2 examples of what you might find this useful for are:

*If you have a client custom field for a Tax ID or VAT Number
*If you have a product custom field containing a Username or Reference for the clients product

So how do you do it? Well it's really simple. Both the client & product field types support this, and to enable it all you need to do is tick the checkbox labelled '''Show on Invoice''' where you configure the custom fields (either in '''Setup > Client Custom Fields''' or the '''Custom Fields''' tab of the product config).

In the case of client custom fields, they will then be shown under the name & address information on the invoice, and in the case of product custom fields they show as part of the line item descriptions for those products.

==Displaying Custom Fields in Emails==
Custom fields can be displayed in email templates using merge fields. The relevant documentation can be found at [[Email_Templates#Merge_Fields]].

==Regular Expression Validation==

The regular expression validation rules allow you to define what value the field can take. The user won't be allowed to proceed until it passes the validation rule. Some common examples you might want:

A domain name in the format "google.com"
/^([a-zA-Z0-9_-])+(\.[a-zA-Z0-9_-]+)*\.([a-zA-Z]{2,6})$/

A username between 4 and 28 characters in length, alpha-numeric, and allowing underscores
/^[a-z\d_]{4,28}$/i

A telephone number in the following format: (###) ###-####
/^($?[0-9]{3,3}$?|[0-9]{3,3}[-. ]?)[ ][0-9]{3,3}[-. ]?[0-9]{4,4}$/

A date in the format DD/MM/YYYY
/^\d{1,2}\/\d{1,2}\/\d{4}$/

Order Management

2014-12-11T19:09:42Z

Samcraven: /* Managing Orders */

==About Orders==
Every time a user buys something from you, this creates an "order" record. The order holds all the details relating to a checkout process, including a unique reference number, any promo codes used, the affiliate who referred them & [[Order_Management#Reviewing_Fraud_Check_Results|fraud check results]] (if enabled) etc.

Orders are not created for renewals, as those don't involve a new checkout process - simply a recurring invoice for a previous order. Orders always remain pending until admin review, even though the items inside them will auto activate (if set to), allowing your staff to review and process all the new orders you receive and run any manual checks or actions you deem necessary for new purchases.

All orders are assigned two unique numbers, first the '''ID Number''' which is an internal reference used by the system, your first order will be ID 1, the second ID2... They are also assigned an '''Order Number''' (or Order #) this is the number your clients will be given at the end of the checkout process and is a randomly generated 10 digit number - this won't divulge the size of your company.

==Managing Orders==
[[File:Order details.png|thumb|Order Details Page]]
Orders can be managed from the '''Order''' tab, the dropdown menu provides the ability to quickly filter orders by status. More granular filtering and searching can be achieved via the '''Search/Filter''' tab on the Manage Orders page.*

*Click the Order ID to view the Order Details page, this page shows all the information pertaining to the order. The first section displays useful reference information:
**The date and time it was placed
**The details of the client who placed it
**The promotion code and discount used (if any)
**Payment method and total amount due,
**Invoice ID associated with this order, click to see the invoice in full
**IP address of the client
**The affiliate who referred the client plus a link to [[Affiliates#Assigning_an_Affiliate_to_an_Existing_Order|manually assign one]]
*The '''Order Items''' section lists each of the products, services and domains the client has ordered alongside the Status and Payment Status, providing at-a-glance reference to whether the account has yet to be created or payment received.
*If products are in pending status as in the screenshot then a number of text fields, dropdowns and checkboxes will be displayed. For more information on these refer to [[#Accepting Pending Orders|Accepting Pending Orders]] below.
*If a [[Fraud Protection]] module is enabled the '''Fraud Check Results''' will be displayed next - in the screenshot Maxmind is being used - for more information refer to [[#Reviewing Fraud Check Results|Reviewing Fraud Check Results]]
*If enabled in General Settings the '''Notes / Additional Information''' are displayed here if the client provided any when placing the order.
*Finally the '''Available Action''' buttons allow the status of the order to be changed:
**Accept Order - Refer to [[#Accepting Pending Orders|Accepting Pending Orders]] below.
**Cancel Order - Sets the order status to Cancelled, runs module termination for any active products in the order (removing accounts from the server and setting the product status to Cancelled) and also sets the invoice status to Cancelled.
**Cancel & Refund - As above but also refunds any invoice payment via the payment gateway (if supported by the module).
**Set as Fraud - Runs the module termination for any active products in the order, cancel the invoice and changes the order's status to Fraud.
**Set Back to Pending - Changes the status of products/services and the order to Pending status.
**Delete Order - Removes the order and everything relating to it - this option should only be used if you want to irrevocably remove the order from the system. This includes deleting the products/services within that order and the associated invoice.

===Bulk Management===
At the bottom of the Orders page are a number of bulk management options that can be used to change the status of multiple orders in one go. These tools only change the status of the order, they do not run any module commands to provision/terminate accounts, that can only be done via the Order Details page.

==Placing an Order==
You can place an order by going to '''Orders > Add New Order'''.

Note: An easier way than using the dropdown menu on the add order page to locate the client you want to add the order to is to locate the client first using the WHMCS intelligent search and then from the Actions menu on the Clients Summary page, just click the Add New Order link and the client will be preselected.

* Begin by selecting the client from the dropdown and choosing the payment gateway with which you want the client to pay.
* Select a promo code from the dropdown of activate promotions to apply a discount to the order. Any discount amount selected here will be applied to the order regardless of any requirements in the promotion configuration, when staff select a discount it is always applied.
* Next, choose the product/service and billing cycle. Here you can specify a quantity if you wish to add duplicates of the same product and specify a price override if you don’t wish to charge the standard product pricing.
* If the package comes with a domain, enter the users domain in the box provided. And if the domain is registered with you, you should select the "Register" option and choose any addons the user has for their domain.
* To add more products to the order click the “Add Another Product” link, this allows you to add a different product whereas the quantity option above would add exact duplicates.
* The Order Setting options allow control over whether the order confirmation email is sent to the client, whether an invoice is generated and if an invoice notification is emailed to the client.

==Accepting Pending Orders==
Whenever an order is placed in WHMCS, it comes in as a pending order. To view pending orders, go to Orders > List Pending Orders and click the Order ID. From there you can accept or deny the order.

Even if you have auto activation enabled, then while the products and services in that order may be automatically provisioned and delivered to the customer, the order status will remain pending until you manually confirm it. This is so that you can always see and review the new orders you've had and be able to manually review, check for fraud, problems, etc...

===Products===
If the order contains any products, you will see those listed in the order items and if the products are linked to a module, and the product/service has not yet been activated (for example by auto activation on payment) then you'll see the options to select a server to install it to, define a username & password, tickbox to create the account and tickbox to send the welcome email. Ticking the "Run Module Create" box will run the associated module creation command when you accept the order.

===Domains===
If the order contains any domains, and they haven't been activated by an automated action on receipt of payment, then you'll also have the option to choose a Domain Registrar and tickbox for "Send to Registrar" to define if you want it to be submitted via the API. You'll need to do this if you don't have automatic registration enabled or are wanting to register/transfer the domain without payment.

It is important to note that while all orders are pending until activated, the items in that order - hosting accounts and domains - will be automatically activated based on your auto setup options and auto registration options. So if you have them set for instantly upon payment that will be done while the order remains pending. This is to ensure you manually review each order you get.

==Reviewing Fraud Check Results==
If you use the MaxMind service, then you might want to check the results sent back from MaxMind regarding an order. You can do this from the order details page. You get to that by clicking the Order ID number for an order next to the order in the list of orders. You will then see an option labelled "Fraud Check Results" which will list what was received back from MaxMind regarding that order.

If you decide that the order was infact not fraudulent, and you want to therefore manually overide the fraud check, you can do that by clicking the '''Set Back to Pending''' button which will change the order status from Fraud to Pending and the invoice back to Unpaid. This then allows the user to go ahead and make payment from the client area as normal, or if a merchant gateway is in use, you can click through to the invoice and instantly attempt to capture the clients payment using the '''Attempt Capture''' button displayed on the invoice.

Note that if an order's fraud score is over your setting's threshold it will skip the 'Pending' status and be set to 'Fraud'.

==Custom Order Statuses==
As standard there are 4 order statuses which should cover most situations; Pending, Active, Fraud and Cancelled. Should more be required they can be created via the '''Setup > Other > Order Statuses''' Page. More information can be found on the [[Order Statuses]] page.

Invoicing

2014-06-18T20:22:04Z

Samcraven: spelling

==Automatic Invoice Generation==

WHMCS automatically generates invoices for products and services that are due in advance of the due date. Exactly how far in advance they generate you can configure yourself in Setup > Automation Settings but by default it is 14 days.

The cron performs the generation each day so it is important you have this configured for it to work.

==Invoice Reminders & Notices==

WHMCS will send one reminder after generation but before the due date if the invoice has not been paid and then up to 3 overdue notices once the due date has passed. These can be used to warn the user about an upcoming suspension or termination of service. You can configure exactly which days these notices go out on again in Config > Automation Settings.

==Creating Custom Invoices==

With WHMCS, you can generate an invoice whenever you want. This is very useful for many reasons, some examples are:

*Overusage Charges
*Web Design
*Other Services
*One Off Sales/Custom Pricing

The steps to do this are below...

#Locate the client you wish to generate an invoice for
#From the client summary page, click the Create Invoice link in the Actions panel
#You will now be presented with a new blank invoice
#To add items to the invoice, simply enter a description and amount in the empty boxes at the bottom of the list of Invoice Items
#Once you have added all the items to the invoice, select the "Options" tab at the top - from here you can configure the payment method, invoice date and due date - on completion, click Save
#Finally, to send the client an email letting them know about the new invoice, select "Invoice Created" from the dropdown menu located on the Summary tab (top right).

==Automatic Grouping of Items==

WHMCS will automatically group products & services, addons and domains due on the same date, with the same payment method and by the same person onto a single invoice. This means the customer only needs to make one transaction making it easier for them and reducing your transaction fees. It is also important the "Separate Invoices" option remains unticked under the client's Profile tab or Client Group.

Of course a client can also do this for themselves for invoices due on different dates using the Mass Pay feature from the client area.

==Creating Mass Pay Invoices==

When enabled under '''Setup > General Settings > [[Invoice_Tab#Enable_Mass_Payment|Invoices tab]]''' clients can pay several invoices in a single transaction, this is quicker and more convenient, plus it reduces your transaction costs. When enabled ''Pay Selected'' and ''Pay All'' options will be displayed on the client area homepage, they can be used to pay only certain invoices or pay all unpaid invoices respectively.

Staff can also create mass pay invoices under a client's Invoices tab by selecting the relevant invoices and clicking the ''Mass Pay'' button beneath.

A new invoice will be generated containing the invoice numbers of the original invoices (one invoice per line). The client should then pay this invoice and the credit will then be used to pay the original invoices.

The invoice will be displayed under the client's Invoices tab in the admin area, but will not be visible to clients. This ensures that a client doesn't see a massively inflated invoices balance, or a large invoice which consists of nothing more than a combination of other invoices. Additionally this prevents a client from creating a mass pay invoice, not paying it, and instead paying one of the original invoices, then going back and paying the mass pay invoice - effectively paying for the same thing twice.

==Creating Add Funds Invoices==

If enabled under '''Setup > General Settings > [[Credit Tab]]''' clients can deposit funds into their account, this will be stored in the form of account credit which can be used to pay for future purchases.

Staff can also create add funds invoices by clicking the ''Create Add Funds Invoice'' link under the client's Summary tab. This is particularly useful for charging a specific amount to a clients credit card.

==Splitting & Merging==

There may be occasions where you need to split certain line items that have been grouped into a single invoice out into an invoice of their own, for example if the client doesn't want to renew all the items that a particular invoice contains. To do this, simply follow the steps below:

#Begin by locating the invoice containing the line items you want to split
#Next, select one or more of the checkboxes on the line items you want to split out into a separate invoice
#Now in the dropdown immediately below the invoice items, choose the option '''Split to New Invoice''' and the page will reload on the new invoice containing those items
#You can then finish by clicking the '''Send Invoice Created''' button to notify the client should you wish

Similarly, you may find there are times you want to combine items which have invoiced separately into a single invoice and again WHMCS makes this possible. To merge invoices, follow the steps below:

#Merging can only be done from the clients invoice list within the client profile section so begin by searching for and loading the client summary page of the client you want to work with
#Once there, you need to select the '''Invoices''' tab
#Next, tick the checkboxes next to the invoices you want to combine
#And finally to complete the process, click the '''Merge''' button located at the bottom of the list

[[File:Videotutorial.png‎|center|link=http://www.youtube.com/watch?v=0RYjgy5wjMI|Watch Video Tutorial]]

==Credit Card Processing Settings==

If you use a credit card merchant gateway with WHMCS, you can configure the way in which charges are handled automatically in '''Setup > Automation Settings'''. You have 3 different options which are explained below:

===Attempt Charges Daily===
This is the default setting and means WHMCS attempts to capture payments for all unpaid invoices that are due each day

===Attempt Only Once===
Ticking the box for this will mean that WHMCS only attempts to capture payment for an invoice once and if it fails, will send an email to the client notifying them and not attempt it again until the client logs in and enters new credit card details

===Retry Every Week Week For===
With this setting, you can specify for WHMCS to attempt to capture the payment for due invoices on the due date and then once every week after that until it succeeds or until the limit you specify for retries is reached.

==Continuous Invoice Generation==

Continuous Invoice Generation refers to whether invoices are created for items that are unpaid. It is best explained through the use of an example.

Take for example a hosting account paid monthly. The user places their order in January. They receive an invoice and they pay their invoice. In the following month, the user gets their next invoice and they pay that. Then in March, the user receives their invoice but they don't pay it because they no longer wish to use the account or simply because they miss the emails about it. With continuous invoice generation disabled, the user would not receive any further invoices until the March invoice has been paid. However, with continuous invoicing enabled, the user would receive invoices every month until the account is set to terminated, regardless of whether the item has been paid for or not.

With Continuous Invoice Generation enabled, any product that is Pending, Active, or Suspended will continue to invoice regardless of the status of its previous invoice(s).

===Enabling Continous Invoicing===

To enable this feature, go to '''Setup > General Settings > Invoicing''' and tick the checkbox next to this setting. After enabling this option, if there are then users who are due invoices for months which have not yet been invoiced, there will be one invoice generated on each cron run for the user for the following days after enabling this.

==Proforma Invoicing/Sequential Invoice Numbering==

This feature is primarily aimed at EU based companies where for accounting reasons, it is sometimes necessary to ensure paid invoice numbers are sequential. This feature in WHMCS can of course be used by all though.

===Enabling Sequential Invoice Numbering===

#To enable this feature, begin by going to '''Setup > General Settings'''
#Then click on the Invoices tab
#Next, tick the box labelled "Sequential Paid Invoice Numbering"
#In the field below, you can then specify the format you want to use for the numbering - it doesn't just have to be a number - you could for example include your companies initials and the year to differentiate invoices for each year - eg. WHMCS2007-{NUMBER} - {NUMBER} placeholder gets replaced with that invoices number
#The final field allows you to set the next number to be assigned to an invoice. Each time an invoice is paid, the number increases by 1. You can alter the number here, such as when removing an invoice or at the beginning of a new year if you want to start at 1 again.

That's all there is to it! Sequential invoice numbering is now enabled and each time an invoice is paid, the next number in the sequence will be applied.

===Proforma Invoicing===

The sequential numbering is most often used in conjunction with proforma invoicing. If you want to do this, then you need to make a few template changes aswell to reflect the different names - Proforma invoice when unpaid and Invoice once paid. Instructions can be found in the viewinvoice.tpl and invoicepdf.tpl files where the changes need to be made - just need to uncomment the commented out code you will find in those files.

[[File:Videotutorial.png‎|center|link=https://www.youtube.com/watch?v=S8d5b4xs8lQ&hd=1|Watch Video Tutorial]]

==Refunding Payments==

If you are using a gateway in WHMCS that has automated refunds implemented (which includes PayPal, Authorize.net, Quantum Gateway, 2Checkout etc...), then WHMCS allows you to issue a refund without ever logging into your gateway. A real time saver!

Even if the refund can't be automated, you can still use this process to enter the refund billing entry into WHMCS which will update the income totals and reflect the refund on the invoice. Then you would go to your gateway and actually send the refund from there.

And as a final alternative you can issue a refund to the clients credit balance with you which instead of losing the money entirely allows you to just give the user a credit against future purchases or renewals from you.

So to perform a refund, simply follow these steps below:

#Locate the invoice you wish to issue a refund for either by searching or from '''Billing > List Paid Invoices''' and click the invoice ID to view it
#Select the '''Refund''' tab
#Choose the transaction you want to refund if more than one has been applied towards the invoice
#Enter the amount you want to refund if only giving a '''partial refund''' or leave blank for '''full'''
#Then select the '''Refund Type''' from the options "Refund through Gateway", "Add to Client's Credit Balance" or "Record Only"
#Tick the '''Send Email''' checkbox if you wish to send a refund confirmation email to the client, it contains useful information on the refund including the amount and refund type.
#Click the '''Refund''' button to submit

===Notes===
If "Refund through Gateway" is chosen, the results of the refund will then be displayed. If successful the relevant transaction entry will also be added. If it fails, you can check in '''Transactions > Gateway Log''' for the detailed response from that gateway as to why.

If refunding a payment that has been added to a clients credit then you must first check that the credit hasn't been used and manually remove the credit. This is because the system does not known that the amount you refunded was (a) linked to a credit and (b) not yet used as a credit.

==Setting the Starting Number==

WHMCS allows you to set the next invoice number that is generated. This is useful for if you want to start invoicing at a number other than 1 or start invoices for a new year from a new number. You do this as follows:

*Go to '''Setup > General Settings > Invoices tab'''
*Enter the next number to assing in the "Invoice Starting #" field
*Click Save

The value will then disappear from the field but the next invoice will be assigned that number.

==Group Similar Line Items==
By enabling this option in '''Setup > General Settings > Invoices tab''' any identical line items will automatically be combined into one summarised quantity format. For example:

Monthly Lease $15.95
Monthly Lease $15.95
Monthly Lease $15.95

becomes

3 x Monthly Lease @ $15.95 $47.85

This format is only used in the client (printable) invoice, the admin area invoice will still display each item on an individual line.

==Common Problems==
There may be occasions where invoices are not generated as expected by the system. The problem is usually a misconfiguration or human error, please refer to the [[Invoicing Issues|Invoicing Issues page]] for an explanation of the symptoms, causes and fixes.

Invoicing

2014-06-18T20:20:49Z

Samcraven: Fog4149

==Automatic Invoice Generation==

WHMCS automatically generates invoices for products and services that are due in advance of the due date. Exactly how far in advance they generate you can configure yourself in Setup > Automation Settings but by default it is 14 days.

The cron performs the generation each day so it is important you have this configured for it to work.

==Invoice Reminders & Notices==

WHMCS will send one reminder after generation but before the due date if the invoice has not been paid and then up to 3 overdue notices once the due date has passed. These can be used to warn the user about an upcoming suspension or termination of service. You can configure exactly which days these notices go out on again in Config > Automation Settings.

==Creating Custom Invoices==

With WHMCS, you can generate an invoice whenever you want. This is very useful for many reasons, some examples are:

*Overusage Charges
*Web Design
*Other Services
*One Off Sales/Custom Pricing

The steps to do this are below...

#Locate the client you wish to generate an invoice for
#From the client summary page, click the Create Invoice link in the Actions panel
#You will now be presented with a new blank invoice
#To add items to the invoice, simply enter a description and amount in the empty boxes at the bottom of the list of Invoice Items
#Once you have added all the items to the invoice, select the "Options" tab at the top - from here you can configure the payment method, invoice date and due date - on completion, click Save
#Finally, to send the client an email letting them know about the new invoice, select "Invoice Created" from the dropdown menu located on the Summary tab (top right).

==Automatic Grouping of Items==

WHMCS will automatically group products & services, addons and domains due on the same date, with the same payment method and by the same person onto a single invoice. This means the customer only needs to make one transaction making it easier for them and reducing your transaction fees. It is also important the "Separate Invoices" option remains unticked under the client's Profile tab or Client Group.

Of course a client can also do this for themselves for invoices due on different dates using the Mass Pay feature from the client area.

==Creating Mass Pay Invoices==

When enabled under '''Setup > General Settings > [[Invoice_Tab#Enable_Mass_Payment|Invoices tab]]''' clients can pay several invoices in a single transaction, this is quicker and more convenient, plus it reduces your transaction costs. When enabled ''Pay Selected'' and ''Pay All'' options will be displayed on the client area homepage, they can be used to pay only certain invoices or pay all unpaid invoices respectively.

Staff can also create mass pay invoices under a client's Invoices tab by selecting the relevant invoices and clicking the ''Mass Pay'' button beneath.

A new invoice will be generated containing the invoice numbers of the original invoices (one invoice per line). The client should then pay this invoice and the credit will then be used to pay the original invoices.

The invoice will be displayed under the client's Invoices tab in the admin area, but will not be visible to clients. This ensures that a client doesn't see a massively inflated invoices balance, or a large invoice which consists of nothing more than a combination of other invoices. Additionally this prevents a client from creating a mass pay invoice, not paying it, and instead paying one of the original invoices, then going back and paying the mass pay invoice - effectively paying for the same thing twice.

==Creating Add Funds Invoices==

If enabled under '''Setup > General Settings > [[Credit Tab]]''' clients can deposit funds into their account, this will be stored in the form of account credit which can be used to pay for future purchases.

Staff can also create add funds invoices by clicking the ''Create Add Funds Invoice'' link under the client's Summary tab. This is particularly useful for charging a specific amount to a clients credit card.

==Splitting & Merging==

There may be occasions where you need to split certain line items that have been grouped into a single invoice out into an invoice of their own, for example if the client doesn't want to renew all the items that a particular invoice contains. To do this, simply follow the steps below:

#Begin by locating the invoice containing the line items you want to split
#Next, select one or more of the checkboxes on the line items you want to split out into a separate invoice
#Now in the dropdown immediately below the invoice items, choose the option '''Split to New Invoice''' and the page will reload on the new invoice containing those items
#You can then finish by clicking the '''Send Invoice Created''' button to notify the client should you wish

Similarly, you may find there are times you want to combine items which have invoiced separately into a single invoice and again WHMCS makes this possible. To merge invoices, follow the steps below:

#Merging can only be done from the clients invoice list within the client profile section so begin by searching for and loading the client summary page of the client you want to work with
#Once there, you need to select the '''Invoices''' tab
#Next, tick the checkboxes next to the invoices you want to combine
#And finally to complete the process, click the '''Merge''' button located at the bottom of the list

[[File:Videotutorial.png‎|center|link=http://www.youtube.com/watch?v=0RYjgy5wjMI|Watch Video Tutorial]]

==Credit Card Processing Settings==

If you use a credit card merchant gateway with WHMCS, you can configure the way in which charges are handled automatically in '''Setup > Automation Settings'''. You have 3 different options which are explained below:

===Attempt Charges Daily===
This is the default setting and means WHMCS attempts to capture payments for all unpaid invoices that are due each day

===Attempt Only Once===
Ticking the box for this will mean that WHMCS only attempts to capture payment for an invoice once and if it fails, will send an email to the client notifying them and not attempt it again until the client logs in and enters new credit card details

===Retry Every Week Week For===
With this setting, you can specify for WHMCS to attempt to capture the payment for due invoices on the due date and then once every week after that until it succeeds or until the limit you specify for retries is reached.

==Continuous Invoice Generation==

Continuous Invoice Generation refers to whether invoices are created for items that are unpaid. It is best explained through the use of an example.

Take for example a hosting account paid monthly. The user places their order in January. They receive an invoice and they pay their invoice. In the following month, the user gets their next invoice and they pay that. Then in March, the user receives their invoice but they don't pay it because they no longer wish to use the account or simply because they miss the emails about it. With continuous invoice generation disabled, the user would not receive any furthur invoices until the March invoice has been paid. However, with continuous invoicing enabled, the user would receive invoices every month until the account is set to terminated, regardless of whether the item has been paid for or not.

With Continuous Invoice Generation enabled, any product that is Pending, Active, or Suspended will continue to invoice regardless of the status of its previous invoice(s).

===Enabling Continous Invoicing===

To enable this feature, go to '''Setup > General Settings > Invoicing''' and tick the checkbox next to this setting. After enabling this option, if there are then users who are due invoices for months which have not yet been invoiced, there will be one invoice generated on each cron run for the user for the following days after enabling this.

==Proforma Invoicing/Sequential Invoice Numbering==

This feature is primarily aimed at EU based companies where for accounting reasons, it is sometimes necessary to ensure paid invoice numbers are sequential. This feature in WHMCS can of course be used by all though.

===Enabling Sequential Invoice Numbering===

#To enable this feature, begin by going to '''Setup > General Settings'''
#Then click on the Invoices tab
#Next, tick the box labelled "Sequential Paid Invoice Numbering"
#In the field below, you can then specify the format you want to use for the numbering - it doesn't just have to be a number - you could for example include your companies initials and the year to differentiate invoices for each year - eg. WHMCS2007-{NUMBER} - {NUMBER} placeholder gets replaced with that invoices number
#The final field allows you to set the next number to be assigned to an invoice. Each time an invoice is paid, the number increases by 1. You can alter the number here, such as when removing an invoice or at the beginning of a new year if you want to start at 1 again.

That's all there is to it! Sequential invoice numbering is now enabled and each time an invoice is paid, the next number in the sequence will be applied.

===Proforma Invoicing===

The sequential numbering is most often used in conjunction with proforma invoicing. If you want to do this, then you need to make a few template changes aswell to reflect the different names - Proforma invoice when unpaid and Invoice once paid. Instructions can be found in the viewinvoice.tpl and invoicepdf.tpl files where the changes need to be made - just need to uncomment the commented out code you will find in those files.

[[File:Videotutorial.png‎|center|link=https://www.youtube.com/watch?v=S8d5b4xs8lQ&hd=1|Watch Video Tutorial]]

==Refunding Payments==

If you are using a gateway in WHMCS that has automated refunds implemented (which includes PayPal, Authorize.net, Quantum Gateway, 2Checkout etc...), then WHMCS allows you to issue a refund without ever logging into your gateway. A real time saver!

Even if the refund can't be automated, you can still use this process to enter the refund billing entry into WHMCS which will update the income totals and reflect the refund on the invoice. Then you would go to your gateway and actually send the refund from there.

And as a final alternative you can issue a refund to the clients credit balance with you which instead of losing the money entirely allows you to just give the user a credit against future purchases or renewals from you.

So to perform a refund, simply follow these steps below:

#Locate the invoice you wish to issue a refund for either by searching or from '''Billing > List Paid Invoices''' and click the invoice ID to view it
#Select the '''Refund''' tab
#Choose the transaction you want to refund if more than one has been applied towards the invoice
#Enter the amount you want to refund if only giving a '''partial refund''' or leave blank for '''full'''
#Then select the '''Refund Type''' from the options "Refund through Gateway", "Add to Client's Credit Balance" or "Record Only"
#Tick the '''Send Email''' checkbox if you wish to send a refund confirmation email to the client, it contains useful information on the refund including the amount and refund type.
#Click the '''Refund''' button to submit

===Notes===
If "Refund through Gateway" is chosen, the results of the refund will then be displayed. If successful the relevant transaction entry will also be added. If it fails, you can check in '''Transactions > Gateway Log''' for the detailed response from that gateway as to why.

If refunding a payment that has been added to a clients credit then you must first check that the credit hasn't been used and manually remove the credit. This is because the system does not known that the amount you refunded was (a) linked to a credit and (b) not yet used as a credit.

==Setting the Starting Number==

WHMCS allows you to set the next invoice number that is generated. This is useful for if you want to start invoicing at a number other than 1 or start invoices for a new year from a new number. You do this as follows:

*Go to '''Setup > General Settings > Invoices tab'''
*Enter the next number to assing in the "Invoice Starting #" field
*Click Save

The value will then disappear from the field but the next invoice will be assigned that number.

==Group Similar Line Items==
By enabling this option in '''Setup > General Settings > Invoices tab''' any identical line items will automatically be combined into one summarised quantity format. For example:

Monthly Lease $15.95
Monthly Lease $15.95
Monthly Lease $15.95

becomes

3 x Monthly Lease @ $15.95 $47.85

This format is only used in the client (printable) invoice, the admin area invoice will still display each item on an individual line.

==Common Problems==
There may be occasions where invoices are not generated as expected by the system. The problem is usually a misconfiguration or human error, please refer to the [[Invoicing Issues|Invoicing Issues page]] for an explanation of the symptoms, causes and fixes.

PayPal

2014-06-18T20:18:29Z

Samcraven: Fog4557

{{gateways
| onetime = yes
| recurring = yes
| refunds = yes
}}

[http://paypal.com PayPal] is one of the most popular and widely recognised online payment processors.

==Setup==
[[File:Videotutorial.png‎|center|link=http://www.youtube.com/watch?v=ilkzwr5Klp8&hd=1|Watch Video Tutorial]]

Begin by activating the payment gateway under '''Setup > Payments > Payment Gateways''' and choose PayPal from the Available Gateways dropdown.

Once activated, you can then enter the configuration details explained below. By default clients can chose between one-time and subscriptions payments and enter their own billing details on the PayPal site, the following options allow this behaviour to be changed.

===PayPal Email===
Enter the email address associated with your PayPal account, this is the only required field and all others are optional.
If you have more than one email address associated with your PayPal account, you may add as many of those as you like, comma-delimited. You must next configure [[#Instant_Payment_Notification_.28IPN.29|Instant Payment Notifications]].

===Force One Time Payments===
When ticked clients will only be able to make one-time payments (subscriptions disabled). For recurring services they will be required to login and pay each invoice.

===Force Subscriptions===
When enabled clients will only be able to make subscription payments when applicable (one-time payments disabled). This means future payments will be sent automatically without the need for manual intervention. There are some [[#PayPal_Subscriptions.2FRecurring_Billing|caveats explained below]].

===Require Shipping Address===
Ticking this option will require clients to provide a shipping address on the PayPal website and will be associated with their payment at PayPal, useful when selling physical products and for PayPal's Seller Protection.

===Client Address Matching===
The details the client provides in WHMCS upon ordering (name, address, phone number etc) will be used associated with their payment at PayPal, they will not be given the opportunity to provide different details on the PayPal website. Clients can update their profile via the WHMCS client area, your staff can use the Profile tab.

===API Fields===
Used for issuing refunds within WHMCS (saving the need to login at PayPal). For more information refer to [[#Automated_Refunds|Automated Refunds]]

==Instant Payment Notification (IPN)==

[[File:paypalipn2.png|thumb|PayPal IPN Setup]]

For PayPal invoices to be automatically marked paid when you receive a payment you need to enable IPN inside your PayPal account. This is done in the '''My Account > Profile > My Selling Preferences > Instant payment notifications'''. It's not important what URL you use so set it to your system url eg. http://www.yourdomain.com/whmcspath/
Then select the "Enabled" option.

===Charset Configuration===

[[File:paypalcharset.png|thumb|PayPal Charset Configuration]]

PayPal defaults the charset used for most accounts to windows-1252. Whilst this is acceptable and will not cause an issue for most users, on occasion, accented characters can be returned incorrectly through the IPN causing the IPN Handshake Invalid message. Setting the charset in your PayPal account to match your WHMCS installation is a recommended setting to ensure this issue does not occur.

This is done in '''My Account > Profile > My Selling Preferences > PayPal button language encoding '''(at the very bottom of the page). Once here, click on '''More Options''' and choose your charset from the dropdown and ensure the radio option is set to '''Yes'''. Click on Save and your configuration is completed.

==PayPal Subscriptions/Recurring Billing==

Unless disabled in the PayPal gateway config, when a user views an invoice for a recurring product or service they will be shown a PayPal Subscribe button. This allows the user to subscribe so that their payment for that product or service is sent to you automatically each month/quarter/etc... and automatically applied to the appropriate renewal invoices by WHMCS.

There are three conditions that must be met for the PayPal subscribe button to appear:

# The invoice's Due Date must be in the future
# The invoice must contain at least 1 recurring product (ie. domains, billable items or addons on their own won't create subscriptions)
# The 'Force One Time Payments' option is UNticked on the payment gateway configuration page.

If an invoice contains both a product, and addons or domains, then any which '''match the products''' billing cycle will '''also be included''' as part of the subscription. For example, if an invoice contained a product, an addon & a domain, all of which recur on an annual basis, then the PayPal subscription that gets created by WHMCS would be for the total amount of all 3 items so that the '''subscription would cover everything''' and pay the renewal invoice in full automatically. What isn't possible however is to create a subscription that has different amounts recurring on different recurring terms, ie. $x Monthly + $Y Annually. PayPal doesn't offer an option for that at the current time.

===Customising Invoice Emails for Subscriptions===

When a subscription is created, the Subscription ID number that gets issued by PayPal is stored by WHMCS in the Subscription ID field for the product. Similarly when a subscription is cancelled the Subscription ID gets removed again. Therefore it is possible to use that ID value to determine if a subscription exists and therefore customise the text shown to the customer in the invoice related emails based on that.

For example, one might customise the "Invoice Created" email template to show different instructions to the customer if a subscription exists (meaning no manual action is required), compared with if one doesn't (meaning the client needs to login and pay the invoice manually), for example:

{if $invoice_subscription_id}
As you have a PayPal Subscription setup, payment will be taken automatically within the
next few days. Please ensure you have enough funds in your PayPal account to cover it.
{else}
You can login to your client area to view and pay the invoice at {$invoice_link}
{/if}

==Automated Refunds==

As of version 4, you can issue refunds for PayPal payments directly from within WHMCS. Before you can do this however, you need to setup PayPal API access. The steps for doing this are as follows:

[[File:Pp_api1.png‎|thumb|PayPal Refunds Step 1]]
*Login to PayPal
*Go to Profile > My Selling Tools > API Access
*Choose '''Option 2''' - Request API credentials to create your own API username and password.
*Choose '''Option 1''' - Request API Signature and click Agree and Submit
[[File:Pp_api2.png‎|thumb|PayPal Refunds Step 2]]
*Copy the username, password and signature that get provided and then click Done
*Enter the details from the previous step into the WHMCS Payment Gateways config screen where requested

You will now be able to enter a refund and have it sent from PayPal at the same time from within the WHMCS admin area invoice management screen.

==Error Messages==
===Invalid Receiver Email===
WHMCS validates the payment receiver email value against the details specified under Setup > Payments > Payment Gateways so this error means the two do not match. If multiple PayPal accounts are used to receive payment, or a single PayPal account has multiple email addresses associated with it ,they must all be listed in a comma separated list eg. email1@mycompany.com,email2@mycompany.com.

The first email you specify will then be the email used for new payments, but any email in the field will be accepted as an invoice payment.

===Not Supported===
This Result will appear when an action occurs that does not require any action on WHMCS' behalf, for example a txn_type value of "subscr_failed" mean a subscription payment failed or "subscr_eot" means End of Subscription Term. You will see these entries under normal operation and is not a problem.

===Unrecognised Currency===
This error in the Gateway Log means an invalid currency code has been entered under Setup > Payments > Currencies. A currency code must use the ISO 4217 standard as explained on the [[Currencies]] page. For example EURO is not valid, but EUR is valid.

This could also be caused by a blank space at the beginning or end of the currency code, so edit the code to ensure there are none.

===IPN Handshake Invalid===
Getting this message in your Gateway Log would mean that WHMCS is unable to verify that the callback occurring has come from PayPal.
This is to stop any false payments being applied to your account, however, on occasion, some valid payments can generate this error.
Follow the instructions above for setting the [[#Charset_Configuration|Charset]] of your IPN to stop this.

{{modules}}

VentraIP Wholesale

2014-06-17T23:15:16Z

Samcraven: Fog4622

{{registrar
| register = yes
| transfer = yes
| renew = yes
| lock = yes
| dns = yes
| whois = yes
| getepp = yes
| regns = yes
| dnsmanagement = yes
| emailforwarding = yes
| domainsync = yes
}}

==Configuration==
Before beginning we suggest you check the API Information section of the Wholesale System to ensure you have the latest version of the WHMCS module installed. You will also require the Reseller ID & API Key from the API Information section (in the Wholesale System) to configure the module in WHMCS correctly.

===Installation===
WHMCS includes a copy of the VentraIP Wholesale domain name module by default. When updates are released for our WHMCS module, they are provided to WHMCS to include in the next release. Sometimes there can be a short delay between the updated module being available in WHMCS and in general release to our Wholesale System clients. We suggest checking the Wholesale System > API Information to ensure that the latest version is running in your WHMCS installation. If you’re not running the latest version, please download the ZIP archive via the Wholesale System, and follow the installation instructions enclosed in the ZIP archive to update your WHMCS module.

===Wholesale System Configuration Options===
Before configuring the module inside of WHMCS, you will need to add your server’s IP address to the ‘Allowed IP Addresses’ section in the Wholesale System via Your Account > API Information. For information on the IP address that your WHMCS installation will use to connect to the Wholesale System, please contact your web-hosting provider. Or alternatively, the IP address that your WHMCS installation is using to connect to the Wholesale System is shown under the Configure options of the WHMCS module:

[[File:Vent_2.png]]

'''Note:''' For security reasons, there is a 5 to 10 minute delay before the allowed IP address is updated in the Wholesale System - so please be patient if you cannot connect initially.

[[File:Vent_1.png]]

===Configuration through WHMCS===
After you have verified you are running the latest version of the WHMCS module, and applied the configuration changes required in the Wholesale System, you will need to configure and enable the module through WHMCS.

Begin by going to WHMCS '''Setup > Product/Services > Domain Registrars'''. Scroll down the page until you find ‘Ventraip’, click Activate and then Configure to modify the settings in the module.

You will need to insert your '''Reseller ID''' and '''API Key''', which can be found in the Wholesale System '''Your Account > API Information'''. You will also be presented with an option that will allow you to control how AU domain name transfers & renewals are handled. More information on this function is included below.

===Renewal on Transfer (.AU)===
When configuring the module via WHMCS, you will be presented with an option to control how AU domain name transfers & renewals are handled.

If you leave the ‘Renewal of Transfer (.AU)’ box unticked, when a .AU domain name is submitted for transfer it will not be renewed irrespective of the expiration date of the domain. If the box is checked (and the option enabled), when a .AU domain is submitted for transfer that is within 90 days of expiration, it will be submitted as a transfer + renewal (and the amount will be deducted from your Wholesale System balance).

[[File:Vent_3.png]]

'''Note:''' This will not charge your customers through WHMCS for the renewal - it will simply submit the domain for a transfer + renewal. You will be able to view your Transaction history through the Wholesale System > Finance > Transactions to see any domain transfer + renewals, which you can retrospectively bill your clients for.

===DNS Management & Email Forwarding===
Before your clients will be able to use the DNS Management or Email Forwarding services through the WHMCS Client Area, you’ll need to enable the option (on a per domain basis) via Wholesale System > Manage (or search for the domain) > Name Servers > Click Email/URL Forwarding or DNS Hosting (depending on what you require).

This will change the name servers on the domain to use the VentraIP Wholesale Email/URL Forwarding & DNS Hosting cluster, but you will be able to manage the records via the WHMCS Client Area upon making those changes. If you have not successfully made the required changes, you will be presented with an error message upon accessing those sections in the WHMCS Client Area.

==Common Problems==
===SoapFault exception: [HTTP] Forbidden in /../modules/registrars/ventraip/ventraip.php:957===
*Port 957 is being blocked by user's firewall, preventing connections to Ventraip API, server admin/hosting provider must open it.
*Server IP address has not been added to 'Allowed IP Addresses' list in the Wholesale System control panel under Your Account > API Information.

===Unable to retrieve domain id===
Domain does not exist in the Wholesale System. It could be that a transfer is in process, the error will disappear once the transfer is completed.

===Unable to update name servers on domain name===
The new nameservers being submitted are being rejected by the System. Most likely they are invalid and not registered. Please confirm you have entered valid nameservers and try again.

Importing Data

2014-06-03T21:31:23Z

Samcraven: Case4609

We understand that the majority of companies already have a billing system in place to manage their hosting clients and are worried by the difficulties of switching to a new billing system. With that in mind, we provide the following guides and automation scripts in order to make importing easy.

==Automated Import Scripts==
The following are automated import scripts from competing applications so if you are already running one of these switching is easy.
*Modernbill V4.4.x & V5
*ClientExec V3 & V4
*WHMAutoPilot V3.x
*AWBS V2.5 or later
*Lpanel V1.7 or later
*WhoisCart V2.2.x
*AccountLab Plus V2.8.x
*Kayako V3
You can download these from the [http://www.whmcs.com/members/downloads.php?action=displaycat&catid=2 Import Scripts] section of our client area.

==Manual Client Entry==

To manually import your clients and their hosting accounts, you should use the following steps.

#Go to Clients > Add New Client
#Fill out the clients details - the minimum required fields are First & Last Name, Email Address & Password
#Click Add Client

Once the client has been added, you can proceed to add their hosting accounts. You do this as follows:

#On the client summary page, click the "Add New Order" link in the Actions panel
#The client will be preselected, so you should fill out the rest of the form - begin by choosing the payment gateway you want the client to pay with
#Next, choose the product/service and billing cycle the client pays by
#If the package comes with a domain, enter the users domain in the box provided. And if the domain is registered with you, you should select the "Register" option and choose any addons the user has for their domain.
#Ensure both tick boxes for sending an order confirmation and generating an invoice are unchecked so the user is not emailed about the order you are adding
#Finally, set the Order Status dropdown to Active and then click the submit button to add the order to WHMCS
#You will now be shown the order screen summarising the details of the order you just added
#Now as the final step, you must go into the products and/or domains page and set the correct next due date. To do this, from the order screen, click on the link in the Item column of the items ordered - this will take you straight to the details screen. From there, you can edit the next due payment date (and for hosting accounts select the correct server and enter the username for the account to allow suspensions & terminations to be performed by WHMCS)

==Manual Domain Only Entry==
To add a domain on it's own without a product, follow the steps below:

#On the client summary page, click the "Add New Order" link in the Actions panel
#The client will be preselected, so you should fill out the rest of the form - begin by choosing the payment gateway you want the client to pay with
#Leave the Product/Service dropdown menu set at None
# Leave the Billing Cycle dropdown menu set at Monthly
#Enter the domain in the Domain text field and select Register as the Domain Registration Option (even though you aren't intending to register it today)
#Choose the number of years you next want the client to be invoiced for at the time of renewal and tick any addons the user has for their domain
#Ensure both tick boxes for sending an order confirmation and generating an invoice are unchecked so the user is not emailed about the order you are adding
#Finally, set the Order Status dropdown to Active and then click the submit button to add the order to WHMCS
#You will now been shown the order screen summarising the details of the order you just added
#Now as the final step, you must go to the domain's information page to enter the correct next due and expiry dates aswell as selecting the registrar the domain is registered with if using one of the built in registrars. To do this, from the order screen, click on the link in the Item column of the items ordered - this will take you straight to the details screen.

You have now finished adding your client. By following the steps above, your client will have not been notified that you've added them and will now be invoiced by WHMCS prior to the next due date for the items you have added to their account.

==WHM/cPanel Import Script==
The WHM Import Tool can be accessed using the Utilities menu. This will allow you to import all the domains from your existing cPanel/WHM servers. Instructions for use can be found on the separate [[CPanel/WHM_Import|CPanel/WHM Import page]].

Currencies

2014-06-03T21:30:52Z

Samcraven: Case4609

You can configure the currencies you wish to use in your WHMCS installation in Setup > Payments > Currencies

By default the base currency will be USD. This can be edited and should be changed to your home currency if not USD. You can then add additional currencies to run alongside that.

'''Currency Setup Guide:'''
[[File:Videotutorial.png‎|center|link=http://www.youtube.com/watch?v=LFTVqImvPHw&hd=1|Watch Video Tutorial]]
'''Change Default Currency:'''
[[File:Videotutorial.png‎|center|link=http://www.youtube.com/watch?v=RPygz_LlBaQ|Watch Video Tutorial]]

==Adding/Editing a Currency==

The fields for adding or editing a currency are the same. Below is an explanation of each of these:

*Currency Code – This should be the standard 3 letter ISO 4217 code used by gateways
*Prefix – The text/symbol to display before the amount
*Suffix – The text/symbol to display after the amount
*Format – Allows you to choose between the different format styles for currencies
*Base Conv. Rate – The rate amounts in this currency should be divided by to get to the base currency, eg. USD to GBP currently 1.5

To find the base conversion rate; visit [http://www.xe.com/ucc/ The Universal Currency Converter], select your default currency in the "From this currency" menu, then select your second currency from the "To this currency" menu and click Go. The base conversion rate will then be displayed as highlighted below:

[[Image:Bcr1.png]]

The first currency is the default one. If you want to define a default currency you must edit the currency code, and set it to the new default currency.

==Auto Updating Rates==

WHMCS has the built in capability to retrieve and update the base conversion rate values daily for the following currencies:

USD, EUR, JPY, BGN, CZK, DKK, EEK, GBP, HUF, LTL, LVL, PLN, RON, SEK, CHF, NOK, HRK, RUB, TRY, AUD, BRL, CAD, CNY, HKD, IDR, INR, KRW, MXN, MYR, NZD, PHP, SGD, THB & ZAR

For a full list of international currency codes: [http://en.wikipedia.org/wiki/ISO_4217]

You can manually request the rates to be synced using the Update Exchange Rates button on the currencies page or you can configure it to be automated with the daily cron in '''Setup > Automation Settings'''.

==Auto Updating Prices==

WHMCS also provides the ability to have the prices in currencies other than the base rate automatically updated based on the rates set. Again you can invoke that manually from the currencies page with the “Update Product Prices” button or you can have it run after the daily rates update in '''Setup > Automation Settings'''.

==Specifying Currency in a link==

You can link to the order form with a specific currency by simulating what the form shown for currency selection does - eg. cart.php?currency=1 cart.php?currency=2

Products Management

2014-06-03T21:30:24Z

Samcraven: Case4609

==Adding Products/Services==

*To add products/services to a clients account, the add order process has to be used
*You can do this from the '''Client Summary''' page by clicking the '''Add Order''' link in the '''Products/Services''' panel

==Managing a Clients Products/Services==

You can locate products/services to manage in a number of ways:

#Search for the Client in '''Clients > View/Search Clients''', and then from the '''Client Summary''' page click the ID of the product you want to manage from the list
#Search for the Product in '''Clients > List All Products/Services > Search/Filter''', then click the product ID or domain to be taken to the product details
#Using the [[Intelligent Search]]

The Products/Services details page inside a clients profile allows you to view and modify all of a products settings. After making any changes, you need to click the '''Save Changes''' button to save your edits.

===Running Module Commands===

If the product/service is linked to a module, you will have a Module Commands row towards the bottom of the page. This allows you to execute any of the commands available in that module. Modules can have custom functions but the most common ones are:

*'''Create''' - runs the creation routine and sets the product status to active
*'''Suspend''' - runs the suspension routine and sets the product status to suspended. You will be prompted to enter a suspension reason, leave it blank if the client has an unpaid invoice and you want the account automatically unsuspended when paid.
*'''Unsuspend''' - runs the unsuspension routine and sets the product status back to active
*'''Terminate''' - runs the termination routine and sets the product status to terminated
*'''Change Package''' - runs the upgrade/downgrade routine for the selected product
*'''Change Password''' - runs the password modification routine for the last saved password value

===Addons===

*Product addons allow you to bill for additional items related to the main product but on independant billing cycles from the product (unlike Configurable Options which have to bill on the same cycle)
*Addons can be preconfigured in '''Setup > Product Addons''' but you can also create custom addons for specific clients which aren't predefined for flexibility
*Preconfigured addons can be ordered by clients from the client area product details page

====Mananging Addons====

*The Products/Services details page shows the number of addons a product has with a '''Click here to Manage''' link just below the domain field
*To view/edit or delete addons you need to click that link and a popup will open
*Any existing addons will be displayed with edit and delete icons for managing them

====Adding Addons to Users====

*To add a new addon, click '''Products/Services''' in Clients Profile.
*Next click on the link '''Click here to Manage''' beside the Addons label, and then click '''Add New Addon''' button.
*If using a predefined addon, simply choose it from the dropdown and leave the name, price and billing cycle fields empty as they will all be automatically set
*Alternatively, if adding a custom addon specific to this client, leave the Predefined Addon set to None and enter a custom name, price and cycle
*If you would like to invoice for the new addon immediately then you don't need to do anything as that will happen by default, or alternatively if you don't want to invoice yet you can just untick the generate invoice checkbox
*Once happy with the selections, click '''Save Changes''' to complete the process

===Auto Recalculate Recurring Price on Save===

*This checkbox option located to the bottom right of the product details screen updates the recurring amount field when checked
*It can be used after changing the product, configurable options, billing cycle or promo code to auto calculate the new recurring price
*It is off by default so that any discounted rates or custom pricing are not overwritten as these aren't taken into account by it

===Overide Auto Suspension===

*This option can be used to allow extra time for payment to be made for specific individuals
*It allows you to set a date to hold the suspension until and then it will only suspend if it's still unpaid when that date is reached
*The checkbox to enable it is at the bottom of the '''Products/Services''' details tab under a '''Clients Profile'''
*Tick that box and then in the date field that appears, choose the date you want to overide the auto suspension until
* Entering the date 00/00/0000 will permanently prevent the product from being suspended.

==Invoicing Early==

There may be times where a client asks for you to invoice them for the next renewal date early. To do this in WHMCS,

#Begin by navigating to the '''Clients Summary''' page for the client you want to invoice
#Now tick the boxes of the '''Products/Services/Addons''' and/or '''Domains''' you want to generate an invoice for
#To complete, click the '''Invoice Selected Items''' button to create the invoice(s) for them
#Multiple invoices may be created if the due dates and payment methods differ as invoicing rules are obeyed as normal

'''Note:''' You won't be able to generate another invoice if an invoice has already been made for the next due date.

'''Note:''' If the Separate Invoices option is enabled in the client's Profile or Client Group, when selecting multiple items here with the same Next Due Date, separate invoices will still be generated.

==Upgrades/Downgrades==

===Admin Area===

If you would like to change the product/service a client is assigned to and automatically charge or credit the difference for that change then you need to use the Upgrade/Downgrade process. You'll find the option for this next to the Products/Services dropdown menu on the Products/Services Details page within the clients profile. To use it, simply navigate to the product you want to change, click the Upgrade/Downgrade link, and in the popup that appears make the new product & billing cycle selections as required and it will give you a preview of what the charge will be for the remainder of the current cycle and allow you to create an order/invoice for that change if happy.

[[File:Videotutorial.png‎|center|link=http://www.youtube.com/watch?v=wXEulukuHdo|Watch Video Tutorial]]

There will no immediate changes to the product after creating an upgrade order, the actual product or config option changes won't take effect until the invoice is paid. But as soon as the invoice is paid the product will be updated, the new recurring amount will be set, and with most supported control panels the upgrade is fully automated with the new package details/changes being passed over to the server module being used. Finally the upgrade email specified in the product configuration is sent to the user advising them of the new products details.

The same process can also be used for configurable options changes and billing the difference for those if the product contains them.

===Client Side===

Clients can also place orders for upgrades & downgrades themselves if you have permitted it in the product configuration. This allows clients to order upgrades/downgrades and complete them automatically without the need for any staff involvement.

For more information, including how to allow clients upgrades and how the upgrade charges are calculated, please refer to the [[Automated Upgrades and Downgrades]] section

===Manual Upgrades===
There may be occasion when you wish to make an upgrade without placing an upgrade order (such as a free upgrade) or processing the upgrade before the client has paid for it. To achieve this:

#Navigate to the client's Products/Services tab,
#Change the product from the dropdown menu,
#Tick "Auto Recalculate on Save" checkbox,
#Click Save Changes,
#Finally click the "Change Package " Module Command button to make the change on the server.

==Mass Updating Services/Addons/Domains==

[[File:Mass update.png|thumb|Mass Update Tool]]
The mass update tool in WHMCS allows you to perform changes to 2 or more products inside a clients profile at the same time. The changes can consist of changes in the price, billing cycle, next due date, status and/or payment method and setting an override auto-suspend date. For example you can use this if you want to reduce a clients price on a number of separate products to the same level, execute module commands in bulk or if you would like to bring multiple services in line to a matching due date.

To use this feature, from the Clients Summary page, simply tick the checkboxes next to the Products/Services, Addons and/or Domains you want to update, and then below the item lists click the '''Mass Update Items''' button which will reveal the options which you can set. Now make your selections (leaving blank any fields you don't want to change), and finally submit to complete the changes.

[[File:Videotutorial.png‎|center|link=http://www.youtube.com/watch?v=WLLsQML6rEU|Watch Video Tutorial]]

===Create Prorata Invoice===
This useful feature means that when changing the Next Due Date of a product/service/addon/domain a pro-rated invoice is created covering the period between the current next due date and the new one. It even works when the various products have different next due dates to start with and will pro-rate each accordingly as separate line items on the invoice.

To use simply specify the new Next Due Date and tick the '''Create Prorata Invoice''' checkbox before clicking Submit.

For example take two products that the client now wishes to pay on the 10th of the month going forward:

Product A - Next Due Date 01/01/2012 @ $30/month
Product B - Next Due Date 05/01/2012 @ $60/month

Set the Next Due Date to 10/01/2012 and tick the checkbox, an invoice with the following line items will be generated:

Product A (01/01/2012 - 09/01/2012) $8.00
Product B (05/01/2012 - 09/01/2012) $10.00
Total Due Today $18.00

Only once paid will the Next Due Dates for both products be updated and in future both products would be invoiced on the 10th January.

==Cancelling a Product/Service==

===Auto Terminate/Fixed Term===
You can setup products to automatically terminated after a set number of days from the date of signup. For more information refer to [[Products_and_Services#Pricing_Tab|Configuring Products/Services]].

===Clients Self Service===
WHMCS can completely automate the process of product cancellation or wait for manual confirmation. To do this navigate to '''Setup > General Settings > Other''' and enable the '''Show Cancellation Link''' option.

Clients can then request cancellation of any of their products & services directly from the client area.

To fully automate cancellation and have the module terminate command run (for example to remove the hosting account from the server) tick the '''Setup > Automation Settings > Cancellation Requests''' option.

Now when the cron runs any services with a cancellation request due today will be removed from the server and the status changed in WHMCS to Cancelled. The process runs as follows:

*Client clicks ''Request Cancellation'' button on the product details page in client area
*They're prompted to provide a cancellation reason and provided 2 choices for the cancellation - either '''Instant''' (on next cron run) or at the '''End of the Current Billing Cycle'''.
*If a matching domain exists under the client's account in active status with ''Auto Renew'' enabled, the customer is given the option to disable auto renew too - thereby leaving the domain to expire.
*Any unpaid invoices for the product will be cancelled ([[Invoice_Tab#Cancellation_Request_Handling|if enabled]])
*A notification email is sent to administrators and you will be able to review the reason provided in '''Clients > Cancellation Requests'''.

====Manual Cancellation====
If the Cancellation Request setting is '''not''' enabled then at this point you must navigate to the cancellation requests page, click through to the service page and click the '''Terminate''' module command button to remove the account from the server. The cancellation request is then moved from the ''Open Requests'' page to ''Completed Requests''.

====Automated Cancellation====
If the Cancellation Request setting '''is''' enabled the cancellation request will be actioned when the daily automation cron runs on the appropriate day. For example if the ''Immediate'' option was selected it will be terminated on the next cron run, if ''End of Billing Period'' was selected it will be terminated when the cron runs on the service's Next Due Date.

===Admin Scheduled Cancellations===

As an admin user, you can schedule the termination of a product at the end of the currently active period by going to the Products/Services tab, ticking the '''Auto-Terminate End of Cycle''' option and optionally entering a reason/note for it. Any unpaid invoices for the product will be cancelled and will suppress any further renewal invoices from generating for this product and terminate it when the next due date is reached.
The "Cancellation Requests" setting in '''Setup > Automation Settings''' must also be enabled.

===Admin Immediate Cancellation===

Finally, if you want to cancel or terminate a product or service immediately then you simply need to locate the item you wish to cancel, and from the Products/Services page, click the '''Terminate''' button if the product is linked to a module or if not, manually change the dropdown status from Active to '''Cancelled'''. Once you've done this, no further invoices will generate for the item.

==Moving a Product/Service to another Client==
[[File:Transfer product.png|thumb|Transfer Product Popup]]
#From the Products/Services details page of the product you want to move, click '''Move Product/Service to Another Client''' located at the top-right of the page
#A popup box will appear (you will need popup blockers disabled to use this)
#In the popup enter the ID of the new owner. If you don't know the client's ID the Search field can be used to search by name, company or email address. Click the client's name and the ID will be filled in.
#After selecting the desired click, click the '''Transfer''' button
#The item will then be transferred, the window will close, and the original window will refresh to show the product under its new owner.

'''N.B.''' Moving a products/service between clients within WHMCS will not have any affect on the account on the server.

===Invoices===
Invoices cannot be moved between clients, therefore when moving a product/service any invoices will remain under the old owner. Therefore it would be advisable to check the old owner's Invoices tab for any unpaid invoices for this service and cancel them. If you wish to invoice the new owner for the service, move the Next Due Date forward/back by one day and a new invoice will be generated when the cron next runs.

==Deleting a Product/Service from a Client==

#From the Products/Services details page of the product you want to delete, scroll to the bottom and click the red '''Delete''' link
#After clicking this link, you will be asked to confirm if you are sure you want to delete the item
#If you click No you will be returned to the page, if you click Yes, the item will be deleted and you will be taken to the next product/service under that client

'''Note:''' Deleting a product from WHMCS will not terminate it on the server. If you wanted to remove it from the server aswell, you need to run the Terminate Module Command as explained above before deleting the record from WHMCS.

==Resending Product Welcome Email==
To re-send a product welcome email simply navigate to the client's Products/Services tab and click the "Resend Product Welcome Email" button at the bottom of the page.

Installing WHMCS

2014-03-31T20:20:02Z

Samcraven: 3884

==Downloading WHMCS==

#Visit http://download.whmcs.com/
#Click the Download button under the Full Release heading - this will be the latest release version

''Please Note: If you do not have a login for our members area, this indicates your key has been obtained via a reseller and they should provide the latest WHMCS files to you''

==Installing Ioncube==

WHMCS is encrypted using Ioncube to protect the source code. These days most servers/webhosts have Ioncube support compiled into the PHP build by default so you don't normally need to do anything extra for it. However if you find you do need to install Ioncube on your server, then you can find out how to do this in our [[Ioncube Installation Tutorial]]

==Installing WHMCS==

[[File:Videotutorial.png‎|center|link=http://www.youtube.com/watch?v=7gANkXcOBoc&hd=1|Watch Video Tutorial]]

Installing WHMCS is very simple. The following steps will guide you through the process:

#Unzip the contents of the zip file to a folder on your computer
#Rename the file configuration.php.new to configuration.php
#Upload the entire whmcs folder to your website - if you experience problems, try uploading in binary mode
#Next you can rename the folder to whatever you like (billing, clients, etc...)
#Now visit the installation script at http://www.yourdomain.com/whmcs/install/install.php to run the installer process - if you get an Ioncube related error message, see the installation Ioncube steps above
#Follow the instructions on screen to install which will involve setting file permissions as listed below, entering your license key and setting up your primary admin account
#When complete, delete the install folder from your web server and CHMOD the configuration.php file back to 644.

Required file & folders permissions (unless your php is suPHP or PHPSuExec):

/configuration.php CHMOD 644 Writeable
/attachments CHMOD 777 Writeable
/downloads CHMOD 777 Writeable
/templates_c CHMOD 777 Writeable
/configuration.php CHMOD 400 READABLE*
*If using DSO as your php handler, you must use 644 permissions.

==Post Installation Suggested Steps==

After installation is completed, we recommend that you go through and configure your new WHMCS system in the following order:

#Login to the Admin Area and configure your General Settings (Setup > [[Configuration|General Settings]])
#Setup your Payment Gateways (Setup > [[Payment Gateways]])
#Setup your Products & Services (Setup > [[Products and Services]])
#Configure your Domain Pricing (Setup > [[Domains_Configuration|Domain Pricing]])
#Setup your Support Ticket Departments (Setup > [[Support_Center|Support Departments]])
#Setup email piping so you can manage tickets using the WHMCS Support Desk - for full instructions on this please see the [[Email Piping]] article
#Ensure the WHMCS Cron Job is setup and configure automated tasks (Setup > [[Automation Settings]])
#Place some test orders on your website to check everything works as expected

[[File:Videotutorial.png‎|center|link=https://www.whmcs.com/get-support/video-tutorials/|Watch Video Tutorial]]
For further guidance, you can watch video tutorials we have prepared for the above tasks @ [https://www.whmcs.com/get-support/video-tutorials/ www.whmcs.com/get-support/video-tutorials/]

Version 5.x System Requirements

2014-02-05T21:58:22Z

Samcraven: Case4014

Most current web servers with PHP & MySQL installed will be capable of running WHMCS. The minimum requirements are:

* Windows or Linux OS
* PHP Version 5.2.x - 5.4.x (with JSON)
* MySQL Version 4.1.x and above (Strict Mode Disabled)
* Curl Support (with SSL)
* GD2 Image Library
* Ioncube Loaders V4.0 or later

<div class="docs-alert-warning">
PHP 5.5 Compatibility 
PHP Version 5.5 is not supported at the current time due to Ioncube encoding restrictions.
</div>

If you would like any more information or need help in determining if your server meets these requirements, please contact us.

Affiliates

2014-01-29T21:25:07Z

Samcraven: Case 3849

WHMCS comes with a built in affiliates system. Affiliates are often key to a business in order to generate revenue by having others refer customers. So with that in mind, WHMCS has a comprehensive affiliate system featuring support for one time and recurring commissions, both percentage or fixed money values, payout delays, minimum withdrawal limits and live stats/info for affiliates from the client area.

Your WHMCS install generates a unique code for each client to use on their website eg: http://example.com/whmcs/aff.php?aff=001
When a visitor clicks this link they will be taken to your site and a cookie saved on their computer. If the visitor then places an order with the cookie present (it lasts for 90 days by default) the client will earn a commission.

==Configuration==

To configure the affiliates system, go to '''Setup > General Settings''' and then select the '''Affiliates''' tab. From here you can set the initial bonus deposit amount, the minimum withdrawal level, the payout delay and the percentage to payout.

*'''Affiliate Earning Percentage''' - The default percentage to pay as commission on all products/services. This can be overidden on a per product basis when configuring a product. And you can then overide the commission settings further on a per client basis and set a specific commission rate for an individual affiliate, ideal for rewarding your best affiliates.
*'''Affiliate Bonus Deposit''' - the amount to default any new affiliates balance to - a way of offering an incentive to new affiliates so they'll reach their first withdrawal level quicker
*'''Affiliate Payout Amount''' - the amount at which you allow affiliates to withdraw their commission balance, for example $50 or more.
*'''Affiliate Commission Delay''' - the number of days to delay commission payments so that you aren't paying commissions as soon as you receive the order. See the '''Commission Delay''' section below for more info.

Any setup fee will be included in the initial commission. Thereafter recurring commissions are based upon the product's Recurring Amount.

=== Setting Commission Per-Product===
To offer a higher commission on a certain product navigate to '''Setup > Product/Services > Edit > Other tab'''.
From here you can choose a percentage or fixed amount commission. Ticking the One Time Payout checkbox will give the commission only once. The default commission setting for WHMCS is recurring.

It is possible to disable commission entirely for an individual product from this page by selecting the ''No Commission'' option.
This setting takes priority over the default commission; product commission > default commission. However, if either the client or the product commission are set to one time, that setting will override.

===Setting Commission Per-Client===
To offer a unique commission click the "View Affiliate Details" link on the Client's Summary Tab and you can set the commission as above.
This setting will take priority over all others; client commission > product commission > default commission. However, if either the client or the product commission are set to one time, that setting will override.

===Promotion Behaviour===
If the referred client uses a promotional code to receive a discount when signing up and you have configured the affiliate to receive a percentage commission, the value of the commission will be reduced. If a fixed amount commission is configured then they will still receive the full value.

For example if a '3 months free' promo is used the affiliate gets the commission based on the first payment amount and then recurring amounts that the product is set to. So the user would get a percentage of zero and therefore zero for the first 3 months.

===Upgrade Behaviour===
If a referred client upgrades/downgrades their product then commissions the affiliate receives in future will also be adjusted to match the price of the new product. Commission payments already earned will be unaffected. There is no commission paid on the upgrade/downgrade order itself. This does not apply to one-time commissions.

==Commission Delay==

This option allows you to set the number of days to delay commission payments so that you aren't paying affiliates as soon as you receive an order. This means you avoid paying commission on fraudulent orders or those cancelled within a few days of ordering as the commission is only paid if the product/service is still active at the end of the delay period.

The way this works is that instead of paying commission instantly when you are paid, it waits for a period of days and then only pays the commission should the product or service still be active after that period of time has passed. For example you could set it to wait 60 days before paying the commission for a sale on the basis that most fraudulent transactions will have been reported to you within that time. At the time of order, the affiliates '''Pending Commissions Balance''' will increase by the amount of commission for the order, but not their '''Available to Withdraw Balance'''.

You can view and delete pending commissions from the affiliates management area anytime from the '''Pending Commissions''' tab under Clients > Manage Affiliates when viewing an individual affiliates details.

==Affiliate Linking Code==

You can specify affiliate link code in the config area. Below is an example:

<nowiki>
<a href="[AffiliateLinkCode]"><img src="http://www.yourcompany.com/banners/468x60banner.gif" width="468" height="60" border="0"></a> 
<(a href="[AffiliateLinkCode]")><(img src="http://www.yourcompany.com/banners/468x60banner.gif" width="468" height="60" border="0")><(/a)> 
<a href="[AffiliateLinkCode]"><img src="http://www.yourcompany.com/banners/120x60banner.gif" width="120" height="60" border="0"></a> 
<(a href="[AffiliateLinkCode]")><(img src="http://www.yourcompany.com/banners/120x60banner.gif" width="120" height="60" border="0")><(/a)> 
</nowiki>

The above code entered in the Affiliates Link section will display the image preview of the banner first and then the code below it for the affiliate to use. The '''<(''' and ''')>''' is special syntax which you must use so the code is '''not executed''' as true HTML. WHMCS modifies this when displaying it to the client so it will appear as normal HTML.

For more advanced link code, you can add it directly to the affiliates.tpl template file of your active template folder using the template field '''{$referrallink}''' wherever you want to include the affiliates unique referral url.

===Linking to a Product===

It is possible to link directly to the order form for a specific product. To do this, simply append '''&pid=x''' to the end of the [AffiliateLinkCode] where x is replaced by the ID of the product. So for example:

<nowiki>
<a href="[AffiliateLinkCode]&pid=2"><img src="http://www.yourcompany.com/banners/468x60banner.gif" width="468" height="60" border="0"></a> <(a href="[AffiliateLinkCode]&pid=2")><(img src=http://www.yourcompany.com/banners/468x60banner.gif" width="468" height="60" border="0")><(/a)>
</nowiki>

==Activating an Affiliate==

Clients can activate their affiliate account from the client area but you as an admin can do it from the client summary page also. To do that, locate the client you want to activate using the search or client list and then in the '''Actions''' panel click the '''Activate as Affiliate''' link.

==Deactivating an Affiliate==
To remove a client from the affiliate program navigate to Clients > Manage Affiliates and click the red X icon next to their name.

==Managing Affiliates==

*To view & manage affiliates, go to '''Clients > Manage Affiliates'''
*To view the affiliate statistics for a specific client, search for that client as normal and from the '''Client Summary" page, click the '''View Affiliate Details''' link in the '''Actions''' panel
*To view your best performing affiliates, click the '''Balance''' column heading to resort the affiliates into order of balance

==Manual Operations==
===Assigning an Affiliate to an Existing Order===

To assign an affiliate to an order which has already been placed and shows no referral, go to '''Orders > List''' and locate the order you want to assign to the affiliate. Once located, click on the '''Order ID''' number to open the details for that order. Now click the '''Manual Assign''' link in the Affiliate section, and you will then get a popup with a dropdown where you can choose the affiliate you want to assign it to, and then click '''Save''' to apply it.

===Paying Commission for an already paid order===

There may be some instances where you apply an affiliate to an order after it has been paid for and that would mean the affiliate has then missed out on the initial commission for that order. To correct that, after assigning the affiliate with the steps above, open the affiliates page (see Managing Affiliates above) and then on the Referrals list for the affiliate, click the '''Manual Payout''' button next to the new account. That will perform the equivalent action of an invoice being paid by the end user for a referred order in terms of crediting the affiliate.

===Manually Adding a Commission===

Sometimes it might be necessary to give commission to an affiliate that is not related to any order, for example a special commission bonus, or if importing a commission balance from another affiliate system. To do this, open the affiliates page (see Managing Affiliates above) and click the '''Commissions History tab''', you can then enter the details of the commission under the '''Add Manual Commission Entry'''' heading. If the commission relates to an existing referral you may select it from the 'Related Referral' menu, otherwise leave it as 'None'.

==Affiliates Cookie ==

The affiliates cookie by default is set to last for 90 days on the users computer. You can change the number of days it lasts for in the aff.php file.

==Multi Currency==

When you select the %age it will pay x% of whatever currency the user pays you in and convert it to the affiliates' currency using the current exchange rate. If you select to pay a fixed amount that will be paid the same amount in any currency.

==Making a Withdrawal (Paying Commission)==

When an affiliate's balance reaches the affiliate payout amount a request withdrawal button appears on the client's affiliate page. If they click that to submit a request, it will open a ticket notifying you of their request.

To process the withdrawal request, simply navigate to the affiliates management page for the affiliate in question, select the '''Withdrawals History''' tab, and there you will see a form for making a withdrawal payout. This allows you to enter the withdrawal onto the system, automatically deducting the specified amount from the users affiliate balance, and performing some additional actions based on the Payout Type selection from the options below:

*'''Create Transaction to Client''' - This will automatically create an expenditure transaction on the clients account in WHMCS to reduce your profit figures for the client (you must still actually make the payment manually - Cheque, PayPal, etc...)
*'''Add Amount to Credit Balance''' - This will automatically create a credit on the clients account equal to the value of the withdrawal amount to be applied to the future invoices they receive from you
*'''Record in Withdrawals Only''' - This just makes a record of the withdrawal in the affiliates area and doesn't create any transaction or credit.

There may be occasions where it is necessary to manually give a client commission, for example if an order was handled outside WHMCS or you've imported from another billing system and want to transfer their affiliate balance across. This is where the '''Add Manual Commission Entry''' section on the Commissions History tab is used. A ''Related Referral'' can also be selected if the commission relates to a specific referral, leave the field at "None" if adding a general commission.

GlobalSign OneClickSSL

2014-01-23T21:10:09Z

Samcraven: Case 3905: Removing references to renewals

Welcome to OneClickSSL, GlobalSign's revolutionary new SSL technology for automating the SSL reselling & installation process.

Always eager to keep up with the latest hosting technologies, here at WHMCS we're proud to be '''the first''' billing solution offering integration with GlobalSign's new service, putting WHMCS users ahead of all the competition!

==What is it?==

With OneClickSSL, users simply activate SSL for their website by redeeming Secure Site vouchers via any of the OneClickSSL plug-ins, available via platforms such as cPanel, Parallels, IIS, and Apache.

Redemption of the voucher using the plug-in transparently creates the cryptographic keys, the Certificate Signing Request (CSR), validates the control of the domain, installs the issued certificate and binds it to the appropriate website, all within just a few seconds, thus eliminating the need to provide your customer with a CSR, and have them go through a lengthy and often confusing SSL configuration process.

But where does the user get the OneClickSSL Voucher you're wondering? Well that's where WHMCS comes in. WHMCS lets you take full advantage of the OneClickSSL automation by allowing your customers to purchase and receive their OneClickSSL Vouchers automatically from your very own WHMCS ordering system.

Here's an example of how a voucher purchase is shown to the customer via your client area:

[[File:GSOneClickSSLClientArea.png]]

And for admin users:

[[File:GSOneClickSSLAdminArea.png]]

==Features==

*Fully Automated Voucher Provisioning
*Supports both DomainSSL & AlphaSSL Products
*Allows offering Registration Periods of up to 5 Years
*Support for SSL Transfers

==Installation==

The GlobalSign OneClickSSL module first became available in August 2011 and so is not included by default in any WHMCS releases prior to V5.0.2. Therefore if you are running on Version 4.5 of WHMCS or earlier, you will need to download and install the module before you can use it. To download simply follow the link below and then to install, it's simply a case of uploading the module folder within the zip file to the /modules/servers/ directory of your installation.

http://www.whmcs.com/members/dl.php?type=d&id=90

Finally your server IP address will need to be whitelisted by Globalsign support for access to their API. Failure to do so will result in a "This IP Address is not registered" error message.

==Setting Up Voucher Products==

To configure a OneClickSSL Voucher product in WHMCS, simply follow the steps below:

# Begin by navigating to '''Setup > Products/Services''' and create a new group for your GlobalSign SSL offerings
# Next proceed to create a new product, selecting the group you just created above, setting the product type to "Other" and giving the new product a name
# You can then configure the description and other settings as you would for any product
# '''Require Domain''' should be unticked. And '''Welcome Email''' should be left at None.
# When it comes to pricing, you can offer the voucher for a one time item, so select the '''One-Time''' Payment Type option.
# Now it's time to configure the GlobalSign related settings via the '''Module Settings''' tab
# Begin by choosing '''Globalsignvouchers''' from the module dropdown menu
# You'll then be presented with a screen like the one below which has the following fields:

*'''Username & Password''' - this is where you need to enter your GlobalSign API Username & Password
*'''SSL Certificate Type''' - in this dropdown menu you can set the type of SSL product this voucher grants access to. The choices are DomainSSL or AlphaSSL.
*'''Validity Period''' - this is where you set the period for which the SSL Certificate should be valid (for example 1 year, 2 year, 3 year).
*'''Order Kind''' - this is where you set the type of order this product is for. The choices are New or Transfer. Normally you should choose New here.
*'''Coupon & Campaign''' - these are optional fields which are only to be used if specifically instructed to by GlobalSign support
*'''Test Mode''' - this checkbox allows you to toggle demo mode for the selected product to allow you to place test orders without being charged

One final requirement for the Voucher products is that a custom field must be created for the customer to enter the domain they are purchasing the voucher for. This will be created automatically for you but you can customise the display name which is the part after the '''Domain|''' via the custom fields tab should you wish.

[[File:GSOneClickSSLModuleSettings.png]]

==Additional Options==

Voucher products can be offered in many different ways and combinations. And so in the module for WHMCS we've tried it make it as flexible as possible. And so to that end, there are a number of optional configurable options you can create to override the default module settings based on customers selections if you wish:

*'''NumYears''' - A configurable option with this keyword name will override the Validity Period set for a product thus allowing you to offer the 1-5 registration periods via a single product
*'''Transfer''' - If you setup a configurable option with this name, set to field type Yes/No, then this allows the customer to specify if the SSL they are ordering is a transfer of an existing SSL simply by checking a box in the order process

Billable Items

2014-01-10T02:39:23Z

Samcraven: Case 2603

Billable items are an alternative to using a product for billing clients, they allow you to add items for a client to be billed that aren't limited to preset products or fixed cycles and are therefore very flexible. A billable item can be set to 1 of 5 invoice options:

*'''Don't invoice for now''' - so it will remain listed in the clients account as an unbilled item
*'''Invoice on Next Cron Run''' - generate an invoice for it the next time your daily cron job runs
*'''Add to User's Next Invoice''' - not necessarily on the next cron run but when the user next gets an invoice for one of their products or services, include the item
*'''Invoice as Normal for Due Date''' - allows you to set a specific date the item is due and it will be invoiced X days in advance like all other products/services
*'''Recur''' - allowing you to set for the item to recur every X Days/Weeks/Months or Years for Y Times

==Adding a Billable Item==

# To add an item, either go to '''Billing > Billable Items > Add New''' or from the client summary page of the client you want to add it to, click the '''Billable Items''' tab and then the '''Add Billing Entry''' button
# Next enter a description for the item which should appear on the invoice when generated
# Then enter the amount to be billed (taxes will be applied as normal when the invoice generates)
# Now choose an invoice action from those explained above. If recurring, also enter how frequently to recur and how many times in the boxes provided. Entering 0 in the times box will result in it recurring indefinitely.
# Finally, if you have selected the "Invoice as Normal for Due Date" or "Recur Every" invoice action then you may specify a '''(Next) Due Date''' value to determine when the first invoice by this billable item will be generated.
# Leave invoice count at zero and then click to '''Save'''

==Managing Billable Items==

Billable items can be reviewed on the '''Billable Items''' tab in a specific clients profile area or collectively in the '''Billing > Billable Items''' area. When editing a billable item, listed below the items details will be a list of all invoices that have been generated for it allowing you quick and easy access to the invoice(s) relating to that item - in most cases it will be just one but for recurring items the list will show all.

==Products vs. Billable Items==
To ensure the best experience for your clients it important to know when a billable item or a product would be more appropriate. The differences are listed here:
* Billable Items can only be added by staff - Products can be added by clients via the public order form
* Billable Items are not displayed in the client area - Products are displayed on the "My Services" page in the client area
* Invoices for both Billable Items and Products will be visible to clients and staff
* Billable Items can be used to generate one-time or recurring invoices with any frequency from daily upwards - Products can be used to generate one-time or recurring invoices on specific billing cycles only (Monthly, Quarterly, Semi-Annually, Annually, Biennially, Triennially)
* Billable Items would typically be used for items unique to an individual client - Products would typically be used for items that many clients will buy

Administrators and Permissions

2013-12-31T02:30:29Z

Samcraven: Case 3789: Updating and minor clarification

==Managing Administrators==

To set up additional admins, go to '''Setup > Staff Management > Administrator Users'''. From here you can view and edit existing operators as well as adding new ones. When editing an operator you can change all the details of the operator including resetting their password. It also allows you to see any notes they have made for themselves.

==Assigning to Support Departments==

To assign an admin to a support department perform the following steps:

#Go to '''Setup > Staff Management > Administrator Users'''
#Click the edit icon next to the administrator you would like to assign to a department
#About halfway down the page, you will see a list of all the support departments in the system, tick the boxes next to the ones you want this admin account to be a member of
#Once finished, click the Save Changes button
Only when an admin account is assigned to a department will that admin user be able to view and respond to tickets in that department.

==Configuring Administrator Roles==

The administrator roles allow you to fine tune exactly what each of your admin users can do within your WHMCS administration area. You can setup as many different role groups as you want and then assign your admins to them as required. As standard, WHMCS comes with 3 default roles - Full, Sales & Support Only.

===Setting Role Group Permissions===

#Begin by going to '''Setup > Staff Management > Administrator Roles'''
#If you want to setup a new role group, click the Add New Role Group link and enter a name for it. Or alternatively if editing the permissions on existing group, click the edit icon next to it
#You will then be shown a complete list of the permissions settings for the group you are creating. Options are provided for each admin area page and for some, individual controls such as whether values can be edited or records deleted are provided.
#You can also set the email receiving preferences - system emails, account emails and support emails
#Once completed, click Save

===Assign an Admin to a Role===

#To assign an admin to a role, go to '''Setup > Staff Management > Administrator Users'''
#Next, click the edit icon next to the admin you want to change
#Now in the Role Group dropdown menu choose the role you want to assign the admin to
#Then click save and the change will take immediate effect