When posting cashbook documents to iplicit via the API, you do not always need to specify tax codes or tax amounts in your payload. iplicit uses the chart of account rules and the legal entity's tax authority settings to calculate tax automatically, reducing the fields you need to include.
How automatic tax calculation works for API cashbook posts
Each chart of account in iplicit can have an associated rule that specifies the tax band to apply. Each legal entity has an associated tax authority, which holds the tax rates for each tax code. When you post a cashbook document via API:
- The
legalEntityIdin your payload determines which tax authority is used - The
accountIdon each detail line determines which tax band is applied, based on the chart of account rule - iplicit calculates the tax amount automatically from these two settings
This means many default settings that exist within iplicit can be relied on, rather than being duplicated in every API payload.
Example – cashbook payload with no tax applied
When the chart of account rule specifies a zero or no-tax band, the full amount posts as net with no tax calculated:
{ "docTypeId": "string", "legalEntityId": "string", "paymentMethodId": "string", "description": "string", "bankAccountId": "string", "bankCurrencyAmount": 100, "isNetEntry": true, "details": [ { "accountId": "string", "description": "string", "netCurrencyAmount": 100 } ] }
Example – cashbook payload with tax calculated automatically
When the chart of account rule specifies a tax band, iplicit calculates the tax from the netCurrencyAmount and the tax rate held against the legal entity's tax authority:
{ "docTypeId": "string", "legalEntityId": "string", "paymentMethodId": "string", "description": "string", "bankAccountId": "string", "bankCurrencyAmount": 100, "isNetEntry": true, "details": [ { "accountId": "string", "description": "string", "netCurrencyAmount": 83.33 } ] }
In the second example, the bankCurrencyAmount of 100 is the gross amount, the netCurrencyAmount of 83.33 is the net line value, and iplicit calculates the 16.67 tax amount automatically from the chart of account's tax band.
The isNetEntry field
The isNetEntry field tells iplicit whether the netCurrencyAmount on each detail line is the net value (tax exclusive). When set to true, iplicit calculates tax on top of the net amount using the chart of account's tax band.
What you still need to include
Even with automatic tax calculation, your payload must include:
docTypeId– the document type being postedlegalEntityId– the legal entity the document belongs topaymentMethodId– the payment method for the cashbook entrybankAccountId– the bank account the cashbook posts againstbankCurrencyAmount– the gross amount in the bank account's currency- At least one detail line with an
accountIdandnetCurrencyAmount
Depending on your iplicit configuration, additional fields may be required. If your payload is rejected with a field validation error, check the error response for the specific field in question.
Related articles - Bank account configuration