Skip to content
Revenue API
/
/
Download a report file

Download a report file

Request

Streams the bytes of a report file stored in your tenant's Revenue file store. Supports .csv and .zip files.

Purpose: Download a file listed by the report-file operations when your tenant stores reports on the Revenue file store. For files in cloud storage, use Get a signed URL instead.

When to use: When your tenant stores report files on the Revenue file store and you have the file_name from a list operation.

Notes:

  • filename is the file_name value from the list operations, including its extension.
  • 204 No Content means the file is not in the file store, or its extension is not .csv or .zip.

Request definition

ParameterInTypeRequiredDefaultDescription
filenamepathstringYesFile name including extension.
Zuora-Track-IdheaderstringNoOptional correlation identifier (up to 64 characters) that you choose. The Zuora One gateway records it; quote it to Zuora Support when you report a problem.
AuthorizationheaderstringYesBearer <access_token> (Zuora OneID OAuth).

Request body: none.

Response definition

HTTP statusContent typeResponse schema
200application/octet-streamstring (binary)
204noneNo body
400application/jsonRiaError
401application/jsonGatewayError or RiaError
403application/jsonRiaError
429application/jsonGatewayError
500application/jsonRiaError
502application/jsonRiaError

Error response schemas (GatewayError, ServiceError, SpringError, SimpleError, MissingFiltersError, RunStatusConflict, RiaError, SignedUrlError) are defined once under Error response schemas in the API overview and in components/schemas.

Response codes: 200, 204, 400, 401, 403, 429, 500, 502. Each response with a body includes worked examples; responses without a body say so.

Security
OneIdOAuth
Path
filenamestringrequired

File name including extension.

Example:WF_SUMMARY_482391.csv
Headers
Zuora-Track-Idstring

Optional correlation identifier (up to 64 characters) that you choose. The Zuora One gateway records it; quote it to Zuora Support when you report a problem.

Example:close-run-2026-09-001
cURL
curl -i -X GET \
  https://one.zuora.com/api/integration/v1/reports/download/WF_SUMMARY_482391.csv \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Zuora-Track-Id: close-run-2026-09-001'

Responses

Success. The file contents.

Bodyapplication/octet-stream
string, (binary)
Response
"Period Name","Revenue Contract ID","Recognized Amount"
"SEP-2026","120045","1000.00"