Report Files

List completed report files and download them through the Integration service.

Operations

List report files by date

Request

Returns the Available report files created on one calendar day, limited to the organizations your role can access. Runs that are still in progress or failed are not returned.

Purpose: Collect every report produced on a given day (for example by schedules in Zuora Revenue) so a nightly job can download them.

When to use: In a daily job that collects every report file produced on a given day, for example by report schedules set up in Zuora Revenue.

Notes:

createddate uses the format DD-Mon-YYYY with an English month abbreviation, for example 09-Oct-2026. The month is not case-sensitive.
When nothing matches, the response is 200 with an empty Result array.

Request definition

Parameter	In	Type	Required	Description
`createddate`	query	string	Yes	Creation date of the report files, formatted `DD-Mon-YYYY`.
`Zuora-Track-Id`	header	string	No	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.
`Authorization`	header	string	Yes	`Bearer <access_token>` (Zuora OneID OAuth).

Request body: none.

Response definition

HTTP status	Content type	Response schema
`200`	`application/json`	ReportFileListResponse
`400`	`application/json`	RiaError
`401`	`application/json`	GatewayError or RiaError
`403`	`application/json`	RiaError
`404`	`application/json`	RiaError
`429`	`application/json`	GatewayError
`500`	`application/json`	RiaError
`502`	`application/json`	RiaError

ReportFileListResponse: Success envelope for the report-file operations.

Field	Type	Required	Description
`Status`	string	No	`Success` when the call completed.
`Message`	string	No	Additional message. Empty on success.
`Result`	array of ReportFile	No	Matching Available report files. An empty array means nothing matched.
`Result[].id`	integer	No	Submission identifier of the run that produced the file. Use it with `GET /reports/{report_id}` and the v2 signed-URL operation.
`Result[].file_name`	string	No	Name of the generated file. Use it with `GET /reports/download/{filename}`.
`Result[].rep_name`	string	No	Name of the report definition that produced the file.
`Result[].category`	string	No	Report category.
`Result[].rep_desc`	string	No	Report description.
`Result[].layout_name`	string	No	Name of the layout that was run.
`Result[].report_date`	string	No	Date and time the run was created, formatted `DD-MM-YYYY HH24:MI:SS`.
`Result[].status`	string	No	Run status. These operations only return Available runs, so the value is `A` (or `Available` on some tenant database platforms). Allowed: `A`, `Available`.
`Result[].org_id`	string	No	Organization security value of the run. Returned on some tenant database platforms only.

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, 400, 401, 403, 404, 429, 500, 502. Each response with a body includes worked examples; responses without a body say so.

Security

OneIdOAuth

Query

createddatestringrequired

Creation date of the report files, formatted DD-Mon-YYYY.

Example:createddate=09-Oct-2026

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/list?createddate=09-Oct-2026' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Zuora-Track-Id: close-run-2026-09-001'

Responses

Success. Matching report files.

Bodyapplication/json

Statusstring

Success when the call completed.

Example:"Success"

Messagestring

Additional message. Empty on success.

Example:""

ResultArray of objects(ReportFile)

Matching Available report files. An empty array means nothing matched.

Response

{
  "Status": "Success",
  "Message": "",
  "Result": [
    { … },
    { … }
  ]
}