Skip to main content
GET
List journals

Authorizations

X-API-Key
string
header
required

Your organization API key. Some operations also need a key that is associated with a user; their pages say so.

Query Parameters

statuses
enum<string>[]

Comma-separated journal statuses: draft, posted, reversed, in_progress, error or unposted. A reversed journal has status reversed, not posted.

Available options:
draft,
posted,
reversed,
unposted,
in_progress,
error
start_date
string<date-time>

Inclusive lower bound on accounting_date. Accepts a date (2026-08-01, meaning midnight UTC) or a full timestamp.

end_date
string<date-time>

Inclusive accounting-date upper bound. A date includes the whole UTC day; a timestamp includes that exact instant.

sort_by
enum<string>

Field to sort by. Use created_at for issuance order; sequence numbers are not a sort option.

Available options:
accounting_date,
created_at,
updated_at
sort_direction
enum<string>

Sort direction. Defaults to desc (newest first).

Available options:
asc,
desc
originated_by
string

Filter by system, user, or both separated by a comma. Other non-empty values return 400.

Pattern: ^\s*(system|user)\s*(,\s*(system|user)\s*)*$
tag_ids
string[]

Comma-separated tag_ IDs. Up to 100 IDs.

sync_status
enum<string>

Latest sync state with the general ledger. pending does not include failed.

Available options:
synced,
pending,
failed
sync_error_types
string[]

Filter failed syncs by error type. Sets sync_status=failed; synced or pending return HTTP 400. Repeat the parameter.

sync_attempt_ids
string[]

Latest sync attempt IDs (jesa_…), up to 100. An older attempt ID returns no journals.

source_types
string[]

Comma-separated journal source types to include. You cannot send it with exclude_source_types.

journal_sequence_numbers
string[]

Exact journal sequence numbers, such as JE-2096, or their numeric part.

transaction_sequence_numbers
string[]

Comma-separated source transaction sequence numbers (such as OT-1234). Returns the entries linked to those transactions.

exclude_source_types
string[]

Comma-separated journal source types to exclude. You cannot send it with source_types.

updated_since
string<date-time>

Return journals updated at or after this time (ISO 8601). Use it to poll for changes.

synced_start_date
string<date-time>

Inclusive lower bound on last_synced_at. Includes entries later removed from the external GL.

synced_end_date
string<date-time>

Inclusive upper bound on last_synced_at. Must be on or after synced_start_date.

sync_history_ids
string[]

Filter by general-ledger sync history IDs (sh_…).

Pattern: ^sh_[0-9a-fA-F]{24}$
created_since
string<date-time>

Return entries whose created_at is at or after this ISO-8601 timestamp (inclusive).

include_count
boolean

Include the total number of matching records. If the count cannot be calculated, the request fails.

Filter by one or more legal entity IDs. Omit to include all authorized entities. An empty list is invalid.

journal_entry_ids
string[]

IDs to return, separated by commas. The other filters also apply.

ledger_account_ids
string[]

Match entries with a line in any of these ledger accounts. The response includes all lines; use matching lines when totaling an account.

accounting_period_ids
string[]

Any of these accounting period IDs.

limit
integer
default:25

Maximum number of records to return.

Required range: 1 <= x <= 100
cursor
string

The next_cursor value from the previous page. Keep the other filters unchanged.

Case-insensitive search in labels and descriptions.

transaction_ids
string[]

Any of these transaction IDs. No date cutoff applies unless you set a date filter.

Maximum array length: 100

Transaction ID (txn_…).

template_ids
string[]

Filter by one or more template ids. Repeat the parameter or send a comma-separated list. Up to 100 IDs.

Response

The matching records.

data
object[]
required

The records.

has_more
boolean
required

Whether another page is available.

next_cursor
string | null
required

Cursor for the next page, or null on the last page.

total_count
integer

Total matching records across all pages. Present when include_count=true.

Required range: x >= 0