Skip to content
Revenue API
/
/
Get BI View data (v2, pag...

Get BI View data (v2, paged) (POST)

Request

Returns one page of BI View rows for a date range as CSV or gzip-compressed CSV. Page 1 starts a background task that writes all pages; the response carries a continuation-token header that you send to read pages 2, 3 and so on. Use POST with a Fields body to return only selected columns.

Purpose: Extract large volumes of Zuora Revenue data (contracts, lines, schedules, bills, journal data) into a data warehouse or reconciliation process efficiently.

Notes:

  • fromDate and toDate use yyyy-MM-ddTHH:mm:ss and filter on the view's incremental update date (INCR_UPDT_DT), so consecutive ranges give you incremental (changed-data) extracts.
  • Request pagenum=1 first without a continuation-token. For every later page, send the token from the page 1 response. Increase pagenum until the response is 404 ("This page will not exist"), which also tells you the total pages and rows.
  • pageSize maximum: 10,000 rows for csv and 20,000 rows for gzip (your tenant may have lower limits).
  • pagenum=0 returns 204 No Content.
  • For BI3_LINE_STAGE_HISTORY and BI3_EVENT_STAGE_HISTORY, fromDate and toDate are optional when you filter by batchId. Always send pagenum=1 (or higher); without it the response is 204.
  • A later page can return 400 "Page still not yet cached. Please retry." while the background task is still writing it. Wait a few seconds and retry; check the task with Get a BI View task if it keeps happening.
  • The default gzip output is returned with content type application/gzip; csv with text/csv.
  • Rows are limited to the organizations your role can access.
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_LNS
Query
fromDatestringrequired

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

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

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

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

Page to return, starting at 1.

Example:pagenum=1
pageSizeinteger

Rows per page.

Default:1000
Example:pageSize=5000
outputTypestring

Response format: gzip (gzip-compressed CSV) or csv.

Default:"gzip"
Enum:"gzip""csv"
Example:outputType=csv
max_pagesinteger

Maximum number of pages the background task prepares.

Default:1000
Example:max_pages=100
add_record_countboolean

Send true to have the task count the rows first. Slower on large views. Omit the parameter to turn counting off: any non-empty value, including false, turns it on.

Example:add_record_count=true
batchIdstring

Batch identifier. Used only by BI3_LINE_STAGE_HISTORY and BI3_EVENT_STAGE_HISTORY, where it replaces the date range filter.

Example:batchId=20260930001
clientIdinteger

Accepted for compatibility with v1. Not used by v2.

Example:clientId=1
Headers
continuation-tokenstring

Task identifier returned in the continuation-token response header of page 1. Required for every page after the first.

Example:3f6c2d0a-8b1e-4f7a-9d2c-55e1a7b0c9f4
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. Omit to return all columns.

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",
    "UPDT_DT"
  ]
}

Responses

One page of rows. The continuation-token header identifies the background task; send it on the next page.

Headers
continuation-tokenstring

Task identifier to send when requesting later pages.

Body
string
Response
"RC_ID","RC_NUM","LINE_ID","EXT_SLL_PRC","UPDT_DT"
"120045","RC-120045","880113","12000","2026-09-14 10:22:05"