The Zuora Query Function enables users to post query operations to Zuora Billing. This function supports two APIs that the users can choose from namely, Action Post Query and Data Query. Users can query data from Zuora to enrich their data processing and create meaningful chargeable records.

Configuration

To configure the Zuora Query Function, follow these steps:

1. In Environment, to access the Zuora tenant environment, specify:

   Field	Description
   Tenant	The name of the Zuora environment.
   URL	The base URL for the REST endpoint. If the Custom tenant is selected, specify the appropriate endpoint.

   If the Zuora tenant is available, you can access the Zuora REST API using the following endpoints:

   Tenant	Base URL for REST Endpoints
   US Production	https://rest.zuora.com
   US API Sandbox	https://rest.apisandbox.zuora.com
   US Performance Test	https://rest.pt1.zuora.com
   EU Production	https://rest.eu.zuora.com
   EU Sandbox	https://rest.sandbox.eu.zuora.com
   Custom	You can also access your own custom tenant environment. Specify the URL for your endpoint.

2. In Credentials, you can choose to authenticate using two methods. In Authenticate by specify:

   Authentication Type	Field	Description
   OAuth	Client ID	The client ID that is displayed when the OAuth client is created in Zuora.
   	Client Secret	The client secret ID that is displayed when the OAuth client is created in Zuora.
   API Key	Access Key ID	The identifier that is used to sign the requests sent to Zuora. It is displayed when the API User is created in Zuora.
   	Secret Access Key	The key that is used along with the Access Key ID to cryptographically sign the Zuora requests.

   Note!

   You can also use the Secrets Wallet toggle button to select a predefined Zuora secret from your Secrets Wallet.

3. In Entity, if you have the Zuora Multi-entity feature enabled, you can specify the name of the entity you want access to. Zuora Multi-entity provides the capability to create and manage multiple entities within a single Zuora tenant. For more information on Zuora Multi-entity, refer to https://knowledgecenter.zuora.com/Billing/Tenant_Management/Multi-entity.

4. In Query, you have a choice in the type of query language you wish to write your queries in. By default, the Zuora Object Query Language (ZOQL) is used to perform queries. Once the API call is made, the API executes the query against the specified object and returns a query response object to your application. Alternatively, you can select the Use Data Query checkbox to use the Data Query feature and perform queries using SQL in your Zuora tenant.

   Note!

   When using Action Post Query API, the Zuora endpoint is POST to/v1/action/query.

   When using Data Query API, the Zuora endpoint is POST to /query/jobs.

5. In Result Key, you can specify the attribute name you wish to have the response stored in the payload.
6. In Cache Settings, you can select the Enable Cache checkbox to enable caching of items. When the Enable Cache checkbox is selected, you can specify the maximum number of items that you wish to store in the cache and also choose the time (in seconds) after which the items can be removed from the cache. By default, the maximum number of items in cache is 100 and the time after which the items are removed is 300 seconds.
7. In Response Timeout, you can specify the maximum amount of time (in seconds) to wait for the final state of the job. If no final state is received within the timeout period, the execution of the stream is aborted.

   Note!

   After configuration, clicking Preview will only display a maximum of five records. However, during the actual execution of the stream, the entire result will be displayed.