v2

latestOpenAPI 3.0.3raw.githubusercontent.com2025-01-245593419.2 KB
Statements

List statements

OAuth scope: organization.read


Retrieves the list of statements for the authenticated organization.

get/v2/statements

Query parameters

{"stackTrail":"paths:/v2/statements:get:parameters:1:schema:items","oasType":"schema","type":"unknown"}

Statements can be filtered by their bank_account_id.<br>⚠️ ibans and bank_account_ids are mutually exclusive and cannot be used together.

{"stackTrail":"paths:/v2/statements:get:parameters:2:schema:items","oasType":"schema","type":"unknown"}

Statements can be filtered by their iban.<br>⚠️ ibans and bank_account_ids are mutually exclusive and cannot be used together.

period_fromstring
Example:01-2023

Statements can be filtered by their period. This filter is the beginning of the desired statement period (included).

period_tostring
Example:12-2023

Statements can be filtered by their period. This filter is the end of the desired statement period (included).

sort_bystring
Example:period:asc

Statements can be sorted by their period in 2 possible directions: asc (Ascending) / desc (Descending).

Headers

X-Qonto-Staging-Tokenstring

Required only for Sandbox API requests; to get one, please submit the following form: https://getqonto.atlassian.net/servicedesk/customer/portal/5/group/47/create/143.

Response

Returns the list of statements of the authentified organization.

Example response

{
  "statements": [
    {
      "id": "08544790-6305-4a85-8487-e035290bcee8",
      "bank_account_id": "9f4af770-344b-42c1-a592-6a2adf82a6d3",
      "period": "08-2024",
      "file": {
        "file_content_type": "application/pdf",
        "file_size": "16966"
      }
    }
  ],
  "meta": {
    "current_page": 2,
    "prev_page": 1,
    "total_pages": 2,
    "total_count": 150,
    "per_page": 100
  }
}