BizKitHub
DocsAPI ReferenceLedger/api/v1/ledger/bank-rule-list
getLedgerPublic API v1

/api/v1/ledger/bank-rule-list

Bank rules of the accounting entity: they classify the unidentified part of a bank payment (no document behind it) to a counter-account. mode auto posts without review, suggest waits for a person.

ledgergetApiV1LedgerBank-rule-list

Parameters

2 query

Query parameters

· 2
apiKeystringRequired

Your BizKitHub API key (passed as GET parameter).

Key format: A 32-character string matching: ^(PROD|DEV_|ROOT)[A-Za-z0-9]{28}$
Prefixes: PROD (production key), DEV_ (individual developer), ROOT (system key with no limits). Learn more

ExamplePRODPGrFxpGEtrOZfuWhnoJohUYBXuOE
entityIdstringRequired

Accounting entity id (from /ledger/entity-list).

Length: 16–24
ExampleKq3vTnY8mZ0aB1cD2eF3gH4i

Response schema

1 status code documented

200Success
itemsobject[]Required
Each array item:
idstringRequired
namestringRequired
ExampleBankovní poplatek
direction"in" | "out"Required
counterpartyAccountstring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
counterpartyBankstring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
variableSymbolstring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
messageContainsstring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
accountCodestringRequired
Example568
mode"suggest" | "auto"Required
isActivebooleanRequired
hitCountnumberRequired

Response example

application/json
{
  "items": [
    {
      "id": "example_id",
      "name": "Bankovní poplatek",
      "accountCode": "568",
      "isActive": false,
      "hitCount": 0
    }
  ]
}

Request example

GET /api/v1/ledger/bank-rule-list

get
curl -X GET "https://api.bizkithub.com/api/v1/ledger/bank-rule-list?apiKey=PRODPGrFxpGEtrOZfuWhnoJohUYBXuOE&entityId=Kq3vTnY8mZ0aB1cD2eF3gH4i" \
  -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