{
 "openapi": "3.1.0",
 "info": {
  "title": "Withholding (W-4) (HRMS)",
  "version": "20261030b",
  "description": "What each employee has told the employer to withhold. Nothing can be calculated for somebody with no setup on file."
 },
 "servers": [
  {
   "url": "https://{tenant}.tranxact.ai",
   "variables": {
    "tenant": {
     "default": "demo"
    }
   }
  }
 ],
 "components": {
  "securitySchemes": {
   "bearer": {
    "type": "http",
    "scheme": "bearer"
   }
  },
  "schemas": {
   "employee-tax-setup": {
    "type": "object",
    "required": [
     "employee_id"
    ],
    "properties": {
     "id": {
      "type": "string",
      "format": "uuid",
      "description": "Id",
      "readOnly": true
     },
     "org_id": {
      "type": "string",
      "format": "uuid",
      "description": "Org id",
      "readOnly": true
     },
     "employee_id": {
      "type": "string",
      "format": "uuid",
      "description": "Employee"
     },
     "jurisdiction": {
      "type": "string",
      "description": "Jurisdiction"
     },
     "authority": {
      "type": "string",
      "description": "Authority"
     },
     "effective_from": {
      "type": "string",
      "format": "date",
      "description": "Effective from"
     },
     "effective_to": {
      "type": "string",
      "format": "date",
      "description": "Effective to"
     },
     "filing_status": {
      "type": "string",
      "description": "Filing status"
     },
     "multiple_jobs": {
      "type": "boolean",
      "description": "Multiple jobs or spouse works (step 2c)"
     },
     "dependents_amount": {
      "type": "string",
      "format": "decimal",
      "description": "Dependents claimed (step 3)"
     },
     "other_income": {
      "type": "string",
      "format": "decimal",
      "description": "Other income (step 4a)"
     },
     "deductions": {
      "type": "string",
      "format": "decimal",
      "description": "Deductions (step 4b)"
     },
     "extra_withholding": {
      "type": "string",
      "format": "decimal",
      "description": "Extra withholding a period (step 4c)"
     },
     "allowances": {
      "type": "integer",
      "description": "State allowances"
     },
     "is_legacy_w4": {
      "type": "boolean",
      "description": "Is legacy w4"
     },
     "exempt_from_withholding": {
      "type": "boolean",
      "description": "Claims exemption"
     },
     "additional_percent": {
      "type": "string",
      "format": "decimal",
      "description": "Additional percent"
     },
     "signed_on": {
      "type": "string",
      "format": "date",
      "description": "Signed on"
     },
     "source": {
      "type": "string",
      "description": "Source"
     },
     "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "Created at",
      "readOnly": true
     },
     "org_unit_id": {
      "type": "string",
      "format": "uuid",
      "description": "Org unit id",
      "readOnly": true
     },
     "additional_allowances": {
      "type": "integer",
      "description": "Additional / estimated deduction allowances"
     },
     "dependents_count": {
      "type": "integer",
      "description": "Dependents (state)"
     },
     "elected_rate": {
      "type": "string",
      "format": "decimal",
      "description": "Elected rate (Arizona A-4)"
     },
     "reciprocity_waived": {
      "type": "boolean",
      "description": "Withhold the work state despite reciprocity"
     },
     "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_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/employee-tax-setup": {
   "get": {
    "summary": "list employee-tax-setup",
    "operationId": "list_employee_tax_setup_0_4",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "post": {
    "summary": "create employee-tax-setup",
    "operationId": "create_employee_tax_setup_1_4",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/hrms/employee-tax-setup/{id}": {
   "get": {
    "summary": "get employee-tax-setup",
    "operationId": "get_employee_tax_setup_0_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "put": {
    "summary": "change employee-tax-setup",
    "operationId": "change_employee_tax_setup_1_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "delete": {
    "summary": "delete employee-tax-setup",
    "operationId": "delete_employee_tax_setup_2_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/hrms/employee-tax-setup/{id}/copy": {
   "post": {
    "summary": "Copy",
    "operationId": "action_employee_tax_setup_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"
     }
    }
   }
  }
 }
}