Skip to main content

Configuring HTML invoice templates

Zuora

Configuring HTML invoice templates

The HTML Templates feature is in the Early Adopter phase for invoices. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at Zuora Global Support.

The HTML Templates feature provides key capabilities to design and customize HTML invoice templates using an online editor. All public objects and fields are available for presence on the template, including custom objects and custom fields. 

Zuora provides an online HTML template editor for you to flexibly manage HTML invoice templates according to business demands.

Overview

You can switch between the Edit mode and Preview mode in the online HTML template editor.

The online HTML template editor in Edit mode mainly consists of the following tabs to provide customization capabilities: the Contents tab, Blocks tab, and Body tab.

  • In the Contents tab, you can drag and drop different components from the tab to the editor to define content components included in templates.
  • In the Blocks tab, you can easily define the headers and footers used in the template. You can also use pre-built design blocks to organize your template content flexibly.
  • In the Body tab, you can configure different settings to customize the default overall template style and appearance, including the text color, background color, content alignment, and font.

In Preview mode, you can select an account and an invoice to preview the PDF file online. See Preview invoices in HTML templates for more information.

Function comparison

Compared to Mail Merge templates, HTML templates provide a variety of advanced features. HTML templates can coexist with Mail Merge templates. You can assign HTML templates to a subset of accounts, and Mail Merge templates to another subset of accounts.

The following table lists the function comparisons between HTML templates and Mail Merge templates.

Functionality Mail Merge templates HTML templates
Online editor with Drag & Drop and Preview functionality Not supported Supported
Optimized update and test cycle 14 steps 4 steps
Data access to Zuora objects and fields Limitedly supported Fully supported
Custom objects Not supported Supported
Data manipulation including grouping, filtering, sorting, and so on Limited fields Any fields
Localizing fields in types of Number, Date, Currency Limitedly supported Fully supported
Pre-built headers and footers Not supported Supported
Starter template library Limitedly supported, available in the Knowledge Center Supported, available online
Embedded images and external image URLs Not supported Supported
Template management through Setting APIs Limitedly supported Fully supported

Restrictions and limitations

The HTML Templates feature has the following restrictions and limitations, specific to one single template:

  • Template size
    • Maximum size of an HTML template: 5Mb
      The uploaded images will be encoded and embedded into the HTML template, so they also contribute to the template size.
  • Data
    • Maximum number of items that can be displayed in a table: 100,000
    • Maximum number of records being processed in total: 1 million (the total records to load to generate the invoice)
  • Images
    • Maximum number of uploaded images: 20
    • Maximum size of an image to be uploaded: 200 Kb
    • Supported image types: APNG (.apng), AVIF (.avif), GIF (.gif), JPG (.jpg), JPEG (.jpeg), JFIF (.jfif), PJPEG (.pjpeg), PJP (.pjp), PNG (.png), SVG (.svg), and WEBP (.webp)
  • Functions
    • Maximum number of fields supported by the SortBy function: 3
    • Maximum number of fields supported by the GroupBy function: 3
  • Text
    • Multibyte characters, such as Japanese, Chinese, and Russian characters
      • Inputting multibyte characters in HTML templates is not supported. 
        For example, if you input Japanese characters as field names or table header names, saving the corresponding template fails. 
      • The values rendered from merge fields support multibyte characters. 
        For example, if the bill to contact addresses or charge names are in Japanese, they can be displayed correctly in generated invoice PDF files.