| AccountNumber |
Yes |
string |
This can either be null on insert, which will auto-populate based on the account number prefix specified in setup, or a string value that does not begin with the account number prefix specified in setup. |
The account number associated with the account that is being created. This must be unique within your system. If you do not specify a number when creating the account, then Zuora will create one. If you specify an account number, Zuora uses the number you specify unless it conflicts with an account number already in the system. |
| AllowInvoiceEdit |
Yes |
boolean |
Yes or No (1 or 0) |
Indicates whether the invoice can be edited (Yes) or not (No). |
| AutoPay |
No |
boolean |
Yes or No (1 or 0) |
Set this to Yes if all future payments are to be automatically billed when due. |
| Batch |
Yes |
string |
This value is set internally. A batch is set up for all manually entered credit card accounts. |
This will be validated with the list of batches in the system. |
| BillCycleDay |
Depends (see description) |
int |
1–28 |
Represents the billing cycle day for the account. Usually should be set based on the day the account was created, but other values will be accepted as well. |
| BillToId |
Depends (see description) |
zns: ID |
A valid contact ID created for this account |
This is the ID of the person who is to be billed for the subscription. It can be the same as the SoldToId, though it doesn't have to be. |
| CreatedDate |
Yes |
dateTime |
This field is not editable. |
The Zuora system automatically generates this date when the account is created. |
| CrmId |
No |
string |
40 characters |
The CRM account ID. If you wish, you can create an initial subscription using the API, and later
return with another call to set or update the CrmId field in this object. |
| Currency |
No |
currency |
Any valid currency values |
The currency with which the account is being paid. It will be validated against the list of available currencies in the system. |
| CustomerServiceRepName |
No |
string |
100 characters |
The name of this account's Customer Service representative. The customer may choose to supply this information if a Customer Service representative was involved. |
| DefaultPaymentMethodId |
Yes if AutoPay is set to Yes; No otherwise |
zns: ID |
ID of existing payment method on Account |
A reference to the default payment for this account. |
| Name |
Yes |
string |
50 characters |
This is the name of the account. |
| PaymentTerm |
Yes |
string |
Typical payment terms (e.g., Due Upon Receipt, Net30, Net45, etc.) |
This field maps to the payment terms defined for your organization as configured in administrative settings.
If a value is provided, it will be referenced with the list of supported payment terms. |
| PurchaseOrderNumber |
No |
string |
Any text string
|
The number of the purchase order associated with this account. |
| SalesRepName |
No |
string |
100 characters |
The customer may choose to supply this information based on whether a sales rep was involved. |
| SoldToId |
Depends (see description) |
zns: ID |
A valid contact ID created for this account |
This is the ID of the person who the subscription is being sold to. It can be the same as the BillToId, though it doesn't have to be. |
| Status |
No |
string (enum) |
Draft, Active, or Canceled |
The status of the account. The values are case sensitive and must be used exactly as shown here. |
| UpdatedDate |
Yes |
dateTime |
This field is not editable. |
The Zuora system automatically generates this date when the contact is modified. |