Retrieve a journal entry

Revenue API

Request

Purpose

Returns the full header of one journal entry, including status, waterfall status, error count and validation messages. Use GET /journal-entries/{jeId}/lines to read its lines.

When to use

You know the jeId and need the entry's current status, waterfall status, error count or validation messages.
After create, update or a workflow action, to confirm the resulting state.
Use fields when you only need a few properties (for example status while polling).

Notes

With fields, date-time properties (for example createdDate) are returned as epoch milliseconds.

Security

OneIdOAuth

Path

jeIdinteger, (int64)required

ID of the journal entry.

Example:10045

Query

fieldsArray of strings

Comma-separated list of header properties to return. When supplied, the response is a flat object containing only id and the requested header properties (no success / jeHeader wrapper).

Example:fields=name&fields=status&fields=waterfallStatus

cURL

curl -i -X GET \
  'https://one.zuora.com/revenue/services/v1/journal-entries/10045?fields=name%2Cstatus%2CwaterfallStatus' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Journal entry

Headers

traceIdstring

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

Bodyapplication/json

Any of:

A journal entry with its header and, depending on the operation, a page of lines or schedules.

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,
  "id": 10045,
  "name": "SEP-2026 Revenue Reclass",
  "status": "New",
  "description": "Reclass deferred revenue for contract RC-1001",
  "waterfallStatus": "NEW",
  "jeHeader": {
    "id": 10045,
    "name": "SEP-2026 Revenue Reclass",
    "description": "Reclass deferred revenue for contract RC-1001",
    "categoryCode": "RECLASS",
    "exchangeRateType": "User",
    "sobId": 1,
    "sobName": "US Primary SOB",
    "functionalCurrency": "USD",
    "periodId": 202609,
    "periodDisplayValue": "SEP-2026",
    "clientId": 1,
    "orgId": "101",
    "orgName": "US Operations",
    "bookId": 1,
    "bookName": "Primary Book",
    "accountMethod": "Standard",
    "revRecType": "STANDARD",
    "status": "New",
    "jeStatus": "New",
    "approvalCurrency": "USD",
    "glTransfer": "Yes",
    "waterfallStatus": "NEW",
    "jeWaterfallStatus": "NEW",
    "jeTempWaterfallStatus": "NEW",
    "reversalStatus": "",
    "errorCount": 0,
    "errorMessages": [],
    "createdBy": "jane.doe@example.com",
    "createdDate": "2026-09-28T10:21:04.000+00:00",
    "updatedBy": "jane.doe@example.com",
    "updatedDate": "2026-09-28T10:21:04.000+00:00"
  }
}