Skip to content
Revenue API Reference
/
/
Get file upload status

Revenue API Reference (2025-08-06)

Introduction

Welcome to the reference for Zuora Revenue REST API!

REST is a web-service protocol that lends itself to rapid development by using everyday HTTP and JSON technology. Zuora Revenue provides various REST APIs for data integration. Use these REST APIs to authenticate and integrate data from the source ERP systems with Zuora Revenue.

All Zuora Revenue REST APIs are secured by using HTTPS. The authentication scheme is token-based authentication, which means an authenticated user must generate a token and then use it for all subsequent APIs until the token expires.

This reference provides detailed descriptions about functions, requests, and responses of each REST API.

Zuora Revenue REST APIs can be broadly classified into the following categories:

  • Authentication

  • Inbound

  • Outbound

Remember:

  • The API service must be enabled for your tenant in the first place. Otherwise, the 405 error will be returned for every API request you submitted. To enable the API service, contact Zuora Revenue Support.

  • Both the inbound and outbound operations require an authentication token to perform integration. You can obtain the token by using the Authentication operation.

  • You can find the Revenue object model on <a href="https://knowledgecenter.zuora.com/Zuora_Revenue/Revenue_insights_and_analytics/Zuora_Revenue_data_object_model" target="_blank">Zuora Revenue data object model</a>.

Endpoints

After the APIs are provisioned in Zuora Revenue Cloud, you can get the endpoint and use that endpoint to call the APIs.

Requirements

Before you use the Zuora Revenue APIs, make sure the following requirements are met:

  • Zuora Revenue uses role based access control to restrict system access to authorized users. To use the Zuora Revenue APIs, make sure that your user role has the Webservices Inbound and Webservices Outbound previleges in Zuora Revenue security settings. For more information, see <a href="https://knowledgecenter.zuora.com/Zuora_Revenue/B_System_Related_Configuration/B_Manage_user_access" target="_blank">Manage User Access</a>.
  • To use the inbound operations to upload data into Zuora Revenue, the upload templates must be created by using the File Upload menu options in the Zuora Revenue UI. Currently, the APIs support transaction upload, bundle upload, and event upload.
  • To use the outbound operations, the outbound GL interface mapping must be set up in the Zuora Revenue UI (Setups > Application > Interface Setup).

Requests and Responses

Zuora Revenue APIs support the JSON format of HTTP responses. Inbound operations for data upload support the CSV format only.

Inbound Data Error

All the inbound data into Zuora Revenue are first loaded into pre-stage tables, namely CUST_UI tables in Zuora Revenue, and then pushed to the corresponding staging tables from CUST_UI tables.

If the data fails in the CUST_UI tables, the entire batch of records will be marked as Failed. It means All or Nothing approach will be followed when data is being inserted to the CUST_UI tables. If the data has been successfully inserted into the CUST_UI tables, it will then be automatically pushed to the staging tables and no manual work is required.

Any uncollected data that remains in the staging tables can be manually fixed or downloaded, and can be reposted from the upstream systems.

You can use the Stage Error operations to retrieve error information about the uploaded data.

Download OpenAPI description
index.json
index.yaml
Languages
Servers
https://yourHost

Authentication

The Authentication operation is the authentication layer when you integrate data with Zuora Revenue APIs. Use this operation to authenticate and generate a token that can be valid for a specific time period. The token is required for all the subsequent API calls. By default, a token will be valid for 30 minutes before it expires. If the issued token expires, call this operation again with valid credentials to get a new token.

To acquire the token, you must provide the user role and client name as well as basic authorization in the HTTP request header. An example of basic authorization header is as follows:

Basic c3lzYWRtaW46fsDFsgsV2cHJvJTEyMw==

An example of the returned authentication token is as follows:

