List posting and reversal periods

Request

Purpose

Returns the posting periods and reversal periods available for a book (and optionally an organization). Use the returned id as periodId or reversalPeriodId.

When to use

Find which periods are open for posting (periodId) or available for reversal (reversalPeriodId) for a book and organization.

Security

OneIdOAuth

Query

bookIdinteger, (int32)required

Accounting book ID.

Example:bookId=1

orgIdstring

Organization ID. Supply it - omitting it currently causes an error.

Example:orgId=101

isJeApprovedboolean

Set to true to get the periods that apply to an approved entry (for example when choosing a reversal period).

Example:isJeApproved=false

cURL

curl -i -X GET \
  'https://one.zuora.com/revenue/services/v1/journal-entries/metadata/periods?bookId=1&orgId=101&isJeApproved=false' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Periods

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

{
  "postingPeriod": [
    { … },
    { … }
  ],
  "reversalPeriod": [
    { … },
    { … }
  ]
}