BizKitHub
DocsAPI ReferenceLedger/api/v1/ledger/stock-status
getLedgerPublic API v1

/api/v1/ledger/stock-status

Stock kept by method A: quantity, value and average unit cost of every stock card as of a date, for all warehouses or one. Values come from the posted stock movements (moving average or FIFO per warehouse).

ledgergetApiV1LedgerStock-status

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
asOfstringOptional
Example2026-12-31
warehouseIdstringOptional

Warehouse external id.

Length: 16–24
Exampleexample_warehouseId
searchstringOptional
Length: 0–100
Exampleexample_search
onlyInStockstringOptional
Exampletrue
limitstringOptional
Exampleexample_limit
offsetstringOptional
Exampleexample_offset

Response schema

1 status code documented

200Success
asOfstringRequired
totalnumberRequired
itemsobject[]Required
Each array item:
idstringRequired
codestringRequired
namestringRequired
unitstringRequired
kind"goods" | "material" | "product"Required
productIdnumber | nullRequired
One of 2:
Variant 1
number
Variant 2
null
stockAccountstringRequired
Example132
quantitynumberRequired
valuenumberRequired
unitCostnumber | nullRequired
One of 2:
Variant 1
number
Variant 2
null

Response example

application/json
{
  "asOf": "example_asOf",
  "total": 0,
  "items": [
    {
      "id": "example_id",
      "code": "example_code",
      "name": "example_name",
      "unit": "example_unit",
      "stockAccount": "132",
      "quantity": 0,
      "value": 0
    }
  ]
}

Request example

GET /api/v1/ledger/stock-status

get
curl -X GET "https://api.bizkithub.com/api/v1/ledger/stock-status?apiKey=PRODPGrFxpGEtrOZfuWhnoJohUYBXuOE&entityId=Kq3vTnY8mZ0aB1cD2eF3gH4i&asOf=2026-12-31&warehouseId=example_warehouseId&search=example_search&onlyInStock=true&limit=example_limit&offset=example_offset" \
  -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