Zuora Usage File
The Zuora Usage File is a forwarder used to send usage data in file format to Zuora Billing using thehttps://developer.zuora.com/v1-api-reference/api/tag/Usage/ API or with the https://developer.zuora.com/archive/active-rating/active-rating-api/#tag/Usage-(with-Active-Rating). You map fields from a source to specific target fields. The Zuora Usage File function then compiles the fields into a comma-separated value (.csv) file or files to be sent downstream.
You can configure this function in the following settings.
Environment
Select the Zuora environment.
Field | Description |
|---|---|
Tenant | The name of the Zuora environment. The following endpoints are available for selection: US DC1 Production: https://rest.na.zuora.com/ EU Production: https://rest.eu.zuora.com/ Custom: Use this option to access your own custom tenant environment. Specify the URL for your endpoint. |
Authentication
Setting | Description |
Select from secrets wallet | Note! This option only appears when the Secrets wallet toggle is enabled. Select a secret with the Zuora secret type. For more details, see Secrets wallet. |
OAuth 2.0 | Note! This option only appears when the Secrets wallet toggle is disabled.
Note! The Client secret field only accepts parameter reference and requires you to use Global parameters. |
API key | Note! This option only appears when the Secrets wallet toggle is disabled.
Note! The Secret access key field only accepts parameter reference and requires you to use Global parameters. |
Entity
Specify the name of the entity if you have the Zuora Multi-entity feature enabled.
Field | Description |
|---|---|
Multi-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, see https://knowledgecenter.zuora.com/Billing/Tenant_Management/Multi-entity. |
Request
The configuration fields will be different if you have selected the Use Active Rating check box described below.
To send usage data to a Zuora Billing system, deselect the Use Active Rating check box. The Active Rating option is only applicable to Zuora customers that have the Active Rating feature activated, and the Use Active Rating check box should always be deselected if this is not the case.
Non-active rating
File information
Field | Description |
|---|---|
File name | Enter the file name of the Zuora usage file. Note!
 Request configuration |
Required fields
In Required fields, the field mapping is done for the mandatory fields for the usage file. You must specify the Source field based on the input from the previous function for the appropriate Required fields. There are four Required fields that must be mapped to the source fields:
ACCOUNT_ID
UOM
QTY
STARTDATE
Optional fields
In Optional fields, you add the remaining optional fields or you may add additional custom fields to compile the usage file. To add an optional field, click the Add field mapping button. There are six Optional fields and those are:
ENDDATE
SUBSCRIPTION_ID
CHARGE_ID
DESCRIPTION
UNIQUE_KEY
PRODUCT_RATE_PLAN_CHARGE_ID
To add a custom field mapping, type the custom field name into Add field.
Response handling
Toggling the Response handling on will allow you to Select Interconnect receiver. The Zuora Usage File function has a built-in Interconnect sender which will forward the status ID and file details received from Zuora after it has received the files. A second stream can use the Interconnect receiver to accept the status ID and file details forwarded by the Zuora Usage File function to track the status of the file in Zuora. If the stream fails for any reason, Zuora Usage File function will not send anything through the Interconnect sender.
Active rating
File information
Field | Description |
|---|---|
File name | Enter the file name of the Zuora usage file. Note!
|
Description | Enter a description for the Zuora usage file. |
Required fields
In Required fields, the field mapping is done for the mandatory fields for the usage file. You must specify the Source field based on the input from the previous function for the appropriate Required fields. There are five Required fields that must be mapped to the source fields: AccountNumber, Tag, UnitOfMeasure, StartDateTime, and Quantity.
Optional fields
In Optional fields, you add the remaining optional fields or you may add additional custom fields to compile the usage file. To add an optional field, click the Add field mapping button. There are three Optional fields and those are Description, UniqueKey, and GroupId. To add a custom field mapping, type the custom field name into Add field. Added custom fields will automatically be appended with the prefix CustomFields.. You do not need to include this prefix in the field name.
Response handling
Toggling the Response handling on will allow you to Select Interconnect receiver. The Zuora Usage File function has a built-in Interconnect sender which will forward the status ID and file details received from Zuora after it has received the files. A second stream can use the Interconnect receiver to accept the status ID and file details forwarded by the Zuora Usage File function to track the status of the file in Zuora. If the stream fails for any reason, Zuora Usage File function will not send anything through the Interconnect sender.