Skip to main content

Custom object records

Zuora

Custom object records

Zuora Custom Objects provide the service to define custom objects. You can extend the Zuora data model to accommodate your specific use cases with custom objects.

This article describes how to view, create, update, and delete custom object records through UI. If you want to access custom object records by API, see Custom Object Records in Zuora API Reference.

View custom object records

To view custom object records:

  1. Navigate through Platform > Custom Objects. The list of custom objects will be displayed.
  2. Input the custom object name in the search box.
  3. Click the object name in the search result. The custom object details will be displayed.
  4. Click VIEW OBJECT RECORDS. The record list of the object will be displayed.

Note that the maximum number of records that can be displayed in the record list is 100,000. 

Create a new custom object record

You can create a new custom object record manually. You can also create a batch of records by uploading a CSV file. 

To create a new custom object record manually:

  1. Click + at the top right of the record list view.
  2. Input the value for each field and click SAVE.

To create records as a batch, you can upload a CSV file that contains the records to be created, one per line. The CSV column names must align exactly with the custom fields' API Names. Do not include system fields such as Id, CreatedDate, or UpdatedDate in your CSV. Take the following steps to upload your CSV file and create the records as a batch:

  1. Click UPLOAD CSV at the top right of the record list view.
  2. Click Choose File and select the CSV file you want to upload in the Upload CSV File dialog.
  3. Click UPLOAD.

Note that the maximum upload file size is 15MB.

If the custom object definition contains a relationship type of field, you need to fill in the mapping field value of the related object. Custom object service currently only supports the related object's ID as the mapping field.

The maximum number of records that you can create for an object type is 3,000,000.

Note that you should not store PCI, sensitive PII, or other regulated data in custom objects. See Responding to individual requests for access, correction, and deletion of data under applicable privacy laws for more information. 

Edit a custom object record

To edit a custom object record:

  1. Click the edit icon on the right side of the record in the record list of the object.
  2. Edit the fields and click SAVE.

Delete a custom object record

To delete a custom object record:

  1. Click the trash can icon on the right of the record in the record list of the object.
  2. Click YES in the confirmation dialog.

To delete all the records of a custom object:

  1. Click the tick box on the left of the record list head.
  2. Click DELETE SELECTED.
  3. Click YES in the confirmation dialog.

To delete the selected records of a custom object:

  1. Tick the records that you want to delete.
  2. Click DELETE SELECTED.
  3. Click YES in the confirmation dialog.

Note that the records are deleted immediately and, therefore, will not be retained once you confirm the deletion.

Query custom object records

You can query custom object records by the following ways:

Manage custom object records in Workflow

Zuora Workflow provides the following tasks for you to create, query, update, or delete custom object records: