Skip to content
Revenue API
/
/
Retrieve reference data

Retrieve reference data

Request

Purpose

Returns the lists of valid values you need to build a journal entry: books, organizations, category codes, exchange rate types, approval and functional currencies, Set of Books names, GL transfer values, accounting methods, account types, accounting segments, VC types and cost types. Call it once and cache the result. Period lists are returned by GET /journal-entries/metadata/periods.

When to use

  • Before building entries: get the valid books, organizations, categories, exchange rate types, account types, currencies and other code lists.
  • Populate drop-downs in your own UI, or validate data in your source system before sending it. Cache the result.
Security
OneIdOAuth
cURL
curl -i -X GET \
  https://one.zuora.com/revenue/services/v1/journal-entries/metadata \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Reference data

Headers
traceIdstring

Identifier of the request. Quote it when you contact Zuora Support.

Bodyapplication/json
postingPeriodArray of objects or null(MetadataOption)

Open periods an entry can be posted to (id is the periodId).

reversalPeriodArray of objects or null(MetadataOption)

Periods that can be used as reversalPeriodId.

createDatestring or null

Current date in the service time zone.

Example:"2026-10-07"
bookIdArray of objects or null(MetadataOption)

Accounting books available to the caller.

categoryIdArray of objects or null(MetadataKeyValue)

Valid categoryCode values.

exchangeRatesArray of objects or null(MetadataKeyValue)

Valid exchangeRateType values.

approvalCurrencyArray of strings or null

Valid approvalCurrency values.

Example:
[
  "USD",
  "EUR"
]
sobNameArray of strings or null

Set of Books names.

Example:
[
  "US Primary SOB"
]
orgIdArray of objects or null(MetadataOption)

Organizations available to the caller.

functionalCurrencyArray of strings or null

Functional currencies.

Example:
[
  "USD"
]
glTransferArray of strings or null

Valid glTransfer values.

Example:
[
  "YES",
  "NO"
]
accountingMethodArray of objects or null(MetadataKeyValue)

Valid accountMethod values.

accountTypesArray of objects or null(MetadataKeyValue)

Valid line accountType values.

accountingSegmentsArray of objects or null(MetadataKeyValue)

Accounting segment definitions used to build accountCode.

vcTypesArray of objects or null(MetadataKeyValue)

Variable consideration types (for typeName when the account type is a VC account).

costTypesArray of objects or null(MetadataKeyValue)

Cost types (for typeName when the account type is a cost account).

Response
{
  "createDate": "2026-10-07",
  "bookId": [
    { … }
  ],
  "orgId": [
    { … }
  ],
  "categoryId": [
    { … },
    { … }
  ],
  "exchangeRates": [
    { … },
    { … }
  ],
  "approvalCurrency": [
    "USD",
    "EUR"
  ],
  "sobName": [
    "US Primary SOB"
  ],
  "functionalCurrency": [
    "USD"
  ],
  "glTransfer": [
    "YES",
    "NO"
  ],
  "accountingMethod": [
    { … }
  ],
  "accountTypes": [
    { … },
    { … }
  ],
  "accountingSegments": [
    { … },
    { … },
    { … }
  ],
  "vcTypes": [
    { … }
  ],
  "costTypes": [
    { … }
  ]
}