BizKitHub
getBank StatementAdmin BFF

/bff/bank-statement/

Paginated list of stored statement PDFs for the caller organisation, newest period first. Filter by bank account (external id), by calendar year / month (period overlap, so a quarterly statement appears in each month it covers) and by full-text query.

Bank statementgetBffBank-statement

Parameters

6 query

Query parameters

· 6
bankAccountExternalIdstringOptional

Restrict to statements of one bank account.

Exampleexample_bankAccountExternalId
yearstring | numberOptional

Statements whose period overlaps this calendar year (e.g. 2026).

monthstring | numberOptional

With year: statements whose period overlaps this month (1-12).

Range: 1–12
filterFulltextQuerystringOptional

Search in account name, IBAN, account number or "N/YYYY".

Exampleexample_filterFulltextQuery
pagestring | numberOptional
limitstring | numberOptional

Response schema

1 status code documented

200Success
itemsobject[]Required
Each array item:
idstringRequired

Row key for data grids, equal to externalId.

externalIdstringRequired

Blob token (immutable). Use as row key and download identifier.

bankAccountExternalIdstring | nullRequired

16-char external id of the source bank account.

One of 2:
Variant 1
string
Variant 2
null
bankAccountDisplayNamestring | nullRequired

Human-readable label of the source account.

One of 2:
Variant 1
string
Variant 2
null
ibanstring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
accountNumberstring | nullRequired

Domestic account number without slash.

One of 2:
Variant 1
string
Variant 2
null
bankCodestring | nullRequired

4-digit Czech bank code.

One of 2:
Variant 1
string
Variant 2
null
statementYearnumberRequired

Bank numbering year of the statement ("8/2026" → 2026).

statementNumbernumberRequired

Statement number within its numbering year ("8/2026" → 8). Not the calendar month.

yearnumberRequired

Calendar year the statement period ends in.

monthnumberRequired

Calendar month (1-12) the statement period ends in.

periodStartstringRequired

ISO date of the first day covered by the statement.

periodEndstringRequired

ISO date of the last day covered by the statement.

openingBalancenumber | nullRequired

Balance at the start of the period, from the PDF header.

One of 2:
Variant 1
number
Variant 2
null
closingBalancenumber | nullRequired

Balance at the end of the period, from the PDF header.

One of 2:
Variant 1
number
Variant 2
null
currencystring | nullRequired

ISO 4217 currency of the account.

One of 2:
Variant 1
string
Variant 2
null
byteSizenumberRequired

PDF size in bytes.

sourcestringRequired

Origin of the PDF (e.g. "fio_api").

Examplefio_api
downloadedDatestringRequired

ISO timestamp when the PDF was pulled from the bank.

filenamestringRequired

Human-facing filename for downloads.

contentTypestringRequired

Blob content type, always application/pdf for statements.

downloadUrlstringRequired

Authenticated BFF download URL (/bff/bank-statement/file?token=…).

itemCountnumberRequired

Response example

application/json
{
  "items": [
    {
      "id": "example_id",
      "externalId": "example_externalId",
      "statementYear": 0,
      "statementNumber": 0,
      "year": 0,
      "month": 0,
      "periodStart": "example_periodStart",
      "periodEnd": "example_periodEnd",
      "currency": "CZK",
      "byteSize": 0,
      "source": "fio_api",
      "downloadedDate": "example_downloadedDate",
      "filename": "example_filename",
      "contentType": "example_contentType",
      "downloadUrl": "example_downloadUrl"
    }
  ],
  "itemCount": 0
}

Request example

GET /bff/bank-statement/

get
curl -X GET "https://api.bizkithub.com/bff/bank-statement/?bankAccountExternalId=example_bankAccountExternalId&filterFulltextQuery=example_filterFulltextQuery" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key