Knowledge Center

Knowledge Center > RBM Solutions > Manage Custom Fields

Manage Custom Fields

You can extend the business objects in your Zuora tenant by defining custom fields. Custom fields that you define are visible in the Zuora user interface and are available through the Zuora API. See How do I use custom fields? for examples of how your organization can leverage custom fields.

This article explains how to view, create, and modify custom field definitions in Zuora Settings. After you have defined a custom field, you can view and edit the field's value through the Zuora user interface, exports and imports, and the Zuora API.

For example, if you define a custom Account field, the field is included on the New Customer Account page and is supported in customer account imports.

View Custom Fields

To view the custom fields that are defined for a business object:

    • If the object is related to accounts, subscriptions, invoices, or products, click your username at the top right and navigate to Settings > Billing.
    • If the object is related to payments or refunds, click your username at the top right and navigate to Settings > Payments.
    • If the object is related to accounting or revenue, click your username at the top right and navigate to Settings > Finance.
  1. Click Manage Custom Fields.

    Zuora lists the objects that support custom fields. For each object, Zuora displays the number of custom fields that have been defined.

  2. Select the object.

    "Invoice Detail" refers to the Invoice Item object.

Zuora lists the custom fields that have been defined for the object. The custom fields are listed in the following groups:

  • Indexed - Indexed custom fields have better performance than non-indexed custom fields. For example, if you are querying custom fields using synchronous API requests, you can expect the best performance if all of the custom fields are indexed.
  • Non-Indexed - Non-indexed custom fields are functionally identical to indexed fields, but have lower performance.

If your Zuora tenant has integrations with external systems, you may see integration-related custom fields in the System group.

Create Custom Fields

To define a custom field for a business object:

  1. View the existing custom fields for the object. See the "View Custom Fields" section for more information.

  2. In the Indexed or Non-Indexed group, click add new field.

  3. Select a field type, then enter the field definition.

    For example:

    Custom_Account_Field.png

    If you select Required, Zuora will require users to specify a value for the field when creating an object. If you select UI Read Only, users will be able to update the field's value via the Zuora API but not via the Zuora UI. 

    The suffix __c (two underscores and the letter "c") is automatically appended to the end of the API name when Zuora creates the custom field.

  4. Click save.

Zuora creates the custom field. The custom field will then appear in the Zuora UI. For example:

Beta_Tester_Field.png

When Zuora creates a custom field, Zuora does not apply the default value to existing objects.

This means that if you define a custom field, then immediately perform a ZOQL query such as select BetaTester__c from Account, the query will not return any values for BetaTester__c.

To apply the default value to an existing object, you must modify the object via the Zuora UI or the Zuora API.

Modify Custom Fields

To modify the definition of a custom field:

  1. In the list of custom fields for an object, click the label or API name of the field.

    Zuora displays the definition of the custom field. For example:

    Custom_Account_Field_Edit.png

  2. Click Edit.

  3. Modify the field definition.

    You cannot change the field type. If the field type is Picklist, you cannot remove picklist values.

  4. Click save.

If you modify or delete a custom field, you must update any integrations that access the field. For instance:

  • If you change the label of a field, the API name of the field will also change. Any integration that continues to use the old API name will receive an error. You must update integrations to use the new API name.
  • If you decrease the length of a field, any integration that sends data that exceeds the new field length will receive an "Invalid_value" error. You must check the maximum length of data that integrations could send.

Notes

  • For the Usage object, do not create a custom field with the same name as a standard Zuora field. This avoids ambiguity when importing usage files.
Last modified

Tags

Classifications

(not set)