Difference between revisions of "PDF Invoice Customisation"

Revision as of 20:23, 11 February 2016

There are 2 invoice templates. One is for the client area invoice (viewinvoice.tpl). The other is for the PDF version of an invoice (invoicepdf.tpl). The templates are found in the active WHMCS template folder.

Modifying the Logo

The logo displayed on the PDF invoices is in the /assets/img/ folder. To change this logo, upload the required logo to the /assets/img/ folder. The name of the file should be "logo.jpg" or "logo.png".

The width of the logo image can be changed in the invoicepdf.tpl template file. On line 4, adjust the last number "75" before the closing bracket );. This variable defines the image width. A developer can then experiment increasing and decreasing it until happy.

Editing Text & Content

A developer can customise the PDF invoices. This includes adding or removing text, altering the layout or adding further images & formatting. Do this by editing the template file invoicepdf.tpl in the active template folder. The file contains all the code relating to the layout and display of the invoice in its PDF format. A basic working knowledge of PHP coding to understand and modify the file.

Displaying Custom Fields

It is possible to display Custom fields on printable and PDF invoices. Do this by ticking the Setup > Custom Client Fields > Show on Invoice option.

The following variables are available for use in the invoicepdf.tpl file. Obtain further data by running SQL queries from within the PHP template.

$invoiceid - The ID of the invoice.
$invoicenum - The custom number of the invoice (only set when proforma or sequential invoicing is enabled)
$datecreated - Creation Date of the invoice.
$duedate - Due date of the invoice.
$datepaid - Shows paid date/time if invoice status is Paid.
$userid - Client ID Number.
$clientsdetails["firstname"] - Client Info First Name.
$clientsdetails["lastname"] - Client Info Last Name.
$clientsdetails["companyname"] - Client Info Company Name.
$clientsdetails["fieldname"] - etc...
$clientsdetails["customfields1"] - Client Info Custom Field #1
$subtotal
$tax
$taxrate
$credit
$total
$status - Paid, Unpaid or Cancelled
$paymentmethod
$notes
$companyname - The Company Name
$companyurl - The Default Website URL
$companyaddress - The Company Address
$invoiceitems - Array of invoice items

Changing/Translating Filename

The default filename for invoices is Invoice-xxx. For quotes, this is Quote-xxx. For both, xxx is the ID of the invoice or quote. It may be desirable to change the filenames the clients see or translate into other languages. Achieve this in the same way as any text within WHMCS, by using the Language Files. Look for the strings:

$_LANG['invoicefilename'] = "Invoice-";
$_LANG['quotefilename'] = "Quote-";

Reducing the Filesize of PDFs

The bulk of the file size for PDFs generated by WHMCS come from the embedded font files for UTF-8. Because the UTF-8 charset has a large range of supported characters, this means it takes up more space than say the iso-8859-1 charset. Unlike UTF-8, iso-8859-1, only supports A-Z 0-9 and other standard characters.

If no clients are using special characters in their names/addresses then UTF-8 is not required. It is then possible to reduce the filesize of PDF's by changing the font. To do that, go to Setup > General Settings > Invoices > TCPDF Font. Once there, change the selection from "Freesans" to "Helvetica".

Additional Fonts

The use of certain special characters may not be available in the standard font. So, WHMCS supply an alternative font type that supports Czech, Russian, Arabic & Persian among others. To install:

Download the font files from the URL below.
Upload into the /vendor/tecnick.com/tcpdf/fonts/ (if you are using WHMCS 6.0 or 6.1) or /vendor/tecnickcom/tcpdf/fonts/ (if you are using WHMCS 6.2 or newer) folder.
Specify the custom font name dejavusans in Setup > General Settings > Invoices > TCPDF Font.

Troubleshooting

Accented Characters

Due to a PHP limitation, the translations of the "Paid" and "Unpaid" text on the PDF Invoices may not display upper-case accented characters.

Question Marks

Sometimes, question marks appear in the PDF files in place of non-Latin or accented characters. This can suggest the character is not supported by the font. The first thing to try is setting the font to "Freesans" in Setup > General Settings > Invoicing.

If the problem persists, please download and install "dejavusans" as described above Additional Fonts. This font pack contains more characters than standard ones so stands the best chance of working with these characters.

@@ Line 19: / Line 19: @@
 The following variables are available for use in the invoicepdf.tpl file. Obtain further data by running SQL queries from within the PHP template.
+*$invoiceid - The ID of the invoice.
+*$invoicenum - The custom number of the invoice (only set when proforma or sequential invoicing is enabled)
 *$datecreated - Creation Date of the invoice.
 *$duedate - Due date of the invoice.

Documentation