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

/api/v1/ledger/entity-list

List accounting entities of the organisation that keep double-entry books.

Use the returned id as entityId in the other ledger endpoints. Entities without activated bookkeeping are omitted.

ledgergetApiV1LedgerEntity-list

Parameters

1 query

Query parameters

· 1
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

Response schema

1 status code documented

200Success
itemsobject[]Required
Each array item:
idstringRequired
namestringRequired
baseCurrencystringRequired
ExampleCZK
accountingStartsOnstring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
fiscalYearStartMonthnumberRequired
Range: 1–12
lockedUntilstring | nullRequired
One of 2:
Variant 1
string

No postings on or before this date.

Variant 2
null
itemCountnumberRequired

Response example

application/json
{
  "items": [
    {
      "id": "example_id",
      "name": "example_name",
      "baseCurrency": "CZK",
      "fiscalYearStartMonth": 0
    }
  ],
  "itemCount": 0
}

Request example

GET /api/v1/ledger/entity-list

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