Blog – WHMCS Tricks

Cancel invoice for terminated and cancelled services

May 5, 2019/2 Comments/in Hooks /by ivan

This hook runs after all the automations and set the invoices to “Cancelled” it the services have been terminated or cancelled. This feature has been long requested to WHMCS but it was never implemented.

All you need to do to install and activate the hook is to upload the file into the /includes/hooks of you WHMCS installation. It will day after the cron runs it will set all the invoices to “Cancelled” if the related product is Terminated or Cancelled.

It will also create an entry in the client log to have a record or the cancelled invoice. The same log will appear also in the System Activity Log.

It’s as easy as that.

whmcstricks cancel invoice for terminated services

WhmcsTricks email Status

April 23, 2019/0 Comments/in Modules /by ivan

As a business you send many important e-mails to your customers. Invoices, renewal notices, quotes, and important announcements are just a few of the many things you may communicate to your customers via e-mail.

Wouldn’t it be great if you could tell if your customers have read the e-mails you have sent? Now you can!

WhmcsTricks E-mail Status allows you to track the e-mails you send, and see which ones have been opened.

Once this module is activated an invisible tracking pixel will be added to the footer of all e-mails sent by WHMCS to your customers, and you can see which messages have been read from the WHMCS Administration Area.

E-mail Tracking

This module allows you to see which e-mails have been opened from the “Emails” tab on the “Client Profile” page in WHMCS. You can also see the date the e-mail was opened, and the IP address that was logged when the message was viewed.

whmcstricks email status

If the email hasn’t been read yet you will see a red icon. If you see no icon it means that the email was sent before activating the module.

Ticket open tracking

Once you answer a ticket check if the client read your last answer or if that was not read yet. If you don’t see any box on top of the ticket page it means tracking is not active (check the module page) or that the ticket emails were sent before you activated the module.

whmcstricks ticket unread whmcstricks ticket read

Statistics

Easily get a quick overview of how many e-mails you are sending, and how many of them are being opened, from the WhmcsTricks E-mail Status summary page. You can calculate the open rate of an email campaign (you can make a search using a specific subject).

WhmcsTricks Email Status stats

You can insert the subject of your mailing list in the box to calculate the open rate of your mass email. You can use “%” as a wildcard in case you were using a dynamic parameter in your subject (for example “hello % here is your discount” where % was the name of every customer).

WhmcsTricks Email Status open rate

Pricing

The module is available on an annual license for 25$ for a lifetime license.

Installation and Configuration

To install the module:

Upload the folder th_es inside the /modules/addons folder of your whmcs installation
From your WHMCS Admin Panel, go to “Setup > Addon Modules”
Click the “Activate” button beside the WhmcsTricks E-mail Status module
On the same page, scroll down and click the “Configure” button beside the WhmcsTricks E-mail Status module
Select all permission groups that you want to be able to use this module, and click “Save Changes”
From your WHMCS Admin Panel, go to “Addons > WhmcsTricks E-mail Status”

To configure the module:

WhmcsTricks Email Status configuration Visiting the module page you will get 2 alerts (or 2 success messages).

You need to add a tag in your email footer, just before the end of the body to include the tracking. If you want to track the ticket emails as well you need to log email ticket replies. Everything is explained in the documentation and in the alerts. Once everything is configured correctly you will see this:

WhmcsTricks Email Status configuration complete

WHMCS API Update CustomFields

February 20, 2019/0 Comments/in WHMCS API /by ivan

A big problem with WHMCS is that you don’t have any API to manage customfields. With this API you can update all clients, products and support custom fields.

You can use it as a standard WHMCS API. You may want to use it with internal API function. In this case WHMCS documentation is helpful so no more explanations are required. Keep in mind that due to the way WHMCS handles API permissions, you will only be able to use this as internal API.

To use it you have to upload the updatecustomfields.php (all lowercase) into the /includes/api whmcs folder and it’s done.

Parameters

Parameter	Type	Description	Required
relid	int	The ID of the related item you want to get the custom fields for	Required
type	string	Supports client, product or support. defaults to client	Optional
customfield	int or string	Use either the id of the customfield or its name	Required
value	string	The new value for the custom field, can be empty	Optional

Response Parameters

Parameter	Type	Description
result	string	The result of the operation: success or error
message	string	The result message

Example request (CURL)

Given the recent changes in WHMCS custom API work only with the Local API function.

Example Request (Local API)

$command = 'UpdateCustomFields';
$postData = array(
    'relid' => 1,
    'customfield' => 12,
    'value' => 'newvalue',
);
$adminUsername = 'ADMIN_USERNAME';

$results = localAPI($command, $postData, $adminUsername);
print_r($results);

Example Response

Array ( 
	[result] => success,
	[message] => Custom field with id # has been updated with the value: newvalue,
	)

Error Responses

Error response codes are:

The relid is undefined
The type you selected does not exists. Please check
The customfield is undefined
The customfield could not be found. Please check the ‘customfield’ and ‘type’ parameters
A client with id # does not exists
A product with id # does not exists
This product does not own this custom field
A ticket with id # does not exists
This support department does not own this custom field

