Skip to main content

Display custom fields on the invoice

Zuora

Display custom fields on the invoice

You can add custom fields to your invoice PDFs.

You can include custom fields from Accounts, Subscriptions, Invoice, Invoice Items, Payments, Refunds, Invoice Item Adjustments and Invoice Adjustments (Invoice Adjustment is deprecated on Production. Zuora recommends that you use the Invoice Item Adjustment instead.) on your Invoice PDF. To display custom fields on your invoice PDF template, enter the custom field API name in the appropriate place on the Invoice PDF template.These custom fields must be created in the Zuora user interface, where you can define the label, API name, and other values.

Supported fields

The following table lists which Region fields support custom fields in the invoice template.

Group and subtotal in nested tables is the only way you can sort by custom fields. For other cases, custom fields are not supported when using TableSort

Invoice PDF tables
(Region fields)

Custom fields in UI

Sample tag

Account

Account

<<Account.ReasonCode__c>>

BillToContact

Contact <<BillToContact.ReasonCode__c>>

SoldToContact

Contact <<SoldToContact.ReasonCode__c>>

Invoice

Invoice

<<Invoice.ReasonCode__c>>

InvoiceItem

InvoiceDetail

<<InvoiceItem.ReasonCode__c>>

Subscription

Subscription

<<Subscription.ReasonCode__c>>

UsageSummary

Not Supported

N/A

Usage

Usages

<<Usage.ReasonCode__c>>

TaxSummary

Not Supported

N/A

TaxItem

Not Supported

N/A

Transaction

  1. Invoice
  2. Invoice Adjustment
  3. Refund
  4. Payment
  5. Invoice Item Adjustment

<<Transaction.Mapping: InvoiceAdjustment.ReasonCode__c,
InvoiceItemAdjustment.ReasonCode__c,Invoice.ReasonCode__c,
Payment.ReasonCode__c,Refund.ReasonCode__c>>

PreviousTransaction

  1. Invoice
  2. Invoice Adjustment
  3. Refund
  4. Payment
  5. Invoice Item Adjustment

<<Transaction.Mapping: InvoiceAdjustment.ReasonCode__c,
InvoiceItemAdjustment.ReasonCode__c,Invoice.ReasonCode__c,
Payment.ReasonCode__c,Refund.ReasonCode__c >>

OpenInvoice

Invoice

<<Invoice.ReasonCode__c>>