{
 "openapi": "3.1.0",
 "info": {
  "title": "Benefit Enrollments (HRMS)",
  "version": "20261030b",
  "description": "Read and maintain benefit enrollments records (hr.benefit_enrollments)."
 },
 "servers": [
  {
   "url": "https://{tenant}.tranxact.ai",
   "variables": {
    "tenant": {
     "default": "demo"
    }
   }
  }
 ],
 "components": {
  "securitySchemes": {
   "bearer": {
    "type": "http",
    "scheme": "bearer"
   }
  },
  "schemas": {
   "benefit-enrollments": {
    "type": "object",
    "required": [
     "employee_id",
     "plan_id",
     "effective_date"
    ],
    "properties": {
     "id": {
      "type": "string",
      "format": "uuid",
      "description": "Id",
      "readOnly": true
     },
     "employee_id": {
      "type": "string",
      "format": "uuid",
      "description": "Employee"
     },
     "plan_id": {
      "type": "string",
      "format": "uuid",
      "description": "Plan"
     },
     "coverage_tier": {
      "type": "string",
      "description": "Coverage (plan without tiers)",
      "enum": [
       "employee",
       "employee_spouse",
       "employee_children",
       "family"
      ]
     },
     "effective_date": {
      "type": "string",
      "format": "date",
      "description": "Effective"
     },
     "end_date": {
      "type": "string",
      "format": "date",
      "description": "End date"
     },
     "status": {
      "type": "string",
      "description": "Status"
     },
     "org_id": {
      "type": "string",
      "format": "uuid",
      "description": "Org id",
      "readOnly": true
     },
     "plan_year_id": {
      "type": "string",
      "format": "uuid",
      "description": "Plan year id",
      "readOnly": true
     },
     "tier_id": {
      "type": "string",
      "format": "uuid",
      "description": "Coverage tier"
     },
     "employee_cost": {
      "type": "string",
      "format": "decimal",
      "description": "Employee cost",
      "readOnly": true
     },
     "employer_cost": {
      "type": "string",
      "format": "decimal",
      "description": "Employer cost",
      "readOnly": true
     },
     "coverage_amount": {
      "type": "string",
      "format": "decimal",
      "description": "Coverage amount",
      "readOnly": true
     },
     "annual_election": {
      "type": "string",
      "format": "decimal",
      "description": "Annual election",
      "readOnly": true
     },
     "elected_at": {
      "type": "string",
      "format": "date-time",
      "description": "Elected at",
      "readOnly": true
     },
     "elected_by": {
      "type": "string",
      "format": "uuid",
      "description": "Elected by",
      "readOnly": true
     },
     "reason": {
      "type": "string",
      "description": "Reason",
      "readOnly": true
     },
     "life_event_id": {
      "type": "string",
      "format": "uuid",
      "description": "Life event id",
      "readOnly": true
     },
     "waived": {
      "type": "boolean",
      "description": "Waived",
      "readOnly": true
     },
     "waiver_reason": {
      "type": "string",
      "description": "Waiver reason",
      "readOnly": true
     },
     "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
     }
    }
   }
  }
 },
 "security": [
  {
   "bearer": []
  }
 ],
 "paths": {
  "/api/hrms/benefit-enrollments": {
   "get": {
    "summary": "list benefit-enrollments",
    "operationId": "list_benefit_enrollments_0_4",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "post": {
    "summary": "create benefit-enrollments",
    "operationId": "create_benefit_enrollments_1_4",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/hrms/benefit-enrollments/{id}": {
   "get": {
    "summary": "get benefit-enrollments",
    "operationId": "get_benefit_enrollments_0_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "put": {
    "summary": "change benefit-enrollments",
    "operationId": "change_benefit_enrollments_1_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "delete": {
    "summary": "delete benefit-enrollments",
    "operationId": "delete_benefit_enrollments_2_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/hrms/benefit-enrollments/{id}/copy": {
   "post": {
    "summary": "Copy",
    "operationId": "action_benefit_enrollments_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"
     }
    }
   }
  }
 }
}