PDF Invoice Customisation - Revision history

SarahK at 17:41, 27 April 2022

2022-04-27T17:41:00Z

Show changes

SarahK at 18:11, 11 March 2022

2022-03-11T18:11:15Z

SarahK at 19:25, 10 January 2022

2022-01-10T19:25:09Z

PeterM: /* Editing Text and Content */

2021-09-21T11:34:11Z

‎Editing Text and Content

SarahK at 23:07, 20 November 2020

2020-11-20T23:07:55Z

Show changes

SarahK at 19:58, 4 August 2020

2020-08-04T19:58:28Z

SarahK at 13:59, 30 April 2020

2020-04-30T13:59:28Z

Show changes

DanR: /* Question Marks */ Typo

2019-09-22T17:08:02Z

‎Question Marks: Typo

PeterB: DOCS-6865

2019-08-27T12:31:16Z

DOCS-6865

Matt: /* Additional Fonts */

2019-02-11T16:07:00Z

‎Additional Fonts

@@ Line 91: / Line 91: @@
 In both of these filenames, <tt>xxx</tt> is the ID of the invoice or quote.
-To change or translate these, use  the WHMCS [[language files]]. When you do this, look for these lines:
+To change or translate these, use  the WHMCS [[Language Files|language files]]. When you do this, look for these lines:
 <div class="source-cli">

@@ Line 1: / Line 1: @@
-There are two invoice templates. One is for the system theme invoice template ('''viewinvoice.tpl'''). The other is for the PDF version of an invoice ('''invoicepdf.tpl'''). The template files are in the active WHMCS system theme template folder.
+You can customize both invoice and quote PDF files using a template file system. You can find these files in the <tt>templates</tt> directory of the active WHMCS system theme.
-−
-==Modifying the Logo==
+==Template Files==
-−
-The logo 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 <tt>logo.jpg</tt> or <tt>logo.png</tt>.
+There are two invoice templates:
+* <tt>templates/viewinvoice.tpl</tt> controls the system theme invoice template.
-You can change the width of the logo image in the <tt>invoicepdf.tpl</tt> template file. On line 10, adjust the last number (<tt>75</tt>) before the closing bracket (<tt>);</tt>). This variable defines the image width. A developer can then increase or decrease this.
+* <tt>templates/invoicepdf.tpl</tt> controls the PDF version of the invoice.
-−
-==Header & Footer==
+The <tt>templates/quotepdf.tpl</tt> file controls quote PDFs.
-−
-<div class="docs-alert-info">
+==Header and Footer==
-<i class="fa fa-info-circle"></i>
-This section describes a feature available in WHMCS 7.0 and above.
+<div class="docs-alert-info">This section describes a feature available in version 7.0 and above.</div>
 </div>
+It is possible to cause a header or footer to automatically repeat on every page of a multi-page PDF invoice or quote by updating the header and footer templates.
 It is possible to cause a header or footer to automatically repeat on every page of a multi-page PDF invoice. If they are present in your theme, the system will include the following system theme template files for every rendered PDF page:
 * <tt>invoicepdfheader.tpl</tt>
@@ Line 22: / Line 25: @@
 During template processing, Smarty will provide each of these system theme template files with the same variables as <tt>invoicepdf.tpl</tt>.
 ==Editing Text and Content==
-A developer can customise the PDF invoices. This includes adding or removing text, altering the layout, or adding further images and formatting. Do this by editing the <tt>invoicepdf.tpl</tt> system theme template file in the active template folder. The file contains all the code relating to the layout and display of the invoice in its PDF format. You will need a basic working knowledge of PHP coding to understand and modify the file.
+A developer can customise the contents of PDF invoices and quotes. This includes adding or removing text, altering the layout, or adding further images and formatting. Do this by editing the <tt>invoicepdf.tpl</tt> or <tt>quotepdf.tpl</tt> system theme template files in the active template folder. The file contains all of the code relating to the layout and display in the PDF file.
-<div class="docs-related-pages">
+<div class="docs-alert-success">
 The system generates PDFs using TCPDF. For more information, see the [https://tcpdf.org/ TCPDF website].
 </div>
-==Displaying Custom Fields==
+===Adding Custom Fields===
-It is possible to display custom fields on printable and PDF invoices. To do this, select '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Custom Fields > Show on Invoice''' or, prior to WHMCS 8.0, '''Setup > Custom Client Fields > Show on Invoice'''.
+To display custom fields on printable and PDF invoices, go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Custom Fields]]''' and select '''Show on Invoice'''.
 The following variables are available for use in the <tt>invoicepdf.tpl</tt> file:
-−
 * <tt>$invoiceid</tt> — The ID of the invoice.
-* <tt>$invoicenum</tt> — The custom number of the invoice (only set this when you have enabled proforma or sequential invoicing).
+* <tt>$invoicenum</tt> — The custom number of the invoice. Only set this when you have enabled proforma or sequential invoicing.
 * <tt>$datecreated</tt> — The creation date of the invoice.
 * <tt>$duedate</tt> — The due date of the invoice.
@@ Line 61: / Line 81: @@
 * <tt>$invoiceitems</tt> — An array of invoice items.
-Obtain further data by running SQL queries from within the PHP template.
+You can retrieve more data by running SQL queries from within the PHP template.
-==Changing/Translating Filename==
+==Changing or Translating Filenames==
-−
-The default filename for invoices is <tt>Invoice-xxx</tt>. For quotes, this is <tt>Quote-xxx</tt>. For both, <tt>xxx</tt> is the ID of the invoice or quote. It may be desirable to change the filenames the clients see or translate it into other languages. Achieve this in the same way as any text within WHMCS, by using the [[Language Files]]. Look for these strings:
+Invoices and quotes have default generated filename formats:
 <div class="source-cli">

@@ Line 28: / Line 28: @@
 <div class="docs-related-pages">
-The system generates PDFs using TCPDF. See the [https://tcpdf.org/docs/srcdoc/TCPDF/class-TCPDF/ full list of functions] to build this.
+The system generates PDFs using TCPDF. For more information, see the [https://tcpdf.org/ TCPDF website].
 </div>
-−
 ==Displaying Custom Fields==

@@ Line 29: / Line 29: @@
 ==Displaying Custom Fields==
-It is possible to display custom fields on printable and PDF invoices. To do this, select the '''Setup > Custom Client Fields > Show on Invoice''' option.
+It is possible to display custom fields on printable and PDF invoices. To do this, select '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Custom Fields > Show on Invoice''' or, prior to WHMCS 8.0, '''Setup > Custom Client Fields > Show on Invoice'''.
 The following variables are available for use in the invoicepdf.tpl file. Obtain further data by running SQL queries from within the PHP template.
