BizKitHub
DocsAPI ReferenceBank Statement/bff/bank-statement/accounts
getBank StatementAdmin BFF

/bff/bank-statement/accounts

For every bank account of the organisation: how many statements are stored, how many Fio has issued but are still missing, and whether the backfill waits for a strong authorization (SCA) in Fio internet banking. Also returns the calendar years that have statements (filter options).

Bank statementgetBffBank-statementAccounts

Parameters

No parameters required

This endpoint takes no path, query, header or body parameters.

Response schema

1 status code documented

200Success
accountsobject[]Required
Each array item:
bankAccountExternalIdstringRequired

16-char external id of the bank account.

status"no-connector" | "unhealthy" | "running" | "waiting" | "backfilling" | "sca-required" | "complete"Required

Completeness of the downloaded statements for this account.

statementCountnumberRequired

Stored statements.

latestPeriodStartstring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
latestPeriodEndstring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
fioLastStatementstring | nullRequired

Newest statement issued by Fio, "N/YYYY".

One of 2:
Variant 1
string
Variant 2
null
missingCountnumberRequired

Statements issued by Fio inside the backfill horizon but not stored yet.

hasUnknownYearsbooleanRequired

A past year has not been probed yet, the gap may be larger.

scaBlockedAtstring | nullRequired

Newest statement that needs a strong authorization, "N/YYYY".

One of 2:
Variant 1
string
Variant 2
null
lastRunDatestring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
lastErrorstring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
yearsnumber[]Required

Response example

application/json
{
  "accounts": [
    {
      "bankAccountExternalId": "example_bankAccountExternalId",
      "statementCount": 0,
      "missingCount": 0,
      "hasUnknownYears": false
    }
  ],
  "years": [
    0
  ]
}

Request example

GET /bff/bank-statement/accounts

get
curl -X GET "https://api.bizkithub.com/bff/bank-statement/accounts" \
  -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