{
 "openapi": "3.1.0",
 "info": {
  "title": "Deduction Codes (HRMS)",
  "version": "20261030b",
  "description": "What comes out, in what order, and which taxes it reduces before it does."
 },
 "servers": [
  {
   "url": "https://{tenant}.tranxact.ai",
   "variables": {
    "tenant": {
     "default": "demo"
    }
   }
  }
 ],
 "components": {
  "securitySchemes": {
   "bearer": {
    "type": "http",
    "scheme": "bearer"
   }
  },
  "schemas": {
   "deduction-codes": {
    "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
     },
     "code": {
      "type": "string",
      "description": "Code"
     },
     "name": {
      "type": "string",
      "description": "Name"
     },
     "category": {
      "type": "string",
      "description": "Category"
     },
     "calculation": {
      "type": "string",
      "description": "Worked out as",
      "enum": [
       "flat_amount",
       "percent_of_gross",
       "percent_of_net",
       "tiered",
       "schedule",
       "formula"
      ]
     },
     "amount": {
      "type": "string",
      "format": "decimal",
      "description": "Amount"
     },
     "percent": {
      "type": "string",
      "format": "decimal",
      "description": "Percent"
     },
     "reduces_fit": {
      "type": "boolean",
      "description": "Reduces federal income tax"
     },
     "reduces_fica": {
      "type": "boolean",
      "description": "Reduces FICA"
     },
     "reduces_sit": {
      "type": "boolean",
      "description": "Reduces state income tax"
     },
     "employer_paid": {
      "type": "boolean",
      "description": "Paid by the employer"
     },
     "employer_match_percent": {
      "type": "string",
      "format": "decimal",
      "description": "Employer match %"
     },
     "employer_match_limit_percent": {
      "type": "string",
      "format": "decimal",
      "description": "Match capped at % of pay"
     },
     "annual_limit": {
      "type": "string",
      "format": "decimal",
      "description": "Annual limit"
     },
     "priority": {
      "type": "integer",
      "description": "Order taken"
     },
     "max_percent_of_disposable": {
      "type": "string",
      "format": "decimal",
      "description": "Cap as % of disposable earnings"
     },
     "w2_box": {
      "type": "string",
      "description": "W-2 box"
     },
     "gl_account_no": {
      "type": "string",
      "description": "Gl account no"
     },
     "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
     },
     "tax_treatment": {
      "type": "string",
      "description": "Tax treatment",
      "enum": [
       "section125",
       "hsa",
       "dependent_care",
       "commuter",
       "pretax_401k",
       "pretax_403b",
       "pretax_457b",
       "roth_401k",
       "roth_403b",
       "roth_457b",
       "posttax",
       "group_term_life",
       "employer_paid"
      ]
     },
     "required_by_law": {
      "type": "boolean",
      "description": "Required by law"
     }
    }
   }
  }
 },
 "security": [
  {
   "bearer": []
  }
 ],
 "paths": {
  "/api/hrms/deduction-codes": {
   "get": {
    "summary": "list deduction-codes",
    "operationId": "list_deduction_codes_0_4",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "post": {
    "summary": "create deduction-codes",
    "operationId": "create_deduction_codes_1_4",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/hrms/deduction-codes/{id}": {
   "get": {
    "summary": "get deduction-codes",
    "operationId": "get_deduction_codes_0_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "put": {
    "summary": "change deduction-codes",
    "operationId": "change_deduction_codes_1_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "delete": {
    "summary": "delete deduction-codes",
    "operationId": "delete_deduction_codes_2_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/hrms/deduction-codes/{id}/copy": {
   "post": {
    "summary": "Copy",
    "operationId": "action_deduction_codes_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"
     }
    }
   }
  }
 }
}