{
 "openapi": "3.1.0",
 "info": {
  "title": "Performance Cycles (HRMS)",
  "version": "20261030b",
  "description": "The period, the rating scale and whether ratings have to fit a distribution."
 },
 "servers": [
  {
   "url": "https://{tenant}.tranxact.ai",
   "variables": {
    "tenant": {
     "default": "demo"
    }
   }
  }
 ],
 "components": {
  "securitySchemes": {
   "bearer": {
    "type": "http",
    "scheme": "bearer"
   }
  },
  "schemas": {
   "performance-cycles": {
    "type": "object",
    "required": [
     "code",
     "name",
     "period_start",
     "period_end"
    ],
    "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"
     },
     "period_start": {
      "type": "string",
      "format": "date",
      "description": "Period start"
     },
     "period_end": {
      "type": "string",
      "format": "date",
      "description": "Period end"
     },
     "review_type": {
      "type": "string",
      "description": "Type",
      "enum": [
       "annual",
       "mid_year",
       "quarterly",
       "probation",
       "project",
       "continuous"
      ]
     },
     "rating_scale": {
      "type": "object",
      "description": "Rating scale"
     },
     "forced_distribution": {
      "type": "object",
      "description": "Forced distribution"
     },
     "self_review_required": {
      "type": "boolean",
      "description": "Self review required"
     },
     "peer_review_enabled": {
      "type": "boolean",
      "description": "Peer review"
     },
     "upward_review_enabled": {
      "type": "boolean",
      "description": "Upward review"
     },
     "calibration_required": {
      "type": "boolean",
      "description": "Calibration required"
     },
     "status": {
      "type": "string",
      "description": "Status",
      "enum": [
       "planned",
       "open",
       "in_review",
       "calibration",
       "closed"
      ]
     },
     "opens_on": {
      "type": "string",
      "format": "date",
      "description": "Opens"
     },
     "closes_on": {
      "type": "string",
      "format": "date",
      "description": "Closes"
     },
     "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
     },
     "review_workflow_id": {
      "type": "string",
      "format": "uuid",
      "description": "Review workflow"
     },
     "checkin_cadence": {
      "type": "string",
      "description": "Goal check-ins",
      "enum": [
       "none",
       "weekly",
       "biweekly",
       "monthly",
       "quarterly"
      ]
     },
     "checkin_grace_days": {
      "type": "integer",
      "description": "Grace (days)"
     }
    }
   }
  }
 },
 "security": [
  {
   "bearer": []
  }
 ],
 "paths": {
  "/api/hrms/performance-cycles": {
   "get": {
    "summary": "list performance-cycles",
    "operationId": "list_performance_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 performance-cycles",
    "operationId": "create_performance_cycles_1_4",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/hrms/performance-cycles/{id}": {
   "get": {
    "summary": "get performance-cycles",
    "operationId": "get_performance_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 performance-cycles",
    "operationId": "change_performance_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 performance-cycles",
    "operationId": "delete_performance_cycles_2_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/hrms/performance-cycles/{id}/copy": {
   "post": {
    "summary": "Copy",
    "operationId": "action_performance_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"
     }
    }
   }
  },
  "/api/hrms/performance-cycles/{id}/start-reviews": {
   "post": {
    "summary": "Start reviews",
    "operationId": "action_performance_cycles_0_6",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  }
 }
}