---
title: "Query exact bank activity"
method: POST
path: "/bank-activity/query"
tags: ["Banking"]
---

# Query exact bank activity

`POST /bank-activity/query`

## Request

- Base URL: `https://ledgerhq.pro/api/v1`
- URL: `https://ledgerhq.pro/api/v1/bank-activity/query`
- Auth: one of:
  - HTTP bearer and API key in header `x-organization-id`
  - HTTP bearer and API key in header `x-organization-id`

Composes offset-aware timestamp or bank-date boundaries with canonical posting, coding, pending, visibility, readiness, reconciliation, source, scope, grouping, pagination, and currency-safe totals. Rows remain paginated, totals use complete-population SQL aggregates, and requested groups are bounded SQL aggregates; coverage.aggregateScope, groupScope, and groupsTruncated identify those contracts.

## Request body

- object
  - `version` 1, required
  - `scope` object, required
    - `mode` 'firm' | 'firm_and_companies' | 'all_companies' | 'selected_companies', required
    - `companyOrganizationIds` string[]
  - `occurredAt` object
    - `field` 'journal_posted_at' | 'row_updated_at' | 'bank_date'
    - `fromInclusive` string, date-time
    - `toExclusive` string, date-time
    - `startDate` string, date
    - `endDate` string, date
    - `timezone` 'America/New_York'
  - `posting` 'posted' | 'unposted' | 'any'
  - `excludeManagementReview` boolean: Exclude Ask Client account activity.
  - `coding` 'coded' | 'uncoded' | 'any'
  - `bankAvailability` 'settled' | 'pending_held' | 'any'
  - `visibility` 'active' | 'excluded' | 'provider_removed' | 'any'
  - `postingReadiness` 'ready' | 'warning' | 'not_postable' | 'any'
  - `reconciliation` 'reconciled' | 'posted_unreconciled' | 'not_applicable' | 'any'
  - `contact` 'assigned' | 'missing' | 'any': Customer/vendor contact on the bank transaction: assigned, missing (none set), or any.
  - `sourceTypes` string[]
  - `search` string
  - `groupBy` string[]
  - `orderBy` 'event_time_desc' | 'event_time_asc' | 'amount_desc' | 'amount_asc'
  - `limit` integer
  - `cursor` string

## Response `200`

Exact bank activity evidence and totals

## Other responses

- `default`: Error response

---

[API](https://skmtc.dev/ledgerhq-pro/apis/ledgerhq-bookkeeping-api.md) · [All operations](https://skmtc.dev/ledgerhq-pro/apis/ledgerhq-bookkeeping-api/llms.txt) · [OpenAPI document](https://skmtc.dev/ledgerhq-pro/apis/ledgerhq-bookkeeping-api/revisions/9a8269f0a586?raw)