BizKitHub
DocsAPI ReferenceLedger/api/v1/ledger/posting-rule-list
getLedgerPublic API v1

/api/v1/ledger/posting-rule-list

Posting rules (předkontace) of an entity. global is the platform default, override the entity override (if any) and effective what document posting uses. A null side is decided by another rule.

ledgergetApiV1LedgerPosting-rule-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:
ruleKeystringRequired
Exampleissued.revenue.services
descriptionstringRequired
globalobjectRequired
debitstring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
creditstring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
overrideobject | nullRequired
One of 2:
Variant 1
debitstring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
creditstring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
isActivebooleanRequired
updatedDatestring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
Variant 2
null
effectiveobjectRequired
debitstring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
creditstring | nullRequired
One of 2:
Variant 1
string
Variant 2
null

Response example

application/json
{
  "items": [
    {
      "ruleKey": "issued.revenue.services",
      "description": "example_description",
      "global": {},
      "effective": {}
    }
  ]
}

Request example

GET /api/v1/ledger/posting-rule-list

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