Knowledge Center

Knowledge Center > Commerce > Zuora Quotes > Set up Zuora Quotes in Salesforce > Send Custom Fields to Zuora

Send Custom Fields to Zuora

Use Zuora Quotes custom fields for sending additional information to Zuora to update subscriptions and customer accounts. You can send custom fields values on the following objects:

  • Quote
    These custom fields are used to populate the custom fields on the subscription in Zuora.
  • Quote Rate Plan
    These custom fields values are used to populate the custom fields on the subscription rate plan in Zuora.
  • Quote Rate Plan Charge
    These custom fields values are used to populate the custom fields on the subscription rate plan charges in Zuora.
  • Account
    The custom field values are used to populate custom fields on the newly created account IN Zuora.

If you clear a custom field value in Zuora Quotes and send it to Zuora, the custom value in Zuora will not be changed to a blank value.

To send a custom field to Zuora:

  1. For each custom field defined on the object in Zuora, create a custom field with the same API name and type on the corresponding object in Salesforce.
  2. In Zuora Quotes, add the custom field to the field set for sending to Zuora:
    • For the Quote object, add the custom field to the Custom Quote Fields field set.
    • For the Quote Rate Plan object, add the custom field to the Custom Rate Plan Fields field set.
    • For the Quote Rate Plan Charge object, add the custom field to the Custom Charge Fields field set.
    • For the ZFeature object, add the custom field to the Custom Quote Product Feature Fields field set.
    • For the Account object, add the custom field to the Custom Account Fields field set. See the example below for detailed steps.
  3. Create a quote and send the quote to Zuora.

Objects and Field Sets for Custom Fields

Add the custom fields you want to send to Zuora to the following field sets. These field sets are supported starting in Zuora Quotes, version 6.0.

Object
(API Name)
Quote Type Options Field Set for Sending to Zuora
(API Name)

Quote
(zqu__Quote__c)

New Subscriptions

Amendments

Renewals

Custom Quote Fields 
(zqu__CustomQuoteFields)

Quote Rate Plan
(zqu__QuoteRatePlan__c)

New Subscriptions

Amendments

Renewals

Custom Rate Plan Fields
(zqu__CustomRatePlanFields)

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

Quote Charge
(zqu__QuoteCharge__c)

New Subscriptions

(6.4x or earlier versions only)

Custom Charge Fields
(zqu__CustomChargeFields of the Quote Rate Plan Charge object)

Use this field set in Zuora Quotes 6.4x or earlier. In the 6.50 or later versions, use the field set on the Quote Rate Plan Charge object.

Quote Rate Plan Charge
(zqu__QuoteRatePlanCharge__c)

New Subscriptions
(6.50 or later versions)

Amendments

Renewals

Custom Charge Fields
(zqu__CustomChargeFields)

ZFeature

(zqu__ZFeature__c)

New Subscriptions

Amendments

Renewals

Custom Quote Product Feature Fields 
(zqu__CustomSentToZuoraFields)

Account
(This is a standard Salesforce object.)

New Subscriptions

Custom Account Fields
(zqu__CustomAccountFields)

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

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 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 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 SetupCustomize > 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.image2014-1-7 14:43:28.png
  5. Drag and drop the Account Type and Notes fields to the In the Field Set section. image2014-1-7 14:46:36.png
  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.image2014-1-7 14:29:6.png
  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.

          image2014-1-7 14:59:58.png

Last modified
10:44, 11 Jul 2017

Tags

Classifications

(not set)