Skip to content
/Journal Entry Lines

Journal Entry Lines

List, search, copy and delete the debit/credit lines of a journal entry.

Operations

List journal entry lines

Request

Purpose

Returns a page of the lines of a journal entry, with filtering, sorting and field selection. Each line's errorMessage shows any validation error recorded on it.

When to use

  • Review or reconcile the debit/credit lines of an entry, for example to show them in your own UI.
  • After validation fails (validationStatus = Error), to find which lines have an errorMessage.
  • Get line IDs before a CSV full-file update, line copy or line delete.

Notes

  • Without fields, the page is wrapped in a JournalEntryResponse under lines. With fields, the page object is returned directly.
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 lines: accountCode, accountType, bookId, comments, costOrVcType, createdBy, createdDate, credit, currency, debit, description, endDate, errorMessage, exchangeRate, exchangeRateDate, gexchangeRate, id, jeSetNo, orgId, rcId, rcLineId, reason, reference1, reference2, reference3, reference4, reference5, reference6, reference7, reference8, reference9, reference10, reference11, reference12, reference13, reference14, reference15, soLineId, soNum, startDate, typeName, updatedBy, updatedDate. Unknown fields return 400 INVALID_VALUE.

Example:filter=accountType.EQ:Revenue
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=id.ASC
fieldsArray of strings

Comma-separated list of properties to return for each record (the id property is always returned). Names must match the response property names exactly. When supplied, each record contains only these properties. Unknown names return 400 INVALID_VALUE.

Example:fields=accountCode&fields=debit&fields=credit
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/lines?filter=accountType.EQ%3ARevenue&sort=id.ASC&fields=accountCode%2Cdebit%2Ccredit&expand=string&pageSize=20&cursor=2' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Journal entry with a page of lines

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,
  "lines": {
    "pageNumber": 1,
    "pageSize": 20,
    "totalRecords": 2,
    "result": [ … ]
  }
}