Field Types

From API Documentation

The underlying basic data types used in the WSDL, which are described in the topic, Understanding the Zuora WSDL, can have different interpretations depending on context. For example, text, textarea, email, phone number, enum, and autonumber are all different types of string fields. The possible interpretations of the basic WSDL data types are provided on the following table.

Field Type	Base Type	Interpretation
autonumber	string	When there is an autonumber field, you don’t need to specify a value. Instead, the system automatically generates a number for you based on your administrator settings. If you do specify a value, then it will validate your specified values for consistency against the system definition.
boolean	boolean	A boolean value is either true or false.
currency	double/decimal	As of v19.0+ of the API, all currency fields are of type decimal. Prior versions of API use type double for currency fields.
dateTime	dateTime	See dateTime.
email	string	Email fields contain email addresses. It is your responsibility to specify valid and properly formatted email addresses in your create and update calls.
enum	string	This type is a string that is restricted to a certain set of values. The set depends on the field and the object context. All enum fields are case sensitive.
ID	zns: ID	All objects in this API have an ID field. This field is inherited from the zObject object. It is 32 alphanumeric characters. The ID is a unique identifier for each record in an object. Some ID fields are automatically generated or updated by the system, such as CreatedById or LastModifiedById. See Zuora IDs for more information.
int	int	An int (integer) data type is a whole number without a decimal point or any value that would follow a decimal point. 1, for example, is an integer; 1.0 and 1. are not. An integer can be a negative number.
phone	string	Phone fields contain telephone numbers, which can include alphabetic characters. As with the email fields, it is your responsibility to format phone numbers.
quantity	double/decimal	As of v19.0+ of the API, quantity fields are represented of type decimal. Older versions of the API use type double.
text	string	A string value. The size varies with the field and object context.
textarea	string	A textarea field is a string that is displayed as a multiline text field; it can contain more than 4,000 bytes of text. Unlike string fields, textarea fields cannot be specified in the WHERE clause of a queryString of a query call. To filter records on this field, you must do so while processing records in the QueryResult.

Required Fields and Non-Editable Fields

In the API reference section, some fields are marked as required. In those cases, those fields cannot have a null value. Sometimes the field will be automatically populated by the system; other times, you will need to provide the necessary information. The description of each field makes it clear which ones are automatically generated and which ones are not.

In some cases, a field is not editable. This is because it is automatically filled in by the system, either directly or by taking the value from another object.

Zuora IDs

Zuora IDs, including the Account ID, Subscription ID, RatePlan ID, and all other IDs in the system, are unique values that are used as Primary Keys for objects. The IDs are generated by Zuora.

The Account ID is included in the URL for an Account. For example:

https://www.zuora.com/apps/CustomerAccount.do?method=view&id=4028e4862dcd32be012dd4a4bd5f07eb

In this example, the Account ID is 4028e4862dcd32be012dd4a4bd5f07eb.