Field descriptions
This reference provides the description of the fields of the Account object.
All field names are case sensitive. Check enumerated values in descriptions to confirm capitalization and spacing.
|
Name |
Required to create? |
Allowed operations |
Description |
|---|---|---|---|
|
AccountNumber |
optional |
Create Query Update Delete Filter |
Unique account number assigned to the account. You can modify the account number of a customer account only if the account has no subscriptions or draft subscriptions only. Otherwise, the account number cannot be modified. Type : string Character limit : 50 Version notes : -- Values : one of the following:
|
|
AdditionalEmailAddresses |
optional |
Create Query Update Delete Filter |
List of additional email addresses to receive email notifications. Type : string Character limit : 1200 Version notes : WSDL 7.0+ Values : comma-separated list of email addresses |
|
AllowInvoiceEdit |
optional |
Create Query Update Delete Filter |
Indicates if associated invoices can be edited. Type : boolean Character limit : 5 Version notes : -- Values : |
|
AutoPay |
optional |
Create Query Update Delete Filter |
Indicates if future payments are automatically collected when they're due during a Payment Run. Type : boolean Character limit : 5 Version notes : -- Values : |
|
Balance |
NA |
Query Filter |
Current outstanding balance for the account. Type : decimal Character limit : 16 Version notes : type is double for WSDL 18.0 and older Values : automatically generated |
|
Batch |
conditional |
Create Query Update Delete Filter |
Organizes your customer accounts into groups to optimize your billing and payment operations. Required if use the subscribe() call, optional for other supported calls. Type : string Character limit : 20 Version notes : -- Values :any system-defined batch ( |
|
BcdSettingOption |
optional |
Create Query Update Delete Filter |
Billing cycle day setting option. Type : string Character limit : 9 Version notes : -- Values : |
|
BillCycleDay |
required |
Create Query Update Delete Filter |
Billing cycle day (BCD) on which bill runs generate invoices for the account. Type : int Character limit : 2 Version notes : WSDL 30.0+ Values : any activated system-defined bill cycle day ( |
|
BillToId |
optional |
Create Query Update Delete Filter |
ID of the person to bill for the account. Type : zns:ID Character limit : 32 Version notes : -- Values : a valid contact ID for the account |
|
CommunicationProfileId |
optional |
Create Query Update Delete Filter |
Associates the account with a specified communication profile. Type : zns:ID Character limit : 32 Version notes : -- Values : a valid communication profile ID |
|
CreatedById |
NA |
Query Filter |
ID of the Zuora user who created the Account object. Type : zns:ID Character limit : 32 Version notes : WSDL 20.0+ Values : automatically generated |
|
CreatedDate |
NA |
Query Filter |
Date when the Account object was created. Type : dateTime Character limit : 29 Version notes : WSDL 20.0+ Values : automatically generated |
|
CreditBalance |
NA |
Query Filter |
Total credit balance for the account. Type : decimal Character limit : 16 Version notes : WSDL 22.0+ Values : automatically generated |
|
CrmId |
optional |
Create Query Update Delete Filter |
CRM account ID for the account. Used in Salesforce integration. Type : string Character limit : 100 Version notes : -- Values : a string of 100 characters or fewer |
|
Currency |
required |
Create Query Update* Delete Filter |
Currency that the customer is billed in. See Currency for more information. You can update this value only when the account is in Type : string Character limit : 100 Version notes : -- Values : a currency value defined in the Zuora Ui admin settings |
|
CustomerServiceRepName |
optional |
Create Query Update Delete Filter |
Name of the account's customer service representative, if applicable. Type : string Character limit : 50 Version notes : -- Values : a string of 50 characters or fewer |
|
DefaultPaymentMethodId |
optional |
Create Query Update Delete Filter |
ID of the default payment method for the account. This field is required if the AutoPay field is set to Type : zns:ID Character limit : 32 Version notes : -- Values : a valid ID for an existing payment method |
|
Gateway |
NA |
NA |
Deprecated at WSDL 23.0. Use the PaymentGateway field instead. |
|
Id |
NA |
Query Filter |
ID of object. Upon creation of this object, this field becomes Type : zns:ID Character limit : 32 Version notes : -- Values : automatically generated |
|
InvoiceDeliveryPrefsEmail |
optional |
Create Query Update Delete Filter |
Indicates if the customer wants to receive invoices through email. Type : boolean Character limit : 5 Version notes : -- Values : |
|
InvoiceDeliveryPrefsPrint |
optional |
Create Query Update Delete Filter |
Indicates if the customer wants to receive printed invoices, such as through postal mail. Type : boolean Character limit : 5 Version notes : -- Values : |
|
InvoiceTemplateId |
optional |
Create Query Update Delete Filter |
The ID of the invoice template. Each customer account can use a specific invoice template for invoice generation. Type : zns:ID Character limit : 32 Version notes : -- Values : a valid template ID configured in Z-Billing Settings To find the ID of your current invoice template: In Zuora, navigate to Settings > Z-Billing > Manage Invoice Rules and Templates and click Show Id next to the template you want to use. |
|
LastInvoiceDate |
optional |
Query Filter |
The date when the previous invoice was generated for the account. The field value is null if no invoice has ever been generated for the account. Type:
Character limit : 29 Version notes : -- Values : automatically generated |
|
Name |
required |
Create Query Update Delete Filter |
Name of the account as displayed in the Zuora UI. Type : string Character limit : 255 Version notes : -- Values : a string of 255 characters or fewer |
|
Notes |
optional |
Create Query Update Delete Filter |
Comments about the account. Type : string Character limit : 65,535 Version notes : -- Values : a string of 65,535 characters |
|
ParentId |
optional |
Create Query Update Delete Filter |
Identifier of the parent customer account for this Account object. Use this field if you have customer hierarchy enabled. Type : zns:ID Character limit : 32 Version notes : -- Values : a valid account ID |
|
PaymentGateway |
optional |
Create Query Update Delete Filter |
Gateway used for processing electronic payments and refunds. Type : string Character limit : 40 Version notes : WSDL 23.0+ Values : one of the following:
|
|
PaymentMethodCascadingConsent |
optional |
Create Query Update Delete |
Indicates whether you have collected consent from your customer to use the Cascading Payment Method feature. Type : boolean Version notes : WSDL 137.0+ Values : true, false (default) |
|
PaymentTerm |
required |
Create Query Update Delete Filter |
Indicates when the customer pays for subscriptions. Type : string Character limit : 100 Version notes : -- Values : a valid, active payment term defined in the web-based UI administrative settings |
|
PurchaseOrderNumber |
optional |
Create Query Update Delete Filter |
The number of the purchase order associated with this account. Purchase order information generally comes from customers. Type : string Character limit : 100 Version notes : -- Values : a string of 100 characters or fewer |
|
SalesRepName |
optional |
Create Query Update Delete Filter |
The name of the sales representative associated with this account, if applicable. Type : string Character limit : 50 Version notes : -- Values : a string of 50 characters or fewer |
|
SequenceSetId |
optional |
Create Query Update Delete Filter |
The ID of the billing document sequence set to assign to the customer account. The billing documents to generate for this account will adopt the prefix and starting document number configured in the sequence set. Type : string Character limit : 32 Version notes : WSDL 96.0+ Values : a string of 32 characters or fewer |
|
SoldToId |
optional |
Create Query Update Delete Filter |
ID of the person who bought the subscription associated with the account. Type : zns:ID Character limit : 32 Version notes : -- Values : a valid contact ID for the account |
|
Status |
required |
Create Query Update Delete Filter |
Status of the account in the system. Type : string Character limit : 8 Version notes : -- Values : one of the following:
|
|
TaxCompanyCode |
optional |
Create Query Update Subscribe |
Unique code that identifies a company account in Avalara. Use this field to calculate taxes based on origin and sold-to addresses in Avalara. Note:
This feature is in the Early Adopter phase. If you want to have access to the feature, submit a request at Zuora Global Support . Type : string Character limit : 50 Version notes : WSDL 70.0+ Values : a valid company code |
|
TaxExemptCertificateID |
optional |
Create Query Update Delete Filter |
ID of your customer's tax exemption certificate. Type : string Character limit : 32 Version notes : requires Z-Tax Values : a string of 32 characters or fewer |
|
TaxExemptCertificateType |
optional |
Create Query Update Delete Filter |
Type of the tax exemption certificate that your customer holds. Type : string Character limit : 32 Version notes : requires Z-Tax Values : a string of 32 characters or fewer |
|
TaxExemptDescription |
optional |
Create Query Update Delete Filter |
Description of the tax exemption certificate that your customer holds. Type : string Character limit : 500 Version notes : requires Z-Tax Values : a string of 500 characters or fewer |
|
TaxExemptEffectiveDate |
optional |
Create Query Update Delete Filter |
Date when the customer's tax exemption starts. Type:
Character limit : 29 Version notes : requires Z-Tax |
|
TaxExemptExpirationDate |
optional |
Create Query Update Delete Filter |
Date when the customer's tax exemption certificate expires Type:
Character limit : 29 Version notes : requires Z-Tax |
|
TaxExemptIssuingJurisdiction |
optional |
Create Query Update Delete Filter |
Indicates the jurisdiction in which the customer's tax exemption certificate was issued. Type : string Character limit : 32 Version notes : requires Z-Tax Values : a string of 32 characters or fewer |
|
TaxExemptStatus |
conditional |
Create Query Update Delete Filter |
Status of the account's tax exemption. Required if you use Z-Tax. This field is unavailable if you don't use Z-Tax. Type : string (enum) Character limit : 19 Version notes : requires Z-Tax Values : one of the following:
|
|
TotalInvoiceBalance |
NA |
Query Filter |
Total balance of the account's invoices. Type : decimal (currency) Character limit : 16 Version notes : requires Credit Balances Values : a valid currency value |
|
UpdatedById |
NA |
Query Filter |
ID of the user who last updated the account. Type : zns:IDzns:ID Character limit : 32 Version notes : -- Values : automatically generated |
|
UpdatedDate |
NA |
Query Filter |
Date when the account was last updated. Type : dateTime Character limit : 29 Version notes : -- Values : automatically generated |
|
VATId |
optional |
Create Query Update Delete Filter |
EU Value Added Tax ID. Note:
This feature is in the Early Adopter phase. If you want to have access to the feature, submit a request at Zuora Global Support . Type : string Character limit : 25 Version notes : requires taxation, WSDL 70.0+ Values : a valid Value Added Tax ID |