{
 "openapi": "3.1.0",
 "info": {
  "title": "Compensation Cycles (HRMS)",
  "version": "20261030b",
  "description": "A review, its budget, and whether the proposals fit inside it."
 },
 "servers": [
  {
   "url": "https://{tenant}.tranxact.ai",
   "variables": {
    "tenant": {
     "default": "demo"
    }
   }
  }
 ],
 "components": {
  "securitySchemes": {
   "bearer": {
    "type": "http",
    "scheme": "bearer"
   }
  },
  "schemas": {
   "comp-cycles": {
    "type": "object",
    "required": [
     "code",
     "name",
     "plan_year",
     "effective_date"
    ],
    "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"
     },
     "cycle_type": {
      "type": "string",
      "description": "Cycle type"
     },
     "plan_year": {
      "type": "integer",
      "description": "Plan year"
     },
     "effective_date": {
      "type": "string",
      "format": "date",
      "description": "Effective date"
     },
     "opens_on": {
      "type": "string",
      "format": "date",
      "description": "Opens on"
     },
     "closes_on": {
      "type": "string",
      "format": "date",
      "description": "Closes on"
     },
     "budget_percent": {
      "type": "string",
      "format": "decimal",
      "description": "Budget percent"
     },
     "budget_amount": {
      "type": "string",
      "format": "decimal",
      "description": "Budget amount"
     },
     "eligible_pay_bill": {
      "type": "string",
      "format": "decimal",
      "description": "Eligible pay bill",
      "readOnly": true
     },
     "proposed_amount": {
      "type": "string",
      "format": "decimal",
      "description": "Proposed amount",
      "readOnly": true
     },
     "approved_amount": {
      "type": "string",
      "format": "decimal",
      "description": "Approved amount",
      "readOnly": true
     },
     "status": {
      "type": "string",
      "description": "Status"
     },
     "min_months_service": {
      "type": "integer",
      "description": "Min months service"
     },
     "approved_by": {
      "type": "string",
      "format": "uuid",
      "description": "Approved by",
      "readOnly": true
     },
     "approved_at": {
      "type": "string",
      "format": "date-time",
      "description": "Approved at",
      "readOnly": true
     },
     "applied_at": {
      "type": "string",
      "format": "date-time",
      "description": "Applied at",
      "readOnly": true
     },
     "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
     }
    }
   }
  }
 },
 "security": [
  {
   "bearer": []
  }
 ],
 "paths": {
  "/api/hrms/comp-cycles": {
   "get": {
    "summary": "list comp-cycles",
    "operationId": "list_comp_cycles_0_4",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "post": {
    "summary": "create comp-cycles",
    "operationId": "create_comp_cycles_1_4",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/hrms/comp-cycles/{id}": {
   "get": {
    "summary": "get comp-cycles",
    "operationId": "get_comp_cycles_0_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "put": {
    "summary": "change comp-cycles",
    "operationId": "change_comp_cycles_1_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "delete": {
    "summary": "delete comp-cycles",
    "operationId": "delete_comp_cycles_2_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/hrms/comp-cycles/{id}/copy": {
   "post": {
    "summary": "Copy",
    "operationId": "action_comp_cycles_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"
     }
    }
   }
  }
 }
}