BizKitHub
DocsAPI ReferenceBank Account/bff/bank-account/
getpostBank AccountAdmin BFF

/bff/bank-account/

Single source of truth for organisation bank accounts. Returns every account ever attached (active + soft-deleted), regardless of source (manual / MFCR / Fio API / GPC). Each row carries identity metadata, optional connector status, optional Fio-style live metadata (balance, sync period), and transaction analytics (counts, last 30d income/expense, match rate, last transaction date). Consumers (Settings page, Bank Transactions page) filter and sort client-side.

Bank accountgetBffBank-account

Parameters

No parameters required

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

Response schema

1 status code documented

200Success
itemsobject[]Required
Each array item:
externalIdstringRequired

Stable external identifier of the bank account.

ibanstring | nullRequired

Account IBAN (normalised, uppercase).

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

Czech domestic representation (e.g. "670100-2110572041/6210"). Null for non-CZ/SK IBANs.

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

Optional user-facing label.

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
bankNamestring | nullRequired

Bank display name.

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

Bank BIC/SWIFT.

One of 2:
Variant 1
string
Variant 2
null
sourcestringRequired

Where the account record originated.

Examplesmanualmfcrfio_apigpc
isActivebooleanRequired

Whether the account is active (false = soft-deleted).

isPrimarybooleanRequired

Marked as the organisation primary account.

isPubliclyListedbooleanRequired

True when this account is currently published in the MFCR VAT-payer registry for the organisation.

mfcrPublishedDatestring | nullRequired

Date the account was published in the MFCR registry (ISO date).

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

Last time the MFCR registry was checked (ISO timestamp).

One of 2:
Variant 1
string
Variant 2
null
fraudHitsnumberRequired

Number of active fraud-list entries linked to this normalised account.

fraudSeveritystring | nullRequired

Highest fraud severity ("info", "warning", "critical") or null when not on any list.

One of 2:
Variant 1
string
Variant 2
null
insertedDatestringRequired

When the account was first added (ISO).

hasConnectorbooleanRequired

True if an active sync connector (e.g. FIO API token) is attached.

connectorTypestring | nullRequired

Connector type, e.g. "fio_v2".

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

Last connector run status ("success" or "error").

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

Last connector run timestamp (ISO).

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

Masked API token (for display only).

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

Timestamp of the last connector fetch attempt (ISO).

One of 2:
Variant 1
string
Variant 2
null
lastSyncSuccessbooleanRequired

True when the last connector run completed without error.

lastSyncErrorMessagestring | nullRequired

Human-readable error message from the last failed sync.

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

Bank account number as reported by the connector (digits before the slash).

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

Account currency code (e.g. "CZK", "EUR").

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

Opening balance from the most recent synced period.

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

Closing balance from the most recent synced period.

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

Start of the most recent synced period (ISO).

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

End of the most recent synced period (ISO).

One of 2:
Variant 1
string
Variant 2
null
transactionCountnumberRequired

Total number of stored transactions for this account.

transactionsThisMonthnumberRequired

Transactions falling within the current calendar month.

totalIncomenumberRequired

All-time sum of incoming payments.

totalExpensenumberRequired

All-time sum of outgoing payments (absolute value).

income30dnumberRequired

Incoming payments in the last 30 days.

expense30dnumberRequired

Outgoing payments in the last 30 days (absolute value).

matchedTransactionsnumberRequired

Transactions automatically matched to an order.

unmatchedTransactionsnumberRequired

Transactions not yet matched to any order.

lastTransactionDatestring | nullRequired

Date of the most recent transaction (ISO) or null.

One of 2:
Variant 1
string
Variant 2
null

Response example

application/json
{
  "items": [
    {
      "externalId": "example_externalId",
      "source": "manual",
      "isActive": false,
      "isPrimary": false,
      "isPubliclyListed": false,
      "fraudHits": 0,
      "insertedDate": "example_insertedDate",
      "hasConnector": false,
      "lastSyncSuccess": false,
      "transactionCount": 0,
      "transactionsThisMonth": 0,
      "totalIncome": 0,
      "totalExpense": 0,
      "income30d": 0,
      "expense30d": 0,
      "matchedTransactions": 0,
      "unmatchedTransactions": 0
    }
  ]
}

Request example

GET /bff/bank-account/

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