Skip to main content

Synchronize Zuora Custom Fields

Zuora

Synchronize Zuora Custom Fields

This article explains how to synchronize custom fields created in the Zuora application to Salesforce. 

Synchronize a Custom Field

Zuora 360+ supports fields of String, Date, and Picklist types. Custom fields are synchronized when the Zuora objects are synced to Salesforce. 

To synchronize a custom field:

  1. In the Zuora application, navigate to Settings > Billing > Manage Custom Fields, and define the custom field as described in Manage Custom Fields.
  2. Define the corresponding field in Salesforce with the same API name. You must create the field in Salesforce before you can sync Zuora custom field data. You can synchronize custom fields up to 255 characters long. For the picklist type custom fields, each picklist option can be up to 255 characters long.
    • For example: Create a subscription custom field in Salesforce by going to Setup > App Setup > Create > Objects > Subscription > New Custom Fields & Relationships. Create the same custom field as you created in Zuora using the same field attributes, such as picklist, values, API Name.
  3. Add the custom field on the Salesforce related list.
    • For example, if you are adding a subscription custom field, go to Setup > App Setup > Customize > Accounts > Page Layouts > Account Z-Force 360 Layout v## (latest version) > Edit the Related List for Subscriptions and add the custom field you created in the prior step.
  4. The sync process will automatically sync the custom fields to Salesforce. Your Zuora 360+ sync will execute according to your sync settings in Zuora. See Synchronize Data from Zuora about setting sync options.

In the Field Name field, you can enter a value, for example, MyCompanySKU, and Salesforce will insert the required __c custom field suffix automatically.

  1. After the sync is completed, refresh the Salesforce account page. The custom fields will now show the value that came from Zuora.

Troubleshooting

In some cases, the sync process cannot sync custom fields. This can happen when the object has already been synced before the custom fields were added in Salesforce.

For example:

  • SubscriptionA exists in Zuora. It has custom fields and values. There are no custom fields defined in Salesforce.com.
  • When you run the sync, SubscriptionA syncs to Salesforce without custom fields.
  • Then you add the custom fields in Salesforce and sync again.

In this case, you will not see values for the custom fields because this is an incremental sync and SubscriptionA is not updated. Because of this, SubscriptionA will not sync to Salesforce.

If you have configured custom fields but do not see them in Salesforce, you must update the object that you want to sync by opening the object for edit in Zuora and then saving the object without making changes. When you update the object, the custom fields will be synced in the next incremental sync. However, if you are updating a large number of records, Zuora recommends that you perform a cleanup sync.

  1.