Skip to main content

Merge field mapping between Word templates and HTML templates for debit memos

Zuora

Merge field mapping between Word templates and HTML templates for debit memos

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.

For most merge fields available in Word templates for debit memos, you can find their equivalents in HTML templates for debit memos.

This article provides a complete list of merge field mapping between Word templates and HTML templates for debit memos. You can also download this CSV file that contains all merge field mapping information for reference.

Customer Account fields

The following table lists the mapping for Customer Account fields in Word templates and HTML templates for debit memos.

Merge field in Word templates Equivalent in HTML templates
Account.AccountNumber DebitMemo.Account.AccountNumber
Account.Autopay DebitMemo.Account.AutoPay
Account.Balance DebitMemo.Account.Balance
Account.BillCycleDay DebitMemo.Account.BillCycleDay
Account.BillingBatch DebitMemo.Account.Batch
Account.CompanyCode DebitMemo.Account.TaxCompanyCode
Account.CreditBalance DebitMemo.Account.CreditBalance
Account.CrmId DebitMemo.Account.CrmId
Account.Currency DebitMemo.Account.Currency
Account.CustomerSupportRepName DebitMemo.Account.CustomerServiceRepName
Account.DefaultPaymentMethod DebitMemo.Account.DefaultPaymentMethodId
Account.MRR DebitMemo.Account.Mrr
Account.Name DebitMemo.Account.Name
Account.NewBalance {{#Wp_Eval}}
"{{DebitMemo.Status}}" == "Draft"
? {{DebitMemo.Account.Balance}} + {{DebitMemo.Balance}}
: {{DebitMemo.Account.Balance}}
{{/Wp_Eval}}
Account.Notes DebitMemo.Account.Notes
Account.Parent.Name DebitMemo.Account.Parent.Name
Account.PaymentTerm DebitMemo.Account.PaymentTerm
Account.PaymentMethodMandateId DebitMemo.Account.DefaultPaymentMethod.MandateID
Account.PreviousBalance {{#Wp_Eval}}
"{{DebitMemo.Status}}" == "Draft"
? {{DebitMemo.Account.Balance}}
: {{DebitMemo.Account.Balance}} - {{DebitMemo.Balance}}
{{/Wp_Eval}}
Account.PreviousTransactionImpactTotal Currently unavailable
Account.PreviousTransactionStartAmount Currently unavailable
Account.PurchaseOrderNumber DebitMemo.Account.PurchaseOrderNumber
Account.SalesRep DebitMemo.Account.SalesRepName
Account.TaxExempt DebitMemo.Account.TaxExemptStatus
Account.TaxExemptCertificateID DebitMemo.Account.TaxExemptCertificateID
Account.TaxExemptCertificateType DebitMemo.Account.TaxExemptCertificateType
Account.TaxExemptDescription DebitMemo.Account.TaxExemptDescription
Account.TaxExemptEffectiveDate DebitMemo.Account.TaxExemptEffectiveDate
Account.TaxExemptExpirationDate DebitMemo.Account.TaxExemptExpirationDate
Account.TaxExemptIssuingJurisdiction DebitMemo.Account.TaxExemptIssuingJurisdiction
Account.VATID DebitMemo.Account.VATId

Bill To Contact fields

The following table lists the mapping for Bill To Contact fields in Word templates and HTML templates for debit memos.

Merge field in Word templates Equivalent in HTML templates
BillToContact.Address1 DebitMemo.Account.BillTo.Address1
BillToContact.Address2 DebitMemo.Account.BillTo.Address2
BillToContact.City DebitMemo.Account.BillTo.City
BillToContact.Country DebitMemo.Account.BillTo.Country
BillToContact.County DebitMemo.Account.BillTo.County
BillToContact.Description DebitMemo.Account.BillTo.Description
BillToContact.Fax DebitMemo.Account.BillTo.Fax
BillToContact.FirstName DebitMemo.Account.BillTo.FirstName
BillToContact.HomePhone DebitMemo.Account.BillTo.HomePhone
BillToContact.LastName DebitMemo.Account.BillTo.LastName
BillToContact.MobilePhone DebitMemo.Account.BillTo.MobilePhone
BillToContact.NickName DebitMemo.Account.BillTo.NickName
BillToContact.OtherPhone DebitMemo.Account.BillTo.OtherPhone
BillToContact.OtherPhoneType DebitMemo.Account.BillTo.OtherPhoneType
BillToContact.PersonalEmail DebitMemo.Account.BillTo.PersonalEmail
BillToContact.PostalCode DebitMemo.Account.BillTo.PostalCode
BillToContact.State DebitMemo.Account.BillTo.State
BillToContact.TaxRegion DebitMemo.Account.BillTo.TaxRegion
BillToContact.WorkEmail DebitMemo.Account.BillTo.WorkEmail
BillToContact.WorkPhone DebitMemo.Account.BillTo.WorkPhone

Sold To Contact fields

The following table lists the mapping for Sold To Contact fields in Word templates and HTML templates for debit memos.

Merge field in Word templates Equivalent in HTML templates
SoldToContact.Address1 DebitMemo.Account.SoldTo.Address1
SoldToContact.Address2 DebitMemo.Account.SoldTo.Address2
SoldToContact.City DebitMemo.Account.SoldTo.City
SoldToContact.Country DebitMemo.Account.SoldTo.Country
SoldToContact.County DebitMemo.Account.SoldTo.County
SoldToContact.Description DebitMemo.Account.SoldTo.Description
SoldToContact.Fax DebitMemo.Account.SoldTo.Fax
SoldToContact.FirstName DebitMemo.Account.SoldTo.FirstName
SoldToContact.HomePhone DebitMemo.Account.SoldTo.HomePhone
SoldToContact.LastName DebitMemo.Account.SoldTo.LastName
SoldToContact.MobilePhone DebitMemo.Account.SoldTo.MobilePhone
SoldToContact.NickName DebitMemo.Account.SoldTo.NickName
SoldToContact.OtherPhone DebitMemo.Account.SoldTo.OtherPhone
SoldToContact.OtherPhoneType DebitMemo.Account.SoldTo.OtherPhoneType
SoldToContact.PersonalEmail DebitMemo.Account.SoldTo.PersonalEmail
SoldToContact.PostalCode DebitMemo.Account.SoldTo.PostalCode
SoldToContact.State DebitMemo.Account.SoldTo.State
SoldToContact.TaxRegion DebitMemo.Account.SoldTo.TaxRegion
SoldToContact.WorkEmail DebitMemo.Account.SoldTo.WorkEmail
SoldToContact.WorkPhone DebitMemo.Account.SoldTo.WorkPhone

Debit Memo fields

The following table lists the mapping for Debit Memo fields in Word templates and HTML templates for debit memos.

Merge field in Word templates Equivalent in HTML templates
DebitMemo.Number DebitMemo.MemoNumber
DebitMemo.AccountName DebitMemo.Account.Name
DebitMemo.Currency DebitMemo.Account.Currency
DebitMemo.DebitMemoDate DebitMemo.MemoDate
DebitMemo.DueDate DebitMemo.DueDate
DebitMemo.PostedOn DebitMemo.PostedOn
DebitMemo.TotalAmount DebitMemo.TotalAmount
DebitMemo.Balance DebitMemo.Balance
DebitMemo.PaidAmount {{#Wp_Eval}}
{{DebitMemo.TotalAmount}} - {{DebitMemo.Balance}}
{{/Wp_Eval}}
DebitMemo.TaxAmount DebitMemo.TaxAmount
DebitMemo.AmountWithoutTax DebitMemo.TotalAmountWithoutTax
DebitMemo.Comment DebitMemo.Comments
DebitMemo.ReferredInvoiceNumber

DebitMemo.Invoice.InvoiceNumber

The referred invoice is only available when a debit memo is created from an invoice.

DebitMemo.ReferredInvoiceTax DebitMemo.Invoice.TaxAmount
DebitMemo.ReferredInvoiceTotal DebitMemo.Invoice.Amount
DebitMemo.ReferredInvoiceComments DebitMemo.Invoice.Comments
DebitMemo.ReferredInvoiceDueDate DebitMemo.Invoice.DueDate
DebitMemo.ReferredInvoiceDate DebitMemo.Invoice.InvoiceDate
DebitMemo.ReferredInvoicePaymentAmount DebitMemo.Invoice.PaymentAmount
DebitMemo.ReferredInvoiceBalance DebitMemo.Invoice.Balance
DebitMemo.ReferredInvoiceAmountWithoutTax DebitMemo.Invoice.AmountWithoutTax
DebitMemo.ReferredInvoiceGrossAmount {{DebitMemo.Invoice.InvoiceItems|FilterByValue(ProcessingType,NE,1)|Sum(ChargeAmount)}}
DebitMemo.ReferredInvoiceRefundAmount DebitMemo.Invoice.RefundAmount
DebitMemo.ReferredInvoiceNetPaymentAmount Currently unavailable
DebitMemo.SequenceNumber

{{DebitMemo.MemoNumber|Substr(2,11)}}

The first parameter of the Substr function needs to change according to the prefix. If the prefix is DM for debit memos, you can use Substr(2,11)to get the debit memo sequence number. For example, if a debit memo number is DM00000075, the rendered result is displayed as 00000075. To learn more information about the Substr function, see Functions used in merge fields

Debit Memo Item fields

To build a debit memo items table in the HTML template editor, you can drag the Debit Memo Details component into an HTML template, and then customize the predefined table according to your business demands. Additionally, you can also use the Configure data tables in HTML templates with more flexibility.

The following table lists the mapping for Debit Memo Item fields in Word templates and HTML templates for debit memos.

Merge field in Word templates Equivalent in HTML templates
DebitMemoItem.PaidAmount DebitMemoItem.BeAppliedByOthersAmount
DebitMemoItem.TaxAmount DebitMemo.TaxAmount
DebitMemoItem.AmountWithoutTax DebitMemoItem.AmountWithoutTax
DebitMemoItem.Sku DebitMemoItem.Sku
DebitMemoItem.Name DebitMemoItem.ChargeName
DebitMemoItem.ServicePeriod {{DebitMemoItem.ServiceStartDate|Localise}} - {{DebitMemoItem.ServiceEndDate|Localise}}
DebitMemoItem.ServiceStartDate {{DebitMemoItem.ServiceStartDate|Localise}}
DebitMemoItem.ServiceEndDate {{DebitMemoItem.ServiceEndDate|Localise}}
DebitMemoItem.Quantity DebitMemoItem.Quantity
DebitMemoItem.ExtendedPrice {{#Wp_Eval}}{{AmountWithoutTax}}+{{TaxAmount}}|Round(2)|Localise{{/Wp_Eval}}
DebitMemoItem.UnitOfMeasure DebitMemoItem.UnitOfMeasure
DebitMemoItem.UnitOfMeasureDisplayedAs Currently unavailable
DebitMemoItem.SubscriptionNumber DebitMemoItem.Subscription.Name
DebitMemoItem.ChargeNumber DebitMemoItem.RatePlanCharge.ChargeNumber
DebitMemoItem.ChargeType DebitMemoItem.RatePlanCharge.ChargeType
DebitMemoItem.ChargeModel DebitMemoItem.RatePlanCharge.ChargeModel
DebitMemoItem.ChargePeriod DebitMemoItem.RatePlanCharge.BillingPeriod
DebitMemoItem.ChargeAccountingCode DebitMemoItem.RatePlanCharge.AccountingCode
DebitMemoItem.CustomField DebitMemoItem.CustomField
DebitMemoItem.AccountName DebitMemo.Account.Name
DebitMemoItem.AccountNumber DebitMemo.Account.AccountNumber
DebitMemoItem.TaxAmount {{DebitMemoItem.TaxAmount|Round(2)|Localise}}
DebitMemoItem.AmountWithoutTax {{DebitMemoItem.AmountWithoutTax|Round(2)|Localise}}
DebitMemoItem.SubscriptionNotes DebitMemoItem.Subscription.Notes
DebitMemoItem.ProductName DebitMemoItem.RatePlanCharge.RatePlan.ProductRatePlan.Product.Name
DebitMemoItem.ProductDescription RatePlanCharge.RatePlanCharge.RatePlan.ProductRatePlan.Product.Description
DebitMemoItem.ProductRatePlanCharge.CustomField DebitMemoItem.RatePlanCharge.ProductRatePlanCharge.customFields
DebitMemoItem.RatePlanName DebitMemoItem.RatePlanCharge.RatePlan.ProductRatePlan.Name
DebitMemoItem.RatePlanDescription DebitMemoItem.RatePlanCharge.RatePlan.ProductRatePlan.Description
DebitMemoItem.RatePlanCharge.CustomField DebitMemoItem.RatePlanCharge.customFields
DebitMemoItem.Description DebitMemoItem.Description
DebitMemoItem.ReferredInvoiceItemSku

DebitMemoItem.InvoiceItem.SKU

The referred invoice item is only available when a debit memo is created from an invoice.

DebitMemoItem.ReferredInvoiceItemName DebitMemoItem.InvoiceItem.ChargeName
DebitMemoItem.ReferredInvoiceItemDescription DebitMemoItem.InvoiceItem.Description
DebitMemoItem.ReferredInvoiceItemServiceStartDate DebitMemoItem.InvoiceItem.ServiceStartDate
DebitMemoItem.ReferredInvoiceItemServiceEndDate DebitMemoItem.InvoiceItem.ServiceEndDate
DebitMemoItem.ReferredInvoiceItemQuantity DebitMemoItem.InvoiceItem.Quantity
DebitMemoItem.ReferredInvoiceItemChargedate DebitMemoItem.InvoiceItem.CreatedDate
DebitMemoItem.ReferredInvoiceItemUnitOfMeasure DebitMemoItem.InvoiceItem.UOM
DebitMemoItem.ReferredInvoiceItemUnitOfMeasureDisplayedAs Currently unavailable
DebitMemoItem.ReferredInvoiceItemExtended {{#Wp_Eval}}{{DebitMemoItem.InvoiceItem.ChargeAmount}} + {{DebitMemoItem.InvoiceItem.TaxAmount}}|Round(2)|Localise{{/Wp_Eval}}
DebitMemoItem.ReferredInvoiceItemUnitPrice DebitMemoItem.InvoiceItem.UnitPrice
DebitMemoItem.ReferredInvoiceItemTaxAmount DebitMemoItem.InvoiceItem.TaxAmount
DebitMemoItem.ReferredInvoiceItemAmountWithoutTax DebitMemoItem.InvoiceItem.ChargeAmount
DebitMemoItem.ReferredInvoiceItemServicePeriod {{DebitMemoItem.InvoiceItem.ServiceStartDate|Localise}} - {{DebitMemoItem.InvoiceItem.ServiceEndDate|Localise}}
DebitMemoItem.ReferredInvoiceItemProductName DebitMemoItem.InvoiceItem.RatePlanCharge.ProductRatePlanCharge.ProductRatePlan.Product.Name
DebitMemoItem.ReferredInvoiceItemProductDescription DebitMemoItem.InvoiceItem.RatePlanCharge.ProductRatePlanCharge.ProductRatePlan.Product.Description
DebitMemoItem.UnitPrice DebitMemoItem.UnitPrice

Tax Item fields

To build a taxation details table in the HTML template editor, follow the procedure described in How to configure taxation details tables in HTML templates.

The following table lists the mapping for Tax Item fields in Word templates and HTML templates for debit memos.

Merge field in Word template Equivalent in HTML template
TaxItem.AmountWithoutTax DebitTaxationItem.DebitMemoItem.AmountWithoutTax
TaxItem.ChargeDescription DebitTaxationItem.DebitMemoItem.RatePlanCharge.ProductRatePlanCharge.Description
TaxItem.ChargeName DebitTaxationItem.DebitMemoItem.RatePlanCharge.ProductRatePlanCharge.Name
TaxItem.ChargePeriod DebitTaxationItem.DebitMemoItem.RatePlanCharge.ProductRatePlanCharge.BillingPeriod
TaxItem.ProductDescription DebitTaxationItem.DebitMemoItem.RatePlanCharge.RatePlan.ProductRatePlan.Product.Description
TaxItem.ProductName DebitTaxationItem.DebitMemoItem.RatePlanCharge.RatePlan.ProductRatePlan.Product.Name
TaxItem.ProductSKU DebitTaxationItem.DebitMemoItem.RatePlanCharge.RatePlan.ProductRatePlan.Product.Product.SKU
TaxItem.RatePlanDescription DebitTaxationItem.DebitMemoItem.RatePlanCharge.RatePlan.ProductRatePlan.Description
TaxItem.RatePlanName DebitTaxationItem.DebitMemoItem.RatePlanCharge.RatePlan.ProductRatePlan.Name
TaxItem.SubscriptionNotes DebitTaxationItem.DebitMemoItem.Subscription.Notes
TaxItem.SubscriptionNumber DebitTaxationItem.DebitMemoItem.Subscription.Name
TaxItem.TaxAccountingCode DebitTaxationItem.AccountingCode
TaxItem.TaxAmount DebitTaxationItem.TaxAmount
TaxItem.TaxCode DebitTaxationItem.TaxCode
TaxItem.TaxItemDate DebitTaxationItem.TaxDate
TaxItem.TaxJurisdiction DebitTaxationItem.Jurisdiction
TaxItem.TaxLocationCode DebitTaxationItem.LocationCode
TaxItem.TaxName DebitTaxationItem.Name
TaxItem.TaxRate DebitTaxationItem.TaxRate
TaxItem.TaxRateDescription DebitTaxationItem.TaxRateDescription
TaxItem.TaxRateType DebitTaxationItem.TaxRateType