Skip to main content

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

Zuora

Merge field mapping between Word templates and HTML templates for credit 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 credit memos, you can find their equivalents in HTML templates for credit memos.

This article provides a complete list of merge field mapping between Word templates and HTML templates for credit 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 credit memos.

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

Bill To Contact fields

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

Merge field in Word templates Equivalent in HTML templates
BillToContact.Address1 CreditMemo.Account.BillTo.Address1
BillToContact.Address2 CreditMemo.Account.BillTo.Address2
BillToContact.City CreditMemo.Account.BillTo.City
BillToContact.Country CreditMemo.Account.BillTo.Country
BillToContact.County CreditMemo.Account.BillTo.County
BillToContact.Description CreditMemo.Account.BillTo.Description
BillToContact.Fax CreditMemo.Account.BillTo.Fax
BillToContact.FirstName CreditMemo.Account.BillTo.FirstName
BillToContact.HomePhone CreditMemo.Account.BillTo.HomePhone
BillToContact.LastName CreditMemo.Account.BillTo.LastName
BillToContact.MobilePhone CreditMemo.Account.BillTo.MobilePhone
BillToContact.NickName CreditMemo.Account.BillTo.NickName
BillToContact.OtherPhone CreditMemo.Account.BillTo.OtherPhone
BillToContact.OtherPhoneType CreditMemo.Account.BillTo.OtherPhoneType
BillToContact.PersonalEmail CreditMemo.Account.BillTo.PersonalEmail
BillToContact.PostalCode CreditMemo.Account.BillTo.PostalCode
BillToContact.State CreditMemo.Account.BillTo.State
BillToContact.TaxRegion CreditMemo.Account.BillTo.TaxRegion
BillToContact.WorkEmail CreditMemo.Account.BillTo.WorkEmail
BillToContact.WorkPhone CreditMemo.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 credit memos.

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

Credit Memo fields

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

Merge field in Word templates Equivalent in HTML templates
CreditMemo.Number CreditMemo.MemoNumber
CreditMemo.AccountName CreditMemo.Account.Name
CreditMemo.CreditMemoDate CreditMemo.MemoDate
CreditMemo.TargetDate CreditMemo.TargetDate
CreditMemo.PostedOn CreditMemo.PostedOn
CreditMemo.TotalAmount CreditMemo.TotalAmount
CreditMemo.TaxAmount CreditMemo.TaxAmount
CreditMemo.AmountWithoutTax CreditMemo.TotalAmountWithoutTax
CreditMemo.UnappliedAmount CreditMemo.Balance
CreditMemo.RefundedAmount CreditMemo.RefundAmount
CreditMemo.AppliedAmount CreditMemo.AppliedAmount
CreditMemo.Comment CreditMemo.Comments
CreditMemo.ReferredInvoiceNumber

CreditMemo.Invoice.InvoiceNumber

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

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

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

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

Credit Memo Item fields

To build a credit memo items table in the HTML template editor, you can drag the Credit 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 Credit Memo Item fields in Word templates and HTML templates for credit memos.

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

CreditMemoItem.InvoiceItem.SKU

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

CreditMemoItem.ReferredInvoiceItemName CreditMemoItem.InvoiceItem.ChargeName
CreditMemoItem.ReferredInvoiceItemDescription CreditMemoItem.InvoiceItem.Description
CreditMemoItem.ReferredInvoiceItemServiceStartDate CreditMemoItem.InvoiceItem.ServiceStartDate
CreditMemoItem.ReferredInvoiceItemServiceEndDate CreditMemoItem.InvoiceItem.ServiceEndDate
CreditMemoItem.ReferredInvoiceItemQuantity CreditMemoItem.InvoiceItem.Quantity
CreditMemoItem.ReferredInvoiceItemChargedate CreditMemoItem.InvoiceItem.CreatedDate
CreditMemoItem.ReferredInvoiceItemUnitOfMeasure CreditMemoItem.InvoiceItem.UOM
CreditMemoItem.ReferredInvoiceItemUnitOfMeasureDisplayedAs Currently unavailable
CreditMemoItem.ReferredInvoiceItemExtended {{#Wp_Eval}}{{ChargeAmount}} + {{TaxAmount}}{{/Wp_Eval}}
CreditMemoItem.ReferredInvoiceItemUnitPrice CreditMemoItem.InvoiceItem.UnitPrice
CreditMemoItem.ReferredInvoiceItemTaxAmount CreditMemoItem.InvoiceItem.TaxAmount
CreditMemoItem.ReferredInvoiceItemAmountWithoutTax CreditMemoItem.InvoiceItem.ChargeAmount
CreditMemoItem.ReferredInvoiceItemServicePeriod {{CreditMemoItem.InvoiceItem.ServiceStartDate|Localise}} - {{CreditMemoItem.InvoiceItem.ServiceEndDate|Localise}}
CreditMemoItem.ReferredInvoiceItemProductName CreditMemoItem.InvoiceItem.RatePlanCharge.ProductRatePlanCharge.ProductRatePlan.Product.Name
CreditMemoItem.ReferredInvoiceItemProductDescription CreditMemoItem.InvoiceItem.RatePlanCharge.ProductRatePlanCharge.ProductRatePlan.Product.Description
CreditMemoItem.UnitPrice CreditMemoItem.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 credit memos.

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