BizKitHub Developer Documentation

Parameters

4 query

Query parameters

· 4

pagestringOptional

Page number (1-based) for pagination.

Example1

limitstringOptional

Maximum items per page (1–500, default 50).

Example50

orderHashstringOptional

Filter transactions linked to a specific order.

Exampleabc123

filterAccountstringOptional

Filter by bank account external ID.

Example2000123456

Response schema

1 status code documented

200SuccessPaginated list of bank transactions.

itemsobject[]Required

Each array item:

Bank transaction record.

idstringRequired

Bank transaction ID (unique within the bank).

dateDate | string | string | numberRequired

Transaction date.

One of 4:

Variant 1

Date

Transaction date.

Variant 2

stringdate-time

Variant 3

stringdate

Variant 4

number

priceobjectRequired

Transaction amount. Positive = incoming, negative = outgoing.

priceWithoutVatnumberRequired

Amount without VAT.

priceWithVatnumberRequired

Amount with VAT (the actual transferred amount).

vatnumberRequired

VAT amount.

currencystringRequired

Currency code (e.g., "CZK").

currencyLocalestringRequired

Locale string for currency formatting.

toAccountstringOptional

Counterparty account number.

toAccountNamestringOptional

Counterparty account holder name.

toBankCodenumberOptional

Counterparty bank code.

toBankNamestringOptional

Counterparty bank name.

constantSymbolnumberOptional

Constant symbol (KS).

variableSymbolnumberOptional

Variable symbol (VS) - used for order matching.

specificSymbolnumberOptional

Specific symbol (SS).

userNoticestringOptional

Notice for the recipient.

toMessagestringOptional

Message for the recipient.

typestringOptional

Raw transaction type from the bank.

senderstringOptional

Sender identification.

messagestringOptional

Transaction message.

commentstringOptional

Internal comment.

bicstringOptional

Counterparty BIC/SWIFT code.

idTransactionnumberOptional

Internal transaction reference number.

orderHashstringOptional

Matched order hash (for linking to order detail).

orderNumberstringOptional

Matched order number.

orderGroupstringOptional

Order group name.

typeCodestringOptional

Transaction category code.

typeLabelstringOptional

Transaction category label.

typeColorstringOptional

Transaction category hex color.

itemCountnumberRequired

Total number of transactions matching the filter (before pagination).

Response example

application/json

{
  "items": [
    {
      "id": "example_id",
      "price": {
        "priceWithoutVat": 0,
        "priceWithVat": 0,
        "vat": 0,
        "currency": "example_currency",
        "currencyLocale": "example_currencyLocale"
      },
      "toAccount": "example_toAccount",
      "toAccountName": "example_toAccountName",
      "toBankCode": 0,
      "toBankName": "example_toBankName",
      "constantSymbol": 0,
      "variableSymbol": 0,
      "specificSymbol": 0,
      "userNotice": "example_userNotice",
      "toMessage": "example_toMessage",
      "type": "example_type",
      "sender": "example_sender",
      "message": "example_message",
      "comment": "example_comment",
      "bic": "example_bic",
      "idTransaction": 0,
      "orderHash": "example_orderHash",
      "orderNumber": "example_orderNumber",
      "orderGroup": "example_orderGroup",
      "typeCode": "example_typeCode",
      "typeLabel": "example_typeLabel",
      "typeColor": "example_typeColor"
    }
  ],
  "itemCount": 0
}

/bff/transaction/list