Skip to main content

How to display payment sequences on invoices

Zuora

How to display payment sequences on invoices

The HTML Templates feature is generally available for invoices as of Zuora Release 2022.02.R2, and for credit and debit memos as of Zuora Release 2022.05.R1.

This article demonstrates how to display payment sequences on invoices. 

Assume an occasion when you have a product called Quality of Experience, which is a subscription-based software license. This product contains a product rate plan, lasting for three years. Within the product rate plan, the product sets up a product rate plan charge priced at $500.20, recurring quarterly. Your customer A starts a three-year subscription to this product rate plan charge, and an invoice of $500.20 is generated for the subscription per quarter through three years. Such a charge brings your customer A to 12 invoices in total.

To allow your customer A to know for which billing period each invoice is generated, HTML templates provide the capability of displaying something like "1 of 12" or "3 of 12" as payment sequences of invoices. For example, if the invoice is the third invoice among the overall 12 invoices, the invoice displays "3 of 12", indicating 9 payments are left.

In this scenario, you can use the HTML component in the HTML template editor to build charge details tables and use the expressions to calculate the payment sequences.

To display payment sequences on invoices, perform the following steps:

  1. In the Content tab of the HTML template editor, drag the Columns component into the HTML template.
    A column block is displayed in the HTML template. It is best practice to add it to the middle of the template.

  2. In the HTML template, click the Row block where you want to add the HTML code. 

  3. In the Content tab, drag the HTML component into the HTML template.

  4. In the HTML template, click the HTML block.
    The Content panel is displayed on the right of the template editor.

  5. In the HTML section, input the following HTML code in the HTML editor as an example.
    You can have your own table HTML code and use the expressions to calculate the payment sequence. You can refer to the description in the code example and the information that follows the code example.

    <style>
    <!-- not show all style code -->
    </style>
    {{#Invoice}}
    <table class="table-grid u_content_custom_generic_table_1">
    <thead><tr>
     <th style="width:auto; text-align:center;">
     Charge Name
     </th>
     <th style="width:auto; text-align:center;">
     Service Period
     </th>
     <th style="width:auto; text-align:center;">
     Payment Sequence
     </th>
     <th style="width:auto; text-align:right;">
     Unit Price
     </th>
     <th style="width:auto; text-align:right;">
     Quantity
     </th>
     <th style="width:auto; text-align:right;">
     Extended Price
     </th>
     <th style="width:auto; text-align:center;">
     Subscription Term
     </th></tr></thead>
    <tbody>
    {{#InvoiceItems}}
    <tr>
    <td style="width:auto; text-align:center;">{{ChargeName}}</td>
    <td style="width:auto; text-align:center;">{{ServiceStartDate|Localise}} - {{ServiceEndDate|Localise}}</td>
    <td style="width:auto; text-align:center;">
    <!-- calculate the Xth payment: X is the number of months between service start date and subscription term start date, divided by billing period →
    <!-- calculate total Y payments: Y is the number of months between subscription term start date and subscription term end date, divided by billing period -->
    {{#Wp_Eval}}
    1 + (new("java.text.SimpleDateFormat","yyyy-MM-dd").parse("{{ServiceStartDate}}").getYear() - new("java.text.SimpleDateFormat","yyyy-MM-dd").parse("{{Subscription.TermStartDate}}").getYear()) * 12 + (new("java.text.SimpleDateFormat","yyyy-MM-dd").parse("{{ServiceStartDate}}").getMonth() - new("java.text.SimpleDateFormat","yyyy-MM-dd").parse("{{Subscription.TermStartDate}}").getMonth()) / ("{{RatePlanCharge.BillingPeriod}}" == "Month" ? 1 : ("{{RatePlanCharge.BillingPeriod}}" == "Quarter" ? 3 : ("{{RatePlanCharge.BillingPeriod}}" == "Semi-Annual" ? 6 : ("{{RatePlanCharge.BillingPeriod}}" == "Annual" ? 12 : 24))))
    {{/Wp_Eval}}
     of
    {{#Wp_Eval}}
    ("{{Subscription.CurrentTermPeriodType}}" == "Year" ? {{Subscription.CurrentTerm}} * 12 : {{Subscription.CurrentTerm}}) / ("{{RatePlanCharge.BillingPeriod}}" == "Month" ? 1 : ("{{RatePlanCharge.BillingPeriod}}" == "Quarter" ? 3 : ("{{RatePlanCharge.BillingPeriod}}" == "Semi-Annual" ? 6 : ("{{RatePlanCharge.BillingPeriod}}" == "Annual" ? 12 : 24))))
    {{/Wp_Eval}}
    </td>
    <td style="width:auto; text-align:right;">{{Invoice.Account.Currency|Symbol}}{{UnitPrice|Round(2)|Localise}}</td>
    <td style="width:auto; text-align:right;">{{Quantity|Round(2)|Localise}}</td>
    <td style="width:auto; text-align:right;">{{Invoice.Account.Currency|Symbol}}{{ChargeAmount|Round(2)|Localise}}</td>
    <td style="width:auto; text-align:center;">{{Subscription.TermStartDate|Localise}} - {{Subscription.TermEndDate|Localise}}</td>
    </tr>
    {{/InvoiceItems}}
    </tbody>
    </table>
    {{/Invoice}}
    
    The expressions have the following constraints. If you have other billing periods, change the expressions.
    • Only the following billing periods are available:
      • Month
      • Quarter
      • Semi-Annual
      • Annual
    • You must set your subscription's term type to termed rather than evergreen.
    • Only the following subscription term period types are available:
      • Month
      • Year
  6. View the template in Edit mode.
    You can edit the HTML source to change the text, font size, font color, rotation, and opacity.

  7. Click Preview, and select an account and an invoice in the Preview Settings section to preview the corresponding PDF file.

The following image shows a charge details table displayed with payment sequences:

HTML_Template_Use_Case_Payment_Sequence.png