Submit a BI View report

Request

Submits a background job that writes the whole BI View for a date range to a report file. Returns the submission ID of the job.

Purpose: Produce a complete extract as one file instead of paging through the data. When the file is ready, download it with Get a signed URL.

Notes:

Dates use DD-Mon-YYYY, for example 01-Sep-2026 (different from the paged operations).
Poll Get a report file by submission ID with report_id until the file appears, then call Get a signed URL.

Security

OneIdOAuth

Path

in_view_namestringrequired

BI View API name. Standard views: BI3_ACCT_TYPE, BI3_APPR_DTL, BI3_BOOK, BI3_CALENDAR, BI3_MJE, BI3_ORG, BI3_PERIODS, BI3_RC_BILL, BI3_RC_HEAD, BI3_RC_LNS, BI3_RC_LN_COST, BI3_RC_POB, BI3_RC_SCHD, BI3_RC_SCHD_DEL, BI3_RI_ACCT_SUMM, BI3_LINE_STAGE_HISTORY, BI3_EVENT_STAGE_HISTORY, BI3_CT_MOD_DETAIL, BI3_RC_LNS_VERSION, BI3_POB_ACTIONS, BI3_RC_CT_MOD_DET, BI3_RC_HOLD. Custom views configured for your tenant are also accepted.

Example:BI3_RC_SCHD

Query

fromDatestringrequired

Start date, DD-Mon-YYYY.

Example:fromDate=01-Sep-2026

toDatestringrequired

End date, DD-Mon-YYYY.

Example:toDate=30-Sep-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 POST \
  'https://one.zuora.com/api/integration/v2/biviews/report/BI3_RC_SCHD?fromDate=01-Sep-2026&toDate=30-Sep-2026' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Zuora-Track-Id: close-run-2026-09-001'

Responses

The job was accepted.

Bodyapplication/json

successboolean

true when the report job was accepted.

Example:true

report_idinteger

Submission identifier of the report job. Use it with GET /api/integration/v1/reports/{report_id} and GET /api/integration/v2/reports/signedurl/{report_id}.

Example:482455

messagestring

Reason the job was not accepted (present only when success is false).

Example:"Unable to submit"

Response

{
  "success": true,
  "report_id": 482455
}