Skip to content
Revenue API
/
/
List journal entries by n...

List journal entries by name

Request

Purpose

Returns the journal entries whose name matches the given text. Use it for quick look-ups (for example a type-ahead); use GET /journal-entries with filter=name.SW:... for paginated searches.

When to use

  • Quick look-up of an entry by (part of) its name, for example in a type-ahead search box.
  • Before retrying a create call that timed out, to check whether the entry was already created.
Security
OneIdOAuth
Path
jeNamestringrequired

Name (or part of the name) to search for. URL-encode spaces and special characters.

Example:SEP-2026
cURL
curl -i -X GET \
  https://one.zuora.com/revenue/services/v1/journal-entries/search/SEP-2026 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Matching journal entries (may be empty)

Headers
traceIdstring

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

Bodyapplication/json
Array [
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"
descriptionstring or null

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

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

Approval status of the reversal of this entry, when a reversal was requested. Empty when the entry has not been reversed.

Example:""
categoryCodestring or null

Journal entry category code. Classifies why the entry is posted (for example an accrual, reclass or adjustment). Valid values are configured in your tenant's MANUAL_JOURNAL lookup; retrieve them from categoryId in GET /journal-entries/metadata.

Example:"RECLASS"
exRateTypestring or null

Exchange rate type used to convert transaction currency to functional and reporting currency (for example User or Corporate). Valid values come from exchangeRates in GET /journal-entries/metadata. (Filter and sort on this property using the name exchangeRateType.)

Example:"User"
periodIdstring or null

Name of the posting period, for example SEP-2026 (in list results this property holds the period name, not the numeric ID; filters compare against the name).

Example:"SEP-2026"
statusstring or null

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

Example:"New"
reversalPeriodIdstring or null

Name of the reversal period, for example OCT-2026 (period name, not the numeric ID).

Example:"OCT-2026"
hashTotalnumber or null, (double)

Hash total of the entry: the sum of all line amounts. Useful as a control total when reconciling uploads.

Example:3000
sobNamestring or null

Name of the Set of Books. On create and update the service derives this from sobId; any value you send is overwritten.

Example:"US Primary SOB"
sobIdinteger or null, (int64)

Identifier of the Set of Books (SOB) the entry posts to. A Set of Books groups the ledger, functional currency and calendar used for accounting.

Example:1
functionalCurrencystring or null

ISO 4217 currency code of the functional (ledger) currency of the Set of Books, for example USD.

Example:"USD"
createdBystring or null

User who created the record.

Example:"jane.doe@example.com"
createdDatestring or null

Timestamp when the record was created (ISO 8601).

Example:"2026-09-28 10:21:04"
updatedBystring or null

User who last updated the record.

Example:"jane.doe@example.com"
updatedDatestring or null

Timestamp when the record was last updated (ISO 8601).

Example:"2026-09-28 10:21:04"
approverNamestring or null

Name of the approver currently assigned to the entry by the approval rule. Read-only on most flows.

bookIdinteger or null, (int32)

Identifier of the accounting book (for example the primary book or a secondary/parallel book) the entry belongs to.

Example:1
secAtrValstring or null

Organization (security attribute value) of the entry. Same meaning as orgId.

Example:"101"
]
Response
[
  {
    "id": 10045,
    "name": "SEP-2026 Revenue Reclass",
    "description": "Reclass deferred revenue for contract RC-1001",
    "reversalStatus": "",
    "categoryCode": "RECLASS",
    "exRateType": "User",
    "periodId": "SEP-2026",
    "status": "New",
    "reversalPeriodId": "OCT-2026",
    "hashTotal": 3000,
    "sobName": "US Primary SOB",
    "sobId": 1,
    "functionalCurrency": "USD",
    "createdBy": "jane.doe@example.com",
    "createdDate": "2026-09-28 10:21:04",
    "updatedBy": "jane.doe@example.com",
    "updatedDate": "2026-09-28 10:21:04",
    "approverName": null,
    "bookId": 1,
    "secAtrVal": "101"
  }
]