TRANXACT.AI Help

Accounting · Tax

Tax Codes

What a document line carries. Zero-rated, exempt and out of scope all show 0.00 on the invoice and are three different things on the return.

Type REST6 operationsBase path /api/accounting/tax-codesPublished as /api/v1/tax-codes

Download specification (OpenAPI 3.1) Screen: Tax Codes

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 Codes 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_codes · 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-codesList tax codes

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",
      "code": "COD-000001",
      "name": "Example",
      "jurisdiction_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "tax_type": "text",
      "direction": "input",
      "treatment": "text",
      "is_reverse_charge": true,
      "is_recoverable": true,
      "recoverable_pct": "1250.00",
      "input_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "output_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "expense_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
    }
  ],
  "count": 1
}

Sample request

curl "https://demo.tranxact.ai/api/accounting/tax-codes?limit=20" \
  -H "Authorization: Bearer $TOKEN"
GET/api/accounting/tax-codes/{id}Read one tax code

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",
  "code": "COD-000001",
  "name": "Example",
  "jurisdiction_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "tax_type": "text",
  "direction": "input",
  "treatment": "text",
  "is_reverse_charge": true,
  "is_recoverable": true,
  "recoverable_pct": "1250.00",
  "input_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "output_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "expense_account_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-codes/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/tax-codesCreate a tax code

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
codetextYesCode
nametextYesName
jurisdiction_iduuidNoJurisdiction
tax_typetextNoType
directiontextNoDirection — An input code recovers tax and an output code owes it. Posting one as the other misstates the liability.
Allowed: input output both none
treatmenttextNoTreatment
is_reverse_chargebooleanNoReverse charge — The BUYER accounts for it: the invoice carries none and the buyer posts both sides.
is_recoverablebooleanNoRecoverable
recoverable_pctnumericNoRecoverable %
input_account_iduuidNoInput tax account
output_account_iduuidNoOutput tax account
expense_account_iduuidNoIrrecoverable tax account
reporting_grouptextNoReporting group
is_defaultbooleanNoDefault
valid_fromdateNoValid from
valid_todateNoValid to
is_activebooleanNoActive
descriptiontextNoDescription
zatca_categorytextNoZATCA category — Saudi e-invoicing only. A line coded to this takes its category from it.
Allowed: S — Standard rate Z — Zero rated E — Exempt O — Out of scope
exemption_reason_codetextNoZATCA exemption reason
exemption_reasontextNoZATCA exemption reason (words)

Sample body

{
  "code": "COD-000001",
  "name": "Example",
  "jurisdiction_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "tax_type": "text",
  "direction": "input",
  "treatment": "text"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "jurisdiction_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "tax_type": "text",
  "direction": "input",
  "treatment": "text",
  "is_reverse_charge": true,
  "is_recoverable": true,
  "recoverable_pct": "1250.00",
  "input_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "output_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "expense_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/accounting/tax-codes" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"code":"COD-000001","name":"Example","jurisdiction_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","tax_type":"text","direction":"input","treatment":"text"}'
PUT/api/accounting/tax-codes/{id}Change a tax code

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.

FieldTypeRequiredDescription
codetextYesCode
nametextYesName
jurisdiction_iduuidNoJurisdiction
tax_typetextNoType
directiontextNoDirection — An input code recovers tax and an output code owes it. Posting one as the other misstates the liability.
Allowed: input output both none
treatmenttextNoTreatment
is_reverse_chargebooleanNoReverse charge — The BUYER accounts for it: the invoice carries none and the buyer posts both sides.
is_recoverablebooleanNoRecoverable
recoverable_pctnumericNoRecoverable %
input_account_iduuidNoInput tax account
output_account_iduuidNoOutput tax account
expense_account_iduuidNoIrrecoverable tax account
reporting_grouptextNoReporting group
is_defaultbooleanNoDefault
valid_fromdateNoValid from
valid_todateNoValid to
is_activebooleanNoActive
descriptiontextNoDescription
zatca_categorytextNoZATCA category — Saudi e-invoicing only. A line coded to this takes its category from it.
Allowed: S — Standard rate Z — Zero rated E — Exempt O — Out of scope
exemption_reason_codetextNoZATCA exemption reason
exemption_reasontextNoZATCA exemption reason (words)

Sample body

{
  "code": "COD-000001",
  "name": "Example"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "jurisdiction_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "tax_type": "text",
  "direction": "input",
  "treatment": "text",
  "is_reverse_charge": true,
  "is_recoverable": true,
  "recoverable_pct": "1250.00",
  "input_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "output_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "expense_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/accounting/tax-codes/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"code":"COD-000001","name":"Example"}'
DELETE/api/accounting/tax-codes/{id}Delete a tax code

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-codes/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/tax-codes/{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-codes/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 code, 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
codetextread, writeCode
nametextread, writeName
jurisdiction_iduuidread, writeJurisdiction
tax_typetextread, writeType
directiontextread, writeDirection — An input code recovers tax and an output code owes it. Posting one as the other misstates the liability.
Allowed: input output both none
treatmenttextread, writeTreatment
is_reverse_chargebooleanread, writeReverse charge — The BUYER accounts for it: the invoice carries none and the buyer posts both sides.
is_recoverablebooleanread, writeRecoverable
recoverable_pctnumericread, writeRecoverable %
input_account_iduuidread, writeInput tax account
output_account_iduuidread, writeOutput tax account
expense_account_iduuidread, writeIrrecoverable tax account
reporting_grouptextread, writeReporting group
is_defaultbooleanread, writeDefault
valid_fromdateread, writeValid from
valid_todateread, writeValid to
is_activebooleanread, writeActive
descriptiontextread, writeDescription
created_attimestamp with time zoneread onlyCreated at
zatca_categorytextread, writeZATCA category — Saudi e-invoicing only. A line coded to this takes its category from it.
Allowed: S — Standard rate Z — Zero rated E — Exempt O — Out of scope
exemption_reason_codetextread, writeZATCA exemption reason
exemption_reasontextread, writeZATCA exemption reason (words)
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 Codes 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.