# GET /api/v1/journal-entries

> List journal entries

- **Tag:** journal-entries
- **Operation ID:** `get_journal_entries_api_v1_journal_entries_get`

## Description

Retrieve journal entries with filtering by date, ledger, source, and text search.

## Authentication

Bearer token in `Authorization` header.
Required header: `x-business-id: <business uuid>`.

## Parameters

- `id` (query, array · string, optional) — Filter by journal entry IDs (comma-separated UUIDs)
- `description` (query, string, optional) — Filter by description (partial match)
- `invoice_id` (query, string, optional) — Filter by linked invoice UUID
- `ledger_id` (query, string, optional) — Filter by ledger account UUID (returns entries with line entries affecting this ledger)
- `source` (query, array · string, optional) — Filter by one or more backend origins: manual, invoice, bill, credit_memo, transaction, stripe, shopify, plaid, ramp, square, system, teal
- `creation_method` (query, JournalEntryCreationMethodEnum, optional) — Filter by creation method: ai (system-generated) or manual (user-typed)
- `start_date` (query, string, optional) — Filter entries on or after this date (ISO 8601: YYYY-MM-DD or YYYY-MM-DDTHH:MM:SSZ)
- `end_date` (query, string, optional) — Filter entries on or before this date (ISO 8601: YYYY-MM-DD or YYYY-MM-DDTHH:MM:SSZ)
- `search` (query, string, optional) — Search journal entries by description (case-insensitive partial match)
- `cursor` (query, string, optional) — Cursor for pagination
- `limit` (query, integer, optional) — Pagination limit
- `direction` (query, string, optional) — Pagination direction: 'next' or 'prev'
- `include_total_count` (query, boolean, optional) — Whether to include total count (expensive - avoid if possible)
- `sort_by` (query, string, optional) — Column name to sort by (e.g. 'created_at', 'amount', 'name'). When changing sort, reset cursor to None.
- `descending` (query, boolean, optional) — Sort direction: true for descending (newest/largest first), false for ascending

## Responses

### 200 — Successful Response

Schema: `JournalEntryListResponse`

- `items` (array · JournalEntryResponse · required) → `JournalEntryResponse` — List of items
  - `id` (string · required) — Unique identifier for this journal entry (UUID7).
  - `description` (string · required) — Human-readable description of the transaction.
  - `currency` (string) — Currency for the journal entry (USD, CAD, AUD, EUR, or GBP).
  - `entry_date` (string · date · required) — The date this transaction occurred.
  - `invoice_id` (string) — UUID of linked invoice, if this entry relates to an invoice.
  - `inventory_order_id` (string) — UUID of linked inventory order (PO), if this entry relates to a PO.
  - `source` (string) — Backend origin: manual, invoice, bill, credit_memo, transaction, stripe, shopify, plaid, ramp, square, system, teal
  - `creation_method` (string) — User-facing creation method: ai (system-generated) or manual (user-typed)
  - `business_id` (string · required) — UUID of the business this entry belongs to.
  - `line_entries` (array · LineEntryResponse) — The debit and credit line entries that make up this journal entry. Will be empty list if not expanded.
  - `thread` (JournalEntryThreadResponse) — Comment thread information if this journal entry has comments. Contains thread_id, comments array, and comment_count.
  - `created_at` (string · date-time) — When this journal entry was created.
  - `updated_at` (string · date-time) — When this journal entry was last modified.
- `total` (integer) — Total number of items (null when not calculated for performance)
- `limit` (integer) — Pagination limit
- `next_cursor` (string) — Cursor for next page
- `prev_cursor` (string) — Cursor for previous page
- `has_next` (boolean · required) — Whether there are more items
- `has_prev` (boolean · required) — Whether there are previous items

### 401 — Unauthorized - Authentication required

### 403 — Forbidden - Insufficient permissions

### 422 — Validation Error

Schema: `HTTPValidationError`

- `detail` (array · ValidationError) → `ValidationError`
  - `loc` (array · string | integer · required)
  - `msg` (string · required)
  - `type` (string · required)
  - `input` (object)
  - `ctx` (object)

## Code samples

### cURL

```bash
curl -X GET 'https://api.ondayzero.com/api/v1/journal-entries' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID'
```

### JavaScript

```javascript
const response = await fetch('https://api.ondayzero.com/api/v1/journal-entries', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer dz_your_token',
    'x-business-id': 'YOUR_BUSINESS_ID',
  },
});
const data = await response.json();
```

### Python

```python
import httpx

headers = {
    "Authorization": "Bearer dz_your_token",
    "x-business-id": "YOUR_BUSINESS_ID",
}

response = httpx.get("https://api.ondayzero.com/api/v1/journal-entries", headers=headers)
data = response.json()
```

## See also

- HTML version: https://www.ondayzero.com/docs/reference/journal-entries/get-journal-entries
- OpenAPI slice: https://www.ondayzero.com/docs/reference/journal-entries/get-journal-entries/openapi.json
- Other endpoints in **journal-entries**: https://www.ondayzero.com/docs/reference/journal-entries