ybmFtZSI6InZpbm90aC5iYWFsYWppIiwiaXNzIjoiUkV```
Operations

Adapter

The Adapter operation is used to retrieve field mapping information in an upload template definitions. The field mapping information determines the mapping between the staging field names and the label names in the upload file.

Operations

BI Views v1

The BI Views V1 operations are used to download data for Zuora Revenue standard BI views.

Note:

  • Only the standard Zuora Revenue BI views are supported.
  • If the data volume to be processed exceeds 100k records per query, it is recommended to use (BI Views V2)[/other-api/revenue/tag/BI-Views-v2/] operations.
Operations

BI Views v2

Starting from version 36.008.00, the BI Views V2 operations are provided to download data from the standard BI views. Compared with the previous version, BI Views V1, this new version has the following enhancements:

  • In addition to CSV format, data can also be downloaded in a compressed format, gzip.
  • The number of rows on each downloaded page is increased. In the CSV format, each page can contain up to 10,000 rows. In the gzip format, each page can contain up to 20,000 rows.
  • The data volume of up to 5 million rows per query can be supported by using the BI Views V2 operations.
  • A continuation token is introduced to accelerate data download for multiple pages. After a request is made for the first page, a continuation token is returned in the response header. Meanwhile, subsequent pages are cached by the system. Using the continuation token in the subsequent requests will make the system to retrieve data from the cache instead of re-executing the query against the database.
  • An operation to query the row count is introduced. You can know the number of rows to be returned before the actual download.

For more information about the BI Views V2 operations, such as new feature introduction, suggested pattern to consume these APIs, and sample codes, see <a href="https://knowledgecenter.zuora.com/Zuora_Revenue/Y_Integration_service_(BI_Views_V2)" target="_blank">Integration service (BI Views V2)</a> in Zuora Revenue Knowledge Center.

Operations

File Upload

The File Upload operations are used to upload large volumes of data as a CSV file in the HTTP body to Zuora Revenue and to get status information about the file upload.

If the data volume is in the range of 40k-60k records per file per request, the Upload file operation can process the data quickly. A unique request ID is generated after the file is successfully received, which can be used to query the upload status in the Get file upload status operation.

Operations

Get file upload status

Request

Gets the status information about the specified file upload request.

Path
file_request_idintegerrequired

The request ID of the file upload to be queried.

Headers
tokenstringrequired

The valid authentication token that is generated by the Authentication operation.

curl -i -X GET \
  'https://yourhost/api/integration/v1/fileupload/status/{file_request_id}' \
  -H 'token: string'

Responses

The status information is returned for the requested file upload.

Bodyapplication/json; charset=utf-8
ResultArray of objects(uploadStatus)
messagestring

Response Message

Default "Data Staged Successfully"
statusstring

Response Status

Default "Success"
Response
application/json; charset=utf-8
{
  "Result": [
    { … }
  ],
  "message": "Data Staged Successfully",
  "status": "Success"
}

Upload file

Request

Upload the event or transaction data in a CSV file to Zuora Revenue in UTF-8.

Note: It is recommended to have up to 60k lines per request in this operation.

Headers
tokenstringrequired

The valid authentication token that is generated by the Authentication operation.

templatenamestringrequired

Name of the upload template that you want to use.

Content-Typestringrequired

Must be set to "multipart/form-data".

Value"multipart/form-data"
Bodymultipart/form-datarequired
filestring(binary)required

The path to the CSV file that is to be uploaded.

curl -i -X POST \
  https://yourhost/api/integration/v1/upload/file \
  -H 'Content-Type: multipart/form-data' \
  -H 'templatename: string' \
  -H 'token: string' \
  -F file=string

Responses

The file is uploaded to Zuora Revenue.

Bodyapplication/json; charset=utf-8
messagestring

Response Message

Default "File received successfully"
statusstring

Response Status

Default "Success"
Response
application/json; charset=utf-8
{
  "message": "File received successfully",
  "status": "Success"
}

Inbound

The Inbound operations are used to upload data in the CSV format to Zuora Revenue. As a prerequisite, the upload template definitions must be present in Zuora Revenue. Then, you specify the template name, file name, authentication token, and the CSV data in HTTP body of the inbound operations to upload data. It is recommended to use the Create upload operation for the CSV file than contains less than 20k lines.

After the data is uploaded to the pre-stage table, Zuora Revenue scheduler will load the CSV content to corresponding staging tables in Zuora Revenue. You can query the upload status by using the Get upload status operation.

Operations

Reports

The Reports operations are used to download reports that are generated in Zuora Revenue.

Operations

Revenue Jobs

The Revenue Jobs operations are used to submit the following programs with Revenue APIs:

  • RevPro3.0 Data Collection Master
  • RevPro3.0 Event Process
  • RevPro3.0 Event Process Master
  • Revpro3.0 Accounting Transfer Master
  • RevPro3.0 Transfer Batch for Org

No matter what program is to be started, two path parameters are required for the (Submit a program with specified parameters)[/other-api/revenue/operation/POST_SubmitRevenueJob/] operation. One is the program ID and the other is the organization ID. Operations are also provided to retrieve the program ID and organization ID.

For an example of using API to submit the Revpro3.0 Accounting Transfer Master program, see <a href="https://knowledgecenter.zuora.com/Zuora_Revenue/Best_practice_for_using_Revenue_APIs#Use_API_to_submit_a_predefined_program">Us API to submit a predefined program</a> in the Knowledge Center.

Operations

Stage Error

The Stage Error operation is used to get the list of records that contain errors in the Zuora Revenue staging tables for transactions or events.

Operations

Transfer Accounting

The Transfer Accounting operations are used to support outbound data integrations. You can use these operations to query the transfer batch information and to update the transfer batch status.

Operations

Transfer Accounting Files

The Transfer Accounting Files operation is used to download the transfer accounting data in a CSV file from Zuora Revenue for a specific transfer batch.

Operations

Data Collection

The Data Collection operations are used to submit the data collection jobs and query the status of the submitted jobs.

Operations