Accounting · Tax
Tax Transactions
Every tax amount on every document, with the TAXABLE BASE the ledger never held. A return cannot be produced without it.
/api/accounting/tax-transactionsPublished as /api/v1/tax-transactionsDownload specification (OpenAPI 3.1) Screen: Tax Transactions
Overview
| Package | Accounting |
|---|---|
| Authentication | Bearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key |
| Authorization | The caller's roles must hold Accounting › Tax Transactions on the Roles screen: display for GET, add for POST, change for PUT, delete for DELETE; an action needs the grant of the button that runs it on the screen. |
| Table | acct.tax_transactions · kept per company (and organisational unit where it has one) |
| Record | Created, changed and (where the screen allows) deleted; key id |
| Rules | The same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail. |
API reference
6 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/accounting/tax-transactionsList tax transactions
Query parameters
| Name | Description | Example |
|---|---|---|
limit | Rows per page (50 by default, at most 200) | limit=100 |
offset | Rows to skip | offset=200 |
q | Free-text search over the search columns | q=acme |
sort | column:asc or column:desc, several separated by commas | sort=created_at:desc |
filter | A JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sorted | filter={"col":"status","op":"eq","value":"open"} |
<field>=<value> | Shorthand for "field is value" |
Response 200
{
"rows": [
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"txn_date": "2026-10-30",
"tax_point_date": "2026-10-30",
"period_code": "PER-000001",
"document_type": "text",
"document_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"document_no": "DOC-000001",
"line_no": 10,
"direction": "text",
"tax_code_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"tax_code": "TAX-000001",
"jurisdiction_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"classification_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/accounting/tax-transactions?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/accounting/tax-transactions/{id}Read one tax transaction
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"txn_date": "2026-10-30",
"tax_point_date": "2026-10-30",
"period_code": "PER-000001",
"document_type": "text",
"document_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"document_no": "DOC-000001",
"line_no": 10,
"direction": "text",
"tax_code_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"tax_code": "TAX-000001",
"jurisdiction_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"classification_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/accounting/tax-transactions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/accounting/tax-transactionsCreate a tax transaction
Request body
The record as JSON. Fields marked Yes are required.
No body.
Sample body
{}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"txn_date": "2026-10-30",
"tax_point_date": "2026-10-30",
"period_code": "PER-000001",
"document_type": "text",
"document_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"document_no": "DOC-000001",
"line_no": 10,
"direction": "text",
"tax_code_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"tax_code": "TAX-000001",
"jurisdiction_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"classification_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/accounting/tax-transactions" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{}'PUT/api/accounting/tax-transactions/{id}Change a tax transaction
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
Only the fields to change; fields left out keep their value.
No body.
Sample body
{}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"txn_date": "2026-10-30",
"tax_point_date": "2026-10-30",
"period_code": "PER-000001",
"document_type": "text",
"document_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"document_no": "DOC-000001",
"line_no": 10,
"direction": "text",
"tax_code_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"tax_code": "TAX-000001",
"jurisdiction_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"classification_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/accounting/tax-transactions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{}'DELETE/api/accounting/tax-transactions/{id}Delete a tax transaction
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{ "deleted": true }Many documents are cancelled or reversed instead; the API refuses a delete the screen would refuse.
Sample request
curl -X DELETE "https://demo.tranxact.ai/api/accounting/tax-transactions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/accounting/tax-transactions/{id}/copyCopy
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
overrides, preview, withLinesResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/accounting/tax-transactions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrides":"value","preview":"value","withLines":"value"}'Data model
Every field of a tax transaction, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.
| Field | Type | Access | Description |
|---|---|---|---|
id | uuid | read only | Id |
org_id | uuid | read only | Org id |
org_unit_id | uuid | read only | Org unit id |
txn_date | date | read only | Txn date |
tax_point_date | date | read only | Tax point date |
period_code | text | read only | Period code |
document_type | text | read only | Document type |
document_id | uuid | read only | Document id |
document_no | text | read only | Document no |
line_no | integer | read only | Line no |
direction | text | read only | Direction |
tax_code_id | uuid | read only | Tax code id |
tax_code | text | read only | Tax code |
jurisdiction_id | uuid | read only | Jurisdiction id |
classification_id | uuid | read only | Classification id |
account_id | uuid | read only | Account id |
supplier_id | uuid | read only | Supplier id |
partner_registration | text | read only | Partner registration |
partner_country | text | read only | Partner country |
currency | text | read only | Currency |
exchange_rate | numeric | read only | Exchange rate |
taxable_base | numeric | read only | Taxable base |
tax_amount | numeric | read only | Tax amount |
non_taxable_amount | numeric | read only | Non taxable amount |
rate_pct | numeric | read only | Rate pct |
recoverable_amount | numeric | read only | Recoverable amount |
irrecoverable_amount | numeric | read only | Irrecoverable amount |
is_reverse_charge | boolean | read only | Is reverse charge |
exemption_id | uuid | read only | Exemption id |
journal_id | uuid | read only | Journal id |
return_id | uuid | read only | Return id |
is_reported | boolean | read only | Is reported |
corrects_id | uuid | read only | Corrects id |
created_at | timestamp with time zone | read only | Created at |
xf_text_1 | text | read only | Xf text 1 |
xf_text_2 | text | read only | Xf text 2 |
xf_text_3 | text | read only | Xf text 3 |
xf_text_4 | text | read only | Xf text 4 |
xf_text_5 | text | read only | Xf text 5 |
xf_num_1 | numeric | read only | Xf num 1 |
xf_num_2 | numeric | read only | Xf num 2 |
xf_num_3 | numeric | read only | Xf num 3 |
xf_date_1 | date | read only | Xf date 1 |
xf_date_2 | date | read only | Xf date 2 |
created_by | uuid | read only | Created by |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
Errors
| Status | Meaning |
|---|---|
| 400 | The request could not be read: a filter that is not JSON, a bad parameter |
| 401 | No credential, or it is wrong, revoked or expired |
| 403 | The caller's roles do not hold Accounting › Tax Transactions for this verb, or the address or origin is not allowed |
| 404 | No record with that id is visible to the caller |
| 409 | A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else |
| 422 | Refused by the same validation as the screen; the error names the field and why |
Every error is JSON: {"error": "a sentence saying what was wrong"}, with field where it applies.