Custom field types and settings
This article describes supported custom field types for Zuora standard and custom objects, including the description, data format, examples, available custom field settings, and limitations of each custom field type.
Custom field types
Zuora supports the following custom field types for standard and custom objects:
- Text
- Long Text
- URL
- Integer
- Number
- Boolean
- Date
- Datetime
- Picklist
- Multiselect
- Relationship
The following table lists the data format, description, and examples of each custom field type:
Custom field type | Data format | Description | Example field values in the UI |
---|---|---|---|
Text | String | Used to store string values. | Blue, ax-23, Completed |
Long Text | String | Used to store long string values. | Long text information… |
URL | String | Used to store URL-formatted string values. | https://mycompany/additionalinfo/437825 |
Integer | Integer | Used to store integer values. | 5, -18, 0 |
Number | Number | Used to store number values. | 5, -18, 0, 20.6, -100.32 |
Boolean | Boolean | Used to store boolean values. | True, False |
Date | String | Used to store date-formatted string values. |
06/18/2023 The date format is based on the locale settings in your tenant. For more information, see Locale date formats. |
Datetime | String | Used to store datetime-formatted string values. |
06/18/2023 02:54 PM The date format is based on the locale settings in your tenant. For more information, see Locale date formats. |
Picklist | String | Used to store a single selection from several pre-defined options. | a |
Multiselect | String | Used to store multiple selections from several pre-defined options. | a,b |
Relationship | String | Used to store links to other related objects. | AcmeCorporation |
Custom field settings
The available custom field settings vary based on the custom field type.
The following common settings are available for most custom field types:
- Required: Indicates whether this custom field is required when creating an object.
- Filterable (Indexed): Indicates whether this custom field is an indexed field in the object. Any custom field can be used as a filter in Data Query, regardless of whether this field setting is turned on or not. However, querying data from indexed fields has better performance than from non-indexed fields.
For indexed fields in custom objects, you can also use them as filters in high-performance queries submitted through the List records for a custom object API operation. - Unique: Indicates whether the value in this custom field is unique.
The Unique setting applies only to custom fields for custom objects. - Auditable: Indicates whether Audit Trail will record the changes of this custom field. The changes include creation, modification, and deletion.
The Auditable setting applies only to custom fields for custom objects.
You must enable the Custom Object Definition audit trail setting in your Zuora tenant before auditing custom field changes. For more information, see Manage audit trail settings.
The following table lists the available settings of each custom field type:
Custom field type | Required | Filterable (Indexed) | Unique | Auditable | Other settings |
---|---|---|---|---|---|
Text |
|
||||
Long Text | N/A | N/A |
|
||
URL | N/A | N/A |
|
||
Integer |
|
||||
Number |
|
||||
Boolean |
Default value: the default value of this field. The available values are as follows:
|
||||
Date | Default value: the default value of this field | ||||
Datetime | Default value: the default value of this field | ||||
Picklist |
|
||||
Multiselect | N/A | N/A |
|
||
Relationship |
|
Notes and limitations
General notes and limitations are as follows:
- You can change a required custom field to optional at any time. However, you can create a required custom field or change an optional custom field to required only if the object to which this custom field belongs has no record.
- Only filterable custom fields can be set to unique.
- One custom object can have a maximum of five unique custom fields.
- One custom object can have a maximum of five auditable custom fields.
- The maximum number of each object's total custom fields or filterable custom fields varies depending on your Zuora edition or Zuora modules. For more information, see Zuora Editions and Zuora Modules.
The following table lists the notes and limitations of each custom field type:
Custom field type | Notes and limitations |
---|---|
Text |
|
Long Text |
|
URL |
|
Integer |
|
Number | The maximum number of digits to the left of the decimal point is 13 and to the right is 9. |
Boolean | N/A |
Date | N/A |
Datetime | Both data and time values are needed. |
Picklist |
|
Multiselect |
|
Relationship |
|