queryCriteria and subscriptionQueryCriteria Fields in Data Extraction

Knowledge Center > Zuora RevPro > Zuora RevPro Integration Overview > queryCriteria and subscriptionQueryCriteria Fields in Data Extraction

queryCriteria and subscriptionQueryCriteria Fields in Data Extraction

To facilitate filtering a specific set of data, Zuora Billing - RevPro Integration introduces the following fields in the Create a data extraction job operation:

  • queryCriteria
  • subscriptionQueryCriteria

You can use them together or individually in an API request to get the desired result. 

The length of both fields cannot exceed 200 characters.

Fields Comparison

The following table describes the differences between the two fields from different perspectives. Examples are also provided to explain how to use them.

  queryCriteria subscriptionQueryCriteria
Business Purpose

This field is used to filter a specific Order, Invoice Item, Credit Memo Item, or Debit Memo Item data set through API.

For the Order data, the filter is applied after the data is queried. This might cause performance issues if you are extracting a large data set.

For the Invoice Item, Credit Memo Item, and Debit Memo Item data, this filter is applied upfront.

This field is used to selectively extract the Order data based on the custom field value set at the related Subscription object.

The filter is applied upfront while querying the Order Metrics data through Revenue Run.

Usage Use this field to filter the Invoice Item, Credit Memo Item, or Debit Memo Item data for better performance. Use this field to filter the Order data for better performance.
Syntax and Example

ZOQL query that begins with:
AND [DataSourceObject].[Field] = [Value]

For example:

AND (InvoiceItem.Quantity = 100 OR Product.Name = 'SampleProduct')

ZOQL query that begins with:
AND Subscription.[Subscription_CustomField] = [Value]

For example:

AND Subscription.CustomProductName__c = 'CustomName'
Supported Transaction Types
  • Order 
  • Invoice Item
  • Credit Memo Item
  • Debit Memo Item
Order
Supported Objects

For Sales Order: 

  • Account
  • Amendment
  • Product
  • ProductRatePlan
  • ProductRatePlanCharge
  • RatePlan
  • RatePlanCharge
  • Subscription

For Invoice Item:

  • Account
  • Amendment
  • Invoice
  • InvoiceItem
  • Product
  • RatePlan
  • RatePlanCharge
  • ProductRatePlan
  • ProductRatePlanCharge
  • RatePlanCharge
  • Subscription

For Credit Memo Item:

  • Account
  • Amendment
  • CreditMemo
  • CreditMemoItem
  • Invoice
  • InvoiceItem
  • Product
  • RatePlan
  • RatePlanCharge
  • ProductRatePlan
  • ProductRatePlanCharge
  • RatePlanCharge
  • Subscription

For Debit Memo Item:

  • Account
  • Amendment
  • DebitMemo
  • DebitMemoItem
  • Invoice
  • InvoiceItem
  • Product
  • RatePlan
  • RatePlanCharge
  • ProductRatePlan
  • ProductRatePlanCharge
  • RatePlanCharge
  • Subscription
Subscription

Fields Validation

When an API request is submitted, Zuora Billing - RevPro Integration does the validation for both fields. The validation has two steps:

  1. Validate the syntax. 

    If the query contains AQuA syntax errors, the job fails.

  2. Validate the performance.

    If the assemble AQuA query takes longer than the query timeout (10 minutes by default) to complete, the data extraction job will be aborted. You must check and modify the query and submit the job again.

It is strongly recommended that you use the indexed custom fields to achieve the best performance. For more information, see Manage Custom Fields.

Last modified

Tags

Classifications

(not set)