{
 "openapi": "3.1.0",
 "info": {
  "title": "Employee Deductions (HRMS)",
  "version": "20261030b",
  "description": "What comes out of a particular person’s pay, including garnishments and loans."
 },
 "servers": [
  {
   "url": "https://{tenant}.tranxact.ai",
   "variables": {
    "tenant": {
     "default": "demo"
    }
   }
  }
 ],
 "components": {
  "securitySchemes": {
   "bearer": {
    "type": "http",
    "scheme": "bearer"
   }
  },
  "schemas": {
   "employee-deductions": {
    "type": "object",
    "required": [
     "employee_id",
     "deduction_code_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"
     },
     "deduction_code_id": {
      "type": "string",
      "format": "uuid",
      "description": "Deduction"
     },
     "amount": {
      "type": "string",
      "format": "decimal",
      "description": "Amount"
     },
     "percent": {
      "type": "string",
      "format": "decimal",
      "description": "Percent"
     },
     "employer_amount": {
      "type": "string",
      "format": "decimal",
      "description": "Employer amount"
     },
     "effective_from": {
      "type": "string",
      "format": "date",
      "description": "From"
     },
     "effective_to": {
      "type": "string",
      "format": "date",
      "description": "To"
     },
     "goal_amount": {
      "type": "string",
      "format": "decimal",
      "description": "Stop after"
     },
     "taken_to_date": {
      "type": "string",
      "format": "decimal",
      "description": "Taken to date"
     },
     "case_number": {
      "type": "string",
      "description": "Case number"
     },
     "payee": {
      "type": "string",
      "description": "Payee"
     },
     "is_active": {
      "type": "boolean",
      "description": "Active"
     },
     "org_unit_id": {
      "type": "string",
      "format": "uuid",
      "description": "Org unit id",
      "readOnly": true
     },
     "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
     },
     "order_type": {
      "type": "string",
      "description": "Order type",
      "readOnly": true
     },
     "order_priority": {
      "type": "integer",
      "description": "Order priority",
      "readOnly": true
     },
     "order_received_on": {
      "type": "string",
      "format": "date",
      "description": "Order received on",
      "readOnly": true
     },
     "issuing_state": {
      "type": "string",
      "description": "Issuing state",
      "readOnly": true
     },
     "issuing_authority": {
      "type": "string",
      "description": "Issuing authority",
      "readOnly": true
     },
     "remit_to_address": {
      "type": "string",
      "description": "Remit to address",
      "readOnly": true
     },
     "remit_fips": {
      "type": "string",
      "description": "Remit fips",
      "readOnly": true
     },
     "remit_method": {
      "type": "string",
      "description": "Remit method",
      "readOnly": true
     },
     "medical_support": {
      "type": "boolean",
      "description": "Medical support",
      "readOnly": true
     },
     "order_notes": {
      "type": "string",
      "description": "Order notes",
      "readOnly": true
     }
    }
   }
  }
 },
 "security": [
  {
   "bearer": []
  }
 ],
 "paths": {
  "/api/hrms/employee-deductions": {
   "get": {
    "summary": "list employee-deductions",
    "operationId": "list_employee_deductions_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-deductions",
    "operationId": "create_employee_deductions_1_4",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/hrms/employee-deductions/{id}": {
   "get": {
    "summary": "get employee-deductions",
    "operationId": "get_employee_deductions_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-deductions",
    "operationId": "change_employee_deductions_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-deductions",
    "operationId": "delete_employee_deductions_2_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "patch": {
    "summary": "Patch employee deductions",
    "operationId": "action_employee_deductions_3_5",
    "description": "Body keys: deduction_code_id",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/hrms/employee-deductions/{id}/copy": {
   "post": {
    "summary": "Copy",
    "operationId": "action_employee_deductions_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"
     }
    }
   }
  }
 }
}