List journal entries

GET /api/v1/journal-entries

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

Operation ID: get_journal_entries_api_v1_journal_entries_get · View as markdown · OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Parameters

Query

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

Responses

200 Successful Response

Schema: JournalEntryListResponse

items array · JournalEntryResponse requiredJournalEntryResponse

List of items

13 fields

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

5 fields

loc array · string | integer required
msg string required
type string required
input object
ctx object

Code samples

GET /api/v1/journal-entries

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

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

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()