Merge fields for credit memos

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.
Example: true, false 

Account.Balance

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
Values: any activated system-defined bill cycle day (1 - 31) 

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 (Batch1 - Batch50 or by name).

Example: 1st of the month

Unique code that identifies a company account in Avalara.

Corresponds to:

• The Tax Company Code field in the customer account on the Zuora UI
• The TaxCompanyCode field on the Account SOAP API object

Example: CCAPAC

This field cannot be translated.

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.
Values: a currency value defined in the administrative web-based UI

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 true.
Values: a valid ID for an existing payment method

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 <<Account.PreviousBalance>> merge field from the invoice tenant plus the invoice balance. This field is needed for some invoice presentation rules as the Account Balance field on the customer account does not include draft invoices.

Example: $304.50

Account.Notes

Use this field to record comments about the account.

Example: Platinum Customer

The parent account name of the current account. You can specify the parent account name in the account detail page.

Example: Finance Dept

Account.PaymentTerm

Indicates when the customer pays for subscriptions.
Values: a valid, active payment term defined in the web-based UI administrative settings

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 Account.PreviousBalance - Account.PreviousTransactionImpactTotal.

Example: $0.00

Account.PurchaseOrderNumber

The number of the purchase order associated with this account. Purchase order information generally comes from customers.
Values: a string of 100 characters or fewer

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.
Values: one of the following:

• Yes
• No
• PendingVerification

Example: Pending Verification

Account.TaxExemptCertificateID

The ID of your customer's tax exemption certificate.

Example: CA8592555

This field cannot be translated.

Account.TaxExemptCertificateType

The type of the tax exemption certificate that your customer holds. 

Example: Reseller Permit

Account.TaxExemptDescription

A description of the tax exemption certificate that your customer holds.

Example: Fax ID: 1031374242

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

Account.VATID

Customer’s Value Added Tax (VAT) ID.

Corresponds to:

• The VAT ID field in the customer account on the Zuora UI
• The VATId field on the Account SOAP API object

Example: VATID12345

This field cannot be translated.

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

BillToContact.OtherPhoneType

Bill to Contact's other phone type

BillToContact.PersonalEmail

Bill to Contact's personal email

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

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

CreditMemo.Number

The credit memo number.

Example: CM00000028

CreditMemo.AccountName

The account name of this credit memo.

Example: Acme Corporation

CreditMemo.Currency

The currency that the credit memo associated with the account are paid with.

This merge field is formatted based on the locale in the customer's communication profile. To use your own format, specify the currency format in the memo template.

Values: a currency value defined in the administrative web-based UI

Example: USD

CreditMemo.CreditMemoDate

The date when this credit memo takes effect. 

This merge field is formatted based on the locale in the customer's communication profile. You can change it in the memo template.

Example: 01/31/2019

CreditMemo.TargetDate

The target date of the bill run that generates this credit memo.

This merge field is formatted based on the locale in the customer's communication profile. You can change it in the memo template.

Example: 01/31/2019

The date and time when this credit memo is posted. 

Example: 2019-05-28T18:34:49.643+08:00

The total amount of this credit memo with tax.

Example: $540

CreditMemo.TaxAmount

The tax amount of this credit memo.

Example: $12.30

CreditMemo.AmountWithoutTax

The total amount of this memo without tax.

Example: $790

CreditMemo.UnappliedAmount

The amount of this credit memo that is not applied. 

Example: $56

CreditMemo.RefundedAmount

The amount of this credit memo that is refunded to your customer.

Example: $48

CreditMemo.AppliedAmount

The amount of this credit memo that is applied to invoices and debit memos.

Example: $120

CreditMemo.Comment

The note of this credit memo. 

Example: Credit memo notes.

CreditMemo.ReferredInvoiceNumber

The invoice number associated with this credit memo.

Example: INV00000047

CreditMemo.ReferredInvoiceTax

The tax amount of the invoice associated with this credit memo.

Example: $600 

CreditMemo.ReferredInvoiceTotal

Total amount of the invoice associated with this credit memo.

Example: $65

CreditMemo.ReferredInvoiceComments

The comments of the invoice associated with this credit memo.

Example: Thank you for your business! Please contact us if you have any questions about your invoice!

CreditMemo.ReferredInvoiceDueDate

The due date of the invoice associated with this credit memo.

This merge field is formatted based on the locale in the customer's communication profile. You can change it in the memo template.

Example: 09/01/2019

The invoice date of the invoice associated with this credit memo.

This merge field is formatted based on the locale in the customer's communication profile. You can change it in the memo template.

Example: 02/01/2019

