Skip to content
Revenue API
/
/
List BI View columns

List BI View columns

Request

Returns the columns of a BI View with their data types and sizes.

Purpose: Build target tables in your warehouse and choose the column names to send in a Fields list.

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
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/v2/biviews/BI3_RC_HEAD/describe-columns \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Zuora-Track-Id: close-run-2026-09-001'

Responses

The columns of the view, as JSON text (served with content type text/html; parse the body as JSON).

Bodytext/html
Array [
column_namestring

Column name. Use it in the Fields list to select columns.

Example:"RC_ID"
data_typestring

Database data type of the column.

Example:"NUMBER"
data_lengthinteger

Maximum length of the column in bytes.

Example:22
data_precisioninteger or null

Numeric precision, when applicable.

Example:38
data_scaleinteger or null

Numeric scale, when applicable.

Example:0
]
Response
[
  {
    "column_name": "RC_ID",
    "data_type": "NUMBER",
    "data_length": 22,
    "data_precision": null,
    "data_scale": null
  },
  {
    "column_name": "RC_NUM",
    "data_type": "VARCHAR2",
    "data_length": 200,
    "data_precision": null,
    "data_scale": null
  },
  {
    "column_name": "UPDT_DT",
    "data_type": "DATE",
    "data_length": 7,
    "data_precision": null,
    "data_scale": null
  }
]