Got questions or problems? Contact us or comment, we’ll be happy to help.

WHMCS API Get CustomFields

February 20, 2019/0 Comments/in WHMCS API /by ivan

A big problem with WHMCS is that you don’t have any API to manage customfields. With this API you can get all clients, products or support custom fields.

You can use it as a standard WHMCS API. You may want to use it with internal API function. In this case WHMCS documentation is helpful so no more explanations are required. Keep in mind that due to the way WHMCS handles API permissions, you will only be able to use this as internal API.

To use it you have to upload the getcustomfields.php (all lowercase) into the /includes/api whmcs folder and it’s done.

Parameters

Parameter	Type	Description	Required
relid	int	The ID of the related item you want to get the custom fields for	Required
type	string	Supports client, product or support. defaults to client	Optional

Response Parameters

Parameter	Type	Description
result	string	The result of the operation: success or error
fieldname	Array	An array with all the data using the name of the field as the key of the Array
fieldid	Array	An array with all the data using the id of the field as the key of the Array

Example request (CURL)

Given the recent changes in WHMCS custom API work only with the Local API function.

Example Request (Local API)

$command = 'GetCustomFields';
$postData = array(
    'relid' => 1,
);
$adminUsername = 'ADMIN_USERNAME';

$results = localAPI($command, $postData, $adminUsername);
print_r($results);

Example Response

Array ( 
	[result] => success,
        [1] => Array
        (
            [id] => 1
            [fieldname] => custom field name
            [fieldtype] => text
            [description] => description
            [fieldoptions] => 
            [regexpr] =>
            [adminonly] => 
            [required] => 
            [showorder] => 
            [showinvoice] => 
            [value] => value
            [created_at] => 2019-01-19 18:00:00
            [updated_at] => 2019-01-20 11:16:43
        )

        [custom field name] => Array
        (
            [id] => 1
            [fieldname] => custom field name
            [fieldtype] => text
            [description] => description
            [fieldoptions] => 
            [regexpr] =>
            [adminonly] => 
            [required] => 
            [showorder] => 
            [showinvoice] => 
            [value] => value
            [created_at] => 2019-01-19 18:00:00
            [updated_at] => 2019-01-20 11:16:43
        )
	)

Error Responses

Error response codes are:

The relid is undefined
The type you selected does not exists. Please check
No custom fields were found

Got questions or problems? Contact us or comment, we’ll be happy to help.

Do not send Upcoming Domain Renewal Notice for “do not renew” domains

February 22, 2018/0 Comments/in Hooks /by ivan

WHMCS has what we think it’s a bug.

If one of your clients decides to not renew a domain you can see it in the domain page, having this checked:

Even if the client expressed he doesn’t want to renew the domain, WHMCS will still send the reminder email, which we think isn’t useful.

We created this free hook to avoid sending emails if the domain has been disabled for auto renew.

Simply download it and upload in includes/hooks folder of your whmcs installation. You don’t have to do anything else.

When The hook stops an email from being sent it creates a log in the user log (and the activity log as well) with this text:

Hook whmcstricks_do_not_send_reminder_email_for_cancelled_domains prevented email to be sent for domain

This way you can make a search and check when it took effect.

Related product required when opening a ticket

February 16, 2018/0 Comments/in Hooks /by ivan

WHMCS by default lets your customers pick a service, addon or domain when opening a ticket.

For some departments it could be useful to force this, setting the Related Service select required.

This is exactly what this hook does.

Installation and configuration

To install the hook simply upload the php file in the includes/hooks folder of your whmcs installation.

This hook requires the Custom module to manage hooks settings that you can download for free.

All you will have to do is to add a setting (whmcstricks_related_product_required_departments) with the departments names as the setting values.

The department names have to be comma separated (example: info, support) with or without the space. Make sure you’re using exactly the same name you’re using in whmcs, with a particular look on capital letters, since the script is case sensitive.

NOTE: if you’re using Dynamic Field Translations please make sure you add all the translations for the department to the setting, to make it work in every language.

Correct the scroll

If you’re using a fixed menu on top, the page will scroll, but most likely the field will remain below the menu. If this is the case with your theme you can set the setting “whmcstricks_related_product_required_full_scroll” to “true” (without the quotation marks). With this setting the page will scroll all the way to the top.

Latest News

Cancel invoice for terminated and cancelled services

WhmcsTricks email Status

E-mail Tracking

Ticket open tracking

Statistics

Pricing

Installation and Configuration

WHMCS API Update CustomFields

Parameters

Response Parameters

Example request (CURL)

Example Request (Local API)

Example Response

Error Responses

WHMCS API Get CustomFields

Parameters

Response Parameters

Example request (CURL)

Example Request (Local API)

Example Response

Error Responses

Do not send Upcoming Domain Renewal Notice for “do not renew” domains

Related product required when opening a ticket

Installation and configuration

Correct the scroll

Categories

WhmcsTricks

Recent Posts

Archive