CreditMemo.ReferredInvoicePaymentAmount

Total payment amount of the invoice associated with this credit memo.

Example: $120

CreditMemo.ReferredInvoiceBalance

The balance of the invoice associated with this credit memo.

Example:  $306.80

CreditMemo.ReferredInvoiceAmountWithoutTax

Total amount of the invoice without tax. The invoice associated with this credit memo.

Example: $540

CreditMemo.ReferredInvoiceGrossAmount

Total of the invoice gross amount that is pre-discount and pre-tax. The invoice associated with this credit memo.

Example: $540

CreditMemo.ReferredInvoiceRefundAmount

Total refunds for the invoice associated with this credit memo. Example: $540

CreditMemo.ReferredInvoiceNetPaymentAmount

Net Payments associated to this invoice (Payments - Refunds). The invoice associated with this credit memo.

Example: $316.80

The credit memo number excluding the prefix.

Example: 00000001

CreditMemoItem.AppliedAmount

The amount of this credit memo item that is applied to invoices and debit memos.

Example: $43

CreditMemoItem.RefundedAmount

The amount of this credit memo item that is refunded to your customer.
Example: $69

CreditMemoItem.UnappliedAmount

The amount of this credit memo item that is not applied to. 

Example: $304.50

CreditMemoItem.Sku

Unique SKU for the product associated with this credit memo item.

Example: SKU-00000006

CreditMemoItem.Name

Name of this credit memo item.

Example: Best Product Ever - Gold Edition: Activation Fee

The service period of this credit memo item.

When the TableSort:CreditMemoItem.ServicePeriod field is used for sorting, data is sorted by alphabet.

Example: 01/01/2019-01/31/2029

CreditMemoItem.ServiceStartDate

Start date of the service period for this credit memo item. If the charge is a one-time fee, this is the date of that charge.

This merge field is formatted based on the locale in the customer's communication profile. You can change it in the memo template.

Example: 01/01/2019

CreditMemoItem.ServiceEndDate

End date of the service period for this credit memo item, such as the last day of the service period.

This merge field is formatted based on the locale in the customer's communication profile. You can change it in the memo template.

Example: 01/31/2029

CreditMemoItem.Quantity

Quantity of this credit memo item in the configured unit of measure for the charge.

Example: 2

CreditMemoItem.ExtendedPrice

Total item charge including taxes.

Example: $162

CreditMemoItem.UnitOfMeasure

The unit of measure for this credit memo item.

Example: Each

CreditMemoItem.UnitOfMeasureDisplayedAs

The display name of the unit of measure.

Example: Each

The subscription number associated with this credit memo item.

Example: A-S00000026

The charge number associated with this credit memo item.

Example: C-00000033

The type of the charge associated with this credit memo item.

Example: One-Time

The charge model associated with this credit memo item.

Example: Per Unit Pricing

The charge period associated with this credit memo item.

Example: Month

The accounting code of the charge associated with this credit memo item.

Example: A81291-OneTimeFees

The name of the invoice owner account associated with the credit memo item.

Example: Super Subscription Emporium

The account number of the invoice owner account associated with the credit memo item.

Example: A00000019

The tax amount of this credit memo item.

Example: $60

The total amount of this credit memo item without tax.

Example: $60

The notes of the subscription associated with this credit memo item.

Example: Notes about the Subscription

The name of the product associated with this credit memo item.

Example: Best Product Ever

The description of the product associated with this credit memo item.

Example: Includes so many features

The custom field of the product rate plan charge associated with this credit memo item.

Example: Comments about the product rate plan charge

The rate plan name of the charge associated with this credit memo item.

Example: Best Product Ever - Gold Edition

The rate plan description of the charge associated with this credit memo item.

Example: Gold Edition includes all features from the Silver Edition

The custom field of the rate plan charge associated with this credit memo item.

Example: Comments about the rate plan charge

The description of this credit memo item.

Example: One Time Fee

Unique SKU for the product associated with the invoice item. The invoice item associated with this credit memo item.

Example: SKU-00000006

The name of the invoice item associated with this credit memo item.

Example: Best Product Ever - Gold Edition: Activation Fee

The description of the charge associated with the invoice item. The invoice item associated with this credit memo item.

Example: One Time Fee

Start date of the service period for the invoice item. The invoice item associated with this credit memo item.

This merge field is formatted based on the locale in the customer's communication profile. You can change it in the memo template.

Example: 01/01/2019

End date of the service period for the invoice item. The invoice item associated with this credit memo item.

This merge field is formatted based on the locale in the customer's communication profile. You can change it in the memo template.

