Welcome to Zuora Product Documentation

Explore our rich library of product information

Legacy accounts update fields

Use this reference to view all the fields associated with the legacy accounts data dictionary.

Note: Fields with an asterisk mark indicate mandatory fields.
Name Description Value

Id *

account ID

string

Account Name

Specify the customer account name.

string <= 255 characters

Account Notes

A string of up to 65,535 characters.

string

Account Number

A unique identifier assigned to the account.

string

Additional Email Addresses

A list of additional email addresses to receive email notifications. Use commas to separate email addresses.

array of strings

Allow Invoice Edit

Indicates whether the invoice can be edited after it is created.

Character limit: 5

Default: false

boolean

Auto Pay

Indicates whether future payments are automatically billed upon reaching their due date.

boolean

Batch

The alias name given to a batch. A string of 50 characters or less.

Note: By default, you have 50 configurable account batches.

string

Bcd Setting Option

Billing cycle day setting option.

string

Bill Cycle Day

Sets the bill cycle day (BCD) for the charge. The BCD determines which day of the month the customer is billed. Values: Any activated system-defined bill cycle day (1-31).

integer <= 2 characters

Bill To Id

A valid contact Id of the person to be billed for the account.

string <= 32 characters

Communication Profile Id

The ID of the communication profile that this account is linked to.

string

CRM Account Id

CRM account ID for the account, up to 100 characters.

string

Currency

A currency as defined in Billing Settings.

You can update this value only when the account is in Draft status. Once the account is activated, you cannot update this value.

string <= 100 characters

Customer Service Rep Name

Name of the account's customer service representative, if applicable.

string <= 50 characters

Default Payment Method Id

Id of the default payment method for the account.

Values: a valid Id for an existing payment method.

string <= 64 characters

Invoice Delivery Prefs Email

Whether the customer wants to receive invoices through email. The default value is false.

boolean

Invoice Delivery Prefs Print

Whether the customer wants to receive invoices through email. The default value is false.

boolean

Invoice Template Id

Invoice template ID, configured in Billing Settings in the Zuora UI.

string

Parent Id

Identifier of the parent customer account for this Account object. Use this field if you have Customer Hierarchy enabled.

string <= 32 characters

Payment Gateway Name

The name of the payment gateway instance. If null or left unassigned, the Account will use the Default Gateway.

string

Payment Method Cascading Consent

Indicates whether you have collected consent from your customer to use the Cascading Payment Method feature.

boolean

Payment Term

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

string

Purchase Order Number

The purchase order number provided by your customer for services, products, or both purchased.

string

Sales Rep Name

The name of the sales representative associated with this account, if applicable. Maximum of 50 characters.

string

Sequence Set Id

The Id of the billing document sequence set to assign to the customer account.

string or null

Sold To Id

A valid contact ID of the person who purchased the subscription associated with the account.

string <= 32 characters

Status

Status of the account in the system.

If you're using subscribe(), leave this field as null.

If you're using create(), specify one of the following statuses:
  • Draft
  • Active
  • Canceled

string

Tax Company Code

Unique code that identifies a company account in Avalara. Use this field to calculate taxes based on origin and sold-to addresses in Avalara.

string <=50 characters

Tax Exempt Certificate Id

Id of the customer's tax exemption certificate.

string

Tax Exempt Certificate Type

Type of tax exemption certificate that the customer holds.

string

Tax Exempt Description

Description of the tax exemption certificate that the customer holds.

string

Tax Exempt Effective Date

Date when the customer tax exemption starts.

string <date>

Tax Exempt Expiration Date

Date when the customer tax exemption expires.

string <date>

Tax Exempt Issuing Jurisdiction

Jurisdiction in which the customer tax exemption certificate was issued.

string

Tax Exempt Status

Status of the account tax exemption.

This field is required when using Z-Tax and is not available if Z-Tax is not enabled.

Values:

  • Yes
  • No (default)
  • Pending Verification

string

VAT Id

EU Value Added Tax ID.

string <= 25