@@ Line 68: / Line 68: @@
 The bulk of the file size for PDFs that WHMCS generates 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, for example, the ISO-8859-1 character set. 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 or addresses, the system does not require UTF-8. It is then possible to reduce the size of PDF files by changing the font. To do that, go to '''Setup > General Settings > Invoices > PDF Font Family'''. Then, change the selection from "Freesans" to "Helvetica".
+If no clients are using special characters in their names or addresses, the system does not require UTF-8. It is then possible to reduce the size of PDF files by changing the font. To do that, go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings > Invoices > PDF Font Family''' or, prior to WHMCS 8.0, '''Setup > General Settings > Invoices > PDF Font Family'''. Then, change the selection from "Freesans" to "Helvetica".
 ==Additional Fonts==
@@ Line 79: / Line 79: @@
 To make this change:
-# Navigate to '''Setup > General Settings > Invoices tab'''.
+# Navigate to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings > Invoices''' or, prior to WHMCS 8.0, '''Setup > General Settings > Invoices'''.
 # Select the "Dejavusans" option for the ''PDF Font Family'' setting.
 # Click Save Changes.
@@ Line 88: / Line 88: @@
 # Download the font files from the URL below.
 # Upload into the '''/vendor/tecnickcom/tcpdf/fonts/''' folder.
-# Specify the custom font name ''dejavusans'' in '''Setup > General Settings > Invoices > PDF Font Family'''.
+# Specify the custom font name ''dejavusans'' in '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings > Invoices > PDF Font Family''' or, prior to WHMCS 8.0, '''Setup > General Settings > Invoices > PDF Font Family'''.
 <div class="docs-related-pages">https://www.whmcs.com/download/106/dejavusans_tcpdf_font</div>
@@ Line 102: / Line 102: @@
 ===Question Marks===
-Sometimes, question marks appear in the PDF files in place of non-Latin or accented characters. This can suggest that the font doesn't support the character. The first thing to try is setting the font to "Freesans" in '''Setup > General Settings > Invoices'''.
+Sometimes, question marks appear in the PDF files in place of non-Latin or accented characters. This can suggest that the font doesn't support the character. The first thing to try is setting the font to "Freesans" in '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings > Invoices''' or, prior to WHMCS 8.0, '''Setup > General Settings > Invoices'''.
 If the problem persists, download and install "dejavusans" using the steps in [[#Additional_Fonts|Additional Fonts]]. This font pack contains more characters than standard ones, so it is likely to work with these characters.

@@ Line 92: / Line 92: @@
 ===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'''.
+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 > Invoices'''.
 If the problem persists, please download and install "dejavusans" as described above [[#Additional_Fonts|Additional Fonts]]. This font pack contains more characters than standard ones so stands the best chance of working with these characters.

@@ Line 43: / Line 43: @@
 *$clientsdetails["companyname"] - Client Info Company Name
 *$clientsdetails["fieldname"] - etc...
-*$clientsdetails["customfields1"] - Client Info Custom Field #1
+*$customfields - An array of Client Custom Fields (e.g. $customfields['Custom Field Name']) - See [[Easy Translation]] for dynamically translating Custom Field Names.
 *$subtotal
 *$tax

@@ Line 84: / Line 84: @@
 # Specify the custom font name ''dejavusans'' in '''Setup > General Settings > Invoices > PDF Font Family'''.
-<div class="docs-related-pages">http://www.whmcs.com/download/106/dejavusans_tcpdf_font</div>
+<div class="docs-related-pages">https://www.whmcs.com/download/106/dejavusans_tcpdf_font</div>
 ==Troubleshooting==