Example: 01/01/2029

Quantity of the invoice item in the configured unit of measure for the charge. The invoice item associated with this credit memo item.

Example: 3

The date and time when the invoice item is created. The invoice item associated with this credit memo item.

Example: 2019-05-28T18:34:49.643+08:00

The unit of measure for the invoice item. The invoice item associated with this credit memo item.

Example: Each

The display name of the unit of measure for the invoice item. The invoice item associated with this credit memo item.

Example: Each

Total item charge including taxes for the invoice item. The invoice item associated with this credit memo item.

Example: $162

The unit price of the charge associated with the invoice item. The invoice item associated with this credit memo item.

Example: $10

The tax amount of the invoice item associated with this credit memo item.

Example: $110

The tax amount of the invoice item without tax. The invoice item associated with this credit memo item.

Example: $100

The service period of the invoice item associated with this credit memo item.

Example: 01/01/2019-01/31/2029

Product name associated with the invoice item. The invoice item associated with this credit memo item.

Example: Best Product Ever

Product description associated with the invoice item. The invoice item associated with this credit memo item.

Example: Gold Edition includes all features from the Silver Edition

The unit price of the charge associated with the credit memo item.

Example: $10

TaxItem.AmountWithoutTax

Example: $12.80

TaxItem.ChargeDescription

The description of the charge (in the Product Catalog) that is related to the taxation.

Example: One Time Fee

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

TaxItem.ChargePeriod

The period of the charge (in the Product Catalog) that is related to the taxation.

Example: Month

TaxItem.ProductDescription

The description of the product (in the Product Catalog) of the subscription charge that is related to the taxation.

Example: Includes so many features

• If the memo item is created from a product rate plan charge, the value of this field is empty.
• If the memo item is created from an invoice item, the value of this field is from the product associated with the invoice item.
• If the memo item is created from a billing engine, the value of this field is from the product associated with the subscription component.

The description of the corresponding product (in the Product Catalog) that is related to the taxation.

Example: Includes so many features

TaxItem.ProductName

The product name of the subscription charge related to the taxation.

Example: Best Product Ever

• If the memo item is created from a product rate plan charge, the value of this field is empty.
• If the memo item is created from an invoice item, the value of this field is from the product associated with the invoice item.
• If the memo item is created from a billing engine, the value of this field is from the product associated with the subscription component.

The name of the corresponding product (in the Product Catalog) that is related to the taxation.

Example: Best Product Ever

TaxItem.ProductSKU

The product SKU number (in the Product Catalog) of the subscription charge that is related to the taxation.

Example: SKU-18412

This field cannot be translated.

• If the memo item is created from a product rate plan charge, the value of this field is empty.
• If the memo item is created from an invoice item, the value of this field is from the product associated with the invoice item.
• If the memo item is created from a billing engine, the value of this field is from the product associated with the subscription component.

The SKU number of the corresponding product (in the Product Catalog) that is related to the taxation.

Example: SKU-18410

This field cannot be translated.

TaxItem.RatePlanDescription

The description of the product rate plan (in the Product Catalog) of the subscription charge that is related to taxation. 

Example: Gold Edition includes all features from the Silver Edition

empty

TaxItem.RatePlanName

The pricing plan (in the Product Catalog) of the subscription charge related to the taxation.

Example: Best Product Ever - Gold Edition

TaxItem.SubscriptionNotes

The notes of the subscription that is related to the taxation.

Example: Notes about the Subscription

TaxItem.SubscriptionNumber

The subscription number that is related to the taxation. 

Example: 82419391339-ABC

This field cannot be translated.

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.

TaxItem.TaxCode

The tax code identifies which tax rules and tax rates to apply to a specific charge. See Set Up Taxation Codes. 
Values: a string of 32 characters or fewer

The description of the tax code.
Values: a string of 255 characters or fewer

TaxItem.TaxItemDate

The date that the tax is applied to the charge.
Values: a valid date formatted MM/dd/yyyy

TaxItem.TaxJurisdiction

The jurisdiction that applies the tax or VAT. This value is typically a state, province, county, or city.

TaxItem.TaxLocationCode

The identifier for the location based on the value of the TaxCode field.
Values: automatically generated

TaxItem.TaxName

The name of the tax rate, such as sales tax or GST. This name is displayed on invoices.
Values: a string of 128 characters or fewer

TaxItem.TaxRate

The tax rate applied to the charge.
Values: a valid decimal value

TaxItem.TaxRateDescription

The description of the tax rate.

TaxItem.TaxRateType

The type of the tax rate applied to the charge.
Values: Percentage, FlatFee