Skip to content
Revenue API
/
/
List journal entry schedu...

List journal entry schedules

Request

Purpose

Returns a page of the revenue schedules (period-by-period accounting entries) that a journal entry generates. Available once waterfall generation has succeeded (waterfallStatus = SUCCESS).

When to use

  • See the period-by-period accounting (debits/credits by account and period) the entry produces, for GL reconciliation.
  • Available after waterfall generation has succeeded (waterfallStatus = SUCCESS).
Security
OneIdOAuth
Path
jeIdinteger, (int64)required

ID of the journal entry.

Example:10045
Query
filterArray of strings

Filter clause in the form field.OPERATOR:value. Repeat the parameter to combine clauses with AND. Operators: EQ (equals), NE (not equals), LT, GT, LE, GE (comparisons for numbers and dates), SW (starts with) and IN (any of a list: field.IN:[v1,v2]). Values are not quoted. Allowed fields for schedules: periodName, accountType, accountCode, acountCode, currencyCode, drAmount, crAmount, funcDrAmount, funcCrAmount, rcurrDrAmount, rcurrCrAmount, schdRcId. Unknown fields return 400 INVALID_VALUE.

Example:filter=periodName.EQ:SEP-2026
sortArray of strings

Sort clause field.ASC or field.DESC. Only the first sort clause is applied. Uses the same field names as filter.

Example:sort=periodName.ASC
fieldsArray of strings

Accepted for consistency with other list endpoints; not applied by this endpoint.

expandArray of strings

Reserved for future use; currently ignored.

pageSizeinteger, (int32)

Number of records per page. Defaults to 20. Values above 40 are reduced to 40.

Default:20
Example:pageSize=20
cursorstring

Page to return. Use the 1-based page number (1, 2, ...). Defaults to the first page. A non-numeric or non-positive value returns 400 INVALID_VALUE.

Example:cursor=2
cURL
curl -i -X GET \
  'https://one.zuora.com/revenue/services/v1/journal-entries/10045/schedules?filter=periodName.EQ%3ASEP-2026&sort=periodName.ASC&fields=string&expand=string&pageSize=20&cursor=2' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Journal entry with a page of schedules

Headers
traceIdstring

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

Bodyapplication/json
successboolean

true when the operation succeeded.

Example:true
idinteger or null, (int64)

Unique system-generated identifier of the journal entry (JE header ID).

Example:10045
namestring or null

Name of the journal entry. Shown in the Zuora Revenue UI and in GL interfaces. Must be meaningful to approvers, for example SEP-2026 Revenue Reclass.

Example:"SEP-2026 Revenue Reclass"
statusstring or null

Journal entry status. One of New, Draft, Validated, Approval Pending, Approved, Rejected, Approval Cancelled, Error, Approval Rule not Defined.

Example:"New"
descriptionstring or null

Free-text description of the journal entry's business purpose.

Example:"Reclass deferred revenue for contract RC-1001"
waterfallStatusstring or null

Status of revenue waterfall (schedule) generation for the entry. One of NEW, IN PROGRESS, SUCCESS, ERROR. For approved entries this reflects the final waterfall; otherwise the preview waterfall.

Example:"NEW"
jeHeaderobject(JournalEntryHeader)

Full header. Returned by create, get and copy.

linesobject(JournalEntryLinesPage)

Page of lines. Returned by GET /journal-entries/{jeId}/lines.

schedulesobject(JournalEntrySchedulesPage)

Page of schedules. Returned by GET /journal-entries/{jeId}/schedules.

Response
{
  "success": true,
  "schedules": {
    "pageNumber": 1,
    "pageSize": 20,
    "totalRecords": 2,
    "result": [ … ]
  }
}