BizKitHub
DocsAPI ReferenceLedger/api/v1/ledger/journal-template-list
getLedgerPublic API v1

/api/v1/ledger/journal-template-list

Journal templates of the accounting entity: the recommended ones (seedKey: payroll, closing.*) and the entity's own. defaultAmount null means the amount is filled in when the template is used.

ledgergetApiV1LedgerJournal-template-list

Parameters

2 query

Query parameters

· 2
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

Response schema

1 status code documented

200Success
itemsobject[]Required
Each array item:
idstringRequired
namestringRequired
ExampleMzdy
descriptionstring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
seedKeystring | nullRequired
One of 2:
Variant 1
string
Examplepayroll
Variant 2
null
linesobject[]Required
Each array item:
lineNonumberRequired
labelstring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
accountCodestringRequired
Example521
side"debit" | "credit"Required
defaultAmountnumber | nullRequired
One of 2:
Variant 1
number

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

Example12100.5
Variant 2
null

Response example

application/json
{
  "items": [
    {
      "id": "example_id",
      "name": "Mzdy",
      "lines": [
        {
          "lineNo": 0,
          "accountCode": "521"
        }
      ]
    }
  ]
}

Request example

GET /api/v1/ledger/journal-template-list

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