BizKitHub
DocsAPI ReferenceLedger/api/v1/ledger/payment-list
getLedgerPublic API v1

/api/v1/ledger/payment-list

Payments (bank transactions and order payments) of an entity with their allocation to documents.

  • direction: in (money received) or out (money paid).
  • settlementState: unmatched, partial, settled, over. openAmount is the part not allocated to any document.
  • journalEntry is set once the payment is posted.
ledgergetApiV1LedgerPayment-list

Parameters

8 query

Query parameters

· 8
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
state"unmatched" | "partial" | "settled" | "over"Optional
direction"in" | "out"Optional
dateFromstringOptional
Example2026-03-31
dateTostringOptional
Example2026-03-31
pagestring | numberOptional
Range: 1–∞
limitstring | numberOptional
Range: 1–500

Response schema

1 status code documented

200Success
pagenumberRequired
limitnumberRequired
totalnumberRequired
itemsobject[]Required
Each array item:
idstringRequired
kindstringRequired
Examplebank
directionstringRequired
Examplein
valueDatestringRequired
amountnumberRequired

Amount in the base currency of the accounting entity (2 decimals).

Example12100.5
currencystringRequired
ExampleCZK
amountBasenumberRequired

Amount in the base currency of the accounting entity (2 decimals).

Example12100.5
variableSymbolstring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
counterpartyNamestring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
settledAmountnumberRequired

Amount in the base currency of the accounting entity (2 decimals).

Example12100.5
openAmountnumberRequired

Amount in the base currency of the accounting entity (2 decimals).

Example12100.5
settlementStatestringRequired
Examplesettled
journalEntryobject | nullRequired
One of 2:
Variant 1
idstringRequired
entryNostring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
Variant 2
null

Response example

application/json
{
  "page": 0,
  "limit": 0,
  "total": 0,
  "items": [
    {
      "id": "example_id",
      "kind": "bank",
      "direction": "in",
      "valueDate": "example_valueDate",
      "amount": 12100.5,
      "currency": "CZK",
      "amountBase": 12100.5,
      "settledAmount": 12100.5,
      "openAmount": 12100.5,
      "settlementState": "settled"
    }
  ]
}

Request example

GET /api/v1/ledger/payment-list

get
curl -X GET "https://api.bizkithub.com/api/v1/ledger/payment-list?apiKey=PRODPGrFxpGEtrOZfuWhnoJohUYBXuOE&entityId=Kq3vTnY8mZ0aB1cD2eF3gH4i&dateFrom=2026-03-31&dateTo=2026-03-31" \
  -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