TRANXACT.AI Help

Accounting · Tax

Tax Jurisdictions

Where tax is levied, nested — a US sale carries state and county and city tax at once, and they are three postings.

Type REST6 operationsBase path /api/accounting/tax-jurisdictionsPublished as /api/v1/tax-jurisdictions

Download specification (OpenAPI 3.1) Screen: Tax Jurisdictions

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 Jurisdictions 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_jurisdictions · 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-jurisdictionsList tax jurisdictions

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",
      "parent_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "authority_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "level": "country",
      "country": "US",
      "region": "text",
      "postal_from": "text",
      "postal_to": "text",
      "is_registered": true,
      "registration_no": "REG-000001",
      "registered_from": "2026-10-30"
    }
  ],
  "count": 1
}

Sample request

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

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",
  "parent_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "authority_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "level": "country",
  "country": "US",
  "region": "text",
  "postal_from": "text",
  "postal_to": "text",
  "is_registered": true,
  "registration_no": "REG-000001",
  "registered_from": "2026-10-30"
}

404 when no record with that id is visible to the caller.

Sample request

curl "https://demo.tranxact.ai/api/accounting/tax-jurisdictions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/tax-jurisdictionsCreate a tax jurisdiction

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
codetextYesCode
nametextYesName
parent_iduuidNoParent
authority_iduuidNoAuthority
leveltextNoLevel
Allowed: country state province county city district economic_zone
countrytextNoCountry
regiontextNoRegion
postal_fromtextNoPostal from
postal_totextNoPostal to
is_registeredbooleanNoWe are registered here — A jurisdiction with no registration is one where tax is not charged and the transaction may still have to be reported.
registration_notextNoRegistration number
registered_fromdateNoRegistered from
registered_todateNoRegistered to
is_activebooleanNoActive
einvoice_regimetextNoE-invoicing regime — ZATCA Phase 1: AR invoices, credit and debit notes are issued in Arabic and English with a QR code, numbered from one series, and cannot be edited or deleted once issued. Needs a Saudi VAT number here and the Arabic name and address on the letterhead.
Allowed: None ZATCA Phase 1 (generation)
name_artextNoName (Arabic)
sourcing_ruletextNoSourcing (in-state sales) — An interstate sale is always taxed at the destination. Texas and Arizona tax an in-state sale where the seller is.
Allowed: Destination (where it is delivered) Origin (where the seller is) Origin, but districts at destination (California)
levies_sales_taxbooleanNoLevies a general sales tax — Untick for Oregon, Delaware, Montana, New Hampshire: nothing is charged there, and the invoice says why.
zatca_phase2booleanNoZATCA Phase 2 (integration) — Each invoice, credit and debit note is stamped as it is issued: UBL 2.1 XML, the invoice counter and previous-invoice hash, an ECDSA signature and the nine-tag QR. Needs a ZATCA signing unit (Accounting › E-invoicing › ZATCA Signing Units).
zatca_phase2_fromdateNoPhase 2 from — The first day of the company’s ZATCA wave. Empty: from the day it is switched on.

Sample body

