Skip to main content

Accounts and Contacts - Data dictionary

Zuora

Accounts and Contacts - Data dictionary

  1. Last updated
  2. Save as PDF

This article lists the fields associated with the Accounts and Contacts module in Zuora. Read more on Accounts and Contacts. 

Note: Fields with an asterisk mark indicate mandatory fields. 

Name Description Value 
Account Name* Account name, up to 255 characters. (Required field) Alphanumeric
Account Notes A string of up to 65,535 characters. Autogenerated Notes
Account Number A unique account number, up to 50 characters. If not provided it will be auto-generated Alphanumeric
Additional Email Addresses A list of additional email addresses to receive email notifications. Multiple email addresses can be provided by using pipe symbol | as a separator. Email = abc@zuora.com|def@zuora.com
autoPay

Whether future payments are to be automatically billed when they are due.

  • If this field is set to true, you must specify either the creditCard field or the hpmCreditCardPaymentMethodId field, but not both.
  • If this field is set to false, you can specify neither the creditCard field nor the hpmCreditCardPaymentMethodId field
 boolean
Batch A string of 50 characters or less (Batch1 - Batch50)

Batch values

For example,

  • Batch1,
  • Batch2,
  • Batch3,
  • Batch4,
  • Batch5,
Bill Cycle Day* Specify any day of the month (1-31, where 31 = end-of-month), or 0 for auto-set.

Number = 0,3,31

Bill Cycle Day values
BillToContact.FirstName* A string of 100 characters Alphanumeric
BillToContact.LastName* A string of 100 characters Alphanumeric
BillToContact.WorkEmail Work email address Email(abc@zuora.com)
BillToContact.PersonalEmail Personal email address Email(abc@zuora.com)
BillToContact.WorkPhone Work phone number Alphanumeric - Accept characters like ()+-,spaces
BillToContact.Country Valid country name or abbreviation.
  • "Norway",
  • "Botswana"
BillToContact.Address1 A string of 255 characters Alphanumeric
BillToContact.Address2 A string of 255 characters

Alphanumeric
BillToContact.City City. A string of 40 characters Alphanumeric
BillToContact.State State. A string of 40 characters Alphanumeric
BillToContact.PostalCode Zip code. A string of 20 characters Alphanumeric
BillToContact.County County. A string of 32 characters Valid County Name
BillToContact.Fax Fax phone number Alphanumeric - Accept characters like ()+-,spaces
BillToContact.HomePhone Home phone number Alphanumeric - Accept characters like ()+-,spaces
BillToContact.MobilePhone Mobile phone number Alphanumeric - Accept characters like ()+-,spaces
BillToContact.NickName Nickname. A string of 100 characters Alphanumeric
BillToContact.OtherPhone Fax phone number Alphanumeric - Accept characters like ()+-,spaces
BillToContact.OtherPhoneType Type of other phone.

Alphanumeric
BillToContact.TaxRegion Tax region. A string of 32 characters Alphanumeric
BillToContact.Description A string of 100 characters Alphanumeric
Class NS Value of the Class field for the corresponding customer account in NetSuite. Only available if you have installed the Zuora Connector for NetSuite. String <= 255 characters
Credit Memo Template Id The unique ID of the credit memo template, configured in Billing Settings(32 character identifier). Alphanumeric Id
CRM Account Id CRM account ID for the account, up to 100 characters. Alphanumeric(CRM12345678)
Communication Profile Name The name of the communication profile configured. A string of 70 characters. Alphanumeric 
Currency* A currency as defined in Billing Settings in the Zuora UI. A string of 3 characters(Required field)

Currency values
Debit Memo Template Id The unique ID of the credit memo template, configured in Billing Settings(32 character identifier). Alphanumeric Id
Department NS Value of the Department field for the corresponding customer account in NetSuite. Only available if you have installed the Zuora Connector for NetSuite. String <= 255 characters
Integration Id NS ID of the corresponding object in NetSuite. Only available if you have installed the Zuora Connector for NetSuite. String <= 255 characters
Integration Status NS Status of the account's synchronization with NetSuite. Only available if you have installed the Zuora Connector for NetSuite. String <= 255 characters
Invoice Delivery Prefs Email Whether the customer wants to receive invoices through email. TRUE,FALSE(Case insensitive boolean value)
Invoice Delivery Prefs Print Whether the customer wants to receive printed invoices, such as through postal mail. TRUE,FALSE(Case insensitive boolean value)
Invoice Template Id Invoice template ID, configured in Billing Settings in the Zuora UI(32 character identifier). Alphanumeric Id
Location NS Value of the Location field for the corresponding customer account in NetSuite. Only available if you have installed the Zuora Connector for NetSuite. String <= 255 characters

Organization Label

This field is only applicable in a Multi-Org environment.  

Label the Org units that need to be associated with Accounts.

All the associated transaction objects of the account being labeled will automatically inherit the org label of the Account.

String
Parent Account Number Parent custom account number up to 50 characters. To access this field, you must have the CustomerHierarchy enabled. Alphanumeric

ParentID

The parent customer account associated with this account. To access this field, you must have the CustomerHierarchy enabled.

 string <= 32 characters
