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

/api/v1/ledger/document-posting

Posting of one accounting document: the journal entry it would get now (accounts resolved exactly as posting would), what the automation would decide (auto, suggest, needs_input, blocked, skip) with a reason code, and the live journal entry once posted. Read only.

ledgergetApiV1LedgerDocument-posting

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
idstringRequired

Document id from /document-list.

Length: 24–24
Exampleexample_id

Response schema

1 status code documented

200Success
documentStatusstringRequired
operationTypestringRequired
Exampledocument.issued
decisionstringRequired
Exampleauto
reasonstring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
errorobject | nullRequired
One of 2:
Variant 1
codestringRequired
messagestringRequired
Variant 2
null
journalEntryobject | nullRequired
One of 2:
Variant 1
idstringRequired
entryNostring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
originstringRequired
isReversedbooleanRequired
Variant 2
null
proposalobject | nullRequired
One of 2:
Variant 1
entryDatestringRequired
amountnumberRequired

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

Example12100.5
linesobject[]Required
Each array item:
accountCodestringRequired
accountNamestringRequired
sidestringRequired
amountnumberRequired

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

Example12100.5
ruleKeystringRequired
Variant 2
null

Response example

application/json
{
  "documentStatus": "example_documentStatus",
  "operationType": "document.issued",
  "decision": "auto"
}

Request example

GET /api/v1/ledger/document-posting

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