BizKitHub
DocsAPI ReferenceLedger/api/v1/ledger/journal-detail
getLedgerPublic API v1

/api/v1/ledger/journal-detail

One posted journal entry with its lines.

Each line has a side (debit = MD, credit = Dal) and a positive amount. isRedStorno lines count negatively on their side (červené storno).

ledgergetApiV1LedgerJournal-detail

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
Length: 24–24
Exampleexample_id

Response schema

1 status code documented

200Success
idstringRequired

Journal entry id.

entryNostring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
entryDatestringRequired

Accounting date (YYYY-MM-DD).

documentDatestring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
documentNostring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
descriptionstring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
amountnumberRequired

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

Example12100.5
sourceTypestringRequired

Origin document type (manual, invoice, bank, …).

originstringRequired

manual, document, opening, closing, adjustment, …

fiscalYearnumberRequired
reversesEntryIdstring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
reversedByEntryIdstring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
linesobject[]Required
Each array item:
lineNonumberRequired
accountCodestringRequired
accountNamestringRequired
side"debit" | "credit"Required
amountnumberRequired

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

Example12100.5
isRedStornobooleanRequired
partnerIdstring | nullRequired
One of 2:
Variant 1
string

Contact id of the counterparty.

Variant 2
null
descriptionstring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
dimensionsobject[]Required

Dimension values of the line (cost centre, project, …), one per dimension type.

Each array item:
typeIdstringRequired
typeNamestringRequired
ExampleStředisko
valueIdstringRequired
valueCodestringRequired
ExamplePRAHA
valueNamestringRequired

Response example

application/json
{
  "id": "example_id",
  "entryDate": "example_entryDate",
  "amount": 12100.5,
  "sourceType": "example_sourceType",
  "origin": "example_origin",
  "fiscalYear": 0,
  "lines": [
    {
      "lineNo": 0,
      "accountCode": "example_accountCode",
      "accountName": "example_accountName",
      "amount": 12100.5,
      "isRedStorno": false,
      "dimensions": [
        {
          "typeId": "example_typeId",
          "typeName": "Středisko",
          "valueId": "example_valueId",
          "valueCode": "PRAHA",
          "valueName": "example_valueName"
        }
      ]
    }
  ]
}

Request example

GET /api/v1/ledger/journal-detail

get
curl -X GET "https://api.bizkithub.com/api/v1/ledger/journal-detail?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