Quote Configuration Settings
This article describes the Quote Configuration Settings in Zuora Quotes.
Quote Configuration Settings
To configure the quote configuration settings:
- In Zuora Quotes, click the Zuora Config tab.
- On the Zuora Quotes Configuration Setting page, click Quote Configuration Settings.
- Click Edit Settings.
- Enter information for the configuration fields. The table below describes these fields in more detail.
- Click Save.
The following fields are available for configuring Zuora Quotes.
Field | Description | Legacy CPQ | CPQ X |
---|---|---|---|
Zuora Package Installation Status | |||
This view-only section displays the installed packages and includes information such as version and namespace. This section is hidden when you are in the edit mode. |
|||
Quote Configurations |
|||
Disable Additional Price Discounts |
Select to prevent users from:
|
||
Enable Consolidated Charge-level Reports |
Select to allow consolidated pipeline reporting on New subscription, Amendment, and Renewal quotes at the charge level. When selected, this options lets you use the Zuora Quotes custom report types. This setting was deprecated as of the 6.50 (Q2 2015) release of Zuora Quotes. |
Deprecated | |
Get Tiers from Zuora |
Select to obtain Subscription Rate Plan Charge Tiers directly from the Subscription in Zuora. If not selected, the information about the Tiers comes from the Zuora Product Catalog in Zuora 360. This setting only applies to Amendment and Renewal quotes, and this setting must be selected to use the automatic price lift feature. |
||
Get Billing Accounts from 360 |
Select to obtain Billing Account information directly from Zuora 360 in Salesforce. We recommend that you have Real-time Sync enabled when using this setting to always have the most up-to-date Billing Account data. If you have a custom field on the Billing Account object, enable this setting to avoid an error from the corresponding custom field missing in Zuora. Irrespective of this setting, CPQ X will consistently retrieve Billing Account details from Zuora 360 in Salesforce for the lists generated in the Billing Account Selector Page. |
||
Enable Amendment Functionality |
Select to allow users to create Amendment quotes from Salesforce. This setting was deprecated as of the 6.50 (Q2 2015) release of Zuora Quotes. |
Deprecated | |
Store Data in Quote Charge |
Starting in the 6.50 (Q2 2015) release, the Quote Rate Plan Charge object is used for New Subscription Quotes. Select this setting to replicate data from the Quote Rate Plan Charge object (zqu__QuoteRatePlanCharge__c) to the Quote Charge object (zqu__QuoteCharge__c) to ensure that your reports and custom codes previously built from the Quote Charge object (zqu__QuoteCharge__c) can still work with the new data model. Use this setting in interim while migrating your reports and customizations to use the new data model with Quote Rate Plan Charge. |
||
Approved Quote Status | Final and approved status of the quote when sent to Zuora. Only the quotes in this status will be sent to Zuora. To add your custom status, add the status value to the picklist of the Approval Status field (zqu__ApprovalStatus__c) on the Quote object (zqu__Quote__c). |
||
Enable Billing Discount Distribution | Controls whether Discount charge metrics will be aggregated on the Discount line item or be spread out to the various other charges that it affects. If enabled, the Billing Discount will be populated for all discounted charges and related objects. If disabled, the aggregate Billing Discount will be present only for the Discount Charge and related objects. Requires WSDL versions 80.0+. | ||
Get Subscriptions from 360 |
Select to obtain Subscription information directly from Zuora 360 in Salesforce when populating the Select Billing Account page of the Quote Wizard. We recommend that you have Real-time Sync enabled when using this setting to always have the most up-to-date subscription data. Irrespective of this setting, CPQ X will consistently retrieve Subscription details from Zuora 360 in Salesforce for the lists generated in the Billing Account Selector Page. Moreover, CPQ X will always retrieve Subscription details for Amendment and Renewal Quotes directly from Zuora Billing via API, regardless of this setting. |
||
Enforce Unique Subscription Quote Number |
Select to prevent a quote from being sent to Zuora if there is an existing subscription with the same quote number. When you clear this setting, the check for duplicate subscriptions is turned off when quotes are sent to Zuora. |
||
Hide Original One-Time Charges | Select to hide the existing one-time charges on the amendment/renewal quotes. This setting must be used in conjunction with the "View Amend Quote as of Quote Start Date" setting under Zuora Config > Quote Studio Settings > Admin Config.
|
||
Enable Rule Validation on Quote Creation |
Select to enable the |
||
Default Trigger Dates |
Select to allow Service Activation Date and Customer Acceptance Date inherit from Contract Effective Date. |
||
Amend List Price to Effective Price | Select to set the list price of the Quote Rate Plan Charge to that of the Subscription Rate Plan Charge on renewal and amendment quotes for non-tiered charges. | ||
Disable chatter feed from Quote | Select to disable the Chatter feeds from quotes. | ||
Disable Edit Product in Quote Detail | Select to disable the editing access of product details on the Quote Detail page. | ||
Quote PDF Processing Options |
|||
Use SFDC Locale to Format Quote DOC |
Select to allow the quote document to be formatted using the locale of the Salesforce user. |
||
Attach Quote PDF/DOC |
Select to automatically attach the quote PDF or Word document to the quote or the opportunity.
If this option is cleared, you must open and view the quote PDF or Word document and save it manually. |
||
Attach PDF/Word documents as Files | Select to enable quote documents to be attached as files. | ||
Quote Processing Options | |||
Update Opportunity Amount with Quote TCV |
Select to copy the Quote TCV amount to the Opportunity Amount field when a quote is created or updated. |
||
Auto-replace Expired Rate Plans |
Select to automatically replace an expired rate plan when creating a renewal quote and the subscription contains an inactive rate plan (past the expiration date set in the product catalog). |
||
Electronic Payment Method Processing Options |
|||
Electronic Payment Method Setting |
Determines how an electronic payment method is treated when sending a new subscription quote to Zuora. To learn how this setting affects the payment processing in Zuora, refer to Process Payments in Zuora Billing. |
||
Send to Zuora Processing Options |
|||
Allow Zuora Account Info to be Updated |
Select to allow users to use Salesforce data to update Zuora billing account and contact information. See below for more information about this setting. |
||
Generate Invoice |
Select to automatically generate an invoice when the subscription is created in Zuora. The setting you select here is a default value at the organization-level. You can override this org-default value when creating a new quote. By default, this option is not set. If this option selected, configure Zuora to invoice subscriptions separately. |
||
Process Payments |
Select to automatically apply a payment when the subscription is created in Zuora. The setting you select here is a default value at the organization-level. You can override this org-default value when creating a new quote. If this option is selected, configure the Zuora application to invoice subscriptions separately. If this option is selected, you need to set up an electric payment method through Hosted Payment Method Pages or Payment Pages. Otherwise, you will not be able to submit quotes to Zuora. |
||
Apply Credit Balance |
Select to automatically apply any credit balance on a customer account to invoices when sending quotes with the Generate Invoice setting enabled. |
||
Always Set Amendments to 'Active' Status |
Select to set the status of Zuora Quotes amendments and renewals to Active when the quotes are sent to Zuora. If the Service Activation Date is blank, the Service Activation Date is set to the same date as the Contract Effective Date. If the Customer Acceptance Date is blank, the Customer Acceptance Date is set to the same date as the Service Activation Date. Zuora recommends enabling this option. You can send an amendment quote to Zuora in the Pending status by leaving the required trigger dates blank. If you want to be able to send amendment quotes in the Pending status, do not enable this setting. |
||
Quote Read-Only after Sent to Zuora |
Select to change quotes to read-only status after they are sent to Zuora. When this option is selected, the Edit button is removed from the Quote view. |
||
Autofill Dates for Quote Metrics Preview |
Select to automatically fill blank trigger dates on the quote when previewing quote metrics on the quote detail page. If the Service Activation Date is blank, the Service Activation Date is set to the same date as the Contract Effective Date. If the Customer Acceptance Date is blank, the Customer Acceptance Date is set to the same date as the Service Activation Date. Note that this setting will not be effective if you enable Orders. |
||
Allow Invoice Separately | Select to allow invoice separately on the Salesforce side. If both this setting and the "Enable Subscriptions to be Invoiced Separately?" setting on Zuora Billing are enabled, the zqu__InvoiceSeparately__c field value on your quote will be sent to Zuora as it is. |
||
Enable High Volume Quoting | Select this check box to enabled the High Volume Quoting feature. See Manage Existing Products on a Subscription for more information. | ||
Enable Ramp Metrics |
This setting is available only if Orders is enabled. Select this check box to enable the calculation of ramp metrics when previewing multi-interval updates. Enabling this setting will also automatically turn on the Ramp toggle when you create an amendment or renewal quote for a subscription with ramp. See the following articles for more information: |
||
Enable Billing Docs Override | This setting is available only if Orders is enabled. Select this check box to take advantage of the following Invoice Settlement features on quote submission:
This setting should be enabled if both Orders and Invoice Settlement are enabled in your Zuora tenant. |
||
Legacy Support: Send SF Custom Fields to Zuora as String | With this setting enabled, the Salesforce Custom Fields are sent to Zuora as string as they were before April 2023, providing backward compatibility for existing integrations.
This setting is disabled by default after upgrading to version 10.24. You can create custom fields of different types (Boolean, Integer, Number, Date) in Salesforce and map them to corresponding custom fields in Zuora. |
||
Default Order/Booking Date to Today | This setting determines the default behavior for sending Booking Dates to Zuora.
To translate Quote Order Date to Booking Date, see Translate object field labels and help text. |
||
Field Configurations |
|||
Enable Invoice Owner |
Select to allow users to specify the invoice owner on the quote. |
||
Enable Parent Customer Account |
Select to allow users to specify the parent customer account when creating a new subscription quote with a new billing account. |
||
Enforce Single Primary Quote |
When this setting is selected:
|
||
Whitelist FieldSet Name |
The API name, including the namespace, of a field set that contains the user-defined custom fields that should be tracked by Zuora Quotes. Only one whitelist field set is tracked per object, and that field set must have the same name that is configured in this setting. See below for a code sample for the whitelist field set. Starting in Version 8.8.1, you can also use this setting to populate additional fields in Product Selector JavaScript plugin. See below for a sample use case. |
Whitelist Field Set Code Sample and Use Case
The following code sample demonstrates how the whitelist field set affects the use of custom fields. See Quote Class for information about getInstance
global method.
//Assumption: There is a custom text field cf1__c on the zqu__Quote__c object zqu__Quote__c currentQuote = zqu.Quote.getInstance('<quoteId>').getSObject() //Scenario 1: The following line will throw an an error // "SObject row was retrieved via SOQL without querying the requested field". System.assertEquals('customFieldText', currentQuote.cf1__c); //Scneario 2: The custom field was added to a Zuora Quotes fieldSet. // The line should not throw an error. System.assertEquals('customFieldText', currentQuote.cf1__c); //Scenario 3: The user registered a whitelist fieldSet // named "custom_object_fields" and added cf1__c to the fieldSet. // The line should not throw an error System.assertEquals('customFieldText', currentQuote.cf1__c);
The following is a sample use case for populating a custom field in the JavaScript plugin using the Whitelist FieldSet Name setting:
- Create a field set, named AdditionalCustomFields, on the QuoteRatePlanCharge object.
- Create a custom field, Cost__c, on the QuoteRatePlanCharge object.
- Add the Cost__c custom field to the AdditionalCustomFields field set.
- In Quote Configuration Settings in the Zuora Config tab, set the value of the Whitelist FieldSet field to AdditionalCustomFields.
- When using Charge Group API or the Product Selector JavaScript plugin, you will see the value of Cost__c included.
Allow Zuora Account Info to be Updated
When the Allow Zuora Account Info to be Updated setting is selected, the following sequence of events occurs when you click Submit on the Quote Order Preview page to send the quote to Zuora:
- Account and contact information on the current quote is compared to the corresponding information in Zuora.
- If no discrepancy is found, the quote is sent to Zuora.
- If a discrepancy is found, a popup notification appears. You can either cancel the submission and address the discrepancy at a later time or acknowledge the discrepancy and proceed to send the quote to Zuora.
The comparison excludes State or County. The comparison also ignores payment term and payment method on all quote types except New Subscription.
Additionally, setting this option enables the following features for your functional users of Zuora Quotes.
- Ability to edit account and contact information on the Update Zuora Account Details page. Click the Update Zuora Account Details button on the Quote Detail page to access the Update Zuora Account Details page. If this setting is disabled, the Update Zuora Account Details page will display an error message and won't allow updating any fields.
- Ability to edit the following fields when creating a quote for an existing billing account. If this setting is disabled, these fields are populated with the values from Zuora and will be read-only fields in Zuora Quotes.
- Bill To Contact
- Sold To Contact
- Payment Term
- Payment Method
- Billing Batch
- Bill Cycle Day
When creating a quote for a new billing account, the preceding fields will be editable even if the Allow Zuora Account info to be Updated setting is disabled.
You cannot update Currency for existing billing accounts regardless of the setting.