Skip to content
Revenue API
/
/
Get BI View data (v1) (PO...

Get BI View data (v1) (POST)

Request

Returns BI View rows as CSV, one page per call, for a date range. Without a date range it returns the view's columns; with count=true it returns the row count; with format=csv and no dates it returns only the CSV header row. Use POST with a Fields body to select columns.

Purpose: Existing integrations built on v1. New integrations should use the v2 operations, which handle large volumes better.

Notes:

  • clientId is required and must match the client of your user (usually 1).
  • fromDate and toDate use yyyy-MM-ddTHH:mm:ss; toDate must be later than fromDate.
  • Pages start at 1. Increase pagenum until the response is 204.
  • pagesize (lowercase) accepts 1 to 10,000; other values fall back to 1,000.
  • When Fields are selected, the response headers pagenum (next page) and record_count (rows in this page) are added.
  • CSV rows are returned with content type text/html; read the body as CSV text.
Security
OneIdOAuth
Path
tmpl_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_HEAD
Query
clientIdintegerrequired

Zuora Revenue client ID of your user.

Example:clientId=1
fromDatestring

Start of the date range, yyyy-MM-ddTHH:mm:ss.

Example:fromDate=2026-09-01T00:00:00
toDatestring

End of the date range, yyyy-MM-ddTHH:mm:ss.

Example:toDate=2026-09-30T23:59:59
pagenuminteger

Page to return, starting at 1.

Default:1
Example:pagenum=1
pagesizeinteger

Rows per page, 1 to 10,000.

Default:1000
Example:pagesize=1000
countboolean

When true (with fromDate and toDate), return the row count instead of rows.

Example:count=false
formatstring

With csv and no dates, return only the CSV header row.

Value:"csv"
Example:format=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
Bodyapplication/json

POST only. Columns to return.

Any of:

Optional body that selects which BI View columns to return. You can also send a plain JSON array of column names.

FieldsArray of strings

Column names to return. Names are matched case-insensitively against the describe-columns output.

Example:
[
  "RC_ID",
  "RC_NUM",
  "UPDT_DT"
]
{
  "Fields": [
    "RC_ID",
    "RC_NUM"
  ]
}

Responses

CSV rows (text/csv), or JSON with the row count (count=true) or the column list (no dates; the columns are returned in Status).

Body
string
Response
"120045","RC-120045","USD","2026-09-14 10:22:05"
"120046","RC-120046","EUR","2026-09-15 08:01:44"