Skip to content
Revenue API
/
/
Search journal entries (f...

Search journal entries (filter in body)

Request

Purpose

Same result as GET /journal-entries, but the filter, sort and page criteria are sent in the request body. Use it for long filters that would exceed URL length limits or for multi-value IN filters.

When to use

  • Your filter is too long for a URL, or you need multi-value IN / NOT IN filters.
  • You prefer to send search criteria as JSON (for example from a reporting tool) rather than as query parameters.

Notes

  • Body filter fieldName values are passed through as-is and must be one of: id, name, description, reversalStatus, categoryCode, exRateType, periodId, status, reversalPeriodId, hashTotal, sobName, sobId, functionalCurrency, createdBy, createdDate, updatedBy, updatedDate, approverName.
  • values must contain at least one element for every operator (including IS NULL / IS NOT NULL).
  • Filters on periodId / reversalPeriodId compare against the period name (for example SEP-2026).
  • pageNumber defaults to 1 and pageSize to 20 when omitted; pageSize above 40 is reduced to 40.
  • Use IN / NOT IN for text comparisons; other operators compare values as-is and are intended for numeric and date fields.
Security
OneIdOAuth
Query
fieldsArray of strings

Comma-separated list of properties to return for each record (id is always returned).

Example:fields=name&fields=status
Bodyapplication/jsonrequired
pageNumberinteger or null, (int32)

1-based page number. Defaults to 1.

Example:1
pageSizeinteger or null, (int32)

Records per page. Defaults to 20; values above 40 are reduced to 40. Not applied by export endpoints, which return all rows.

Example:20
filtersArray of objects or null(QueryFilter)

Filter conditions, combined with AND.

orderingobject(QueryOrder)

Single sort order.

{
  "pageNumber": 1,
  "pageSize": 20,
  "filters": [
    { … },
    { … }
  ],
  "ordering": {
    "fieldName": "createdDate",
    "orderBy": "DESC"
  }
}

Responses

Page of journal entries

Headers
traceIdstring

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

Bodyapplication/json
pageNumberinteger or null, (int32)

1-based number of the page returned.

Example:1
pageSizeinteger or null, (int32)

Maximum number of records per page (capped at 40).

Example:20
totalRecordsinteger or null, (int64)

Total number of records that match the query across all pages.

Example:1
resultArray of objects or null(JournalEntryListItem)

Records on this page.

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