Merge fields for invoices
In most cases, the field definitions are self-evident, based on the fields of the user interface. Additional descriptions are provided as needed.
See Merge Fields Supported in IF Fields on Invoice Templates for information about which merge fields can be used in Conditional Logic (IF Fields).
Customer Account Fields
| Merge Field | Description |
|---|---|
|
Account.AccountNumber |
The unique account number assigned to the account being created. Example: A000842911 This field cannot be translated. |
|
Account.Autopay |
Indicates if future payments are automatically collected when they're due during a Payment Run. |
|
Account.Balance |
Zuora recommends that you use the Previous Balance and New Balance instead of this field. Previous account balance at time of invoice generation. Does not include any charges from this invoice as this invoice is in draft mode. Example: $304.50 |
|
Account.BillCycleDay |
Indicates the account's billing cycle day (BCD), which is when the bill runs generate invoices for the account. Type: int Example: 1st of the month |
|
Account.BillingBatch |
A batch organizes your customer accounts into groups to optimize your billing and payment operations. Values: any system-defined batch ( Example: Batch1 |
| Account.CompanyCode |
Unique code that identifies a company account in Avalara. Corresponds to:
Example: CCAPAC This field cannot be translated. |
|
Account.CreditBalance |
Credit balance of the customer account. This functionality is permission-controlled. Contact Zuora for more information about enabling credit balance features. Example: $12.30 |
|
Account.CrmId |
The CRM account ID for the account. A CRM is a customer relationship management system, such as Salesforce.com. Values: a string of 100 characters or fewer Example: 912D24U2482904820948 This field cannot be translated. |
|
Account.Currency |
The currency that invoices associated with the account are paid with. Example: USD |
|
Account.CustomerSupportRepName |
The name of the account's customer service representative, if applicable. Example: Melanie Dolgachev |
|
Account.DefaultPaymentMethod |
The ID of the default payment method for the account. This field is required if the AutoPay field is set to Example: CreditCard |
|
Account.MRR |
This is the Monthly Recurring Revenue for the Account. This value is the sum of all subscription MRRs. Example: $316.80 |
|
Account.Name |
The name of the account. The account name displays on lists of accounts in the web-based UI. Example: Super Subscription Emporium |
|
Account.NewBalance |
This field is the Example: $304.50 |
|
Account.Notes |
Use this field to record comments about the account. Example: Platinum Customer |
| Account.Parent.Name |
The parent account name of the current account. You can specify the parent account name in the account detail page. This merge field correlates with the Customer Hierarchy feature. The Customer Hierarchy feature is in Limited Availability. If you wish to have access to the feature, submit a request at Zuora Global Support. Example: Finance Dept |
|
Account.PaymentTerm |
Indicates when the customer pays for subscriptions. Example: Due Upon Receipt |
|
Account.PaymentMethodMandateId |
The ID of the mandate. A mandate is a signed authorization for UK and NL customers. This field is used only for the direct debit payment method. Example: CCJW9VR |
|
Account.PreviousBalance |
The previous account balance is a dynamic field that is the account balance for draft invoices or the current account balance less the invoice balance when the invoice is posted. This field is needed for some invoice presentation rules as the Account Balance field on the customer account does not include draft invoices. Example: $0.00 |
|
Account.PreviousTransactionImpactTotal |
The sum of all rows that appear in the Previous Transactions table based on specific table filters, such as LastInvoice or UptoDaysOld. Example: $0.00 |
|
Account.PreviousTransactionStartAmount |
The Starting Balance with respect to the Previous Transaction table. The difference of Example: $0.00 |
|
Account.PurchaseOrderNumber |
The number of the purchase order associated with this account. Purchase order information generally comes from customers. This field cannot be translated. Example: PO102925 |
|
Account.SalesRep |
The name of the sales representative associated with this account, if applicable. Example: Travis Huch |
|
Account.TaxExempt |
The status of the account's tax exemption.
Example: Pending Verification You must use this field if you use Zuora Tax. This field is unavailable if you don't use Zuora Tax. |
|
Account.TaxExemptCertificateID |
The ID of your customer's tax exemption certificate. Example: CA8592555 This field cannot be translated. Requires Zuora Tax. |
|
Account.TaxExemptCertificateType |
The type of the tax exemption certificate that your customer holds. Example: Reseller Permit Requires Zuora Tax. |
|
Account.TaxExemptDescription |
A description of the tax exemption certificate that your customer holds. Example: Fax ID: 1031374242 Requires Zuora Tax. |
|
Account.TaxExemptEffectiveDate |
Date when the the customer's tax exemption starts. Corresponds to the TaxExemptEffectiveDate field on the Account SOAP API object. Example: 01/01/2016 |
|
Account.TaxExemptExpirationDate |
Date when the customer's tax exemption ends. Corresponds to the TaxExemptExpirationDate field on the Account SOAP API object. Example: 12/31/2016 |
|
Account.TaxExemptIssuingJurisdiction |
Indicates the jurisdiction in which the customer's tax exemption certificate was issued. Example: California Requires Zuora Tax. |
|
Account.VATID |
Customer’s Value Added Tax (VAT) ID. Corresponds to:
Example: VATID12345 This field cannot be translated. |
Bill To Contact Fields
The Bill To Contact is the person that you would like to bill or send the invoice to.
| Merge Field | Description |
|---|---|
|
BillToContact.Address1 |
Bill To Contact's street address Example: 678 Evergreen Terrace |
|
BillToContact.Address2 |
Bill to Contact's second address line Example: 2nd Floor |
|
BillToContact.City |
Bill to Contact's city of residence Example: Springfield |
|
BillToContact.Country |
Bill to Contact's country of residence Example: United States |
|
BillToContact.County |
Bill to Contact's county of residence Example: Providence Only available to users of Zuora Tax. |
|
BillToContact.Description |
Description of Bill to Contact's user status Example: Certified User Only available to users of Zuora Tax. |
|
BillToContact.Fax |
Bill to Contact's fax number Example: 1-213-555-1234 |
|
BillToContact.FirstName |
Bill to Contact's first name Example: Stewart |
|
BillToContact.HomePhone |
Bill to Contact's home phone number Example: 1-213-555-4141 |
|
BillToContact.LastName |
Bill to Contact's last name Example: Griffin |
|
BillToContact.MobilePhone |
Bill to Contact's mobile phone number Example: 1-213-555-5656 |
|
BillToContact.NickName |
Bill to Contact's last name Example: Stewie |
|
BillToContact.OtherPhone |
Bill to Contact's other phone number Example: 1-310-555-1212 |
|
BillToContact.OtherPhoneType |
Bill to Contact's other phone type Example: Other |
|
BillToContact.PersonalEmail |
Bill to Contact's personal email Example: Stewart@testemail.com |
|
BillToContact.PostalCode |
Bill to Contact's postal code Example: 86441 |
|
BillToContact.State |
Bill to Contact's state of residence Example: Illinois |
|
BillToContact.TaxRegion |
Bill to Contact's transportation district Example: Transportation District Only available to users of Zuora Tax. |
|
BillToContact.WorkEmail |
Bill to Contact's work email Example: stewart@test.com |
|
BillToContact.WorkPhone |
Bill to Contact's work phone number Example: 1-213-555-1212 |
Sold To Contact Fields
The Sold To Contact is person that you have sold your product or services to. This person can be the same as the Bill To Contact.
| Merge Field | Description |
|---|---|
|
SoldToContact.Address1 |
Sold to Contact's street address Example: 123 Main Street |
|
SoldToContact.Address2 |
Sold to Contact's second address line Example: Suite 100 |
|
SoldToContact.City |
Sold to Contact's city of residence Example: Quahog |
|
SoldToContact.Country |
Sold to Contact's country of residence Example: United States |
|
SoldToContact.County |
Sold to Contact's county of residence Example: Madison Only available to users of Zuora Tax. |
|
SoldToContact.Description |
Sold to Contact's description Example: Decision Maker Only available to users of Zuora Tax. |
|
SoldToContact.Fax |
Sold to Contact's fax number Example: 1-809-555-1234 |
|
SoldToContact.FirstName |
Sold to Contact's first name Example: Marge |
|
SoldToContact.HomePhone |
Sold to Contact's home phone number Example: 1-567-555-4141 |
|
SoldToContact.LastName |
Sold to Contact's last name Example: Simpson |
|
SoldToContact.MobilePhone |
Sold to Contact's mobile phone number Example: 1-893-555-5656 |
|
SoldToContact.NickName |
Sold to Contact's nickname Example: Big Blue Hair |
|
SoldToContact.OtherPhone |
Sold to Contact's other phone number Example: 1-212-555-1212 |
|
SoldToContact.OtherPhoneType |
Sold to Contact's other phone type Example: Other |
|
SoldToContact.PersonalEmail |
Sold to Contact's personal email address Example: Marge@testemail.com |
|
SoldToContact.PostalCode |
Sold to Contact's postal code Example: 78213-9781 |
|
SoldToContact.State |
Sold to Contact's state of residence Example: Rhode Island |
|
SoldToContact.TaxRegion |
Sold to Contact's tax region Example: Nuclear Tax District Only available to users of Zuora Tax. |
|
SoldToContact.WorkEmail |
Sold to Contact's work email address Example: Marge@test.com |
|
SoldToContact.WorkPhone |
Sold to Contact's work phone number Example: 1-707-555-1212 |
Invoice Fields
| Merge Field | Description |
|---|---|
| Invoice.Adjustment |
Total of all Invoice Adjustments for this invoice. This does not include Invoice Item or Credit Balance Adjustments. Note: Invoice Adjustment is deprecated on Production. Zuora recommends that you use the Invoice Item Adjustment to adjust invoices. Example: ($15.00) |
|
Invoice.AmountWithoutTax |
Subtotal of all charges without any taxes. Example: $754.00 |
|
Invoice.Balance |
Invoice Balance as of invoice generation. Example: $306.80 |
|
Invoice.BillRunID |
The ID of the bill run where the invoice is generated. Example: BR-132399 If Unified Invoicing is enabled, standalone invoices are not generated from bill runs, so the value of this field is empty |
|
Invoice.Comments |
Example: Thank you for your business! Please contact us if you have any questions about your invoice! |
| Invoice.CreditMemoAmount |
Total amount of the credit memos that are applied to the invoice. Example: $500.00 Only available to users of Invoice Settlement. |
|
Invoice.Discount |
Total amount of discount charges. Example: ($8.00) |
|
Invoice.DueDate |
Example: 02/01/2009 |
| Invoice.FileVersionNumber |
Invoice PDF file version number. This field is available for new PDF files generated in R186 or later. Example: 1423786755800 This field cannot be translated. |
|
Invoice.GrossAmount |
Total of charge gross amount that is pre-discount and pre-tax. Example: $762.00 |
|
Invoice.InvoiceDate |
Example: 02/01/2009 |
|
Invoice.InvoiceNumber |
Example: Inv-549241 This field cannot be translated. |
|
Invoice.PaymentAmount |
Total payments associated with the invoice. Example: $400.00 |
|
Invoice.Tax |
Total of all taxes for this invoice. Example: $12.80 |
|
Invoice.Total |
Total charges and taxes for this invoice. Example: $766.80 |
|
Invoice.RefundAmount |
Total refunds for this invoice. Example: $300.00 |
|
Invoice.SubTotalOneTimeChargeAmount |
Subtotal of Invoice Items that were generated from One Time charges. This value does not include any associated discounts or any associated taxes. Example: $168.80 |
|
Invoice.NetTotalOneTimeChargeAmount |
This value includes any associated discounts, but does not include any associated taxes. Example: $166.80 |
|
Invoice.TotalOneTimeChargeAmount |
This value includes any associated discounts and also includes any associated taxes. Example: $169.60 |
|
Invoice.SubTotalRecurringChargeAmount |
Subtotal of Invoice Items that were generated from Recurring charges. This value does not include any associated discounts or any associated taxes. Example: $400.00 |
|
Invoice.NetTotalRecurringChargeAmount |
This value includes any associated discounts, but does not include any associated taxes. Example: $397.00 |
|
Invoice.TotalRecurringChargeAmount |
This value includes any associated discounts and also includes any associated taxes. Example: $403.00 |
|
Invoice.SubTotalUsageChargeAmount |
Subtotal of Invoice Items that were generated from Usage charges. This value does not include any associated discounts or any associated taxes. Example: $300.00 |
|
Invoice.NetTotalUsageChargeAmount |
This value includes any associated discounts, but does not include any associated taxes. Example: $297.00 |
|
Invoice.TotalUsageChargeAmount |
This value includes any associated discounts and also includes any associated taxes. Example: $301.00 |
|
Invoice.NetPaymentAmount |
Net Payments associated to this invoice (Payments - Refunds). Example: $100.00 |
|
Invoice.TaxInvoiceItemAdjustmentAmount |
The sum of all invoice item adjustments that were associated to taxation items. Example: ($10.00) |
|
Invoice.ChargeInvoiceItemAdjustmentAmount |
The sum of all invoice item adjustments that were associated to charges. Example: ($20.00) |
|
Invoice.InvoiceItemAdjustmentAmount |
The sum of all invoice item adjustments that were associated to this invoice (includes both charge and tax). Example: ($30.00) |
|
Invoice.CreditBalanceAdjustmentAmount |
This is the sum of all Credit Balance Adjustments associated to this invoice. These can be applied to the invoice and/or transferred from the invoice. Example: ($5.00) |
|
Invoice.TotalInvoiceAdjustmentAmount |
Sum of invoice adjustments and invoice item adjustments. Example: ($45.00) |
|
Invoice.TotalAdjustmentAmount |
Sum of invoice adjustments and invoice item adjustments and credit balance adjustments. Example: ($50.00) |
|
Invoice.CreditBalanceIncreaseAmount |
Total credit balance adjustment increases. Example: $0.00 |
|
Invoice.CreditBalanceDecreaseAmount |
Total credit balance adjustment decreases. Example: $5.00 |
| Invoice.SequenceNumber |
The invoice number excluding the prefix. Example: 00000001 |
Invoice Item Fields
Zuora supports multi-level nested tables within the invoice items table.
If you enable Unified Invoicing, the values of some Invoice Item fields depend on the source of the corresponding taxation item.
You can customize your invoice templates to display invoice items in nested tables. In nested tables, you can group and subtotal complex invoice items by any custom fields from the associated product rate plan charge or rate plan charge. For more information, see Grouping and Subtotal Functions in Nested Tables.
Advanced custom fields cannot be used with Word Template. Similarly, custom fields created using Object Manage cannot be utilized with Mail Merge Template.
| Merge Field | Subscription invoice Item | Invoice Item from ProductRatePlanCharge | Standalone invoice item |
|---|---|---|---|
|
InvoiceItem.AccountName |
The account name of the subscription owner Example: Super Subscription Emporium |
empty | empty |
|
InvoiceItem.AccountNumber |
The account number of the subscription owner Example: A00010085 This field cannot be translated. |
empty | empty |
|
InvoiceItem.ActualQuantity |
The quantity of the units that the customer consumed during the billing period. Type: Number Example: 4 Note: Extra invoice items might be generated in the invoice to display the overage information. In such cases, this field returns the value, 0. For example, you provide a monthly service:
If your customer consumed 400 minutes in a month:
If your customer consumed 1000 minutes in a month:
|
0 | 0 |
|
InvoiceItem.AmountWithoutTax |
Example: $150.00 |
||
|
InvoiceItem.ChargeAccountingCode |
The accounting code of the invoice item. Example: A81291-OneTimeFees |
The accounting code of the invoice item. | The accounting code of the invoice item. |
|
InvoiceItem.ChargeDate |
Example: 01/01/2009 |
||
|
InvoiceItem.ChargeModel |
Example: Per Unit Pricing |
empty | empty |
|
InvoiceItem.ChargeNumber |
Example: C-000004 This field cannot be translated. |
empty | empty |
|
InvoiceItem.ChargePeriod |
Example: Month |
empty | empty |
|
InvoiceItem.ChargeType |
Example: One-Time |
empty | empty |
|
InvoiceItem.Description |
The charge description. Example: One Time Fee |
||
| InvoiceItem.DiscountAmount |
The discount amount of the invoice item. You can use the Example: $-1.50 |
||
| InvoiceItem.DiscountTaxAmount |
The discount tax amount of the invoice item. You can use the Example: $-0.50 |
||
|
InvoiceItem.ExtendedPrice |
Total item charge including taxes. Example: $162.00 |
||
| InvoiceItem.IsNew |
Indicates whether the invoice item charges are displayed in the most recently posted invoice. Supported values are:
Example: true or false |
false |
false |
|
InvoiceItem.ListPrice |
Example: Tier / From / To / List Price / Price Format |
empty | empty |
| InvoiceItem.ListPriceBase |
List price base of the charge. Supported values are:
|
empty | empty |
|
InvoiceItem.Name |
Charge Name Example: Best Product Ever - Gold Edition: Activation Fee |
||
|
InvoiceItem.ProductDescription |
The item description in the product catalog. Example: Includes so many features |
The description of the product associated with this invoice item. |
empty |
|
InvoiceItem.ProductName |
The name of the product associated with this invoice item. Example: Best Product Ever |
The name of the product associated with this invoice item. |
empty |
| InvoiceItem.ProductRatePlanCharge.CustomField |
The custom field of the product rate plan charge associated with this invoice item. Example: Comments about the product rate plan charge |
The custom field of the product rate plan charge associated with this invoice item. | empty |
|
InvoiceItem.Quantity |
The quantity of units that the customer consumed during the billing period. Type: Number Example: 3 Note: For overage invoice items:
For example, you provide a monthly service:
If your customer consumed 400 minutes in a month:
If your customer consumed 1000 minutes in a month:
|
||
| InvoiceItem.RatePlanCharge.CustomField |
The custom field of the rate plan charge associated with this invoice item. Example: Comments about the rate plan charge |
||
|
InvoiceItem.RatePlanDescription |
Example: Gold Edition includes all features from the Silver Edition |
empty | empty |
|
InvoiceItem.RatePlanName |
Example: Best Product Ever - Gold Edition |
empty | empty |
|
InvoiceItem.RevenueRecognitionCode |
The revenue recognition accounting code on this invoice item, so the value is empty. SubscriptionComponent.Revrec.Code Example: 1Year_Straightline |
The revenue recognition accounting code on this invoice item. invoiceItem.RevRecCode |
The revenue recognition accounting code on this invoice item. invoiceItem.RevRecCode |
|
InvoiceItem.ServicePeriod |
This field is a text field and is sorted in alphabetical order. Example: 01/31/2009-01/31/2009 |
||
|
InvoiceItem.ServiceStartDate |
Type: Date Example: 01/31/2009 |
||
|
InvoiceItem.ServiceEndDate |
Type: Date Example: 01/31/2009 |
||
|
InvoiceItem.Sku |
Example: SKU-18412 This field cannot be translated. |
||
|
InvoiceItem.SubscriptionNotes |
Example: Notes about the Subscription |
empty | empty |
|
InvoiceItem.SubscriptionNumber |
Example: 82419391339-ABC This field cannot be translated. |
empty | empty |
|
InvoiceItem.TaxAmount |
Subtotal of taxes associated with the invoice item. Only available to users of Zuora Tax. Example: $12.00 |
||
|
InvoiceItem.UnitOfMeasure |
Example: Each |
||
|
InvoiceItem.UnitOfMeasureDisplayedAs |
UOM Display Name Example: Each |
||
|
InvoiceItem.UnitPrice |
The unit price of the rate plan charge associated with the invoice item. The value format varies depending on the item type:
|
The unit price of the invoice item. The value format varies depending on the item type:
|
The unit price of the invoice item. The value format varies depending on the item type:
|
| InvoiceItem.TaxCode |
The tax code name that is mapped to the product charge. Example: California 2019 |
||
| InvoiceItem.CustomField | If the table requires to group invoice item data (containing a groupBy tag), the value is the custom field of subscription charge. Otherwise, the value is from the invoice item. Therefore, when the table requires to group invoice item data, the value is empty. |
When it is not a group table, the value is the custom field of the invoice item. Otherwise, the value is empty. | When it is not a group table, the value is the custom field of the invoice item. Otherwise, the value is empty. |
| InvoiceItem.PurchaseOrderNumber | empty | The purchase order number that you provide for the invoice item. | The purchase order number that you provide for the invoice item. |
| InvoiceItem.ItemType | empty | The item type that you provide for the invoice item. | The item type that you provide for the invoice item. |
Subscription Fields
| Merge Field | Description | Sort Order |
|---|---|---|
|
Subscription.Autorenew |
Example: true |
|
| Subscription.AmountWithoutTax |
Example: $754.00 |
|
| Subscription.ExtendedPrice |
Total charge including taxes Example: $766.80 |
|
|
Subscription.Notes |
Example: Notes about the Subscription |
|
| Subscription.Owner.BillToContact.Address1 |
Subscription Owner's Bill To Contact street address Example: 678 Evergreen Terrace |
|
| Subscription.Owner.BillToContact.Address2 |
Subscription Owner's Bill To Contact second address line Example: Suite 100 |
|
| Subscription.Owner.BillToContact.City |
Subscription Owner's Bill To Contact city of residence Example: Paris |
|
| Subscription.Owner.BillToContact.Country |
Subscription Owner's Bill To Contact country of residence Example: France |
|
| Subscription.Owner.BillToContact.County |
Subscription Owner's Bill To Contact county of residence Example: Madison Only available to users of Zuora Tax. |
|
| Subscription.Owner.BillToContact.FirstName | Subscription Owner's Bill To Contact first name
Example: Stewart |
|
| Subscription.Owner.BillToContact.LastName |
Subscription Owner's Bill To Contact last name Example: Griffin |
|
| Subscription.Owner.BillToContact.MobilePhone |
Subscription Owner's Bill To Contact phone number Example: 1-555-123-4567 |
|
| Subscription.Owner.BillToContact.PostalCode | Subscription Owner's Bill To Contact postal code
Example: 86441 |
|
| Subscription.Owner.BillToContact.State |
Subscription Owner's Bill To Contact state of residence Example: California |
|
| Subscription.Owner.BillToContact.WorkEmail |
Subscription Owner's Bill To Contact work email Example: Tyler@TestEmail.com |
|
| Subscription.Owner.BillToContact.WorkPhone |
Subscription Owner's Bill To Contact work phone Example: 1-232-415-9876 |
|
| Subscription.Owner.SoldToContact.Address1 |
Subscription Owner's Sold To Contact street address Example: 677 Maple Drive |
|
| Subscription.Owner.SoldToContact.Address2 |
Subscription Owner's Sold To Contact second address line Example: Suite 100 |
|
| Subscription.Owner.SoldToContact.City |
Subscription Owner's Sold To Contact city of residence Example: Chicago |
|
| Subscription.Owner.SoldToContact.Country |
Subscription Owner's Sold To Contact country of residence Example: United States |
|
| Subscription.Owner.SoldToContact.County |
Subscription Owner's Sold To Contact county of residence Example: Oneida Only available to users of Zuora Tax. |
|
| Subscription.Owner.SoldToContact.FirstName | Subscription Owner's Sold To Contact first name
Example: Hilliary |
|
| Subscription.Owner.SoldToContact.LastName | Subscription Owner's Sold To Contact last name
Example: Brown |
|
| Subscription.Owner.SoldToContact.MobilePhone |
Subscription Owner's Sold To Contact mobile phone number Example: 1-555-123-4567 |
|
| Subscription.Owner.SoldToContact.PostalCode | Subscription Owner's Sold To Contact postal code
Example: 94941 |
|
| Subscription.Owner.SoldToContact.State |
Subscription Owner's Sold To Contact state of residence Example: New York |
|
| Subscription.Owner.SoldToContact.WorkEmail |
Subscription Owner's Sold To Contact work email Example: Tomas@TestCompanycom |
|
| Subscription.Owner.SoldToContact.WorkPhone |
Subscription Owner's Sold To Contact work phone Example: 1-232-415-9876 |
|
|
Subscription.Product.Description |
Example: Includes so many features |
|
|
Subscription.Product.Name |
Example: Best Product Ever |
2 |
|
Subscription.Product.SKU |
Example: SKU-18412 This field cannot be translated. |
|
|
Subscription.RatePlan.Description |
Example: Gold Edition includes all features from the Silver Edition |
|
|
Subscription.RatePlan.Name |
Example: Best Product Ever - Gold Edition |
3 |
|
Subscription.SubscriptionNumber |
Example: 82419391339-ABC This field cannot be translated. |
1 |
| Subscription.TaxAmount | Subtotal of taxes associated with the Subscription or Rateplan.
Example: $12.80 Only available with Zuora Tax Engine. |
|
|
Subscription.TermEndDate |
Type: Date Example: 12/31/2009 |
|
|
Subscription.TermStartDate |
Type: Date Example: 01/01/2009 |
|
Usage Summary Fields
| Merge Field | Notes | Sort Order |
|---|---|---|
|
UsageSummary.AccountName |
The account name of the subscription owner Example: Super Subscription Emporium |
|
|
UsageSummary.AccountNumber |
The account number of the subscription owner Example: A000842911 This field cannot be translated. |
|
|
UsageSummary.AmountWithoutTax |
Type: Number Example: $10.00 |
|
|
UsageSummary.ChargeDescription |
Charge Description from the subscription Example: Usage Fee |
|
|
UsageSummary.ChargeModel |
Example: Per Unit Pricing |
|
|
UsageSummary.ChargeName |
Charge Name from the subscription Example: Best Product Ever - Gold Edition: Usage Fees |
|
|
UsageSummary.ChargeNumber |
Charge ID from subscription Example: C-000006 This field cannot be translated. |
4 |
|
UsageSummary.ExtendedPrice |
Type: Number Example: $10.80 |
|
|
UsageSummary.IncludedQuantity |
Type: Number Example: 19 |
|
|
UsageSummary.ListPrice |
Example: Tier / From / To / List Price / Price Format |
|
|
UsageSummary.OverageQuantity |
Type: Number Example: 0 |
|
|
UsageSummary.ProductDescription |
Example: Includes so many features |
|
|
UsageSummary.ProductName |
Example: Best Product Ever |
3 |
|
UsageSummary.ProductSKU |
Example: SKU-18412 This field cannot be translated. |
|
|
UsageSummary.Quantity |
Type: Number Example: 2 |
|
|
UsageSummary.RatePlanDescription |
Example: Gold Edition includes all features from the Silver Edition |
|
|
UsageSummary.RateDetail |
Usage charge data such as units consumed, price per unit and the total charge amount. The format depends on the pricing charge model of the usage charge. For amounts, the format, such as decimal places, is determined by the setting of the currency. |
|
|
UsageSummary.RatePlanName |
Example: Best Product Ever - Gold Edition |
|
|
UsageSummary.ServicePeriod |
The date range Example: 01/01/2009-01/31/2009 |
2 |
|
UsageSummary.ServiceStartDate |
Type: Date Example: 01/01/2009 |
|
|
UsageSummary.ServiceEndDate |
Type: Date Example: 01/31/2009 |
|
|
UsageSummary.SubscriptionNotes |
Example: Notes about the Subscription |
|
|
UsageSummary.SubscriptionNumber |
Example: 82419391339-ABC This field cannot be translated. |
1 |
|
UsageSummary.TaxAmount |
Subtotal of taxes associated with the usage summary. Example: $0.80 Only available to users of Zuora Tax. |
|
|
UsageSummary.UOM |
Example: Custom Objects |
|
|
UsageSummary.UOMDisplayedAs |
UOM Display Name Example: Custom Objects |
|
|
UsageSummary.UsagePeriod |
The type of period Example: Month |
|
Usage Lines (Items) Fields
Zuora supports multi-level nested tables within the usage items table.
You can customize your invoice templates to display usage items in nested tables. In nested tables, you can group and subtotal complex usage items by any supported merge fields or custom fields. For more information, see Grouping and Subtotal Functions in Nested Tables.
Advanced custom fields cannot be used with Word Template. Similarly, custom fields created using Object Manage cannot be utilized with Mail Merge Template.
| Merge Field | Description | Sort Order |
|---|---|---|
|
Usage.ChargeAccountingCode |
Example: A2411-UsageFees |
|
|
Usage.ChargeDescription |
Usage Description Field Example: Objects: Krusty Burger Special |
4 |
|
Usage.ChargeName |
Charge Name from the subscription Example: Best Product Ever - Gold Edition: Usage Fees |
|
|
Usage.ChargeNumber |
Charge ID from subscription Example: C-000006 This field cannot be translated. |
2 |
|
Usage.Date |
Type: Date Example: 01/16/2009 |
3 |
|
Usage.ProductChargeDescription |
Charge Description from the subscription Example: Usage Fee |
|
|
Usage.ProductDescription |
Example: Includes so many features |
|
|
Usage.ProductName |
Example: Best Product Ever |
|
|
Usage.ProductSKU |
Example: SKU-18412 This field cannot be translated. |
|
|
Usage.Quantity |
Example: 2 |
|
|
Usage.RatePlanDescription |
Example: Gold Edition includes all features from the Silver Edition |
|
|
Usage.RatePlanName |
Example: Best Product Ever - Gold Edition |
|
| Usage.RatingAmount |
If you are using the individual usage rating feature, use this optional field to display the usage rating amount on a line-by-line basis in the Usage Details section of the Invoice PDF. |
|
|
Usage.RevenueRecognitionCode |
Example: Revenue |
|
|
Usage.SubscriptionNotes |
Example: Notes about the Subscription |
|
|
Usage.SubscriptionNumber |
Example: 82419391339-ABC This field cannot be translated. |
1 |
|
Usage.UOM |
Example: Custom Objects |
|
|
Usage.UOMDisplayedAs |
UOM Display Name Example: Custom Objects |
|
|
Usage.AccountNumber |
Account Number of the usage record Example: A000842911 |
|
Tax Summary Fields
These fields are available only if you have enabled one of the tax automation options in Zuora.
| Merge Field | Description | Sort Order |
|---|---|---|
|
TaxSummary.AmountWithoutTax |
Subtotal of all charges without any taxes. Example: $12.80 Note: If multiple taxes with different jurisdictions are associated with the same invoice item, the value will include these tax amounts in the sum. |
|
|
TaxSummary.TaxExtendedAmount |
Summary of all taxes by unique combination of Tax Name, Tax Rate and Tax Rate Type. Type: Number Example: $12.80 |
|
|
TaxSummary.TaxName |
The name of the tax rate, such as sales tax or GST. This name is displayed on invoices. |
1 |
|
TaxSummary.TaxRate |
The tax rate applied to the charge. |
2 |
|
TaxSummary.TaxRateType |
The type of the tax rate applied to the charge. |
3 |
Tax Item Fields
Zuora supports multi-level nested tables within the tax items table.
You can customize your invoice templates to display tax items in nested tables. In nested tables, you can group and subtotal complex tax items by any supported merge fields or custom fields. For more information, see Grouping and Subtotal Functions in Nested Tables.
Advanced custom fields cannot be used with Word Template. Similarly, custom fields created using Object Manage cannot be utilized with Mail Merge Template.
If you enable Unified Invoicing, the values of some Tax Item fields depend on the source of the corresponding taxation item.
These fields are available only if you have enabled one of the tax automation options in Zuora.
| Merge Field | Sort Order | Description | Invoice Item from ProductRatePlanCharge | Standalone invoice item |
|---|---|---|---|---|
|
TaxItem.AmountWithoutTax |
|
Subtotal of all charges without any taxes.
Example: $12.80 |
||
|
TaxItem.ChargeDescription |
|
The description of the charge (in the Product Catalog) that is related to the taxation. Example: One Time Fee |
empty | empty |
|
TaxItem.ChargeName |
|
The name of the charge (in the Product Catalog) that is related to the taxation. Example: Best Product Ever - Gold Edition: Activation Fee |
empty | empty |
|
TaxItem.ChargePeriod |
|
The period of the charge (in the Product Catalog) that is related to the taxation. Example: Month |
empty | empty |
|
TaxItem.ProductDescription |
|
The description of the product (in the Product Catalog) related to taxation. Example: Includes so many features |
The description of the product (in the Product Catalog) related to taxation. | empty |
|
TaxItem.ProductName |
3 |
The name of the product (in the Product Catalog) related to taxation. Example: Best Product Ever |
The name of the product (in the Product Catalog) related to taxation. | empty |
|
TaxItem.ProductSKU |
|
The SKU number of the product (in the Product Catalog) related to taxation. Example: SKU-18412 This field cannot be translated. |
The SKU number of the product (in the Product Catalog) related to taxation. This field cannot be translated. |
empty |
|
TaxItem.RatePlanDescription |
|
The description of the product rate plan (in the Product Catalog) that is related to taxation. Example: Gold Edition includes all features from the Silver Edition |
empty | empty |
|
TaxItem.RatePlanName |
4 |
The pricing plan (in the Product Catalog) related to the taxation. Example: Best Product Ever - Gold Edition |
empty | empty |
|
TaxItem.SubscriptionNotes |
|
The notes of the subscription that is related to the taxation. Example: Notes about the Subscription |
empty | empty |
|
TaxItem.SubscriptionNumber |
2 |
The subscription number that is related to the taxation. Example: 82419391339-ABC This field cannot be translated. |
empty | empty |
|
TaxItem.TaxAccountingCode |
|
This accounting code is associated to the taxes in the Invoice Details Export. Example: 12987113-Tax |
||
|
TaxItem.TaxAmount |
|
The amount of the tax applied to the charge. Example: $12.00 |
||
|
TaxItem.TaxCode |
|
The tax code identifies which tax rules and tax rates to apply to a specific charge. See Set Up Taxation Codes. |
||
| TaxItem.TaxCodeDescription |
The description of the tax code. |
|||
|
TaxItem.TaxItemDate |
1 |
The date that the tax is applied to the charge. |
||
|
TaxItem.TaxJurisdiction |
|
The jurisdiction that applies the tax or VAT. This value is typically a state, province, county, or city. Example: County |
||
|
TaxItem.TaxLocationCode |
|
The identifier for the location based on the value of the |
||
|
TaxItem.TaxName |
|
The name of the tax rate, such as sales tax or GST. This name is displayed on invoices. |
||
|
TaxItem.TaxRate |
|
The tax rate applied to the charge. |
||
|
TaxItem.TaxRateDescription |
|
The description of the tax rate. Example: State: 0.06 |
||
|
TaxItem.TaxRateType |
|
The type of the tax rate applied to the charge. |
||
Transaction Fields
Refunds, Payments, Adjustments, and Credit Balance Adjustments are displayed in the transaction table. These are transactions that are associated only with this invoice. If you have the Invoice Settlement feature enabled, credit memos are also supported. See Configure the Transaction Table for more information.
| Merge Field | Sort Order | Description |
|---|---|---|
|
Transaction.TransactionDate |
1 |
Type: Date Example: 01/01/2009 |
|
Transaction.TransactionNumber |
|
Example: P-00000003 |
|
Transaction.TransactionType |
|
Example: Payment |
|
Transaction.Description |
|
Example: pay |
|
Transaction.AppliedAmount |
|
Type: Number Example: ($400.00) |
Previous Transactions Fields
Refunds, Payments, Adjustments, and Invoices are displayed in the transaction table currently. These transactions are associated to the Account and not associated to this invoice. If you have the Invoice Settlement feature enabled, credit memos and debit memos are also supported. See Display Previous Transactions Data for more information.
| Merge Field | Sort Order | Description |
|---|---|---|
|
Transaction.TransactionDate |
1 |
Type: Date Example: 7/17/15 |
|
Transaction.TransactionNumber |
|
Example: INV00000001 This field cannot be translated. |
|
Transaction.TransactionType |
|
The type of transaction. Example: Credit card payment |
|
Transaction.Description |
|
Example: invoice |
|
Transaction.TransactionAmount |
|
Type: Number Example: $8,000.00 |
|
Transaction.AccountBalanceImpact |
|
This field is the balance impact of the transaction. For example, a payment amount might be 50, but its balance impact is -50. Type: Number Example: $8,000.00 |
Open Invoice Fields
All Open Invoices associated to this Account. An open invoice is any invoice where the balance is not equal to 0.
| Merge Field | Sort Order | Description |
|---|---|---|
|
Invoice.InvoiceDate |
|
Type: Date Example: 02/01/2009 |
|
Invoice.InvoiceNumber |
|
Example: INV00000008 |
|
Invoice.DueDate |
1 |
Type: Date Example: 02/01/2009 |
|
Invoice.Total |
|
Type: Number Example: $998.80 |
|
Invoice.Balance |
|
Type: Number Example: $548.80 |
Bar Code Fields
| Merge Field | Description |
|---|---|
|
BarCode.Code128 |
In order to have a barcode on your invoice, you need to use a barcode merge field in your template. Currently, Zuora supports up to five Code 128 barcodes per invoice template. This field cannot be translated. |
| BarCode.AustraliaPost |
Zuora also supports barcodes generated by Australia Post. See Using Barcodes on Invoice Templates. This field cannot be translated. |
Payment Fields
| Merge Fields | Sort Order | Description |
|---|---|---|
|
Payment.AccountingCode |
|
Example: 10845.CC_Payment |
|
Payment.AppliedAmount |
|
Type: Number Example: $400.00 |
|
Payment.CreditCardNumberMasked |
|
Example: XXXXXXXXXXXX4111 This field cannot be translated. |
|
Payment.CreditCardType |
|
Example: Visa |
|
Payment.Date |
1 |
Type: Date Example: 01/01/2009 |
|
Payment.Description |
|
Example: Payment for goods |
|
Payment.Method |
|
Example: CreditCard |
|
Payment.Number |
2 |
Example: P-00000003 This field cannot be translated. |
|
Payment.PaymentType |
|
Example: Electronic |
|
Payment.ReferenceId |
|
Example: 9183013NSLD01313083 This field cannot be translated. |
Deprecated Tables and Fields
Zuora recommends that you use Transaction Table instead of the Invoice Adjustment fields.
Invoice Adjustment Fields
|
Merge Field |
Description | Sort Order |
|---|---|---|
|
Adjustment.AccountingCode |
The accounting code for the invoice item. Accounting codes group transactions that contain similar accounting attributes. Values: inherited from |
|
|
Adjustment.AppliedAmount |
The amount of the invoice item adjustment. Values: a valid currency amount Example: $4.00 |
|
|
Adjustment.Date |
The date when the invoice item adjustment is applied. This date must be the same as the invoice's date or later. Values: a valid date and time value |
2 |
|
Adjustment.Description |
A description of the invoice adjustment. |
|
|
Adjustment.Number |
A unique string to identify an individual invoice item adjustment. Values: automatically generated This field cannot be translated. |
3 |
|
Adjustment.Type |
The type of invoice adjustment. |
1 |