TRANXACT.AI Help

Accounting · Tax

Tax Determination

Which code applies, in priority order, first match wins. This IS the tax engine; everything else is bookkeeping around it.

Type REST6 operationsBase path /api/accounting/tax-determination-rulesPublished as /api/v1/tax-determination-rules

Download specification (OpenAPI 3.1) Screen: Tax Determination

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 Determination 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_determination_rules · 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-determination-rulesList tax determination

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",
      "priority": 10,
      "transaction_type": "sale",
      "ship_from_country": "US",
      "ship_from_region": "text",
      "ship_to_country": "US",
      "ship_to_region": "text",
      "jurisdiction_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "classification_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
    }
  ],
  "count": 1
}

Sample request

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

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",
  "priority": 10,
  "transaction_type": "sale",
  "ship_from_country": "US",
  "ship_from_region": "text",
  "ship_to_country": "US",
  "ship_to_region": "text",
  "jurisdiction_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "classification_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "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-determination-rules/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/tax-determination-rulesCreate a tax determination rule

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
codetextYesCode
nametextYesName
priorityintegerNoPriority — Lower runs first.
transaction_typetextNoTransaction type
Allowed: sale purchase import export transfer service all
ship_from_countrytextNoShip-from country
ship_from_regiontextNoShip-from region
ship_to_countrytextNoShip-to country
ship_to_regiontextNoShip-to region
jurisdiction_iduuidNoJurisdiction
classification_iduuidNoClassification
item_iduuidNoItem
account_iduuidNoCustomer
supplier_iduuidNoSupplier
partner_registeredbooleanNoCounterparty is registered — A B2B sale across a border with a valid registration is zero-rated; the same sale to an unregistered buyer is not.
partner_exemptbooleanNoCounterparty is exempt
amount_minnumericNoAmount from
amount_maxnumericNoAmount to
tax_code_iduuidYesTax code
tax_code_2_iduuidNoSecond tax code
tax_code_3_iduuidNoThird tax code
valid_fromdateNoValid from
valid_todateNoValid to
is_activebooleanNoActive
reasontextNoReason

Sample body

{
  "code": "COD-000001",
  "name": "Example",
  "tax_code_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "priority": 10,
  "transaction_type": "sale",
  "ship_from_country": "US",
  "ship_from_region": "text"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "priority": 10,
  "transaction_type": "sale",
  "ship_from_country": "US",
  "ship_from_region": "text",
  "ship_to_country": "US",
  "ship_to_region": "text",
  "jurisdiction_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "classification_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/accounting/tax-determination-rules" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"code":"COD-000001","name":"Example","tax_code_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","priority":10,"transaction_type":"sale","ship_from_country":"US","ship_from_region":"text"}'
PUT/api/accounting/tax-determination-rules/{id}Change a tax determination rule

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
priorityintegerNoPriority — Lower runs first.
transaction_typetextNoTransaction type
Allowed: sale purchase import export transfer service all
ship_from_countrytextNoShip-from country
ship_from_regiontextNoShip-from region
ship_to_countrytextNoShip-to country
ship_to_regiontextNoShip-to region
jurisdiction_iduuidNoJurisdiction
classification_iduuidNoClassification
item_iduuidNoItem
account_iduuidNoCustomer
supplier_iduuidNoSupplier
partner_registeredbooleanNoCounterparty is registered — A B2B sale across a border with a valid registration is zero-rated; the same sale to an unregistered buyer is not.
partner_exemptbooleanNoCounterparty is exempt
amount_minnumericNoAmount from
amount_maxnumericNoAmount to
tax_code_iduuidYesTax code
tax_code_2_iduuidNoSecond tax code
tax_code_3_iduuidNoThird tax code
valid_fromdateNoValid from
valid_todateNoValid to
is_activebooleanNoActive
reasontextNoReason

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",
  "priority": 10,
  "transaction_type": "sale",
  "ship_from_country": "US",
  "ship_from_region": "text",
  "ship_to_country": "US",
  "ship_to_region": "text",
  "jurisdiction_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "classification_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Sample request

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

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-determination-rules/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/tax-determination-rules/{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-determination-rules/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 determination rule, 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
priorityintegerread, writePriority — Lower runs first.
transaction_typetextread, writeTransaction type
Allowed: sale purchase import export transfer service all
ship_from_countrytextread, writeShip-from country
ship_from_regiontextread, writeShip-from region
ship_to_countrytextread, writeShip-to country
ship_to_regiontextread, writeShip-to region
jurisdiction_iduuidread, writeJurisdiction
classification_iduuidread, writeClassification
item_iduuidread, writeItem
account_iduuidread, writeCustomer
supplier_iduuidread, writeSupplier
partner_registeredbooleanread, writeCounterparty is registered — A B2B sale across a border with a valid registration is zero-rated; the same sale to an unregistered buyer is not.
partner_exemptbooleanread, writeCounterparty is exempt
amount_minnumericread, writeAmount from
amount_maxnumericread, writeAmount to
tax_code_iduuidread, writeTax code
tax_code_2_iduuidread, writeSecond tax code
tax_code_3_iduuidread, writeThird tax code
valid_fromdateread, writeValid from
valid_todateread, writeValid to
is_activebooleanread, writeActive
reasontextread, writeReason
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_attimestamp with time zoneread onlyCreated at
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 Determination 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.