Zuora Usage File Forwarder

The Zuora Usage File Forwarder is used to send usage data in file format to Zuora Billing using the Zuora Post Usage API or with the Active Rating Post Usage API. You map fields from a source to specific target fields. Zuora Usage File Forwarder 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 to select the Zuora environment.

  • Authentication to select a Zuora credential from Secrets Wallet. 

  • Entity to specify the name of the entity if you have the Zuora Multi-entity feature enabled.

  • Request to enable Active Rating. The configuration fields will be different if you have selected the Use Active Rating check box described below.

    • File information

    • Required fields to field map the mandatory fields for the usage file.

    • Optional fields to add the remaining or additional optional fields to compile the usage file.

    • Response handling to determine the response details sent to a selected Interconnect receiver.

Environment

Field

Description

Field

Description

Tenant

The name of the Zuora environment. The following endpoints are available for selection:

US DC1 Production: https://rest.na.zuora.com/
US DC2 Production: https://rest.zuora.com/
US DC1 API Sandbox: https://rest.sandbox.na.zuora.com/
US DC2 API Sandbox: https://rest.apisandbox.zuora.com/
US Central Sandbox: https://rest.test.zuora.com/

EU Production: https://rest.eu.zuora.com/
EU Sandbox: https://rest.sandbox.eu.zuora.com/
EU Central Sandbox: https://rest.test.eu.zuora.com/

Custom: Use this option to access your own custom tenant environment. Specify the URL for your endpoint.

Authentication

Field

Description

Field

Description

Select from secrets wallet

Choose from a list of Zuora secret wallet passes.

Entity

Field

Description

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

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.