List Journals
list_journalsRetrieve paginated journal entries, optionally filtered by date, client, registration status, operation type, or document number; use brief or full views to inspect headers.
Instructions
List journal entries. Paginated. Brief view omits postings; use view='full' for headers or get_journal for postings.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number (default 1) | |
| view | No | Response detail: brief (default) returns triage fields; full returns every API field. | |
| date_to | No | Only journals with effective_date <= this (YYYY-MM-DD). Filters by effective_date; narrowed server-side. | |
| per_page | No | Items per page when filtering (default 100, max 500) | |
| date_from | No | Only journals with effective_date >= this (YYYY-MM-DD). Filters by effective_date; narrowed server-side. | |
| clients_id | No | Filter by clients_id | |
| registered | No | Only registered (true) or unregistered (false) journals | |
| modified_since | No | Return only objects modified since this timestamp (ISO 8601) | |
| operation_type | No | Filter by operation_type (e.g. INITIAL for UI-managed opening balances, ENTRY, TRANSACTION, SALE_INVOICE, PURCHASE_INVOICE) | |
| document_number_contains | No | Case-insensitive substring match on document_number |