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

/api/v1/ledger/inventory

Inventory of balance-sheet accounts for one fiscal period (§ 29–30 of the Czech Accounting Act): book balance at the balance-sheet date, actual (counted) balance, difference and how it was resolved.

ledgergetApiV1LedgerInventory

Parameters

3 query

Query parameters

· 3
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
periodIdstringRequired

Fiscal period external id.

Length: 16–24
Exampleexample_periodId

Response schema

1 status code documented

200Success
periodobjectRequired
idstringRequired
fiscalYearnumberRequired
startsOnstringRequired
endsOnstringRequired
status"not_started" | "in_progress" | "completed"Required
asOfstring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
responsiblePersonstring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
inventoryDatestring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
protocolRefstring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
itemsobject[]Required
Each array item:
accountCodestringRequired
Example211
accountNamestringRequired
method"physical" | "document"Required
booknumberRequired
countednumber | nullRequired
One of 2:
Variant 1
number
Variant 2
null
differencenumberRequired
resolution"open" | "resolved" | "posted"Required
adjustmentEntryNostring | nullRequired
One of 2:
Variant 1
string
Variant 2
null

Response example

application/json
{
  "period": {
    "id": "example_id",
    "fiscalYear": 0,
    "startsOn": "example_startsOn",
    "endsOn": "example_endsOn"
  },
  "items": [
    {
      "accountCode": "211",
      "accountName": "example_accountName",
      "book": 0,
      "difference": 0
    }
  ]
}

Request example

GET /api/v1/ledger/inventory

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