{
  "code": "COD-000001",
  "name": "Example",
  "parent_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "authority_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "level": "country",
  "country": "US"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "parent_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "authority_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "level": "country",
  "country": "US",
  "region": "text",
  "postal_from": "text",
  "postal_to": "text",
  "is_registered": true,
  "registration_no": "REG-000001",
  "registered_from": "2026-10-30"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/accounting/tax-jurisdictions" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"code":"COD-000001","name":"Example","parent_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","authority_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","level":"country","country":"US"}'
PUT/api/accounting/tax-jurisdictions/{id}Change a tax jurisdiction

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
parent_iduuidNoParent
authority_iduuidNoAuthority
leveltextNoLevel
Allowed: country state province county city district economic_zone
countrytextNoCountry
regiontextNoRegion
postal_fromtextNoPostal from
postal_totextNoPostal to
is_registeredbooleanNoWe are registered here — A jurisdiction with no registration is one where tax is not charged and the transaction may still have to be reported.
registration_notextNoRegistration number
registered_fromdateNoRegistered from
registered_todateNoRegistered to
is_activebooleanNoActive
einvoice_regimetextNoE-invoicing regime — ZATCA Phase 1: AR invoices, credit and debit notes are issued in Arabic and English with a QR code, numbered from one series, and cannot be edited or deleted once issued. Needs a Saudi VAT number here and the Arabic name and address on the letterhead.
Allowed: None ZATCA Phase 1 (generation)
name_artextNoName (Arabic)
sourcing_ruletextNoSourcing (in-state sales) — An interstate sale is always taxed at the destination. Texas and Arizona tax an in-state sale where the seller is.
Allowed: Destination (where it is delivered) Origin (where the seller is) Origin, but districts at destination (California)
levies_sales_taxbooleanNoLevies a general sales tax — Untick for Oregon, Delaware, Montana, New Hampshire: nothing is charged there, and the invoice says why.
zatca_phase2booleanNoZATCA Phase 2 (integration) — Each invoice, credit and debit note is stamped as it is issued: UBL 2.1 XML, the invoice counter and previous-invoice hash, an ECDSA signature and the nine-tag QR. Needs a ZATCA signing unit (Accounting › E-invoicing › ZATCA Signing Units).
zatca_phase2_fromdateNoPhase 2 from — The first day of the company’s ZATCA wave. Empty: from the day it is switched on.

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",
  "parent_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "authority_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "level": "country",
  "country": "US",
  "region": "text",
  "postal_from": "text",
  "postal_to": "text",
  "is_registered": true,
  "registration_no": "REG-000001",
  "registered_from": "2026-10-30"
}

Sample request

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

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-jurisdictions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/tax-jurisdictions/{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-jurisdictions/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 jurisdiction, 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
parent_iduuidread, writeParent
authority_iduuidread, writeAuthority
leveltextread, writeLevel
Allowed: country state province county city district economic_zone
countrytextread, writeCountry
regiontextread, writeRegion
postal_fromtextread, writePostal from
postal_totextread, writePostal to
is_registeredbooleanread, writeWe are registered here — A jurisdiction with no registration is one where tax is not charged and the transaction may still have to be reported.
registration_notextread, writeRegistration number
registered_fromdateread, writeRegistered from
registered_todateread, writeRegistered to
is_activebooleanread, writeActive
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
einvoice_regimetextread, writeE-invoicing regime — ZATCA Phase 1: AR invoices, credit and debit notes are issued in Arabic and English with a QR code, numbered from one series, and cannot be edited or deleted once issued. Needs a Saudi VAT number here and the Arabic name and address on the letterhead.
Allowed: None ZATCA Phase 1 (generation)
name_artextread, writeName (Arabic)
sourcing_ruletextread, writeSourcing (in-state sales) — An interstate sale is always taxed at the destination. Texas and Arizona tax an in-state sale where the seller is.
Allowed: Destination (where it is delivered) Origin (where the seller is) Origin, but districts at destination (California)
levies_sales_taxbooleanread, writeLevies a general sales tax — Untick for Oregon, Delaware, Montana, New Hampshire: nothing is charged there, and the invoice says why.
zatca_phase2booleanread, writeZATCA Phase 2 (integration) — Each invoice, credit and debit note is stamped as it is issued: UBL 2.1 XML, the invoice counter and previous-invoice hash, an ECDSA signature and the nine-tag QR. Needs a ZATCA signing unit (Accounting › E-invoicing › ZATCA Signing Units).
zatca_phase2_fromdateread, writePhase 2 from — The first day of the company’s ZATCA wave. Empty: from the day it is switched on.
zatca_archive_yearsintegerread onlyZatca archive years

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 Jurisdictions 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.