Send Custom Fields to Zuora

Objects and Field Sets for Custom Fields

Add the custom fields you want to send to Zuora to the following field sets. The Custom Amendment Fields field set is supported starting in Zuora Quotes, version 9.0. The rest field sets are supported starting in Zuora Quotes, version 6.0.

Supported Data Types

The following data types are supported for Zuora Quotes custom fields used for sending quotes to Zuora.

• Text
• Text Area
• Text Area Long
• Picklist
• Number
• Boolean (Checkbox in Salesforce)

Custom Quote Fields

When you add a custom field to the Custom Quote Fields (zqu__CustomQuoteFields) field set, the value of that custom field is used to populate the corresponding custom field of the same API name on the Subscription when the quote is sent to Zuora.

To send a Subscription custom field to Zuora:

1. In Zuora, create the custom field on the Subscription object.
2. In Zuora Quotes, create the custom field on the Quote object with the exact same API name and type as in Step #1.
3. in Zuora Quotes, add the custom field you created in Step #2 to the Custom Quote Fields field set.

When a quote is sent to Zuora, the value in the custom field of the quote will be sent to Zuora to set the value of the custom field on the Subscription object in Zuora.

You cannot add the standard fields, prefixed with "zqu_", on the Quote object to the Custom Quote Fields field set.

By default, this field set contains no fields.  

Custom Order Fields

This field set is applicable only if you have the Orders feature enabled for your Zuora tenant.

When you add a custom field to the Custom Order Fields (zqu__CustomOrderFields) field set, the value of that custom field is used to populate the corresponding custom field of the same API name on the Order when the quote is sent to Zuora.

To send an Order custom field to Zuora:

1. In Zuora, create the custom field on the Order object.
2. In Zuora Quotes, create the custom field on the Quote object with the exact same API name and type as in Step #1.
3. in Zuora Quotes, add the custom field you created in Step #2 to the Custom Order Fields field set.

When a quote is sent to Zuora, the value in the custom field of the quote will be sent to Zuora to set the value of the custom field on the Order object in Zuora.

You cannot add the standard fields, prefixed with "zqu_", on the Quote object to the Custom Order Fields field set.

By default, this field set contains no fields.  

Custom Quote Query Fields

This field set is applicable to query the custom fields from Zuora to CPQ.

To display a new custom field and pass the value to Zuora when a new subscription, add the new custom field to the quote object and add it to the existing field set (quote information). If the custom field value is modified in Zuora and if you want to query the latest value during an amend or renew, this new field set is applicable (zqu__CustomQuoteQueryFields). 

Custom Amendment Fields

When you add a custom field to the Custom Amendment Fields (zqu__CustomAmendmentFields) field set, the value of that custom field is used to populate the corresponding custom field of the same API name on the Subscription when the quote is sent to Zuora.

To send a Subscription custom field to Zuora:

1. In Zuora, create the custom field on the Subscription object.
2. In Zuora Quotes, create the custom field on the Quote Amendment object with the exact same API name and type as in Step #1.
3. in Zuora Quotes, add the custom field you created in Step #2 to the Custom Amendment Fields field set.

When a quote is sent to Zuora, the value in the custom field of the quote will be sent to Zuora to set the value of the custom field on the Subscription object in Zuora.

You cannot add the standard fields, prefixed with "zqu_", on the Quote Amendment object to the Custom Amendment Fields field set.

The Custom Amendment Fields field set is sent to Zuora when:

• Creating a renewal
• Creating an amendment

By default, this field set contains no fields.  

Custom Charge Fields

When you add a custom field to the Custom Charge Fields (zqu__CustomChargeFields) field set, the value of the custom field is used to populate the corresponding custom field of the same API name on the subscription rate plan charges.

In Zuora Quotes, the Quote Rate Plan Charge object represents quote charges. For each custom field you have on the Subscription Rate Plan Charge object, you need to create the custom field with the same API name on the Quote Rate Plan Charge object and add the custom field to the Custom Charge Fields field set of the Quote Rate Plan Charge object.

