{
 "openapi": "3.1.0",
 "info": {
  "title": "Local Tax Jurisdictions (HRMS)",
  "version": "20261030b",
  "description": "Cities, counties, school districts, PA political subdivisions and transit districts, with their resident and non-resident rates and the rule that decides between them."
 },
 "servers": [
  {
   "url": "https://{tenant}.tranxact.ai",
   "variables": {
    "tenant": {
     "default": "demo"
    }
   }
  }
 ],
 "components": {
  "securitySchemes": {
   "bearer": {
    "type": "http",
    "scheme": "bearer"
   }
  },
  "schemas": {
   "local-tax-jurisdictions": {
    "type": "object",
    "required": [
     "tax_year",
     "code",
     "name",
     "state_code"
    ],
    "properties": {
     "id": {
      "type": "string",
      "format": "uuid",
      "description": "Id",
      "readOnly": true
     },
     "tax_year": {
      "type": "integer",
      "description": "Tax year"
     },
     "code": {
      "type": "string",
      "description": "Code"
     },
     "name": {
      "type": "string",
      "description": "Name"
     },
     "state_code": {
      "type": "string",
      "description": "State code"
     },
     "jurisdiction_type": {
      "type": "string",
      "description": "Type",
      "enum": [
       "city",
       "county",
       "school_district",
       "municipal",
       "transit_district",
       "state_district"
      ]
     },
     "psd_code": {
      "type": "string",
      "description": "PSD / district number"
     },
     "tax_kind": {
      "type": "string",
      "description": "Tax",
      "enum": [
       "income",
       "occupational",
       "lst",
       "head_tax",
       "transit",
       "surcharge"
      ]
     },
     "method": {
      "type": "string",
      "description": "Resident tax worked out as",
      "enum": [
       "flat_rate",
       "graduated",
       "flat_amount",
       "percent_of_state_tax",
       "percent_of_state_taxable"
      ]
     },
     "wage_basis": {
      "type": "string",
      "description": "Charged on",
      "enum": [
       "state_wages",
       "fica_wages",
       "gross",
       "fit_wages"
      ]
     },
     "resident_rate": {
      "type": "string",
      "format": "decimal",
      "description": "Resident rate"
     },
     "nonresident_rate": {
      "type": "string",
      "format": "decimal",
      "description": "Non-resident rate"
     },
     "resident_applies": {
      "type": "boolean",
      "description": "Taxes residents"
     },
     "nonresident_applies": {
      "type": "boolean",
      "description": "Taxes non-residents"
     },
     "nonresident_out_of_state_only": {
      "type": "boolean",
      "description": "Non-residents only when out of state"
     },
     "resident_requires_work_here": {
      "type": "boolean",
      "description": "Residents only for work done here"
     },
     "pa_act32": {
      "type": "boolean",
      "description": "Pennsylvania Act 32 (higher of home and work)"
     },
     "flat_amount": {
      "type": "string",
      "format": "decimal",
      "description": "Flat amount (employee)"
     },
     "employer_flat_amount": {
      "type": "string",
      "format": "decimal",
      "description": "Flat amount (employer)"
     },
     "flat_frequency": {
      "type": "string",
      "description": "Flat amount is",
      "enum": [
       "annual",
       "monthly",
       "per_period"
      ]
     },
     "exempt_below": {
      "type": "string",
      "format": "decimal",
      "description": "Exempt below"
     },
     "exempt_below_period": {
      "type": "string",
      "description": "Exempt below, per",
      "enum": [
       "annual",
       "monthly"
      ]
     },
     "employer_rate": {
      "type": "string",
      "format": "decimal",
      "description": "Employer rate"
     },
     "wage_base": {
      "type": "string",
      "format": "decimal",
      "description": "Annual wage base"
     },
     "annual_max": {
      "type": "string",
      "format": "decimal",
      "description": "Annual maximum"
     },
     "exemption_amount": {
      "type": "string",
      "format": "decimal",
      "description": "Exemption per allowance"
     },
     "standard_deduction_single": {
      "type": "string",
      "format": "decimal",
      "description": "Deduction — single"
     },
     "standard_deduction_married": {
      "type": "string",
      "format": "decimal",
      "description": "Deduction — married"
     },
     "credit_factor": {
      "type": "string",
      "format": "decimal",
      "description": "Residence credit share"
     },
     "credit_rate_limit": {
      "type": "string",
      "format": "decimal",
      "description": "Residence credit limited to rate"
     },
     "auto_apply": {
      "type": "string",
      "description": "Applies without an assignment to",
      "enum": [
       "none",
       "work_state",
       "resident_state",
       "work_or_resident",
       "work_state_nonresident"
      ]
     },
     "collector": {
      "type": "string",
      "description": "Collector"
     },
     "w2_locality_name": {
      "type": "string",
      "description": "W-2 box 20 name"
     },
     "source_note": {
      "type": "string",
      "description": "Source"
     },
     "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
     }
    }
   }
  }
 },
 "security": [
  {
   "bearer": []
  }
 ],
 "paths": {
  "/api/hrms/local-tax-jurisdictions": {
   "get": {
    "summary": "list local-tax-jurisdictions",
    "operationId": "list_local_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 local-tax-jurisdictions",
    "operationId": "create_local_tax_jurisdictions_1_4",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/hrms/local-tax-jurisdictions/{id}": {
   "get": {
    "summary": "get local-tax-jurisdictions",
    "operationId": "get_local_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 local-tax-jurisdictions",
    "operationId": "change_local_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 local-tax-jurisdictions",
    "operationId": "delete_local_tax_jurisdictions_2_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/hrms/local-tax-jurisdictions/{id}/copy": {
   "post": {
    "summary": "Copy",
    "operationId": "action_local_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"
     }
    }
   }
  }
 }
}