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

/api/v1/ledger/document-list

Canonical accounting documents (doklady) of an entity, projected from invoices, purchase invoices and expenses.

  • status: draft, ready, blocked (open blocking data-quality finding), posted, cancelled, voided.
  • Amounts totalNet/Vat/Gross are in the document currency; totalGrossBase in the entity base currency.
  • Ordered by accounting date, newest first.
ledgergetApiV1LedgerDocument-list

Parameters

9 query

Query parameters

· 9
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
kindstringOptional
Length: 0–32
Exampleissued_invoice
direction"issued" | "received" | "internal"Optional
status"draft" | "ready" | "blocked" | "posted" | "cancelled" | "voided"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

Document id.

kindstringRequired
directionstringRequired
statusstringRequired
documentNostring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
externalDocumentNostring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
partnerNamestring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
partnerVatIdstring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
accountingDatestringRequired
taxableSupplyDatestring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
dueDatestring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
currencystringRequired
totalNetnumberRequired
totalVatnumberRequired
totalGrossnumberRequired
totalGrossBasenumberRequired

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

Example12100.5
openFindingsnumberRequired
blockingFindingsnumberRequired

Response example

application/json
{
  "page": 0,
  "limit": 0,
  "total": 0,
  "items": [
    {
      "id": "example_id",
      "kind": "example_kind",
      "direction": "example_direction",
      "status": "example_status",
      "accountingDate": "example_accountingDate",
      "currency": "example_currency",
      "totalNet": 0,
      "totalVat": 0,
      "totalGross": 0,
      "totalGrossBase": 12100.5,
      "openFindings": 0,
      "blockingFindings": 0
    }
  ]
}

Request example

GET /api/v1/ledger/document-list

get
curl -X GET "https://api.bizkithub.com/api/v1/ledger/document-list?apiKey=PRODPGrFxpGEtrOZfuWhnoJohUYBXuOE&entityId=Kq3vTnY8mZ0aB1cD2eF3gH4i&kind=issued_invoice&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