BizKitHub
DocsAPI ReferenceLedger/api/v1/ledger/saldo
getLedgerPublic API v1

/api/v1/ledger/saldo

Saldokonto: open receivables and payables from the journal as of a date (default today), per document, with aging.

  • amount is positive for what is owed (to the entity for receivables, by the entity for payables), in the base currency.
  • bucket: not_due, d1_30, d31_60, d61_90, d91_180, d181_365, over_365, unassigned (journal lines without a document).
  • accounts sums every open-item account with the same buckets.
ledgergetApiV1LedgerSaldo

Parameters

7 query

Query parameters

· 7
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
asOfstringOptional
Example2026-03-31
side"receivable" | "payable"Optional
accountCodestringOptional
Length: 0–16
Example311
pagestring | numberOptional
Range: 1–∞
limitstring | numberOptional
Range: 1–500

Response schema

1 status code documented

200Success
asOfstringRequired
pagenumberRequired
limitnumberRequired
totalnumberRequired
accountsobject[]Required
Each array item:
codestringRequired
namestringRequired
sidestringRequired
amountnumberRequired

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

Example12100.5
countnumberRequired
bucketsobjectRequired
itemsobject[]Required
Each array item:
documentIdstring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
documentNostring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
dueDatestring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
partnerNamestring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
accountCodestringRequired
sidestringRequired
amountnumberRequired

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

Example12100.5
daysOverduenumber | nullRequired
One of 2:
Variant 1
number
Variant 2
null
bucketstringRequired

Response example

application/json
{
  "asOf": "example_asOf",
  "page": 0,
  "limit": 0,
  "total": 0,
  "accounts": [
    {
      "code": "example_code",
      "name": "example_name",
      "side": "example_side",
      "amount": 12100.5,
      "count": 0,
      "buckets": {}
    }
  ],
  "items": [
    {
      "accountCode": "example_accountCode",
      "side": "example_side",
      "amount": 12100.5,
      "bucket": "example_bucket"
    }
  ]
}

Request example

GET /api/v1/ledger/saldo

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