Skip to main content

Custom object records

Zuora

Custom object records

  1. Last updated
  2. Save as PDF

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, perform the following steps:

  1. Navigate to Platform > Custom Objects.
  2. Click the object name in the Label column. The custom object records page opens.
    You can find all custom object records of the current custom object from the list view.

When using custom object records, keep the following notes in mind:

  • The maximum number of records that can be displayed in the record list is 100,000.
  • The ID of a custom object record contains 36 characters, including four hyphens. For example, 98687943-22ec-4283-be45-01cefb6e5ece.

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, perform the following steps:

  1. Click the Create icon Create.png at the upper 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 the Import icon Import.png at the upper right of the record list view.
  2. Click Choose File and select the CSV file you want to upload in the CSV Import 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 10,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, perform the following steps:

  1. Click the ID of a custom object record from the record list view. The record details page opens.
  2. Click the edit icon Edit.png to enable the edit mode, and then update the record details as needed.
    Note that if you click the edit icon again, Zuora will exit the edit mode without saving any of your changes.
  3. Click the save icon Save.png to save your changes.

Delete custom object records

To delete a custom object record, perform the following steps:

  1. Click the Delete icon Delete.png to the right of a record from the record list view.
  2. Click Delete in the confirmation dialog.

To delete the selected records of a custom object, perform the following steps:

  1. Select the records that you want to delete from the record list view.
  2. Click the Delete Selected icon Delete.png at the upper right of the list.
  3. Click Delete in the confirmation dialog.

To delete all the records of a custom object, perform the following steps:

  1. Click the Delete All icon Delete All.png at the upper right of the record list view.
  2. Click Delete 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:

  • Make a Query custom object records call. This is a high-performance query and only filterable fields can be used as filters in this query. See Query syntax of custom object records for details.
  • Use Data Query. This is an asynchronous query and any field can be used in the WHERE clause to filter results. See SQL Queries in Data Query for details.

    Note that it may take up to 60 minutes for a newly created custom object to be available in Data Query.

    To query custom objects in Data Query, the custom object name needs to be prefixed with default__ and custom field API names should be used in the SELECT statement. For example:

    SELECT make__c, model__c, year__c, VIN__c 
    FROM default__Vehicle

Manage custom object records in Workflow

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