---
title: "Query bank statements"
method: POST
path: "/v6/banks/statements/query"
tags: ["Bank Statements"]
---

# Query bank statements

`POST /v6/banks/statements/query`

Query bank statements for the authenticated user

## Request body

- BankStatementsGetParam
  - `cursor` string, nullable — Cursor from the previous paginated response
  - `limit` integer — Page size, i.e. number of items to return per page
  - `sort` BankStatementsSort — Sort order for the items in the response.
    - `orderBy` 'DATE_UPLOADED' — Sort column
    - `direction` 'ASC' | 'DESC' — Sort direction. Defaults to DESC
  - `filter` BankStatementsFilterParam — Filter for items in the response.
    - `bankAccount` BankAccountFilter — Bank filter
      - `id` BankAccountIds — Id filter - returns all entities with the following bank accounts.
        - `in` string[] — List of values to include.
        - `notIn` string[] — List of values to exclude.

## Response `200`

Success

- PaginatedResponseBankStatementGetDto
  - `result` 'SUCCESS' | 'FAILURE' — The result of the action performed.
  - `data` BankStatementGetDto[] — The data generated by the action performed.
    - `id` string, required — Id of the bank statement
    - `status` 'ACTIVE' | 'INACTIVE' | 'REMOVED', required — Status of the bank statement
    - `url` string, nullable, required — URL to the bank statement document
    - `bankAccount` BankAccountExpanded, required — Bank account of the matching bank transaction
      - `id` string, required — Id of the bank account
      - `name` string — Name of the bank account
      - `displayName` string — Display Name of the bank account
    - `period` BankStatementPeriodGetDto, nullable, required — The date period covered by this bank statement
      - `beginDate` string, date, nullable, required — Start date of the bank statement period
      - `endDate` string, date, nullable, required — End date of the bank statement period
    - `customData` JsonNode, nullable — Custom JSON in which you can store any data with max length of 2000 characters
      - `empty` boolean
      - `array` boolean
      - `null` boolean
      - `object` boolean
      - `float` boolean
      - `string` boolean
      - `number` boolean
      - `missingNode` boolean
      - `valueNode` boolean
      - `nodeType` 'ARRAY' | 'BINARY' | 'BOOLEAN' | 'MISSING' | 'NULL' | 'NUMBER' | 'OBJECT' | 'POJO' | 'STRING'
      - `pojo` boolean
      - `integralNumber` boolean
      - `floatingPointNumber` boolean
      - `short` boolean
      - `int` boolean
      - `long` boolean
      - `double` boolean
      - `bigDecimal` boolean
      - `bigInteger` boolean
      - `textual` boolean
      - `boolean` boolean
      - `binary` boolean
      - `container` boolean
      - `embeddedValue` boolean
  - `cursor` ResponseCursor — Cursor to be used in your subsequent paginated request. Only populated if there are more pages available.
    - `after` string — After cursor - Fetches entities after this cursor. Useful for paging forwards.
    - `before` string — Before cursor - Fetches entities before this cursor. Useful for paging backwards.

## Other responses

- `400` — Bad request
- `401` — Not authenticated
- `403` — Not authorized
- `404` — Endpoint not found
- `500` — Internal server error

---

[API](https://skmtc.net/tight/apis/tight-api.md) · [All operations](https://skmtc.net/tight/apis/tight-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/tight/tight-api/revisions/e9f0790a89af/schema)