TRANXACT.AI Help

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.

Type REST6 operationsBase path /api/accounting/tax-transactionsPublished as /api/v1/tax-transactions

Download specification (OpenAPI 3.1) Screen: Tax Transactions

Overview

PackageAccounting
AuthenticationBearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key
AuthorizationThe 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.
Tableacct.tax_transactions · kept per company (and organisational unit where it has one)
RecordCreated, changed and (where the screen allows) deleted; key id
RulesThe 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

NameDescriptionExample
limitRows per page (50 by default, at most 200)limit=100
offsetRows to skipoffset=200
qFree-text search over the search columnsq=acme
sortcolumn:asc or column:desc, several separated by commassort=created_at:desc
filterA JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sortedfilter={"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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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, withLines

Response

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.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
org_unit_iduuidread onlyOrg unit id
txn_datedateread onlyTxn date
tax_point_datedateread onlyTax point date
period_codetextread onlyPeriod code
document_typetextread onlyDocument type
document_iduuidread onlyDocument id
document_notextread onlyDocument no
line_nointegerread onlyLine no
directiontextread onlyDirection
tax_code_iduuidread onlyTax code id
tax_codetextread onlyTax code
jurisdiction_iduuidread onlyJurisdiction id
classification_iduuidread onlyClassification id
account_iduuidread onlyAccount id
supplier_iduuidread onlySupplier id
partner_registrationtextread onlyPartner registration
partner_countrytextread onlyPartner country
currencytextread onlyCurrency
exchange_ratenumericread onlyExchange rate
taxable_basenumericread onlyTaxable base
tax_amountnumericread onlyTax amount
non_taxable_amountnumericread onlyNon taxable amount
rate_pctnumericread onlyRate pct
recoverable_amountnumericread onlyRecoverable amount
irrecoverable_amountnumericread onlyIrrecoverable amount
is_reverse_chargebooleanread onlyIs reverse charge
exemption_iduuidread onlyExemption id
journal_iduuidread onlyJournal id
return_iduuidread onlyReturn id
is_reportedbooleanread onlyIs reported
corrects_iduuidread onlyCorrects id
created_attimestamp with time zoneread onlyCreated at
xf_text_1textread onlyXf text 1
xf_text_2textread onlyXf text 2
xf_text_3textread onlyXf text 3
xf_text_4textread onlyXf text 4
xf_text_5textread onlyXf text 5
xf_num_1numericread onlyXf num 1
xf_num_2numericread onlyXf num 2
xf_num_3numericread onlyXf num 3
xf_date_1dateread onlyXf date 1
xf_date_2dateread onlyXf date 2
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by

Errors

StatusMeaning
400The request could not be read: a filter that is not JSON, a bad parameter
401No credential, or it is wrong, revoked or expired
403The caller's roles do not hold Accounting › Tax Transactions for this verb, or the address or origin is not allowed
404No record with that id is visible to the caller
409A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else
422Refused 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.