Payment Gateway Name The name of the payment gateway instance. Alphanumeric
Payment Term Payment terms configured for this account. A string of 100 characters. Due Upon Receipt, Net 30, Net 60, Net 90
Sales Rep Name The name of the sales representative associated with this account. A string of 50 characters. Alphanumeric
salesRep The name of the sales representative associated with this account. Maximum of 50 characters. string
Sequence Set Name The name of the billing document sequence set to assign to the customer account. A string of 32 characters Alphanumeric
ShipToContact FirstName* First name, 100 characters or less string
ShipToContact LastName* Last name, 100 characters or less string
shipToContactId The ship-to contact ID for the current account. string 
ShipToContact Address1 First address line, 255 characters or less string
ShipToContact Address2 Second address line, 255 characters or less string
ShipToContact City City, 40 characters or less string
ShipToContact Country Country; must be a valid country name or abbreviation string
ShipToContact County County; 32 characters or less. Can be optionally used by Zuora Tax to calculate county tax. string
ShipToContact Fax Fax phone number, 40 characters or less string
ShipToContact HomePhone Home phone number, 40 characters or less string
ShipToContact MobilePhone Mobile phone number, 40 characters or less string
ShipToContact NickName Nickname for this contact string
ShipToContact OtherPhone Other phone number, 40 characters or less string
ShipToContact OtherPhoneType Possible values are: Work, Mobile, Home, Other string
ShipToContact PersonalEmail Personal email address string <email> <= 80 characters
ShipToContact PostalCode Zip code, 20 characters or less string
ShipToContact State State; must be a valid subregion (state or province) name or code. For more information, see View subregions of a specific country or region. string
ShipToContact TaxRegion If using Zuora Tax, you can optionally define a region string in your tax rules, but it's not required. string
ShipToContact WorkEmail Work email address, 80 characters or less string
ShipToContact WorkPhone Work phone number, 40 characters or less string
SoldToSameAsBillTo Whether the sold-to contact and bill-to contact are the same entity. Boolean
SoldToContact.FirstName* A string of 100 characters Alphanumeric
SoldToContact.LastName* A string of 100 characters Alphanumeric
soldToContactId The sold-to contact ID for the current account. string
SoldToContact.WorkEmail Work email address Email(abc@zuora.com)
SoldToContact.PersonalEmail Personal email address Email(abc@zuora.com)
SoldToContact.WorkPhone Work phone number Alphanumeric - Accept characters like ()+-,spaces
SoldToContact.Country Valid country name or abbreviation.

Alphanumeric
SoldToContact.Address1 A string of 255 characters Alphanumeric
SoldToContact.Address2 A string of 255 characters Alphanumeric
SoldToContact.City City. A string of 40 characters Alphanumeric
SoldToContact.State State. A string of 40 characters Alphanumeric
SoldToContact.PostalCode Zip code. A string of 20 characters Alphanumeric
SoldToContact.County County. A string of 32 characters Valid County Name
SoldToContact.Fax Fax phone number Alphanumeric - Accept characters like ()+-,spaces
SoldToContact.HomePhone Home phone number Alphanumeric - Accept characters like ()+-,spaces
SoldToContact.MobilePhone Mobile phone number Alphanumeric - Accept characters like ()+-,spaces
SoldToContact.NickName Nickname. A string of 100 characters Alphanumeric
SoldToContact.OtherPhone Fax phone number Alphanumeric - Accept characters like ()+-,spaces
SoldToContact.Country Valid country name or abbreviation

Country values
SoldToContact.TaxRegion Tax region. A string of 32 characters Alphanumeric
SoldToContact.Description A string of 100 characters Alphanumeric
Subsidiary NS Value of the Subsidiary field for the corresponding customer account in NetSuite. The Subsidiary field is required if you use NetSuite OneWorld. Only available if you have installed the Zuora Connector for NetSuite. String <= 255 characters
summaryStatementTemplateId The summary statement template ID or null string
Sync Date NS Date when the account was sychronized with NetSuite. Only available if you have installed the Zuora Connector for NetSuite. String <= 255 characters
Sync To Net Suite NS Specifies whether the account should be synchronized with NetSuite. Only available if you have installed the Zuora Connector for NetSuite. String
TaxCompany Code Unique code that identifies a company account in Avalara Alphanumeric
TaxExempt Certificate Id ID of the customer tax exemption certificate Alphanumeric Id
TaxExempt Certificate Type Type of tax exemption certificate that the customer holds Alphanumeric
TaxExempt Description Description of the tax exemption certificate Alphanumeric
TaxExempt Effective Date Date when the customer tax exemption starts Date(yyyy-MM-dd)
TaxExempt Entity UseCode A unique entity use code Alphanumeric
TaxExempt ExemptExpirationDate Date when the customer tax exemption expires Date yyyy-MM-dd)
TaxExempt Issuing Jurisdiction Jurisdiction in which the customer tax exemption certificate was issued. Alphanumeric
TaxExempt Status Status of the account tax

TaxExempt Status values

  • Yes
  • No
  • PendingVerification
TaxExempt VATId Value Added Tax ID Alphanumeric Id