{
 "openapi": "3.1.0",
 "info": {
  "title": "Tax Jurisdictions (Accounting)",
  "version": "20261030b",
  "description": "Where tax is levied, nested — a US sale carries state and county and city tax at once, and they are three postings."
 },
 "servers": [
  {
   "url": "https://{tenant}.tranxact.ai",
   "variables": {
    "tenant": {
     "default": "demo"
    }
   }
  }
 ],
 "components": {
  "securitySchemes": {
   "bearer": {
    "type": "http",
    "scheme": "bearer"
   }
  },
  "schemas": {
   "tax-jurisdictions": {
    "type": "object",
    "required": [
     "code",
     "name"
    ],
    "properties": {
     "id": {
      "type": "string",
      "format": "uuid",
      "description": "Id",
      "readOnly": true
     },
     "org_id": {
      "type": "string",
      "format": "uuid",
      "description": "Org id",
      "readOnly": true
     },
     "org_unit_id": {
      "type": "string",
      "format": "uuid",
      "description": "Org unit id",
      "readOnly": true
     },
     "code": {
      "type": "string",
      "description": "Code"
     },
     "name": {
      "type": "string",
      "description": "Name"
     },
     "parent_id": {
      "type": "string",
      "format": "uuid",
      "description": "Parent"
     },
     "authority_id": {
      "type": "string",
      "format": "uuid",
      "description": "Authority"
     },
     "level": {
      "type": "string",
      "description": "Level",
      "enum": [
       "country",
       "state",
       "province",
       "county",
       "city",
       "district",
       "economic_zone"
      ]
     },
     "country": {
      "type": "string",
      "description": "Country"
     },
     "region": {
      "type": "string",
      "description": "Region"
     },
     "postal_from": {
      "type": "string",
      "description": "Postal from"
     },
     "postal_to": {
      "type": "string",
      "description": "Postal to"
     },
     "is_registered": {
      "type": "boolean",
      "description": "We are registered here"
     },
     "registration_no": {
      "type": "string",
      "description": "Registration number"
     },
     "registered_from": {
      "type": "string",
      "format": "date",
      "description": "Registered from"
     },
     "registered_to": {
      "type": "string",
      "format": "date",
      "description": "Registered to"
     },
     "is_active": {
      "type": "boolean",
      "description": "Active"
     },
     "xf_text_1": {
      "type": "string",
      "description": "Xf text 1",
      "readOnly": true
     },
     "xf_text_2": {
      "type": "string",
      "description": "Xf text 2",
      "readOnly": true
     },
     "xf_text_3": {
      "type": "string",
      "description": "Xf text 3",
      "readOnly": true
     },
     "xf_text_4": {
      "type": "string",
      "description": "Xf text 4",
      "readOnly": true
     },
     "xf_text_5": {
      "type": "string",
      "description": "Xf text 5",
      "readOnly": true
     },
     "xf_num_1": {
      "type": "string",
      "format": "decimal",
      "description": "Xf num 1",
      "readOnly": true
     },
     "xf_num_2": {
      "type": "string",
      "format": "decimal",
      "description": "Xf num 2",
      "readOnly": true
     },
     "xf_num_3": {
      "type": "string",
      "format": "decimal",
      "description": "Xf num 3",
      "readOnly": true
     },
     "xf_date_1": {
      "type": "string",
      "format": "date",
      "description": "Xf date 1",
      "readOnly": true
     },
     "xf_date_2": {
      "type": "string",
      "format": "date",
      "description": "Xf date 2",
      "readOnly": true
     },
     "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "Created at",
      "readOnly": true
     },
     "created_by": {
      "type": "string",
      "format": "uuid",
      "description": "Created by",
      "readOnly": true
     },
     "updated_at": {
      "type": "string",
      "format": "date-time",
      "description": "Updated at",
      "readOnly": true
     },
     "updated_by": {
      "type": "string",
      "format": "uuid",
      "description": "Updated by",
      "readOnly": true
     },
     "einvoice_regime": {
      "type": "string",
      "description": "E-invoicing regime",
      "enum": [
       "None",
       "ZATCA Phase 1 (generation)"
      ]
     },
     "name_ar": {
      "type": "string",
      "description": "Name (Arabic)"
     },
     "sourcing_rule": {
      "type": "string",
      "description": "Sourcing (in-state sales)",
      "enum": [
       "Destination (where it is delivered)",
       "Origin (where the seller is)",
       "Origin, but districts at destination (California)"
      ]
     },
     "levies_sales_tax": {
      "type": "boolean",
      "description": "Levies a general sales tax"
     },
     "zatca_phase2": {
      "type": "boolean",
      "description": "ZATCA Phase 2 (integration)"
     },
     "zatca_phase2_from": {
      "type": "string",
      "format": "date",
      "description": "Phase 2 from"
     },
     "zatca_archive_years": {
      "type": "integer",
      "description": "Zatca archive years",
      "readOnly": true
     }
    }
   }
  }
 },
 "security": [
  {
   "bearer": []
  }
 ],
 "paths": {
  "/api/accounting/tax-jurisdictions": {
   "get": {
    "summary": "list tax-jurisdictions",
    "operationId": "list_tax_jurisdictions_0_4",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "post": {
    "summary": "create tax-jurisdictions",
    "operationId": "create_tax_jurisdictions_1_4",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/accounting/tax-jurisdictions/{id}": {
   "get": {
    "summary": "get tax-jurisdictions",
    "operationId": "get_tax_jurisdictions_0_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "put": {
    "summary": "change tax-jurisdictions",
    "operationId": "change_tax_jurisdictions_1_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "delete": {
    "summary": "delete tax-jurisdictions",
    "operationId": "delete_tax_jurisdictions_2_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/accounting/tax-jurisdictions/{id}/copy": {
   "post": {
    "summary": "Copy",
    "operationId": "action_tax_jurisdictions_0_6",
    "description": "Body keys: overrides, preview, withLines",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  }
 }
}