To send a Subscription Rate Plan Charge custom field to Zuora:

1. In Zuora, create the custom field on the Subscription Rate Plan Charge object.
2. In Zuora Quotes, create the custom field on the Quote Rate Plan Charge object with the exact same API name and type as in Step #1.
3. In Zuora Quotes, add the custom field you created in Step #2 to the Custom Charge Fields field set of the Quote Rate Plan Charge object.

When a quote is sent to Zuora, the value in the custom field of the quote charge will be sent to Zuora to set the value of the custom field on the Subscription Rate Plan Charge in Zuora.

You cannot add the standard fields, prefixed with "zqu_",on the Quote Rate Plan Charge object to this field set.

The Custom Charge Fields field set is sent to Zuora when:

• Creating a new subscription
• Creating a renewal
• Creating an amendment by adding or updating products

By default, this field set contains no fields. 

Custom Quote Product Feature Fields

When a quote is sent to Zuora, the custom fields added to the Custom Quote Product Feature Fields (zqu__zqu__CustomSentToZuoraFields) field set are sent to Zuora along with the quote. The value of each custom field is used to populate the corresponding custom field, with the same API name, on the Subscription Product Feature object in Zuora.

To send a ZFeature custom field from Salesforce to Zuora:

1. In Zuora, create a custom field on the Subscription Product Feature object.
2. In Zuora Quotes, create a custom field on the ZFeature object with the exact same API name and type as in Step #1.
3. In Zuora Quotes, add the custom field you created in Step #2 to the Custom Quote Product Feature Fields field set on the ZFeature object. 
4. The products that include the feature attributes must have the Allow Feature Changes in Subscriptions field checked in Zuora Product Catalog.

Custom Account Fields

When you add a custom field on the Account object to the Custom Account Fields (zqu__CustomAccountFields) field set, the value of the custom field is used to populate the corresponding custom field, with the same API name, on the account when the quote is sent to Zuora. 

Custom Account Fields are sent to Zuora only when you create a subscription for a NEW billing account.

By default, this field set contains no fields.

Sync Method Precedence

Any pre-existing custom implementation that uses the sendToBilling() method to programmatically send custom fields to Zuora will override any custom fields configured to send through the Zuora Quotes field sets.

For example, if you a have custom implementation that sends MyCustomField_1__c to Zuora and configured MyCustomField_2__c and MyCustomField_3__c through a field set, only MyCustomField_1__c is sent to Zuora.

You must choose one send method to Zuora – configuration through fields sets or custom implementation.

Zuora recommends reviewing your customizations before configuring custom fields and sending them to Zuora.

See the sendToBilling method or Sending Custom Fields to Zuora for more information about this alternate method.

Example

In this example, you add two Account-level custom fields, Notes and Account Type, to the Custom Account Fields field set for sending to Zuora. 

To add custom fields to the Custom Account Fields field set:

1. In Zuora, create the custom fields on the Account object with the following API names and types:
   • Notes__c with Text type.
   • Account_Type__c with Picklist type of Emerging, Enterprise, and Strategic as picklist values.
2. Go to Setup > App Setup > Customize > Accounts.
3. Create the custom fields, Notes, (Notes__c) and Account Type (Account_Type__c) with the same API names and types.
4. In the Fields Sets section, click Edit next to Custom Account Fields.
   
5. Drag and drop the Account Type and Notes fields to the In the Field Set section. 
   
6. Click Save.

To send the newly added custom fields to Zuora:

1. Specify values for these fields on the account for the desired quote, and save the changes.
   
2. Create a quote for a new billing account for this account.
3. On the quote's detail page, click Send To Zuora, and click Submit.
4. After the quote is successfully sent, you see the fields on the newly created account in Zuora populated with the values from the Salesforce Account.