Welcome to Zuora Product Documentation

Explore our rich library of product information

Quote state helper methods in ZQFClient

Use ZQFClient helper methods to read and update quoteState in Quote Studio extensibility code without manually traversing the quote state object.

ZQFClient is a customer-facing helper for Quote Studio extensibility code. It helps you read and update quoteState by using helper methods instead of manually traversing the quote state object in your custom code.

Starting with Quotes version 10.58, these helper methods are available to modify quoteState directly through hooks and events. This simplifies implementation, reduces boilerplate code, and makes quote state updates easier to maintain.

Use ZQFClient when you want to do any of the following in the Extensibility Framework:

  • Read quote, subscription, timeline, rate plan, charge, tier, ramp interval, or amendment data from quoteState.

  • Update quote fields by using helper methods that return events you can dispatch from hook code.

  • Add or remove products and charges, including interval-specific actions for ramp quotes.

  • Apply grouped or bulk updates to charges, tiers, rate plans, amendments, and products.

Key considerations

  • Import ZQFClient from zqu/zqfClient.

  • Standard Salesforce fields remain unnamespaced, for example Id and Name.

  • Zuora package fields must use the full namespace, for example zqu__Quantity__c and zqu__ContractEffectiveDate__c.

  • Mutation helpers return CustomEvent objects, and your hook code must explicitly call dispatchEvent(...).

  • pageState can be used for current interval resolution when interval context is required.