{
 "openapi": "3.1.0",
 "info": {
  "title": "Dependents (HRMS)",
  "version": "20261030b",
  "description": "Read and maintain dependants records (hr.dependants)."
 },
 "servers": [
  {
   "url": "https://{tenant}.tranxact.ai",
   "variables": {
    "tenant": {
     "default": "demo"
    }
   }
  }
 ],
 "components": {
  "securitySchemes": {
   "bearer": {
    "type": "http",
    "scheme": "bearer"
   }
  },
  "schemas": {
   "dependants": {
    "type": "object",
    "required": [
     "person_id",
     "first_name",
     "last_name",
     "relationship"
    ],
    "properties": {
     "id": {
      "type": "string",
      "format": "uuid",
      "description": "Id",
      "readOnly": true
     },
     "org_id": {
      "type": "string",
      "format": "uuid",
      "description": "Org id",
      "readOnly": true
     },
     "person_id": {
      "type": "string",
      "format": "uuid",
      "description": "Person"
     },
     "first_name": {
      "type": "string",
      "description": "First name"
     },
     "last_name": {
      "type": "string",
      "description": "Last name"
     },
     "relationship": {
      "type": "string",
      "description": "Relationship",
      "enum": [
       "spouse",
       "domestic_partner",
       "child",
       "stepchild",
       "adopted_child",
       "foster_child",
       "disabled_adult_child",
       "other"
      ]
     },
     "date_of_birth": {
      "type": "string",
      "format": "date",
      "description": "Date of birth"
     },
     "gender": {
      "type": "string",
      "description": "Gender"
     },
     "national_id_last4": {
      "type": "string",
      "description": "National id last4",
      "readOnly": true
     },
     "is_student": {
      "type": "boolean",
      "description": "Full-time student"
     },
     "is_disabled": {
      "type": "boolean",
      "description": "Disabled"
     },
     "ages_off_on": {
      "type": "string",
      "format": "date",
      "description": "Ages off cover on"
     },
     "verified_at": {
      "type": "string",
      "format": "date-time",
      "description": "Verified at",
      "readOnly": true
     },
     "is_active": {
      "type": "boolean",
      "description": "Is active"
     },
     "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
     },
     "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
     },
     "national_id_cipher": {
      "type": "string",
      "description": "National id cipher",
      "readOnly": true
     },
     "verification_status": {
      "type": "string",
      "description": "Verification status",
      "readOnly": true
     }
    }
   }
  }
 },
 "security": [
  {
   "bearer": []
  }
 ],
 "paths": {
  "/api/hrms/dependants": {
   "get": {
    "summary": "list dependants",
    "operationId": "list_dependants_0_4",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "post": {
    "summary": "create dependants",
    "operationId": "create_dependants_1_4",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/hrms/dependants/{id}": {
   "get": {
    "summary": "get dependants",
    "operationId": "get_dependants_0_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "put": {
    "summary": "change dependants",
    "operationId": "change_dependants_1_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "delete": {
    "summary": "delete dependants",
    "operationId": "delete_dependants_2_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/hrms/dependants/{id}/copy": {
   "post": {
    "summary": "Copy",
    "operationId": "action_dependants_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"
     }
    }
   }
  },
  "/api/hrms/dependants/{id}/verify": {
   "post": {
    "summary": "Verify",
    "operationId": "action_dependants_0_6",
    "description": "Body keys: status; status one of verified|rejected|pending",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  }
 }
}