---
title: "Query journal entries"
method: POST
path: "/journal_entries/search"
tags: ["Journal Entries"]
---

# Query journal entries

`POST /journal_entries/search`

## Request

- Base URL: `https://us.api.flexprice.io/v1`
- URL: `https://us.api.flexprice.io/v1/journal_entries/search`
- Auth: API key in header `x-api-key`

Use when listing journal entries by period, event type, account, customer, contract, performance obligation or source. Returns a paginated list with lines.

## Request body

- JournalFilter
  - `accounting_period_ids` string[]
  - `accounts` TypesLedgerAccountKey[]
  - `contract_ids` string[]
  - `customer_ids` string[]
  - `end_time` string, date-time
  - `event_types` TypesJournalEventType[]
  - `expand` string
  - `filters` TypesFilterCondition[]
    - `data_type` 'string' | 'number' | 'date' | 'array'
    - `field` string
    - `operator` 'eq' | 'contains' | 'not_contains' | 'gt' | 'lt' | 'gte' | 'in' | 'not_in' | 'before' | 'after'
    - `value` TypesValue
      - `array` string[]
      - `boolean` boolean
      - `date` string
      - `number` number
      - `string` string
  - `journal_entry_ids` string[]
  - `limit` integer
  - `offset` integer
  - `order` 'asc' | 'desc'
  - `pob_ids` string[]
  - `sort` TypesSortCondition[]
    - `direction` 'asc' | 'desc'
    - `field` string
  - `source_entity_ids` string[]
  - `source_entity_type` 'subscription' | 'subscription_line_item' | 'invoice' | 'credit_note' | 'payment' | 'refund' | 'pob'
  - `start_time` string, date-time
  - `status` 'published' | 'deleted' | 'archived'

## Response `200`

OK

- ListJournalEntriesResponse
  - `items` JournalEntryResponse[]
    - `accounting_period_id` string
    - `business_date` string, date-time
    - `contract_id` string
    - `created_at` string, date-time
    - `currency` string
    - `customer_id` string
    - `event_type` 'invoice_finalized' | 'invoice_voided' | 'credit_note_finalized' | 'credit_note_voided' | 'payment_succeeded' | 'payment_reversed' | 'refund_succeeded' | 'revenue_earned' | 'revenue_offset'
    - `id` string
    - `lines` JournalLineResponse[]
      - `account` 'cash' | 'accounts_receivable' | 'unbilled_receivable' | 'deferred_revenue' | 'customer_credit' | 'tax_payable' | 'revenue' | 'contra_revenue'
      - `amount` string
      - `direction` 'debit' | 'credit'
      - `id` string
      - `pob_id` string
    - `reversal_of` string
    - `source_entity_id` string
    - `source_entity_type` 'subscription' | 'subscription_line_item' | 'invoice' | 'credit_note' | 'payment' | 'refund' | 'pob'
  - `pagination` TypesPaginationResponse
    - `limit` integer
    - `offset` integer
    - `total` integer

## Other responses

- `400`: Invalid request
- `500`: Server error

## Changes

- **2026-10-29** `f4730fdf8ea5`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/flexprice/apis/flexprice-api/changes/journal_entries/search/post.md)

---

[API](https://skmtc.dev/flexprice/apis/flexprice-api.md) - [All operations](https://skmtc.dev/flexprice/apis/flexprice-api/llms.txt) - [OpenAPI document](https://skmtc.dev/flexprice/apis/flexprice-api/revisions/e1348d61034c?raw)