{"openapi":"3.0.3","info":{"title":"JantaHR API","version":"1.0.0","description":"REST API of JantaHR, open-source HR and payroll software for India: employees, leave, attendance, payroll with PF, ESI, TDS and professional tax, compliance, lifecycle, performance, recruitment and privacy requests.\n\nSend a Supabase Auth access token as a bearer token. Every call acts as that signed-in user: it sees only their company and can do only what their role allows. There are no API keys.\n\nRequests and responses are JSON. Amounts are in Indian rupees. Errors share one shape (the Error schema).","license":{"name":"AGPL-3.0","url":"https://www.gnu.org/licenses/agpl-3.0.html"},"contact":{"name":"JantaHR","url":"https://github.com/devag7/jantahr"}},"servers":[{"url":"/api"}],"tags":[{"name":"ai","description":"Ai operations"},{"name":"announcements","description":"Announcements operations"},{"name":"attendance","description":"Attendance operations"},{"name":"auth","description":"Auth operations"},{"name":"billing","description":"Billing operations"},{"name":"company","description":"Company operations"},{"name":"compliance","description":"Compliance operations"},{"name":"departments","description":"Departments operations"},{"name":"designations","description":"Designations operations"},{"name":"employees","description":"Employees operations"},{"name":"expenses","description":"Expenses operations"},{"name":"health","description":"Health operations"},{"name":"helpdesk","description":"Helpdesk operations"},{"name":"holidays","description":"Holidays operations"},{"name":"leave","description":"Leave operations"},{"name":"lifecycle","description":"Lifecycle operations"},{"name":"masters","description":"Masters operations"},{"name":"meta","description":"Meta operations"},{"name":"notifications","description":"Notifications operations"},{"name":"payroll","description":"Payroll operations"},{"name":"performance","description":"Performance operations"},{"name":"policies","description":"Policies operations"},{"name":"privacy","description":"Privacy operations"},{"name":"public","description":"Public operations"},{"name":"recruitment","description":"Recruitment operations"},{"name":"reports","description":"Reports operations"},{"name":"uploads","description":"Uploads operations"}],"paths":{"/ai/anomalies":{"get":{"operationId":"ai_anomalies","tags":["ai"],"summary":"Ai: anomalies","description":"Ai: anomalies (GET /ai/anomalies). Needs a signed-in user with the role SUPER_ADMIN, HR_ADMIN, PAYROLL_ADMIN, AUDITOR or MANAGER. On the cloud edition the company’s plan must include the “analytics” feature.","parameters":[{"name":"days","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN","PAYROLL_ADMIN","AUDITOR","MANAGER"],"x-required-feature":"analytics"}},"/ai/attrition-risk":{"get":{"operationId":"ai_attrition","tags":["ai"],"summary":"Ai: attrition","description":"Ai: attrition (GET /ai/attrition-risk). Needs a signed-in user with the role SUPER_ADMIN or HR_ADMIN. On the cloud edition the company’s plan must include the “analytics” feature.","responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN"],"x-required-feature":"analytics"}},"/ai/chat":{"post":{"operationId":"ai_chat","tags":["ai"],"summary":"Ai: chat","description":"Ai: chat (POST /ai/chat). Needs a signed-in user of the company; any role.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatDto"}}}},"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}]}},"/announcements":{"get":{"operationId":"announcements_list","tags":["announcements"],"summary":"Announcements: list","description":"Announcements: list (GET /announcements). Needs a signed-in user of the company; any role.","responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}]},"post":{"operationId":"announcements_create","tags":["announcements"],"summary":"Announcements: create","description":"Announcements: create (POST /announcements). Needs a signed-in user with the role SUPER_ADMIN or HR_ADMIN.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnnouncementDto"}}}},"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN"]}},"/announcements/{id}":{"delete":{"operationId":"announcements_remove","tags":["announcements"],"summary":"Announcements: remove","description":"Announcements: remove (DELETE /announcements/{id}). Needs a signed-in user with the role SUPER_ADMIN or HR_ADMIN.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN"]},"patch":{"operationId":"announcements_update","tags":["announcements"],"summary":"Announcements: update","description":"Announcements: update (PATCH /announcements/{id}). Needs a signed-in user with the role SUPER_ADMIN or HR_ADMIN.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAnnouncementDto"}}}},"responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN"]}},"/attendance/biometric/push":{"post":{"operationId":"attendance_push","tags":["attendance"],"summary":"Attendance: push","description":"Attendance: push (POST /attendance/biometric/push). No sign-in needed.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BiometricPushDto"}}}},"responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[]}},"/attendance/daily":{"get":{"operationId":"attendance_daily","tags":["attendance"],"summary":"Attendance: daily","description":"Attendance: daily (GET /attendance/daily). Needs a signed-in user with the role SUPER_ADMIN, HR_ADMIN, PAYROLL_ADMIN, AUDITOR or MANAGER.","parameters":[{"name":"date","in":"query","required":false,"schema":{"type":"string","description":"ISO 8601 date or date-time"}},{"name":"departmentId","in":"query","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","required":false,"schema":{"minimum":1,"type":"integer"}},{"name":"limit","in":"query","required":false,"schema":{"maximum":200,"minimum":1,"type":"integer"}},{"name":"search","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN","PAYROLL_ADMIN","AUDITOR","MANAGER"]}},"/attendance/devices":{"get":{"operationId":"attendance_devices","tags":["attendance"],"summary":"Attendance: devices","description":"Attendance: devices (GET /attendance/devices). Needs a signed-in user with the role SUPER_ADMIN or HR_ADMIN. On the cloud edition the company’s plan must include the “biometric” feature.","responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN"],"x-required-feature":"biometric"},"post":{"operationId":"attendance_createDevice","tags":["attendance"],"summary":"Attendance: create device","description":"Attendance: create device (POST /attendance/devices). Needs a signed-in user with the role SUPER_ADMIN or HR_ADMIN. On the cloud edition the company’s plan must include the “biometric” feature.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceDto"}}}},"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN"],"x-required-feature":"biometric"}},"/attendance/devices/{id}/active":{"post":{"operationId":"attendance_deviceActive","tags":["attendance"],"summary":"Attendance: device active","description":"Attendance: device active (POST /attendance/devices/{id}/active). Needs a signed-in user with the role SUPER_ADMIN or HR_ADMIN. On the cloud edition the company’s plan must include the “biometric” feature.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"isActive":{}},"required":["isActive"]}}}},"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN"],"x-required-feature":"biometric"}},"/attendance/import":{"post":{"operationId":"attendance_import","tags":["attendance"],"summary":"Attendance: import","description":"Attendance: import (POST /attendance/import). Needs a signed-in user with the role SUPER_ADMIN or HR_ADMIN.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportAttendanceDto"}}}},"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN"]}},"/attendance/locations":{"get":{"operationId":"attendance_locations","tags":["attendance"],"summary":"Attendance: locations","description":"Attendance: locations (GET /attendance/locations). Needs a signed-in user of the company; any role.","responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}]},"post":{"operationId":"attendance_createLocation","tags":["attendance"],"summary":"Attendance: create location","description":"Attendance: create location (POST /attendance/locations). Needs a signed-in user with the role SUPER_ADMIN or HR_ADMIN.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShiftLocationDto"}}}},"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN"]}},"/attendance/locations/{id}":{"delete":{"operationId":"attendance_deleteLocation","tags":["attendance"],"summary":"Attendance: delete location","description":"Attendance: delete location (DELETE /attendance/locations/{id}). Needs a signed-in user with the role SUPER_ADMIN or HR_ADMIN.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN"]},"patch":{"operationId":"attendance_updateLocation","tags":["attendance"],"summary":"Attendance: update location","description":"Attendance: update location (PATCH /attendance/locations/{id}). Needs a signed-in user with the role SUPER_ADMIN or HR_ADMIN.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateShiftLocationDto"}}}},"responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN"]}},"/attendance/mark":{"post":{"operationId":"attendance_mark","tags":["attendance"],"summary":"Attendance: mark","description":"Attendance: mark (POST /attendance/mark). Needs a signed-in user with the role SUPER_ADMIN or HR_ADMIN.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ManualMarkDto"}}}},"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN"]}},"/attendance/mark-absent":{"post":{"operationId":"attendance_markAbsent","tags":["attendance"],"summary":"Attendance: mark absent","description":"Attendance: mark absent (POST /attendance/mark-absent). Needs a signed-in user with the role SUPER_ADMIN or HR_ADMIN.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RangeDto"}}}},"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN"]}},"/attendance/me":{"get":{"operationId":"attendance_me","tags":["attendance"],"summary":"Attendance: me","description":"Attendance: me (GET /attendance/me). Needs a signed-in user of the company; any role.","parameters":[{"name":"year","in":"query","required":false,"schema":{"type":"string"}},{"name":"month","in":"query","required":false,"schema":{"type":"string"}},{"name":"employeeId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}]}},"/attendance/process":{"post":{"operationId":"attendance_process","tags":["attendance"],"summary":"Attendance: process","description":"Attendance: process (POST /attendance/process). Needs a signed-in user with the role SUPER_ADMIN or HR_ADMIN.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RangeDto"}}}},"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN"]}},"/attendance/punch":{"post":{"operationId":"attendance_punch","tags":["attendance"],"summary":"Attendance: punch","description":"Attendance: punch (POST /attendance/punch). Needs a signed-in user of the company; any role.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PunchDto"}}}},"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}]}},"/attendance/requests":{"get":{"operationId":"attendance_requests","tags":["attendance"],"summary":"Attendance: requests","description":"Attendance: requests (GET /attendance/requests). Needs a signed-in user of the company; any role.","parameters":[{"name":"status","in":"query","required":false,"schema":{"type":"string"}},{"name":"scope","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}]},"post":{"operationId":"attendance_request","tags":["attendance"],"summary":"Attendance: request","description":"Attendance: request (POST /attendance/requests). Needs a signed-in user of the company; any role.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegularizationDto"}}}},"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}]}},"/attendance/requests/{id}/approve":{"post":{"operationId":"attendance_approve","tags":["attendance"],"summary":"Attendance: approve","description":"Attendance: approve (POST /attendance/requests/{id}/approve). Needs a signed-in user with the role SUPER_ADMIN, HR_ADMIN, PAYROLL_ADMIN, MANAGER or EMPLOYEE.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DecisionDto"}}}},"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN","PAYROLL_ADMIN","MANAGER","EMPLOYEE"]}},"/attendance/requests/{id}/reject":{"post":{"operationId":"attendance_reject","tags":["attendance"],"summary":"Attendance: reject","description":"Attendance: reject (POST /attendance/requests/{id}/reject). Needs a signed-in user with the role SUPER_ADMIN, HR_ADMIN, PAYROLL_ADMIN, MANAGER or EMPLOYEE.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DecisionDto"}}}},"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN","PAYROLL_ADMIN","MANAGER","EMPLOYEE"]}},"/attendance/roster":{"post":{"operationId":"attendance_roster","tags":["attendance"],"summary":"Attendance: roster","description":"Attendance: roster (POST /attendance/roster). Needs a signed-in user with the role SUPER_ADMIN or HR_ADMIN.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RosterDto"}}}},"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN"]}},"/attendance/shift-assignments":{"get":{"operationId":"attendance_assignments","tags":["attendance"],"summary":"Attendance: assignments","description":"Attendance: assignments (GET /attendance/shift-assignments). Needs a signed-in user with the role SUPER_ADMIN, HR_ADMIN, PAYROLL_ADMIN, AUDITOR or MANAGER.","parameters":[{"name":"employeeId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN","PAYROLL_ADMIN","AUDITOR","MANAGER"]},"post":{"operationId":"attendance_assign","tags":["attendance"],"summary":"Attendance: assign","description":"Attendance: assign (POST /attendance/shift-assignments). Needs a signed-in user with the role SUPER_ADMIN or HR_ADMIN.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShiftAssignmentDto"}}}},"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN"]}},"/attendance/shift-assignments/{id}":{"delete":{"operationId":"attendance_removeAssignment","tags":["attendance"],"summary":"Attendance: remove assignment","description":"Attendance: remove assignment (DELETE /attendance/shift-assignments/{id}). Needs a signed-in user with the role SUPER_ADMIN or HR_ADMIN.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN"]}},"/attendance/shifts":{"get":{"operationId":"attendance_shiftTypes","tags":["attendance"],"summary":"Attendance: shift types","description":"Attendance: shift types (GET /attendance/shifts). Needs a signed-in user of the company; any role.","responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}]},"post":{"operationId":"attendance_createShift","tags":["attendance"],"summary":"Attendance: create shift","description":"Attendance: create shift (POST /attendance/shifts). Needs a signed-in user with the role SUPER_ADMIN or HR_ADMIN.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShiftTypeDto"}}}},"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN"]}},"/attendance/shifts/{id}":{"delete":{"operationId":"attendance_deleteShift","tags":["attendance"],"summary":"Attendance: delete shift","description":"Attendance: delete shift (DELETE /attendance/shifts/{id}). Needs a signed-in user with the role SUPER_ADMIN or HR_ADMIN.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN"]},"patch":{"operationId":"attendance_updateShift","tags":["attendance"],"summary":"Attendance: update shift","description":"Attendance: update shift (PATCH /attendance/shifts/{id}). Needs a signed-in user with the role SUPER_ADMIN or HR_ADMIN.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateShiftTypeDto"}}}},"responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN"]}},"/attendance/status":{"get":{"operationId":"attendance_status","tags":["attendance"],"summary":"Attendance: status","description":"Attendance: status (GET /attendance/status). Needs a signed-in user of the company; any role.","responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}]}},"/attendance/summary":{"get":{"operationId":"attendance_summary","tags":["attendance"],"summary":"Attendance: summary","description":"Attendance: summary (GET /attendance/summary). Needs a signed-in user with the role SUPER_ADMIN, HR_ADMIN, PAYROLL_ADMIN, AUDITOR or MANAGER.","parameters":[{"name":"year","in":"query","required":false,"schema":{"type":"string"}},{"name":"month","in":"query","required":false,"schema":{"type":"string"}},{"name":"departmentId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN","PAYROLL_ADMIN","AUDITOR","MANAGER"]}},"/auth/change-password":{"post":{"operationId":"auth_change","tags":["auth"],"summary":"Auth: change","description":"Auth: change (POST /auth/change-password). Needs a signed-in user of the company; any role.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChangePasswordDto"}}}},"responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}]}},"/auth/me":{"get":{"operationId":"auth_me","tags":["auth"],"summary":"Auth: me","description":"Auth: me (GET /auth/me). Needs a signed-in user of the company; any role.","responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}]}},"/auth/mfa/sync":{"post":{"operationId":"auth_syncMfa","tags":["auth"],"summary":"Auth: sync mfa","description":"Auth: sync mfa (POST /auth/mfa/sync). Needs a signed-in user of the company; any role.","responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}]}},"/auth/provision":{"post":{"operationId":"auth_provision","tags":["auth"],"summary":"Auth: provision","description":"Auth: provision (POST /auth/provision). Needs a signed-in user; a JantaHR company account is not required yet.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProvisionCompanyDto"}}}},"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}]}},"/auth/set-password":{"post":{"operationId":"auth_setPassword","tags":["auth"],"summary":"Auth: set password","description":"Auth: set password (POST /auth/set-password). Needs a signed-in user of the company; any role.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetPasswordDto"}}}},"responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}]}},"/billing":{"get":{"operationId":"billing_overview","tags":["billing"],"summary":"Billing: overview","description":"Billing: overview (GET /billing). Needs a signed-in user with the role SUPER_ADMIN, HR_ADMIN, PAYROLL_ADMIN or AUDITOR.","responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN","PAYROLL_ADMIN","AUDITOR"]}},"/billing/cancel":{"post":{"operationId":"billing_cancel","tags":["billing"],"summary":"Billing: cancel","description":"Billing: cancel (POST /billing/cancel). Needs a signed-in user with the role SUPER_ADMIN.","responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN"]}},"/billing/checkout":{"post":{"operationId":"billing_checkout","tags":["billing"],"summary":"Billing: checkout","description":"Billing: checkout (POST /billing/checkout). Needs a signed-in user with the role SUPER_ADMIN.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckoutDto"}}}},"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN"]}},"/billing/checkout/confirm":{"post":{"operationId":"billing_confirm","tags":["billing"],"summary":"Billing: confirm","description":"Billing: confirm (POST /billing/checkout/confirm). Needs a signed-in user with the role SUPER_ADMIN.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfirmCheckoutDto"}}}},"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN"]}},"/billing/entitlements":{"get":{"operationId":"billing_ent","tags":["billing"],"summary":"Billing: ent","description":"Billing: ent (GET /billing/entitlements). Needs a signed-in user of the company; any role.","responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}]}},"/billing/invoices/{id}/pdf":{"get":{"operationId":"billing_invoicePdf","tags":["billing"],"summary":"Billing: invoice pdf","description":"Billing: invoice pdf (GET /billing/invoices/{id}/pdf). Needs a signed-in user with the role SUPER_ADMIN, HR_ADMIN, PAYROLL_ADMIN or AUDITOR.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The file or stream the operation produces (for example a PDF or CSV), sent as a download.","content":{"*/*":{"schema":{"type":"string","format":"binary"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN","PAYROLL_ADMIN","AUDITOR"]}},"/billing/plans":{"get":{"operationId":"billing_plans","tags":["billing"],"summary":"Billing: plans","description":"Billing: plans (GET /billing/plans). No sign-in needed.","responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[]}},"/billing/platform/tenants":{"get":{"operationId":"billing_tenants","tags":["billing"],"summary":"Billing: tenants","description":"Billing: tenants (GET /billing/platform/tenants). Needs a signed-in user of the company; any role.","responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}]}},"/billing/seats":{"post":{"operationId":"billing_seats","tags":["billing"],"summary":"Billing: seats","description":"Billing: seats (POST /billing/seats). Needs a signed-in user with the role SUPER_ADMIN.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SeatsDto"}}}},"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN"]}},"/company":{"get":{"operationId":"company_get","tags":["company"],"summary":"Company: get","description":"Company: get (GET /company). Needs a signed-in user of the company; any role.","responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}]},"patch":{"operationId":"company_update","tags":["company"],"summary":"Company: update","description":"Company: update (PATCH /company). Needs a signed-in user with the role SUPER_ADMIN or HR_ADMIN.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCompanyDto"}}}},"responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN"]}},"/company/setup-status":{"get":{"operationId":"company_setupStatus","tags":["company"],"summary":"Company: setup status","description":"Company: setup status (GET /company/setup-status). Needs a signed-in user with the role SUPER_ADMIN or HR_ADMIN.","responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN"]}},"/compliance/calendar":{"get":{"operationId":"compliance_calendar","tags":["compliance"],"summary":"Compliance: calendar","description":"Compliance: calendar (GET /compliance/calendar). Needs a signed-in user with the role SUPER_ADMIN, HR_ADMIN, PAYROLL_ADMIN or AUDITOR. On the cloud edition the company’s plan must include the “statutory” feature.","responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN","PAYROLL_ADMIN","AUDITOR"],"x-required-feature":"statutory"}},"/compliance/filings/{key}":{"delete":{"operationId":"compliance_unmark","tags":["compliance"],"summary":"Compliance: unmark","description":"Compliance: unmark (DELETE /compliance/filings/{key}). Needs a signed-in user with the role SUPER_ADMIN, HR_ADMIN or PAYROLL_ADMIN. On the cloud edition the company’s plan must include the “statutory” feature.","parameters":[{"name":"key","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN","PAYROLL_ADMIN"],"x-required-feature":"statutory"},"put":{"operationId":"compliance_mark","tags":["compliance"],"summary":"Compliance: mark","description":"Compliance: mark (PUT /compliance/filings/{key}). Needs a signed-in user with the role SUPER_ADMIN, HR_ADMIN or PAYROLL_ADMIN. On the cloud edition the company’s plan must include the “statutory” feature.","parameters":[{"name":"key","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkFiledDto"}}}},"responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN","PAYROLL_ADMIN"],"x-required-feature":"statutory"}},"/compliance/overtime":{"get":{"operationId":"compliance_overtime","tags":["compliance"],"summary":"Compliance: overtime","description":"Compliance: overtime (GET /compliance/overtime). Needs a signed-in user with the role SUPER_ADMIN, HR_ADMIN, PAYROLL_ADMIN or AUDITOR. On the cloud edition the company’s plan must include the “statutory” feature.","responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN","PAYROLL_ADMIN","AUDITOR"],"x-required-feature":"statutory"}},"/departments":{"get":{"operationId":"departments_departments","tags":["departments"],"summary":"Departments: departments","description":"Departments: departments (GET /departments). Needs a signed-in user of the company; any role.","responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}]},"post":{"operationId":"departments_createDept","tags":["departments"],"summary":"Departments: create dept","description":"Departments: create dept (POST /departments). Needs a signed-in user with the role SUPER_ADMIN or HR_ADMIN.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DepartmentDto"}}}},"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN"]}},"/departments/{id}":{"delete":{"operationId":"departments_deleteDept","tags":["departments"],"summary":"Departments: delete dept","description":"Departments: delete dept (DELETE /departments/{id}). Needs a signed-in user with the role SUPER_ADMIN or HR_ADMIN.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN"]},"patch":{"operationId":"departments_updateDept","tags":["departments"],"summary":"Departments: update dept","description":"Departments: update dept (PATCH /departments/{id}). Needs a signed-in user with the role SUPER_ADMIN or HR_ADMIN.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateDepartmentDto"}}}},"responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN"]}},"/departments/tree":{"get":{"operationId":"departments_tree","tags":["departments"],"summary":"Departments: tree","description":"Departments: tree (GET /departments/tree). Needs a signed-in user of the company; any role.","responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}]}},"/designations":{"get":{"operationId":"designations_designations","tags":["designations"],"summary":"Designations: designations","description":"Designations: designations (GET /designations). Needs a signed-in user of the company; any role.","responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}]},"post":{"operationId":"designations_createDesig","tags":["designations"],"summary":"Designations: create desig","description":"Designations: create desig (POST /designations). Needs a signed-in user with the role SUPER_ADMIN or HR_ADMIN.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DesignationDto"}}}},"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN"]}},"/designations/{id}":{"delete":{"operationId":"designations_deleteDesig","tags":["designations"],"summary":"Designations: delete desig","description":"Designations: delete desig (DELETE /designations/{id}). Needs a signed-in user with the role SUPER_ADMIN or HR_ADMIN.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN"]},"patch":{"operationId":"designations_updateDesig","tags":["designations"],"summary":"Designations: update desig","description":"Designations: update desig (PATCH /designations/{id}). Needs a signed-in user with the role SUPER_ADMIN or HR_ADMIN.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateDesignationDto"}}}},"responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN"]}},"/employees":{"get":{"operationId":"employees_list","tags":["employees"],"summary":"Employees: list","description":"Employees: list (GET /employees). Needs a signed-in user with the role SUPER_ADMIN, HR_ADMIN, PAYROLL_ADMIN, AUDITOR or MANAGER.","parameters":[{"name":"departmentId","in":"query","required":false,"schema":{"type":"string"}},{"name":"designationId","in":"query","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","required":false,"schema":{"type":"string","enum":["ACTIVE","INACTIVE","SUSPENDED","LEFT"]}},{"name":"employmentType","in":"query","required":false,"schema":{"type":"string"}},{"name":"managerId","in":"query","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","required":false,"schema":{"minimum":1,"type":"integer"}},{"name":"limit","in":"query","required":false,"schema":{"maximum":200,"minimum":1,"type":"integer"}},{"name":"search","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN","PAYROLL_ADMIN","AUDITOR","MANAGER"]},"post":{"operationId":"employees_create","tags":["employees"],"summary":"Employees: create","description":"Employees: create (POST /employees). Needs a signed-in user with the role SUPER_ADMIN or HR_ADMIN.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateEmployeeDto"}}}},"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN"]}},"/employees/{id}":{"get":{"operationId":"employees_one","tags":["employees"],"summary":"Employees: one","description":"Employees: one (GET /employees/{id}). Needs a signed-in user of the company; any role.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}]},"patch":{"operationId":"employees_update","tags":["employees"],"summary":"Employees: update","description":"Employees: update (PATCH /employees/{id}). Needs a signed-in user with the role SUPER_ADMIN or HR_ADMIN.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateEmployeeDto"}}}},"responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN"]}},"/employees/{id}/documents":{"get":{"operationId":"employees_documents","tags":["employees"],"summary":"Employees: documents","description":"Employees: documents (GET /employees/{id}/documents). Needs a signed-in user of the company; any role.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}]},"post":{"operationId":"employees_addDocument","tags":["employees"],"summary":"Employees: add document","description":"Employees: add document (POST /employees/{id}/documents). Needs a signed-in user of the company; any role.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"upload":{}},"required":["upload"]}}}},"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}]}},"/employees/{id}/reset-password":{"post":{"operationId":"employees_resetPassword","tags":["employees"],"summary":"Employees: reset password","description":"Employees: reset password (POST /employees/{id}/reset-password). Needs a signed-in user with the role SUPER_ADMIN or HR_ADMIN.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN"]}},"/employees/{id}/status":{"post":{"operationId":"employees_status","tags":["employees"],"summary":"Employees: status","description":"Employees: status (POST /employees/{id}/status). Needs a signed-in user with the role SUPER_ADMIN or HR_ADMIN.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetStatusDto"}}}},"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN"]}},"/employees/directory":{"get":{"operationId":"employees_directory","tags":["employees"],"summary":"Employees: directory","description":"Employees: directory (GET /employees/directory). Needs a signed-in user of the company; any role.","parameters":[{"name":"search","in":"query","required":false,"schema":{"type":"string"}},{"name":"departmentId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}]}},"/employees/documents/{docId}":{"delete":{"operationId":"employees_removeDoc","tags":["employees"],"summary":"Employees: remove doc","description":"Employees: remove doc (DELETE /employees/documents/{docId}). Needs a signed-in user of the company; any role.","parameters":[{"name":"docId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}]}},"/employees/documents/{docId}/download":{"get":{"operationId":"employees_download","tags":["employees"],"summary":"Employees: download","description":"Employees: download (GET /employees/documents/{docId}/download). Needs a signed-in user of the company; any role.","parameters":[{"name":"docId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The file or stream the operation produces (for example a PDF or CSV), sent as a download.","content":{"*/*":{"schema":{"type":"string","format":"binary"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}]}},"/employees/documents/{docId}/verify":{"post":{"operationId":"employees_verify","tags":["employees"],"summary":"Employees: verify","description":"Employees: verify (POST /employees/documents/{docId}/verify). Needs a signed-in user with the role SUPER_ADMIN or HR_ADMIN.","parameters":[{"name":"docId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN"]}},"/employees/import":{"post":{"operationId":"employees_import","tags":["employees"],"summary":"Employees: import","description":"Employees: import (POST /employees/import). Needs a signed-in user with the role SUPER_ADMIN or HR_ADMIN.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportEmployeesDto"}}}},"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN"]}},"/employees/me":{"get":{"operationId":"employees_me","tags":["employees"],"summary":"Employees: me","description":"Employees: me (GET /employees/me). Needs a signed-in user of the company; any role.","responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}]},"patch":{"operationId":"employees_updateMe","tags":["employees"],"summary":"Employees: update me","description":"Employees: update me (PATCH /employees/me). Needs a signed-in user of the company; any role.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSelfDto"}}}},"responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}]}},"/employees/org-chart":{"get":{"operationId":"employees_orgChart","tags":["employees"],"summary":"Employees: org chart","description":"Employees: org chart (GET /employees/org-chart). Needs a signed-in user of the company; any role.","responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}]}},"/expenses/categories":{"get":{"operationId":"expenses_categories","tags":["expenses"],"summary":"Expenses: categories","description":"Expenses: categories (GET /expenses/categories). Needs a signed-in user of the company; any role. On the cloud edition the company’s plan must include the “expenses” feature.","responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-feature":"expenses"}},"/expenses/claims":{"get":{"operationId":"expenses_list","tags":["expenses"],"summary":"Expenses: list","description":"Expenses: list (GET /expenses/claims). Needs a signed-in user of the company; any role. On the cloud edition the company’s plan must include the “expenses” feature.","parameters":[{"name":"scope","in":"query","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-feature":"expenses"},"post":{"operationId":"expenses_create","tags":["expenses"],"summary":"Expenses: create","description":"Expenses: create (POST /expenses/claims). Needs a signed-in user of the company; any role. On the cloud edition the company’s plan must include the “expenses” feature.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExpenseClaimDto"}}}},"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-feature":"expenses"}},"/expenses/claims/{id}":{"delete":{"operationId":"expenses_remove","tags":["expenses"],"summary":"Expenses: remove","description":"Expenses: remove (DELETE /expenses/claims/{id}). Needs a signed-in user of the company; any role. On the cloud edition the company’s plan must include the “expenses” feature.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-feature":"expenses"},"patch":{"operationId":"expenses_update","tags":["expenses"],"summary":"Expenses: update","description":"Expenses: update (PATCH /expenses/claims/{id}). Needs a signed-in user of the company; any role. On the cloud edition the company’s plan must include the “expenses” feature.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateExpenseClaimDto"}}}},"responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-feature":"expenses"}},"/expenses/claims/{id}/approve":{"post":{"operationId":"expenses_approve","tags":["expenses"],"summary":"Expenses: approve","description":"Expenses: approve (POST /expenses/claims/{id}/approve). Needs a signed-in user with the role SUPER_ADMIN, HR_ADMIN, PAYROLL_ADMIN, MANAGER or EMPLOYEE. On the cloud edition the company’s plan must include the “expenses” feature.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExpenseDecisionDto"}}}},"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN","PAYROLL_ADMIN","MANAGER","EMPLOYEE"],"x-required-feature":"expenses"}},"/expenses/claims/{id}/reject":{"post":{"operationId":"expenses_reject","tags":["expenses"],"summary":"Expenses: reject","description":"Expenses: reject (POST /expenses/claims/{id}/reject). Needs a signed-in user with the role SUPER_ADMIN, HR_ADMIN, PAYROLL_ADMIN, MANAGER or EMPLOYEE. On the cloud edition the company’s plan must include the “expenses” feature.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExpenseDecisionDto"}}}},"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN","PAYROLL_ADMIN","MANAGER","EMPLOYEE"],"x-required-feature":"expenses"}},"/expenses/claims/{id}/submit":{"post":{"operationId":"expenses_submit","tags":["expenses"],"summary":"Expenses: submit","description":"Expenses: submit (POST /expenses/claims/{id}/submit). Needs a signed-in user of the company; any role. On the cloud edition the company’s plan must include the “expenses” feature.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-feature":"expenses"}},"/expenses/receipts":{"post":{"operationId":"expenses_upload","tags":["expenses"],"summary":"Expenses: upload","description":"Expenses: upload (POST /expenses/receipts). Needs a signed-in user of the company; any role. On the cloud edition the company’s plan must include the “expenses” feature.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"upload":{}},"required":["upload"]}}}},"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-feature":"expenses"}},"/expenses/receipts/download":{"get":{"operationId":"expenses_receipt","tags":["expenses"],"summary":"Expenses: receipt","description":"Expenses: receipt (GET /expenses/receipts/download). Needs a signed-in user of the company; any role. On the cloud edition the company’s plan must include the “expenses” feature.","parameters":[{"name":"key","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The file or stream the operation produces (for example a PDF or CSV), sent as a download.","content":{"*/*":{"schema":{"type":"string","format":"binary"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-feature":"expenses"}},"/expenses/travel":{"get":{"operationId":"expenses_travel","tags":["expenses"],"summary":"Expenses: travel","description":"Expenses: travel (GET /expenses/travel). Needs a signed-in user of the company; any role. On the cloud edition the company’s plan must include the “expenses” feature.","parameters":[{"name":"scope","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-feature":"expenses"},"post":{"operationId":"expenses_createTravel","tags":["expenses"],"summary":"Expenses: create travel","description":"Expenses: create travel (POST /expenses/travel). Needs a signed-in user of the company; any role. On the cloud edition the company’s plan must include the “expenses” feature.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TravelRequestDto"}}}},"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-feature":"expenses"}},"/expenses/travel/{id}/approve":{"post":{"operationId":"expenses_approveTravel","tags":["expenses"],"summary":"Expenses: approve travel","description":"Expenses: approve travel (POST /expenses/travel/{id}/approve). Needs a signed-in user with the role SUPER_ADMIN, HR_ADMIN, PAYROLL_ADMIN, MANAGER or EMPLOYEE. On the cloud edition the company’s plan must include the “expenses” feature.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"comment":{}},"required":["comment"]}}}},"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN","PAYROLL_ADMIN","MANAGER","EMPLOYEE"],"x-required-feature":"expenses"}},"/expenses/travel/{id}/reject":{"post":{"operationId":"expenses_rejectTravel","tags":["expenses"],"summary":"Expenses: reject travel","description":"Expenses: reject travel (POST /expenses/travel/{id}/reject). Needs a signed-in user with the role SUPER_ADMIN, HR_ADMIN, PAYROLL_ADMIN, MANAGER or EMPLOYEE. On the cloud edition the company’s plan must include the “expenses” feature.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"comment":{}},"required":["comment"]}}}},"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN","PAYROLL_ADMIN","MANAGER","EMPLOYEE"],"x-required-feature":"expenses"}},"/health":{"get":{"operationId":"health_check","tags":["health"],"summary":"Health: check","description":"Health: check (GET /health). No sign-in needed.","responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[]}},"/helpdesk/categories":{"get":{"operationId":"helpdesk_categories","tags":["helpdesk"],"summary":"Helpdesk: categories","description":"Helpdesk: categories (GET /helpdesk/categories). Needs a signed-in user of the company; any role. On the cloud edition the company’s plan must include the “helpdesk” feature.","responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-feature":"helpdesk"}},"/helpdesk/tickets":{"get":{"operationId":"helpdesk_list","tags":["helpdesk"],"summary":"Helpdesk: list","description":"Helpdesk: list (GET /helpdesk/tickets). Needs a signed-in user of the company; any role. On the cloud edition the company’s plan must include the “helpdesk” feature.","parameters":[{"name":"scope","in":"query","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-feature":"helpdesk"},"post":{"operationId":"helpdesk_create","tags":["helpdesk"],"summary":"Helpdesk: create","description":"Helpdesk: create (POST /helpdesk/tickets). Needs a signed-in user of the company; any role. On the cloud edition the company’s plan must include the “helpdesk” feature.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TicketDto"}}}},"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-feature":"helpdesk"}},"/helpdesk/tickets/{id}":{"get":{"operationId":"helpdesk_one","tags":["helpdesk"],"summary":"Helpdesk: one","description":"Helpdesk: one (GET /helpdesk/tickets/{id}). Needs a signed-in user of the company; any role. On the cloud edition the company’s plan must include the “helpdesk” feature.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-feature":"helpdesk"},"patch":{"operationId":"helpdesk_update","tags":["helpdesk"],"summary":"Helpdesk: update","description":"Helpdesk: update (PATCH /helpdesk/tickets/{id}). Needs a signed-in user of the company; any role. On the cloud edition the company’s plan must include the “helpdesk” feature.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TicketUpdateDto"}}}},"responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-feature":"helpdesk"}},"/helpdesk/tickets/{id}/comments":{"post":{"operationId":"helpdesk_comment","tags":["helpdesk"],"summary":"Helpdesk: comment","description":"Helpdesk: comment (POST /helpdesk/tickets/{id}/comments). Needs a signed-in user of the company; any role. On the cloud edition the company’s plan must include the “helpdesk” feature.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommentDto"}}}},"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-feature":"helpdesk"}},"/holidays/calendar":{"get":{"operationId":"holidays_calendar","tags":["holidays"],"summary":"Holidays: calendar","description":"Holidays: calendar (GET /holidays/calendar). Needs a signed-in user of the company; any role.","parameters":[{"name":"year","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}]}},"/holidays/lists":{"get":{"operationId":"holidays_lists","tags":["holidays"],"summary":"Holidays: lists","description":"Holidays: lists (GET /holidays/lists). Needs a signed-in user with the role SUPER_ADMIN or HR_ADMIN.","parameters":[{"name":"year","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN"]},"post":{"operationId":"holidays_create","tags":["holidays"],"summary":"Holidays: create","description":"Holidays: create (POST /holidays/lists). Needs a signed-in user with the role SUPER_ADMIN or HR_ADMIN.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HolidayListDto"}}}},"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN"]}},"/holidays/lists/{id}":{"delete":{"operationId":"holidays_remove","tags":["holidays"],"summary":"Holidays: remove","description":"Holidays: remove (DELETE /holidays/lists/{id}). Needs a signed-in user with the role SUPER_ADMIN or HR_ADMIN.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN"]},"patch":{"operationId":"holidays_update","tags":["holidays"],"summary":"Holidays: update","description":"Holidays: update (PATCH /holidays/lists/{id}). Needs a signed-in user with the role SUPER_ADMIN or HR_ADMIN.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateHolidayListDto"}}}},"responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN"]}},"/leave/accrual/run":{"post":{"operationId":"leave_runAccrual","tags":["leave"],"summary":"Leave: run accrual","description":"Leave: run accrual (POST /leave/accrual/run). Needs a signed-in user with the role SUPER_ADMIN or HR_ADMIN.","responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN"]}},"/leave/allocations":{"get":{"operationId":"leave_allocationsList","tags":["leave"],"summary":"Leave: allocations list","description":"Leave: allocations list (GET /leave/allocations). Needs a signed-in user with the role SUPER_ADMIN or HR_ADMIN.","parameters":[{"name":"employeeId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN"]},"post":{"operationId":"leave_manual","tags":["leave"],"summary":"Leave: manual","description":"Leave: manual (POST /leave/allocations). Needs a signed-in user with the role SUPER_ADMIN or HR_ADMIN.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ManualAllocationDto"}}}},"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN"]}},"/leave/applications":{"get":{"operationId":"leave_list","tags":["leave"],"summary":"Leave: list","description":"Leave: list (GET /leave/applications). Needs a signed-in user of the company; any role.","parameters":[{"name":"scope","in":"query","required":false,"schema":{"enum":["mine","team","all"],"type":"string"}},{"name":"status","in":"query","required":false,"schema":{"enum":["OPEN","APPROVED","REJECTED","CANCELLED"],"type":"string"}},{"name":"employeeId","in":"query","required":false,"schema":{"type":"string"}},{"name":"from","in":"query","required":false,"schema":{"type":"string","description":"ISO 8601 date or date-time"}},{"name":"to","in":"query","required":false,"schema":{"type":"string","description":"ISO 8601 date or date-time"}},{"name":"page","in":"query","required":false,"schema":{"minimum":1,"type":"integer"}},{"name":"limit","in":"query","required":false,"schema":{"maximum":200,"minimum":1,"type":"integer"}},{"name":"search","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}]},"post":{"operationId":"leave_apply","tags":["leave"],"summary":"Leave: apply","description":"Leave: apply (POST /leave/applications). Needs a signed-in user of the company; any role.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplyLeaveDto"}}}},"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}]}},"/leave/applications/{id}/approve":{"post":{"operationId":"leave_approve","tags":["leave"],"summary":"Leave: approve","description":"Leave: approve (POST /leave/applications/{id}/approve). Needs a signed-in user with the role SUPER_ADMIN, HR_ADMIN, PAYROLL_ADMIN, MANAGER or EMPLOYEE.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DecisionDto"}}}},"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN","PAYROLL_ADMIN","MANAGER","EMPLOYEE"]}},"/leave/applications/{id}/cancel":{"post":{"operationId":"leave_cancel","tags":["leave"],"summary":"Leave: cancel","description":"Leave: cancel (POST /leave/applications/{id}/cancel). Needs a signed-in user of the company; any role.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}]}},"/leave/applications/{id}/reject":{"post":{"operationId":"leave_reject","tags":["leave"],"summary":"Leave: reject","description":"Leave: reject (POST /leave/applications/{id}/reject). Needs a signed-in user with the role SUPER_ADMIN, HR_ADMIN, PAYROLL_ADMIN, MANAGER or EMPLOYEE.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DecisionDto"}}}},"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN","PAYROLL_ADMIN","MANAGER","EMPLOYEE"]}},"/leave/applications/pending":{"get":{"operationId":"leave_pending","tags":["leave"],"summary":"Leave: pending","description":"Leave: pending (GET /leave/applications/pending). Needs a signed-in user with the role SUPER_ADMIN, HR_ADMIN, PAYROLL_ADMIN, MANAGER or EMPLOYEE.","responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN","PAYROLL_ADMIN","MANAGER","EMPLOYEE"]}},"/leave/balance":{"get":{"operationId":"leave_balance","tags":["leave"],"summary":"Leave: balance","description":"Leave: balance (GET /leave/balance). Needs a signed-in user of the company; any role.","parameters":[{"name":"employeeId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}]}},"/leave/calendar":{"get":{"operationId":"leave_calendar","tags":["leave"],"summary":"Leave: calendar","description":"Leave: calendar (GET /leave/calendar). Needs a signed-in user of the company; any role.","parameters":[{"name":"year","in":"query","required":false,"schema":{"type":"string"}},{"name":"month","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}]}},"/leave/comp-off":{"get":{"operationId":"leave_compOff","tags":["leave"],"summary":"Leave: comp off","description":"Leave: comp off (GET /leave/comp-off). Needs a signed-in user of the company; any role.","parameters":[{"name":"scope","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}]},"post":{"operationId":"leave_requestComp","tags":["leave"],"summary":"Leave: request comp","description":"Leave: request comp (POST /leave/comp-off). Needs a signed-in user of the company; any role.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompOffDto"}}}},"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}]}},"/leave/comp-off/{id}/approve":{"post":{"operationId":"leave_approveComp","tags":["leave"],"summary":"Leave: approve comp","description":"Leave: approve comp (POST /leave/comp-off/{id}/approve). Needs a signed-in user with the role SUPER_ADMIN, HR_ADMIN, PAYROLL_ADMIN, MANAGER or EMPLOYEE.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DecisionDto"}}}},"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN","PAYROLL_ADMIN","MANAGER","EMPLOYEE"]}},"/leave/comp-off/{id}/reject":{"post":{"operationId":"leave_rejectComp","tags":["leave"],"summary":"Leave: reject comp","description":"Leave: reject comp (POST /leave/comp-off/{id}/reject). Needs a signed-in user with the role SUPER_ADMIN, HR_ADMIN, PAYROLL_ADMIN, MANAGER or EMPLOYEE.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DecisionDto"}}}},"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN","PAYROLL_ADMIN","MANAGER","EMPLOYEE"]}},"/leave/encashments":{"get":{"operationId":"leave_encashments","tags":["leave"],"summary":"Leave: encashments","description":"Leave: encashments (GET /leave/encashments). Needs a signed-in user of the company; any role.","responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}]},"post":{"operationId":"leave_requestEnc","tags":["leave"],"summary":"Leave: request enc","description":"Leave: request enc (POST /leave/encashments). Needs a signed-in user of the company; any role.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EncashmentDto"}}}},"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}]}},"/leave/encashments/{id}/approve":{"post":{"operationId":"leave_approveEnc","tags":["leave"],"summary":"Leave: approve enc","description":"Leave: approve enc (POST /leave/encashments/{id}/approve). Needs a signed-in user with the role SUPER_ADMIN or HR_ADMIN.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN"]}},"/leave/encashments/{id}/reject":{"post":{"operationId":"leave_rejectEnc","tags":["leave"],"summary":"Leave: reject enc","description":"Leave: reject enc (POST /leave/encashments/{id}/reject). Needs a signed-in user with the role SUPER_ADMIN or HR_ADMIN.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN"]}},"/leave/policies":{"get":{"operationId":"leave_policies","tags":["leave"],"summary":"Leave: policies","description":"Leave: policies (GET /leave/policies). Needs a signed-in user with the role SUPER_ADMIN or HR_ADMIN.","responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN"]},"post":{"operationId":"leave_createPolicy","tags":["leave"],"summary":"Leave: create policy","description":"Leave: create policy (POST /leave/policies). Needs a signed-in user with the role SUPER_ADMIN or HR_ADMIN.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LeavePolicyDto"}}}},"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN"]}},"/leave/policies/{id}":{"patch":{"operationId":"leave_updatePolicy","tags":["leave"],"summary":"Leave: update policy","description":"Leave: update policy (PATCH /leave/policies/{id}). Needs a signed-in user with the role SUPER_ADMIN or HR_ADMIN.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateLeavePolicyDto"}}}},"responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN"]}},"/leave/policies/{id}/assign":{"post":{"operationId":"leave_assign","tags":["leave"],"summary":"Leave: assign","description":"Leave: assign (POST /leave/policies/{id}/assign). Needs a signed-in user with the role SUPER_ADMIN or HR_ADMIN.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssignPolicyDto"}}}},"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN"]}},"/leave/preview":{"post":{"operationId":"leave_preview","tags":["leave"],"summary":"Leave: preview","description":"Leave: preview (POST /leave/preview). Needs a signed-in user of the company; any role.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplyLeaveDto"}}}},"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}]}},"/leave/rollover/{year}":{"post":{"operationId":"leave_rollover","tags":["leave"],"summary":"Leave: rollover","description":"Leave: rollover (POST /leave/rollover/{year}). Needs a signed-in user with the role SUPER_ADMIN or HR_ADMIN.","parameters":[{"name":"year","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN"]}},"/leave/types":{"get":{"operationId":"leave_types","tags":["leave"],"summary":"Leave: types","description":"Leave: types (GET /leave/types). Needs a signed-in user of the company; any role.","responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}]},"post":{"operationId":"leave_createType","tags":["leave"],"summary":"Leave: create type","description":"Leave: create type (POST /leave/types). Needs a signed-in user with the role SUPER_ADMIN or HR_ADMIN.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LeaveTypeDto"}}}},"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN"]}},"/leave/types/{id}":{"delete":{"operationId":"leave_deleteType","tags":["leave"],"summary":"Leave: delete type","description":"Leave: delete type (DELETE /leave/types/{id}). Needs a signed-in user with the role SUPER_ADMIN or HR_ADMIN.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN"]},"patch":{"operationId":"leave_updateType","tags":["leave"],"summary":"Leave: update type","description":"Leave: update type (PATCH /leave/types/{id}). Needs a signed-in user with the role SUPER_ADMIN or HR_ADMIN.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateLeaveTypeDto"}}}},"responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN"]}},"/lifecycle/clearances/{id}":{"patch":{"operationId":"lifecycle_clearance","tags":["lifecycle"],"summary":"Lifecycle: clearance","description":"Lifecycle: clearance (PATCH /lifecycle/clearances/{id}). Needs a signed-in user with the role SUPER_ADMIN or HR_ADMIN. On the cloud edition the company’s plan must include the “lifecycle” feature.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClearanceUpdateDto"}}}},"responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN"],"x-required-feature":"lifecycle"}},"/lifecycle/onboarding":{"get":{"operationId":"lifecycle_listOnboarding","tags":["lifecycle"],"summary":"Lifecycle: list onboarding","description":"Lifecycle: list onboarding (GET /lifecycle/onboarding). Needs a signed-in user with the role SUPER_ADMIN, HR_ADMIN, PAYROLL_ADMIN or AUDITOR. On the cloud edition the company’s plan must include the “lifecycle” feature.","parameters":[{"name":"all","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN","PAYROLL_ADMIN","AUDITOR"],"x-required-feature":"lifecycle"}},"/lifecycle/onboarding-templates":{"get":{"operationId":"lifecycle_templates","tags":["lifecycle"],"summary":"Lifecycle: templates","description":"Lifecycle: templates (GET /lifecycle/onboarding-templates). Needs a signed-in user with the role SUPER_ADMIN, HR_ADMIN, PAYROLL_ADMIN or AUDITOR. On the cloud edition the company’s plan must include the “lifecycle” feature.","responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN","PAYROLL_ADMIN","AUDITOR"],"x-required-feature":"lifecycle"},"post":{"operationId":"lifecycle_createTemplate","tags":["lifecycle"],"summary":"Lifecycle: create template","description":"Lifecycle: create template (POST /lifecycle/onboarding-templates). Needs a signed-in user with the role SUPER_ADMIN or HR_ADMIN. On the cloud edition the company’s plan must include the “lifecycle” feature.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OnboardingTemplateDto"}}}},"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN"],"x-required-feature":"lifecycle"}},"/lifecycle/onboarding-templates/{id}":{"patch":{"operationId":"lifecycle_updateTemplate","tags":["lifecycle"],"summary":"Lifecycle: update template","description":"Lifecycle: update template (PATCH /lifecycle/onboarding-templates/{id}). Needs a signed-in user with the role SUPER_ADMIN or HR_ADMIN. On the cloud edition the company’s plan must include the “lifecycle” feature.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateOnboardingTemplateDto"}}}},"responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN"],"x-required-feature":"lifecycle"}},"/lifecycle/onboarding/{employeeId}/start":{"post":{"operationId":"lifecycle_startOnboarding","tags":["lifecycle"],"summary":"Lifecycle: start onboarding","description":"Lifecycle: start onboarding (POST /lifecycle/onboarding/{employeeId}/start). Needs a signed-in user with the role SUPER_ADMIN or HR_ADMIN. On the cloud edition the company’s plan must include the “lifecycle” feature.","parameters":[{"name":"employeeId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN"],"x-required-feature":"lifecycle"}},"/lifecycle/onboarding/employee/{employeeId}":{"get":{"operationId":"lifecycle_getOnboarding","tags":["lifecycle"],"summary":"Lifecycle: get onboarding","description":"Lifecycle: get onboarding (GET /lifecycle/onboarding/employee/{employeeId}). Needs a signed-in user of the company; any role. On the cloud edition the company’s plan must include the “lifecycle” feature.","parameters":[{"name":"employeeId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-feature":"lifecycle"}},"/lifecycle/onboarding/remind":{"post":{"operationId":"lifecycle_remind","tags":["lifecycle"],"summary":"Lifecycle: remind","description":"Lifecycle: remind (POST /lifecycle/onboarding/remind). Needs a signed-in user with the role SUPER_ADMIN or HR_ADMIN. On the cloud edition the company’s plan must include the “lifecycle” feature.","responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN"],"x-required-feature":"lifecycle"}},"/lifecycle/onboarding/tasks/{taskId}":{"patch":{"operationId":"lifecycle_updateTask","tags":["lifecycle"],"summary":"Lifecycle: update task","description":"Lifecycle: update task (PATCH /lifecycle/onboarding/tasks/{taskId}). Needs a signed-in user of the company; any role. On the cloud edition the company’s plan must include the “lifecycle” feature.","parameters":[{"name":"taskId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskUpdateDto"}}}},"responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-feature":"lifecycle"}},"/lifecycle/resign":{"post":{"operationId":"lifecycle_resign","tags":["lifecycle"],"summary":"Lifecycle: resign","description":"Lifecycle: resign (POST /lifecycle/resign). Needs a signed-in user of the company; any role. On the cloud edition the company’s plan must include the “lifecycle” feature.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResignDto"}}}},"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-feature":"lifecycle"}},"/lifecycle/separations":{"get":{"operationId":"lifecycle_list","tags":["lifecycle"],"summary":"Lifecycle: list","description":"Lifecycle: list (GET /lifecycle/separations). Needs a signed-in user of the company; any role. On the cloud edition the company’s plan must include the “lifecycle” feature.","responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-feature":"lifecycle"},"post":{"operationId":"lifecycle_initiate","tags":["lifecycle"],"summary":"Lifecycle: initiate","description":"Lifecycle: initiate (POST /lifecycle/separations). Needs a signed-in user with the role SUPER_ADMIN or HR_ADMIN. On the cloud edition the company’s plan must include the “lifecycle” feature.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InitiateSeparationDto"}}}},"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN"],"x-required-feature":"lifecycle"}},"/lifecycle/separations/{id}":{"get":{"operationId":"lifecycle_one","tags":["lifecycle"],"summary":"Lifecycle: one","description":"Lifecycle: one (GET /lifecycle/separations/{id}). Needs a signed-in user of the company; any role. On the cloud edition the company’s plan must include the “lifecycle” feature.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-feature":"lifecycle"}},"/lifecycle/separations/{id}/approve":{"post":{"operationId":"lifecycle_approve","tags":["lifecycle"],"summary":"Lifecycle: approve","description":"Lifecycle: approve (POST /lifecycle/separations/{id}/approve). Needs a signed-in user with the role SUPER_ADMIN, HR_ADMIN, PAYROLL_ADMIN, MANAGER or EMPLOYEE. On the cloud edition the company’s plan must include the “lifecycle” feature.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SeparationDecisionDto"}}}},"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN","PAYROLL_ADMIN","MANAGER","EMPLOYEE"],"x-required-feature":"lifecycle"}},"/lifecycle/separations/{id}/complete":{"post":{"operationId":"lifecycle_complete","tags":["lifecycle"],"summary":"Lifecycle: complete","description":"Lifecycle: complete (POST /lifecycle/separations/{id}/complete). Needs a signed-in user with the role SUPER_ADMIN or HR_ADMIN. On the cloud edition the company’s plan must include the “lifecycle” feature.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN"],"x-required-feature":"lifecycle"}},"/lifecycle/separations/{id}/exit-interview":{"post":{"operationId":"lifecycle_exitInterview","tags":["lifecycle"],"summary":"Lifecycle: exit interview","description":"Lifecycle: exit interview (POST /lifecycle/separations/{id}/exit-interview). Needs a signed-in user with the role SUPER_ADMIN or HR_ADMIN. On the cloud edition the company’s plan must include the “lifecycle” feature.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExitInterviewDto"}}}},"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN"],"x-required-feature":"lifecycle"}},"/lifecycle/separations/{id}/fnf":{"post":{"operationId":"lifecycle_fnf","tags":["lifecycle"],"summary":"Lifecycle: fnf","description":"Lifecycle: fnf (POST /lifecycle/separations/{id}/fnf). Needs a signed-in user with the role SUPER_ADMIN, HR_ADMIN or PAYROLL_ADMIN. On the cloud edition the company’s plan must include the “lifecycle” feature.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FnfDto"}}}},"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN","PAYROLL_ADMIN"],"x-required-feature":"lifecycle"}},"/lifecycle/separations/{id}/fnf/approve":{"post":{"operationId":"lifecycle_approveFnf","tags":["lifecycle"],"summary":"Lifecycle: approve fnf","description":"Lifecycle: approve fnf (POST /lifecycle/separations/{id}/fnf/approve). Needs a signed-in user with the role SUPER_ADMIN, HR_ADMIN or PAYROLL_ADMIN. On the cloud edition the company’s plan must include the “lifecycle” feature.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN","PAYROLL_ADMIN"],"x-required-feature":"lifecycle"}},"/lifecycle/separations/{id}/letter":{"get":{"operationId":"lifecycle_letter","tags":["lifecycle"],"summary":"Lifecycle: letter","description":"Lifecycle: letter (GET /lifecycle/separations/{id}/letter). Needs a signed-in user with the role SUPER_ADMIN or HR_ADMIN. On the cloud edition the company’s plan must include the “lifecycle” feature.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"type","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The file or stream the operation produces (for example a PDF or CSV), sent as a download.","content":{"*/*":{"schema":{"type":"string","format":"binary"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN"],"x-required-feature":"lifecycle"}},"/lifecycle/separations/{id}/reject":{"post":{"operationId":"lifecycle_reject","tags":["lifecycle"],"summary":"Lifecycle: reject","description":"Lifecycle: reject (POST /lifecycle/separations/{id}/reject). Needs a signed-in user with the role SUPER_ADMIN, HR_ADMIN, PAYROLL_ADMIN, MANAGER or EMPLOYEE. On the cloud edition the company’s plan must include the “lifecycle” feature.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SeparationDecisionDto"}}}},"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN","PAYROLL_ADMIN","MANAGER","EMPLOYEE"],"x-required-feature":"lifecycle"}},"/masters/states":{"get":{"operationId":"masters_states","tags":["masters"],"summary":"Masters: states","description":"Masters: states (GET /masters/states). No sign-in needed.","responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[]}},"/meta/runtime":{"get":{"operationId":"meta_runtime","tags":["meta"],"summary":"Meta: runtime","description":"Meta: runtime (GET /meta/runtime). No sign-in needed.","responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[]}},"/notifications":{"get":{"operationId":"notifications_list","tags":["notifications"],"summary":"Notifications: list","description":"Notifications: list (GET /notifications). Needs a signed-in user of the company; any role.","parameters":[{"name":"unread","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}]}},"/notifications/{id}/read":{"patch":{"operationId":"notifications_read","tags":["notifications"],"summary":"Notifications: read","description":"Notifications: read (PATCH /notifications/{id}/read). Needs a signed-in user of the company; any role.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}]}},"/notifications/read-all":{"post":{"operationId":"notifications_readAll","tags":["notifications"],"summary":"Notifications: read all","description":"Notifications: read all (POST /notifications/read-all). Needs a signed-in user of the company; any role.","responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}]}},"/notifications/realtime":{"get":{"operationId":"notifications_realtime","tags":["notifications"],"summary":"Notifications: realtime","description":"Notifications: realtime (GET /notifications/realtime). Needs a signed-in user of the company; any role.","responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}]}},"/notifications/unread-count":{"get":{"operationId":"notifications_count","tags":["notifications"],"summary":"Notifications: count","description":"Notifications: count (GET /notifications/unread-count). Needs a signed-in user of the company; any role.","responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}]}},"/payroll/additional":{"get":{"operationId":"payroll_additional","tags":["payroll"],"summary":"Payroll: additional","description":"Payroll: additional (GET /payroll/additional). Needs a signed-in user with the role SUPER_ADMIN, HR_ADMIN, PAYROLL_ADMIN or AUDITOR. On the cloud edition the company’s plan must include the “payroll” feature.","parameters":[{"name":"employeeId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN","PAYROLL_ADMIN","AUDITOR"],"x-required-feature":"payroll"},"post":{"operationId":"payroll_createAdditional","tags":["payroll"],"summary":"Payroll: create additional","description":"Payroll: create additional (POST /payroll/additional). Needs a signed-in user with the role SUPER_ADMIN, HR_ADMIN or PAYROLL_ADMIN. On the cloud edition the company’s plan must include the “payroll” feature.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdditionalSalaryDto"}}}},"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN","PAYROLL_ADMIN"],"x-required-feature":"payroll"}},"/payroll/additional/{id}":{"delete":{"operationId":"payroll_deleteAdditional","tags":["payroll"],"summary":"Payroll: delete additional","description":"Payroll: delete additional (DELETE /payroll/additional/{id}). Needs a signed-in user with the role SUPER_ADMIN, HR_ADMIN or PAYROLL_ADMIN. On the cloud edition the company’s plan must include the “payroll” feature.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN","PAYROLL_ADMIN"],"x-required-feature":"payroll"}},"/payroll/assignments":{"get":{"operationId":"payroll_assignments","tags":["payroll"],"summary":"Payroll: assignments","description":"Payroll: assignments (GET /payroll/assignments). Needs a signed-in user with the role SUPER_ADMIN, HR_ADMIN, PAYROLL_ADMIN or AUDITOR. On the cloud edition the company’s plan must include the “payroll” feature.","parameters":[{"name":"employeeId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN","PAYROLL_ADMIN","AUDITOR"],"x-required-feature":"payroll"},"post":{"operationId":"payroll_assign","tags":["payroll"],"summary":"Payroll: assign","description":"Payroll: assign (POST /payroll/assignments). Needs a signed-in user with the role SUPER_ADMIN, HR_ADMIN or PAYROLL_ADMIN. On the cloud edition the company’s plan must include the “payroll” feature.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssignmentDto"}}}},"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN","PAYROLL_ADMIN"],"x-required-feature":"payroll"}},"/payroll/assignments/bulk":{"post":{"operationId":"payroll_bulkAssign","tags":["payroll"],"summary":"Payroll: bulk assign","description":"Payroll: bulk assign (POST /payroll/assignments/bulk). Needs a signed-in user with the role SUPER_ADMIN, HR_ADMIN or PAYROLL_ADMIN. On the cloud edition the company’s plan must include the “payroll” feature.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkAssignmentDto"}}}},"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN","PAYROLL_ADMIN"],"x-required-feature":"payroll"}},"/payroll/components":{"get":{"operationId":"payroll_components","tags":["payroll"],"summary":"Payroll: components","description":"Payroll: components (GET /payroll/components). Needs a signed-in user with the role SUPER_ADMIN, HR_ADMIN, PAYROLL_ADMIN or AUDITOR. On the cloud edition the company’s plan must include the “payroll” feature.","responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN","PAYROLL_ADMIN","AUDITOR"],"x-required-feature":"payroll"},"post":{"operationId":"payroll_createComponent","tags":["payroll"],"summary":"Payroll: create component","description":"Payroll: create component (POST /payroll/components). Needs a signed-in user with the role SUPER_ADMIN, HR_ADMIN or PAYROLL_ADMIN. On the cloud edition the company’s plan must include the “payroll” feature.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SalaryComponentDto"}}}},"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN","PAYROLL_ADMIN"],"x-required-feature":"payroll"}},"/payroll/components/{id}":{"delete":{"operationId":"payroll_deleteComponent","tags":["payroll"],"summary":"Payroll: delete component","description":"Payroll: delete component (DELETE /payroll/components/{id}). Needs a signed-in user with the role SUPER_ADMIN, HR_ADMIN or PAYROLL_ADMIN. On the cloud edition the company’s plan must include the “payroll” feature.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN","PAYROLL_ADMIN"],"x-required-feature":"payroll"},"patch":{"operationId":"payroll_updateComponent","tags":["payroll"],"summary":"Payroll: update component","description":"Payroll: update component (PATCH /payroll/components/{id}). Needs a signed-in user with the role SUPER_ADMIN, HR_ADMIN or PAYROLL_ADMIN. On the cloud edition the company’s plan must include the “payroll” feature.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSalaryComponentDto"}}}},"responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN","PAYROLL_ADMIN"],"x-required-feature":"payroll"}},"/payroll/loans":{"get":{"operationId":"payroll_loans","tags":["payroll"],"summary":"Payroll: loans","description":"Payroll: loans (GET /payroll/loans). Needs a signed-in user with the role SUPER_ADMIN, HR_ADMIN, PAYROLL_ADMIN or AUDITOR. On the cloud edition the company’s plan must include the “payroll” feature.","parameters":[{"name":"employeeId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN","PAYROLL_ADMIN","AUDITOR"],"x-required-feature":"payroll"},"post":{"operationId":"payroll_createLoan","tags":["payroll"],"summary":"Payroll: create loan","description":"Payroll: create loan (POST /payroll/loans). Needs a signed-in user with the role SUPER_ADMIN, HR_ADMIN or PAYROLL_ADMIN. On the cloud edition the company’s plan must include the “payroll” feature.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoanDto"}}}},"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN","PAYROLL_ADMIN"],"x-required-feature":"payroll"}},"/payroll/loans/{id}/close":{"post":{"operationId":"payroll_closeLoan","tags":["payroll"],"summary":"Payroll: close loan","description":"Payroll: close loan (POST /payroll/loans/{id}/close). Needs a signed-in user with the role SUPER_ADMIN, HR_ADMIN or PAYROLL_ADMIN. On the cloud edition the company’s plan must include the “payroll” feature.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN","PAYROLL_ADMIN"],"x-required-feature":"payroll"}},"/payroll/payslips/{id}":{"get":{"operationId":"payroll_slip","tags":["payroll"],"summary":"Payroll: slip","description":"Payroll: slip (GET /payroll/payslips/{id}). Needs a signed-in user of the company; any role. On the cloud edition the company’s plan must include the “payroll” feature.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-feature":"payroll"}},"/payroll/payslips/{id}/pdf":{"get":{"operationId":"payroll_slipPdf","tags":["payroll"],"summary":"Payroll: slip pdf","description":"Payroll: slip pdf (GET /payroll/payslips/{id}/pdf). Needs a signed-in user of the company; any role. On the cloud edition the company’s plan must include the “payroll” feature.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The file or stream the operation produces (for example a PDF or CSV), sent as a download.","content":{"*/*":{"schema":{"type":"string","format":"binary"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-feature":"payroll"}},"/payroll/payslips/employee/{employeeId}":{"get":{"operationId":"payroll_empSlips","tags":["payroll"],"summary":"Payroll: emp slips","description":"Payroll: emp slips (GET /payroll/payslips/employee/{employeeId}). Needs a signed-in user with the role SUPER_ADMIN, HR_ADMIN or PAYROLL_ADMIN. On the cloud edition the company’s plan must include the “payroll” feature.","parameters":[{"name":"employeeId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN","PAYROLL_ADMIN"],"x-required-feature":"payroll"}},"/payroll/payslips/me":{"get":{"operationId":"payroll_mySlips","tags":["payroll"],"summary":"Payroll: my slips","description":"Payroll: my slips (GET /payroll/payslips/me). Needs a signed-in user of the company; any role. On the cloud edition the company’s plan must include the “payroll” feature.","responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-feature":"payroll"}},"/payroll/preview":{"get":{"operationId":"payroll_preview","tags":["payroll"],"summary":"Payroll: preview","description":"Payroll: preview (GET /payroll/preview). Needs a signed-in user with the role SUPER_ADMIN, HR_ADMIN or PAYROLL_ADMIN. On the cloud edition the company’s plan must include the “payroll” feature.","parameters":[{"name":"employeeId","in":"query","required":false,"schema":{"type":"string"}},{"name":"month","in":"query","required":false,"schema":{"type":"string"}},{"name":"year","in":"query","required":false,"schema":{"type":"string"}},{"name":"treatUnmarkedAsLop","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN","PAYROLL_ADMIN"],"x-required-feature":"payroll"}},"/payroll/reports/24q":{"get":{"operationId":"payroll_q24","tags":["payroll"],"summary":"Payroll: q24","description":"Payroll: q24 (GET /payroll/reports/24q). Needs a signed-in user with the role SUPER_ADMIN, HR_ADMIN, PAYROLL_ADMIN or AUDITOR. On the cloud edition the company’s plan must include the “payroll” feature.","parameters":[{"name":"fy","in":"query","required":false,"schema":{"type":"string"}},{"name":"quarter","in":"query","required":false,"schema":{"type":"string"}},{"name":"format","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The file or stream the operation produces (for example a PDF or CSV), sent as a download.","content":{"*/*":{"schema":{"type":"string","format":"binary"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN","PAYROLL_ADMIN","AUDITOR"],"x-required-feature":"payroll"}},"/payroll/reports/bank-advice":{"get":{"operationId":"payroll_bank","tags":["payroll"],"summary":"Payroll: bank","description":"Payroll: bank (GET /payroll/reports/bank-advice). Needs a signed-in user with the role SUPER_ADMIN, HR_ADMIN or PAYROLL_ADMIN. On the cloud edition the company’s plan must include the “payroll” feature.","parameters":[{"name":"month","in":"query","required":true,"schema":{"maximum":12,"minimum":1,"type":"integer"}},{"name":"year","in":"query","required":true,"schema":{"maximum":2100,"minimum":2000,"type":"integer"}},{"name":"format","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The file or stream the operation produces (for example a PDF or CSV), sent as a download.","content":{"*/*":{"schema":{"type":"string","format":"binary"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN","PAYROLL_ADMIN"],"x-required-feature":"payroll"}},"/payroll/reports/bonus":{"get":{"operationId":"payroll_bonus","tags":["payroll"],"summary":"Payroll: bonus","description":"Payroll: bonus (GET /payroll/reports/bonus). Needs a signed-in user with the role SUPER_ADMIN, HR_ADMIN, PAYROLL_ADMIN or AUDITOR. On the cloud edition the company’s plan must include the “payroll” feature.","parameters":[{"name":"fy","in":"query","required":false,"schema":{"type":"string"}},{"name":"rate","in":"query","required":false,"schema":{"type":"string"}},{"name":"format","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The file or stream the operation produces (for example a PDF or CSV), sent as a download.","content":{"*/*":{"schema":{"type":"string","format":"binary"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN","PAYROLL_ADMIN","AUDITOR"],"x-required-feature":"payroll"}},"/payroll/reports/ecr":{"get":{"operationId":"payroll_ecr","tags":["payroll"],"summary":"Payroll: ecr","description":"Payroll: ecr (GET /payroll/reports/ecr). Needs a signed-in user with the role SUPER_ADMIN, HR_ADMIN, PAYROLL_ADMIN or AUDITOR. On the cloud edition the company’s plan must include the “payroll” feature.","parameters":[{"name":"month","in":"query","required":true,"schema":{"maximum":12,"minimum":1,"type":"integer"}},{"name":"year","in":"query","required":true,"schema":{"maximum":2100,"minimum":2000,"type":"integer"}},{"name":"format","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The file or stream the operation produces (for example a PDF or CSV), sent as a download.","content":{"*/*":{"schema":{"type":"string","format":"binary"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN","PAYROLL_ADMIN","AUDITOR"],"x-required-feature":"payroll"}},"/payroll/reports/esi":{"get":{"operationId":"payroll_esi","tags":["payroll"],"summary":"Payroll: esi","description":"Payroll: esi (GET /payroll/reports/esi). Needs a signed-in user with the role SUPER_ADMIN, HR_ADMIN, PAYROLL_ADMIN or AUDITOR. On the cloud edition the company’s plan must include the “payroll” feature.","parameters":[{"name":"month","in":"query","required":true,"schema":{"maximum":12,"minimum":1,"type":"integer"}},{"name":"year","in":"query","required":true,"schema":{"maximum":2100,"minimum":2000,"type":"integer"}},{"name":"format","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The file or stream the operation produces (for example a PDF or CSV), sent as a download.","content":{"*/*":{"schema":{"type":"string","format":"binary"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN","PAYROLL_ADMIN","AUDITOR"],"x-required-feature":"payroll"}},"/payroll/reports/pt":{"get":{"operationId":"payroll_pt","tags":["payroll"],"summary":"Payroll: pt","description":"Payroll: pt (GET /payroll/reports/pt). Needs a signed-in user with the role SUPER_ADMIN, HR_ADMIN, PAYROLL_ADMIN or AUDITOR. On the cloud edition the company’s plan must include the “payroll” feature.","parameters":[{"name":"month","in":"query","required":true,"schema":{"maximum":12,"minimum":1,"type":"integer"}},{"name":"year","in":"query","required":true,"schema":{"maximum":2100,"minimum":2000,"type":"integer"}},{"name":"format","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The file or stream the operation produces (for example a PDF or CSV), sent as a download.","content":{"*/*":{"schema":{"type":"string","format":"binary"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN","PAYROLL_ADMIN","AUDITOR"],"x-required-feature":"payroll"}},"/payroll/reports/register":{"get":{"operationId":"payroll_register","tags":["payroll"],"summary":"Payroll: register","description":"Payroll: register (GET /payroll/reports/register). Needs a signed-in user with the role SUPER_ADMIN, HR_ADMIN, PAYROLL_ADMIN or AUDITOR. On the cloud edition the company’s plan must include the “payroll” feature.","parameters":[{"name":"month","in":"query","required":true,"schema":{"maximum":12,"minimum":1,"type":"integer"}},{"name":"year","in":"query","required":true,"schema":{"maximum":2100,"minimum":2000,"type":"integer"}},{"name":"format","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The file or stream the operation produces (for example a PDF or CSV), sent as a download.","content":{"*/*":{"schema":{"type":"string","format":"binary"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN","PAYROLL_ADMIN","AUDITOR"],"x-required-feature":"payroll"}},"/payroll/runs":{"get":{"operationId":"payroll_runs","tags":["payroll"],"summary":"Payroll: runs","description":"Payroll: runs (GET /payroll/runs). Needs a signed-in user with the role SUPER_ADMIN, HR_ADMIN, PAYROLL_ADMIN or AUDITOR. On the cloud edition the company’s plan must include the “payroll” feature.","responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN","PAYROLL_ADMIN","AUDITOR"],"x-required-feature":"payroll"},"post":{"operationId":"payroll_createRun","tags":["payroll"],"summary":"Payroll: create run","description":"Payroll: create run (POST /payroll/runs). Needs a signed-in user with the role SUPER_ADMIN, HR_ADMIN or PAYROLL_ADMIN. On the cloud edition the company’s plan must include the “payroll” feature.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunDto"}}}},"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN","PAYROLL_ADMIN"],"x-required-feature":"payroll"}},"/payroll/runs/{id}":{"delete":{"operationId":"payroll_deleteRun","tags":["payroll"],"summary":"Payroll: delete run","description":"Payroll: delete run (DELETE /payroll/runs/{id}). Needs a signed-in user with the role SUPER_ADMIN, HR_ADMIN or PAYROLL_ADMIN. On the cloud edition the company’s plan must include the “payroll” feature.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN","PAYROLL_ADMIN"],"x-required-feature":"payroll"},"get":{"operationId":"payroll_run","tags":["payroll"],"summary":"Payroll: run","description":"Payroll: run (GET /payroll/runs/{id}). Needs a signed-in user with the role SUPER_ADMIN, HR_ADMIN, PAYROLL_ADMIN or AUDITOR. On the cloud edition the company’s plan must include the “payroll” feature.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN","PAYROLL_ADMIN","AUDITOR"],"x-required-feature":"payroll"}},"/payroll/runs/{id}/approve":{"post":{"operationId":"payroll_approve","tags":["payroll"],"summary":"Payroll: approve","description":"Payroll: approve (POST /payroll/runs/{id}/approve). Needs a signed-in user with the role SUPER_ADMIN, HR_ADMIN or PAYROLL_ADMIN. On the cloud edition the company’s plan must include the “payroll” feature.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN","PAYROLL_ADMIN"],"x-required-feature":"payroll"}},"/payroll/runs/{id}/generate":{"post":{"operationId":"payroll_generate","tags":["payroll"],"summary":"Payroll: generate","description":"Payroll: generate (POST /payroll/runs/{id}/generate). Needs a signed-in user with the role SUPER_ADMIN, HR_ADMIN or PAYROLL_ADMIN. On the cloud edition the company’s plan must include the “payroll” feature.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"treatUnmarkedAsLop":{}},"required":["treatUnmarkedAsLop"]}}}},"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN","PAYROLL_ADMIN"],"x-required-feature":"payroll"}},"/payroll/runs/{id}/paid":{"post":{"operationId":"payroll_paid","tags":["payroll"],"summary":"Payroll: paid","description":"Payroll: paid (POST /payroll/runs/{id}/paid). Needs a signed-in user with the role SUPER_ADMIN, HR_ADMIN or PAYROLL_ADMIN. On the cloud edition the company’s plan must include the “payroll” feature.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN","PAYROLL_ADMIN"],"x-required-feature":"payroll"}},"/payroll/runs/{id}/reopen":{"post":{"operationId":"payroll_reopen","tags":["payroll"],"summary":"Payroll: reopen","description":"Payroll: reopen (POST /payroll/runs/{id}/reopen). Needs a signed-in user with the role SUPER_ADMIN, HR_ADMIN or PAYROLL_ADMIN. On the cloud edition the company’s plan must include the “payroll” feature.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN","PAYROLL_ADMIN"],"x-required-feature":"payroll"}},"/payroll/structures":{"get":{"operationId":"payroll_structures","tags":["payroll"],"summary":"Payroll: structures","description":"Payroll: structures (GET /payroll/structures). Needs a signed-in user with the role SUPER_ADMIN, HR_ADMIN, PAYROLL_ADMIN or AUDITOR. On the cloud edition the company’s plan must include the “payroll” feature.","responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN","PAYROLL_ADMIN","AUDITOR"],"x-required-feature":"payroll"},"post":{"operationId":"payroll_createStructure","tags":["payroll"],"summary":"Payroll: create structure","description":"Payroll: create structure (POST /payroll/structures). Needs a signed-in user with the role SUPER_ADMIN, HR_ADMIN or PAYROLL_ADMIN. On the cloud edition the company’s plan must include the “payroll” feature.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SalaryStructureDto"}}}},"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN","PAYROLL_ADMIN"],"x-required-feature":"payroll"}},"/payroll/structures/{id}":{"delete":{"operationId":"payroll_deleteStructure","tags":["payroll"],"summary":"Payroll: delete structure","description":"Payroll: delete structure (DELETE /payroll/structures/{id}). Needs a signed-in user with the role SUPER_ADMIN, HR_ADMIN or PAYROLL_ADMIN. On the cloud edition the company’s plan must include the “payroll” feature.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN","PAYROLL_ADMIN"],"x-required-feature":"payroll"},"patch":{"operationId":"payroll_updateStructure","tags":["payroll"],"summary":"Payroll: update structure","description":"Payroll: update structure (PATCH /payroll/structures/{id}). Needs a signed-in user with the role SUPER_ADMIN, HR_ADMIN or PAYROLL_ADMIN. On the cloud edition the company’s plan must include the “payroll” feature.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSalaryStructureDto"}}}},"responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN","PAYROLL_ADMIN"],"x-required-feature":"payroll"}},"/payroll/structures/preview":{"post":{"operationId":"payroll_previewStructure","tags":["payroll"],"summary":"Payroll: preview structure","description":"Payroll: preview structure (POST /payroll/structures/preview). Needs a signed-in user with the role SUPER_ADMIN, HR_ADMIN or PAYROLL_ADMIN. On the cloud edition the company’s plan must include the “payroll” feature.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StructurePreviewDto"}}}},"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN","PAYROLL_ADMIN"],"x-required-feature":"payroll"}},"/payroll/tax/categories":{"get":{"operationId":"payroll_categories","tags":["payroll"],"summary":"Payroll: categories","description":"Payroll: categories (GET /payroll/tax/categories). Needs a signed-in user of the company; any role. On the cloud edition the company’s plan must include the “payroll” feature.","responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-feature":"payroll"}},"/payroll/tax/compare":{"get":{"operationId":"payroll_compare","tags":["payroll"],"summary":"Payroll: compare","description":"Payroll: compare (GET /payroll/tax/compare). Needs a signed-in user of the company; any role. On the cloud edition the company’s plan must include the “payroll” feature.","parameters":[{"name":"fy","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-feature":"payroll"}},"/payroll/tax/declaration/me":{"get":{"operationId":"payroll_myDeclaration","tags":["payroll"],"summary":"Payroll: my declaration","description":"Payroll: my declaration (GET /payroll/tax/declaration/me). Needs a signed-in user of the company; any role. On the cloud edition the company’s plan must include the “payroll” feature.","parameters":[{"name":"fy","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-feature":"payroll"},"put":{"operationId":"payroll_saveDeclaration","tags":["payroll"],"summary":"Payroll: save declaration","description":"Payroll: save declaration (PUT /payroll/tax/declaration/me). Needs a signed-in user of the company; any role. On the cloud edition the company’s plan must include the “payroll” feature.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeclarationDto"}}}},"responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-feature":"payroll"}},"/payroll/tax/declarations":{"get":{"operationId":"payroll_declarations","tags":["payroll"],"summary":"Payroll: declarations","description":"Payroll: declarations (GET /payroll/tax/declarations). Needs a signed-in user with the role SUPER_ADMIN, HR_ADMIN, PAYROLL_ADMIN or AUDITOR. On the cloud edition the company’s plan must include the “payroll” feature.","parameters":[{"name":"fy","in":"query","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN","PAYROLL_ADMIN","AUDITOR"],"x-required-feature":"payroll"}},"/payroll/tax/declarations/{id}/approve":{"post":{"operationId":"payroll_approveDecl","tags":["payroll"],"summary":"Payroll: approve decl","description":"Payroll: approve decl (POST /payroll/tax/declarations/{id}/approve). Needs a signed-in user with the role SUPER_ADMIN, HR_ADMIN or PAYROLL_ADMIN. On the cloud edition the company’s plan must include the “payroll” feature.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN","PAYROLL_ADMIN"],"x-required-feature":"payroll"}},"/payroll/tax/declarations/{id}/reject":{"post":{"operationId":"payroll_rejectDecl","tags":["payroll"],"summary":"Payroll: reject decl","description":"Payroll: reject decl (POST /payroll/tax/declarations/{id}/reject). Needs a signed-in user with the role SUPER_ADMIN, HR_ADMIN or PAYROLL_ADMIN. On the cloud edition the company’s plan must include the “payroll” feature.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN","PAYROLL_ADMIN"],"x-required-feature":"payroll"}},"/payroll/tax/form16":{"get":{"operationId":"payroll_form16","tags":["payroll"],"summary":"Payroll: form16","description":"Payroll: form16 (GET /payroll/tax/form16). Needs a signed-in user of the company; any role. On the cloud edition the company’s plan must include the “payroll” feature.","parameters":[{"name":"employeeId","in":"query","required":false,"schema":{"type":"string"}},{"name":"fy","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The file or stream the operation produces (for example a PDF or CSV), sent as a download.","content":{"*/*":{"schema":{"type":"string","format":"binary"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-feature":"payroll"}},"/performance/appraisals/{id}":{"get":{"operationId":"performance_one","tags":["performance"],"summary":"Performance: one","description":"Performance: one (GET /performance/appraisals/{id}). Needs a signed-in user of the company; any role. On the cloud edition the company’s plan must include the “performance” feature.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-feature":"performance"}},"/performance/appraisals/{id}/apply-revision":{"post":{"operationId":"performance_revise","tags":["performance"],"summary":"Performance: revise","description":"Performance: revise (POST /performance/appraisals/{id}/apply-revision). Needs a signed-in user with the role SUPER_ADMIN, HR_ADMIN or PAYROLL_ADMIN. On the cloud edition the company’s plan must include the “performance” feature.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplyRevisionDto"}}}},"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN","PAYROLL_ADMIN"],"x-required-feature":"performance"}},"/performance/appraisals/{id}/finalize":{"post":{"operationId":"performance_finalize","tags":["performance"],"summary":"Performance: finalize","description":"Performance: finalize (POST /performance/appraisals/{id}/finalize). Needs a signed-in user with the role SUPER_ADMIN or HR_ADMIN. On the cloud edition the company’s plan must include the “performance” feature.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrFinalizeDto"}}}},"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN"],"x-required-feature":"performance"}},"/performance/appraisals/{id}/manager-review":{"post":{"operationId":"performance_manager","tags":["performance"],"summary":"Performance: manager","description":"Performance: manager (POST /performance/appraisals/{id}/manager-review). Needs a signed-in user with the role SUPER_ADMIN, HR_ADMIN, PAYROLL_ADMIN, MANAGER or EMPLOYEE. On the cloud edition the company’s plan must include the “performance” feature.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ManagerReviewDto"}}}},"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN","PAYROLL_ADMIN","MANAGER","EMPLOYEE"],"x-required-feature":"performance"}},"/performance/appraisals/{id}/self-review":{"post":{"operationId":"performance_self","tags":["performance"],"summary":"Performance: self","description":"Performance: self (POST /performance/appraisals/{id}/self-review). Needs a signed-in user of the company; any role. On the cloud edition the company’s plan must include the “performance” feature.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SelfReviewDto"}}}},"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-feature":"performance"}},"/performance/appraisals/cycle/{cycleId}":{"get":{"operationId":"performance_byCycle","tags":["performance"],"summary":"Performance: by cycle","description":"Performance: by cycle (GET /performance/appraisals/cycle/{cycleId}). Needs a signed-in user with the role SUPER_ADMIN, HR_ADMIN, PAYROLL_ADMIN, AUDITOR or MANAGER. On the cloud edition the company’s plan must include the “performance” feature.","parameters":[{"name":"cycleId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN","PAYROLL_ADMIN","AUDITOR","MANAGER"],"x-required-feature":"performance"}},"/performance/appraisals/mine":{"get":{"operationId":"performance_mine","tags":["performance"],"summary":"Performance: mine","description":"Performance: mine (GET /performance/appraisals/mine). Needs a signed-in user of the company; any role. On the cloud edition the company’s plan must include the “performance” feature.","responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-feature":"performance"}},"/performance/appraisals/pending":{"get":{"operationId":"performance_pending","tags":["performance"],"summary":"Performance: pending","description":"Performance: pending (GET /performance/appraisals/pending). Needs a signed-in user with the role SUPER_ADMIN, HR_ADMIN, PAYROLL_ADMIN, MANAGER or EMPLOYEE. On the cloud edition the company’s plan must include the “performance” feature.","responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN","PAYROLL_ADMIN","MANAGER","EMPLOYEE"],"x-required-feature":"performance"}},"/performance/cycles":{"get":{"operationId":"performance_cycles","tags":["performance"],"summary":"Performance: cycles","description":"Performance: cycles (GET /performance/cycles). Needs a signed-in user of the company; any role. On the cloud edition the company’s plan must include the “performance” feature.","responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-feature":"performance"},"post":{"operationId":"performance_createCycle","tags":["performance"],"summary":"Performance: create cycle","description":"Performance: create cycle (POST /performance/cycles). Needs a signed-in user with the role SUPER_ADMIN or HR_ADMIN. On the cloud edition the company’s plan must include the “performance” feature.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CycleDto"}}}},"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN"],"x-required-feature":"performance"}},"/performance/cycles/{id}":{"patch":{"operationId":"performance_updateCycle","tags":["performance"],"summary":"Performance: update cycle","description":"Performance: update cycle (PATCH /performance/cycles/{id}). Needs a signed-in user with the role SUPER_ADMIN or HR_ADMIN. On the cloud edition the company’s plan must include the “performance” feature.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCycleDto"}}}},"responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN"],"x-required-feature":"performance"}},"/performance/cycles/{id}/launch":{"post":{"operationId":"performance_launch","tags":["performance"],"summary":"Performance: launch","description":"Performance: launch (POST /performance/cycles/{id}/launch). Needs a signed-in user with the role SUPER_ADMIN or HR_ADMIN. On the cloud edition the company’s plan must include the “performance” feature.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LaunchDto"}}}},"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN"],"x-required-feature":"performance"}},"/performance/cycles/{id}/summary":{"get":{"operationId":"performance_summary","tags":["performance"],"summary":"Performance: summary","description":"Performance: summary (GET /performance/cycles/{id}/summary). Needs a signed-in user with the role SUPER_ADMIN, HR_ADMIN, PAYROLL_ADMIN or AUDITOR. On the cloud edition the company’s plan must include the “performance” feature.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN","PAYROLL_ADMIN","AUDITOR"],"x-required-feature":"performance"}},"/performance/goals":{"get":{"operationId":"performance_goals","tags":["performance"],"summary":"Performance: goals","description":"Performance: goals (GET /performance/goals). Needs a signed-in user of the company; any role. On the cloud edition the company’s plan must include the “performance” feature.","parameters":[{"name":"employeeId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-feature":"performance"},"post":{"operationId":"performance_createGoal","tags":["performance"],"summary":"Performance: create goal","description":"Performance: create goal (POST /performance/goals). Needs a signed-in user of the company; any role. On the cloud edition the company’s plan must include the “performance” feature.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoalDto"}}}},"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-feature":"performance"}},"/performance/goals/{id}":{"patch":{"operationId":"performance_updateGoal","tags":["performance"],"summary":"Performance: update goal","description":"Performance: update goal (PATCH /performance/goals/{id}). Needs a signed-in user of the company; any role. On the cloud edition the company’s plan must include the “performance” feature.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateGoalDto"}}}},"responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-feature":"performance"}},"/performance/goals/{id}/approve":{"post":{"operationId":"performance_approveGoal","tags":["performance"],"summary":"Performance: approve goal","description":"Performance: approve goal (POST /performance/goals/{id}/approve). Needs a signed-in user with the role SUPER_ADMIN, HR_ADMIN, PAYROLL_ADMIN, MANAGER or EMPLOYEE. On the cloud edition the company’s plan must include the “performance” feature.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN","PAYROLL_ADMIN","MANAGER","EMPLOYEE"],"x-required-feature":"performance"}},"/performance/goals/{id}/reject":{"post":{"operationId":"performance_rejectGoal","tags":["performance"],"summary":"Performance: reject goal","description":"Performance: reject goal (POST /performance/goals/{id}/reject). Needs a signed-in user with the role SUPER_ADMIN, HR_ADMIN, PAYROLL_ADMIN, MANAGER or EMPLOYEE. On the cloud edition the company’s plan must include the “performance” feature.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN","PAYROLL_ADMIN","MANAGER","EMPLOYEE"],"x-required-feature":"performance"}},"/policies":{"get":{"operationId":"policies_policies","tags":["policies"],"summary":"Policies: policies","description":"Policies: policies (GET /policies). Needs a signed-in user of the company; any role.","responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}]},"post":{"operationId":"policies_createPolicy","tags":["policies"],"summary":"Policies: create policy","description":"Policies: create policy (POST /policies). Needs a signed-in user with the role SUPER_ADMIN or HR_ADMIN.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PolicyDto"}}}},"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN"]}},"/policies/{id}":{"patch":{"operationId":"policies_updatePolicy","tags":["policies"],"summary":"Policies: update policy","description":"Policies: update policy (PATCH /policies/{id}). Needs a signed-in user with the role SUPER_ADMIN or HR_ADMIN.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePolicyDto"}}}},"responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN"]}},"/policies/{id}/acknowledge":{"post":{"operationId":"policies_ack","tags":["policies"],"summary":"Policies: ack","description":"Policies: ack (POST /policies/{id}/acknowledge). Needs a signed-in user of the company; any role.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}]}},"/policies/{id}/acknowledgements":{"get":{"operationId":"policies_acks","tags":["policies"],"summary":"Policies: acks","description":"Policies: acks (GET /policies/{id}/acknowledgements). Needs a signed-in user with the role SUPER_ADMIN or HR_ADMIN.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN"]}},"/privacy/applicants/anonymise":{"post":{"operationId":"privacy_anonymiseApplicants","tags":["privacy"],"summary":"Privacy: anonymise applicants","description":"Privacy: anonymise applicants (POST /privacy/applicants/anonymise). Needs a signed-in user with the role SUPER_ADMIN or HR_ADMIN.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnonymiseApplicantsDto"}}}},"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN"]}},"/privacy/breaches":{"get":{"operationId":"privacy_listBreaches","tags":["privacy"],"summary":"Privacy: list breaches","description":"Privacy: list breaches (GET /privacy/breaches). Needs a signed-in user with the role SUPER_ADMIN, HR_ADMIN or AUDITOR.","responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN","AUDITOR"]},"post":{"operationId":"privacy_createBreach","tags":["privacy"],"summary":"Privacy: create breach","description":"Privacy: create breach (POST /privacy/breaches). Needs a signed-in user with the role SUPER_ADMIN or HR_ADMIN.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BreachDto"}}}},"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN"]}},"/privacy/breaches/{id}":{"patch":{"operationId":"privacy_updateBreach","tags":["privacy"],"summary":"Privacy: update breach","description":"Privacy: update breach (PATCH /privacy/breaches/{id}). Needs a signed-in user with the role SUPER_ADMIN or HR_ADMIN.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BreachUpdateDto"}}}},"responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN"]}},"/privacy/breaches/{id}/notify-employees":{"post":{"operationId":"privacy_notifyBreach","tags":["privacy"],"summary":"Privacy: notify breach","description":"Privacy: notify breach (POST /privacy/breaches/{id}/notify-employees). Needs a signed-in user with the role SUPER_ADMIN or HR_ADMIN.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN"]}},"/privacy/consents":{"get":{"operationId":"privacy_consents","tags":["privacy"],"summary":"Privacy: consents","description":"Privacy: consents (GET /privacy/consents). Needs a signed-in user of the company; any role.","responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}]}},"/privacy/consents/{purpose}":{"put":{"operationId":"privacy_setConsent","tags":["privacy"],"summary":"Privacy: set consent","description":"Privacy: set consent (PUT /privacy/consents/{purpose}). Needs a signed-in user of the company; any role.","parameters":[{"name":"purpose","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentDto"}}}},"responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}]}},"/privacy/erase/{employeeId}":{"post":{"operationId":"privacy_erase","tags":["privacy"],"summary":"Privacy: erase","description":"Privacy: erase (POST /privacy/erase/{employeeId}). Needs a signed-in user with the role SUPER_ADMIN or HR_ADMIN.","parameters":[{"name":"employeeId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EraseDto"}}}},"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN"]}},"/privacy/export/{employeeId}":{"get":{"operationId":"privacy_exportFor","tags":["privacy"],"summary":"Privacy: export for","description":"Privacy: export for (GET /privacy/export/{employeeId}). Needs a signed-in user with the role SUPER_ADMIN or HR_ADMIN.","parameters":[{"name":"employeeId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The file or stream the operation produces (for example a PDF or CSV), sent as a download.","content":{"*/*":{"schema":{"type":"string","format":"binary"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN"]}},"/privacy/housekeeping/run":{"post":{"operationId":"privacy_runHousekeeping","tags":["privacy"],"summary":"Privacy: run housekeeping","description":"Privacy: run housekeeping (POST /privacy/housekeeping/run). Needs a signed-in user with the role SUPER_ADMIN.","responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN"]}},"/privacy/my-data":{"get":{"operationId":"privacy_myData","tags":["privacy"],"summary":"Privacy: my data","description":"Privacy: my data (GET /privacy/my-data). Needs a signed-in user of the company; any role.","responses":{"200":{"description":"The file or stream the operation produces (for example a PDF or CSV), sent as a download.","content":{"*/*":{"schema":{"type":"string","format":"binary"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}]}},"/privacy/overview":{"get":{"operationId":"privacy_overview","tags":["privacy"],"summary":"Privacy: overview","description":"Privacy: overview (GET /privacy/overview). Needs a signed-in user with the role SUPER_ADMIN, HR_ADMIN or AUDITOR.","responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN","AUDITOR"]}},"/privacy/requests":{"get":{"operationId":"privacy_allRequests","tags":["privacy"],"summary":"Privacy: all requests","description":"Privacy: all requests (GET /privacy/requests). Needs a signed-in user with the role SUPER_ADMIN, HR_ADMIN or AUDITOR.","parameters":[{"name":"status","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN","AUDITOR"]},"post":{"operationId":"privacy_createRequest","tags":["privacy"],"summary":"Privacy: create request","description":"Privacy: create request (POST /privacy/requests). Needs a signed-in user of the company; any role.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrivacyRequestDto"}}}},"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}]}},"/privacy/requests/{id}":{"patch":{"operationId":"privacy_updateRequest","tags":["privacy"],"summary":"Privacy: update request","description":"Privacy: update request (PATCH /privacy/requests/{id}). Needs a signed-in user with the role SUPER_ADMIN or HR_ADMIN.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrivacyRequestUpdateDto"}}}},"responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN"]}},"/privacy/requests/mine":{"get":{"operationId":"privacy_myRequests","tags":["privacy"],"summary":"Privacy: my requests","description":"Privacy: my requests (GET /privacy/requests/mine). Needs a signed-in user of the company; any role.","responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}]}},"/privacy/retention":{"get":{"operationId":"privacy_retention","tags":["privacy"],"summary":"Privacy: retention","description":"Privacy: retention (GET /privacy/retention). Needs a signed-in user with the role SUPER_ADMIN, HR_ADMIN or AUDITOR.","parameters":[{"name":"years","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN","AUDITOR"]}},"/public/careers/company/{companyId}":{"get":{"operationId":"public_jobs","tags":["public"],"summary":"Public: jobs","description":"Public: jobs (GET /public/careers/company/{companyId}). No sign-in needed.","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[]}},"/public/careers/jobs/{slug}":{"get":{"operationId":"public_job","tags":["public"],"summary":"Public: job","description":"Public: job (GET /public/careers/jobs/{slug}). No sign-in needed.","parameters":[{"name":"slug","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[]}},"/public/careers/jobs/{slug}/apply":{"post":{"operationId":"public_apply","tags":["public"],"summary":"Public: apply","description":"Public: apply (POST /public/careers/jobs/{slug}/apply). No sign-in needed.","parameters":[{"name":"slug","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"upload":{}},"required":["upload"]}}}},"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[]}},"/public/careers/jobs/{slug}/resume-upload":{"post":{"operationId":"public_signResume","tags":["public"],"summary":"Public: sign resume","description":"Public: sign resume (POST /public/careers/jobs/{slug}/resume-upload). No sign-in needed.","parameters":[{"name":"slug","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignUploadDto"}}}},"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[]}},"/recruitment/applicants":{"get":{"operationId":"recruitment_applicants","tags":["recruitment"],"summary":"Recruitment: applicants","description":"Recruitment: applicants (GET /recruitment/applicants). Needs a signed-in user with the role SUPER_ADMIN, HR_ADMIN, PAYROLL_ADMIN or AUDITOR. On the cloud edition the company’s plan must include the “recruitment” feature.","parameters":[{"name":"jobId","in":"query","required":false,"schema":{"type":"string"}},{"name":"stage","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN","PAYROLL_ADMIN","AUDITOR"],"x-required-feature":"recruitment"}},"/recruitment/applicants/{id}/resume":{"get":{"operationId":"recruitment_resume","tags":["recruitment"],"summary":"Recruitment: resume","description":"Recruitment: resume (GET /recruitment/applicants/{id}/resume). Needs a signed-in user with the role SUPER_ADMIN or HR_ADMIN. On the cloud edition the company’s plan must include the “recruitment” feature.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The file or stream the operation produces (for example a PDF or CSV), sent as a download.","content":{"*/*":{"schema":{"type":"string","format":"binary"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN"],"x-required-feature":"recruitment"}},"/recruitment/applicants/{id}/stage":{"patch":{"operationId":"recruitment_stage","tags":["recruitment"],"summary":"Recruitment: stage","description":"Recruitment: stage (PATCH /recruitment/applicants/{id}/stage). Needs a signed-in user with the role SUPER_ADMIN or HR_ADMIN. On the cloud edition the company’s plan must include the “recruitment” feature.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StageDto"}}}},"responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN"],"x-required-feature":"recruitment"}},"/recruitment/funnel":{"get":{"operationId":"recruitment_funnel","tags":["recruitment"],"summary":"Recruitment: funnel","description":"Recruitment: funnel (GET /recruitment/funnel). Needs a signed-in user with the role SUPER_ADMIN, HR_ADMIN, PAYROLL_ADMIN or AUDITOR. On the cloud edition the company’s plan must include the “recruitment” feature.","parameters":[{"name":"jobId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN","PAYROLL_ADMIN","AUDITOR"],"x-required-feature":"recruitment"}},"/recruitment/hire":{"post":{"operationId":"recruitment_hire","tags":["recruitment"],"summary":"Recruitment: hire","description":"Recruitment: hire (POST /recruitment/hire). Needs a signed-in user with the role SUPER_ADMIN or HR_ADMIN. On the cloud edition the company’s plan must include the “recruitment” feature.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HireDto"}}}},"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN"],"x-required-feature":"recruitment"}},"/recruitment/interviews":{"post":{"operationId":"recruitment_schedule","tags":["recruitment"],"summary":"Recruitment: schedule","description":"Recruitment: schedule (POST /recruitment/interviews). Needs a signed-in user with the role SUPER_ADMIN or HR_ADMIN. On the cloud edition the company’s plan must include the “recruitment” feature.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterviewDto"}}}},"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN"],"x-required-feature":"recruitment"}},"/recruitment/interviews/{id}":{"patch":{"operationId":"recruitment_feedback","tags":["recruitment"],"summary":"Recruitment: feedback","description":"Recruitment: feedback (PATCH /recruitment/interviews/{id}). Needs a signed-in user with the role SUPER_ADMIN or HR_ADMIN. On the cloud edition the company’s plan must include the “recruitment” feature.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterviewFeedbackDto"}}}},"responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN"],"x-required-feature":"recruitment"}},"/recruitment/jobs":{"get":{"operationId":"recruitment_jobs","tags":["recruitment"],"summary":"Recruitment: jobs","description":"Recruitment: jobs (GET /recruitment/jobs). Needs a signed-in user with the role SUPER_ADMIN, HR_ADMIN, PAYROLL_ADMIN or AUDITOR. On the cloud edition the company’s plan must include the “recruitment” feature.","parameters":[{"name":"status","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN","PAYROLL_ADMIN","AUDITOR"],"x-required-feature":"recruitment"},"post":{"operationId":"recruitment_createJob","tags":["recruitment"],"summary":"Recruitment: create job","description":"Recruitment: create job (POST /recruitment/jobs). Needs a signed-in user with the role SUPER_ADMIN or HR_ADMIN. On the cloud edition the company’s plan must include the “recruitment” feature.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobDto"}}}},"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN"],"x-required-feature":"recruitment"}},"/recruitment/jobs/{id}":{"patch":{"operationId":"recruitment_updateJob","tags":["recruitment"],"summary":"Recruitment: update job","description":"Recruitment: update job (PATCH /recruitment/jobs/{id}). Needs a signed-in user with the role SUPER_ADMIN or HR_ADMIN. On the cloud edition the company’s plan must include the “recruitment” feature.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateJobDto"}}}},"responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN"],"x-required-feature":"recruitment"}},"/recruitment/offers":{"post":{"operationId":"recruitment_offer","tags":["recruitment"],"summary":"Recruitment: offer","description":"Recruitment: offer (POST /recruitment/offers). Needs a signed-in user with the role SUPER_ADMIN or HR_ADMIN. On the cloud edition the company’s plan must include the “recruitment” feature.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfferDto"}}}},"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN"],"x-required-feature":"recruitment"}},"/recruitment/offers/{id}/accept":{"post":{"operationId":"recruitment_accept","tags":["recruitment"],"summary":"Recruitment: accept","description":"Recruitment: accept (POST /recruitment/offers/{id}/accept). Needs a signed-in user with the role SUPER_ADMIN or HR_ADMIN. On the cloud edition the company’s plan must include the “recruitment” feature.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN"],"x-required-feature":"recruitment"}},"/recruitment/offers/{id}/decline":{"post":{"operationId":"recruitment_decline","tags":["recruitment"],"summary":"Recruitment: decline","description":"Recruitment: decline (POST /recruitment/offers/{id}/decline). Needs a signed-in user with the role SUPER_ADMIN or HR_ADMIN. On the cloud edition the company’s plan must include the “recruitment” feature.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN"],"x-required-feature":"recruitment"}},"/reports/custom":{"post":{"operationId":"reports_customRun","tags":["reports"],"summary":"Reports: custom run","description":"Reports: custom run (POST /reports/custom). Needs a signed-in user with the role SUPER_ADMIN, HR_ADMIN, PAYROLL_ADMIN or AUDITOR. On the cloud edition the company’s plan must include the “analytics” feature.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomReportDto"}}}},"responses":{"201":{"description":"The file or stream the operation produces (for example a PDF or CSV), sent as a download.","content":{"*/*":{"schema":{"type":"string","format":"binary"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN","PAYROLL_ADMIN","AUDITOR"],"x-required-feature":"analytics"}},"/reports/custom/catalog":{"get":{"operationId":"reports_customCatalog","tags":["reports"],"summary":"Reports: custom catalog","description":"Reports: custom catalog (GET /reports/custom/catalog). Needs a signed-in user with the role SUPER_ADMIN, HR_ADMIN, PAYROLL_ADMIN or AUDITOR. On the cloud edition the company’s plan must include the “analytics” feature.","responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN","PAYROLL_ADMIN","AUDITOR"],"x-required-feature":"analytics"}},"/reports/dashboard/admin":{"get":{"operationId":"reports_admin","tags":["reports"],"summary":"Reports: admin","description":"Reports: admin (GET /reports/dashboard/admin). Needs a signed-in user with the role SUPER_ADMIN, HR_ADMIN, PAYROLL_ADMIN or AUDITOR.","responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN","PAYROLL_ADMIN","AUDITOR"]}},"/reports/dashboard/ess":{"get":{"operationId":"reports_ess","tags":["reports"],"summary":"Reports: ess","description":"Reports: ess (GET /reports/dashboard/ess). Needs a signed-in user of the company; any role.","responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}]}},"/reports/dashboard/manager":{"get":{"operationId":"reports_manager","tags":["reports"],"summary":"Reports: manager","description":"Reports: manager (GET /reports/dashboard/manager). Needs a signed-in user with the role SUPER_ADMIN, HR_ADMIN, PAYROLL_ADMIN, MANAGER or EMPLOYEE.","responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN","PAYROLL_ADMIN","MANAGER","EMPLOYEE"]}},"/reports/mis":{"get":{"operationId":"reports_catalog","tags":["reports"],"summary":"Reports: catalog","description":"Reports: catalog (GET /reports/mis). Needs a signed-in user with the role SUPER_ADMIN, HR_ADMIN, PAYROLL_ADMIN or AUDITOR. On the cloud edition the company’s plan must include the “analytics” feature.","responses":{"200":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN","PAYROLL_ADMIN","AUDITOR"],"x-required-feature":"analytics"}},"/reports/mis/{key}":{"get":{"operationId":"reports_run","tags":["reports"],"summary":"Reports: run","description":"Reports: run (GET /reports/mis/{key}). Needs a signed-in user with the role SUPER_ADMIN, HR_ADMIN, PAYROLL_ADMIN or AUDITOR. On the cloud edition the company’s plan must include the “analytics” feature.","parameters":[{"name":"key","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The file or stream the operation produces (for example a PDF or CSV), sent as a download.","content":{"*/*":{"schema":{"type":"string","format":"binary"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}],"x-required-roles":["SUPER_ADMIN","HR_ADMIN","PAYROLL_ADMIN","AUDITOR"],"x-required-feature":"analytics"}},"/uploads/sign":{"post":{"operationId":"uploads_sign","tags":["uploads"],"summary":"Uploads: sign","description":"Uploads: sign (POST /uploads/sign). Needs a signed-in user of the company; any role.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignUploadDto"}}}},"responses":{"201":{"description":"The result as JSON: an object or a list, depending on the operation.","content":{"application/json":{"schema":{}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"bearerAuth":[]}]}}},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"A Supabase Auth access token for the signed-in user. The API maps it to the user’s JantaHR account, company and role."}},"schemas":{"AdditionalSalaryDto":{"type":"object","properties":{"employeeId":{"type":"string"},"salaryComponentId":{"type":"string"},"amount":{"minimum":1,"type":"number"},"payrollDate":{"type":"string","description":"ISO 8601 date or date-time"},"reason":{"type":"string"},"isRecurring":{"type":"boolean"},"fromDate":{"type":"string","description":"ISO 8601 date or date-time"},"toDate":{"type":"string","description":"ISO 8601 date or date-time"}},"required":["employeeId","salaryComponentId","amount","payrollDate"]},"AnnouncementDto":{"type":"object","properties":{"title":{"minLength":2,"type":"string"},"body":{"minLength":2,"type":"string"},"pinned":{"type":"boolean"},"publishAt":{"type":"string","description":"ISO 8601 date or date-time"},"expiresAt":{"type":"string","description":"ISO 8601 date or date-time"}},"required":["title","body"]},"AnonymiseApplicantsDto":{"type":"object","properties":{"olderThanMonths":{"maximum":120,"minimum":6,"type":"integer"}},"required":["olderThanMonths"]},"ApplyLeaveDto":{"type":"object","properties":{"leaveTypeId":{"type":"string"},"fromDate":{"type":"string","description":"ISO 8601 date or date-time"},"toDate":{"type":"string","description":"ISO 8601 date or date-time"},"halfDay":{"type":"boolean"},"halfDayDate":{"type":"string","description":"ISO 8601 date or date-time"},"reason":{"type":"string"},"employeeId":{"type":"string"}},"required":["leaveTypeId","fromDate","toDate"]},"ApplyRevisionDto":{"type":"object","properties":{"effectiveFrom":{"type":"string","description":"ISO 8601 date or date-time"}},"required":["effectiveFrom"]},"ApproveItemDto":{"type":"object","properties":{"itemId":{"type":"string"},"approvedAmount":{"minimum":0,"type":"number"}},"required":["itemId","approvedAmount"]},"AssignmentDto":{"type":"object","properties":{"employeeId":{"type":"string"},"salaryStructureId":{"type":"string"},"fromDate":{"type":"string","description":"ISO 8601 date or date-time"},"base":{"minimum":1,"type":"number"},"variable":{"minimum":0,"type":"number"},"taxRegime":{"type":"string","enum":["OLD","NEW"]}},"required":["employeeId","salaryStructureId","fromDate","base"]},"AssignPolicyDto":{"type":"object","properties":{"employeeIds":{"type":"array","items":{"type":"string"}},"allEmployees":{"type":"boolean"},"effectiveFrom":{"type":"string","description":"ISO 8601 date or date-time"}}},"BiometricPunchItem":{"type":"object","properties":{"employeeCode":{"type":"string"},"time":{"type":"string","description":"ISO 8601 date or date-time"},"type":{"enum":["IN","OUT"],"type":"string"}},"required":["employeeCode","time"]},"BiometricPushDto":{"type":"object","properties":{"punches":{"type":"array","items":{"$ref":"#/components/schemas/BiometricPunchItem"},"minItems":1}},"required":["punches"]},"BreachDto":{"type":"object","properties":{"title":{"maxLength":255,"minLength":3,"type":"string"},"description":{"maxLength":6000,"minLength":10,"type":"string"},"severity":{"type":"string","enum":["LOW","MEDIUM","HIGH","CRITICAL"]},"occurredAt":{"type":"string","description":"ISO 8601 date or date-time"},"detectedAt":{"type":"string","description":"ISO 8601 date or date-time"},"affectedCount":{"minimum":0,"type":"integer"},"dataCategories":{"maxLength":500,"type":"string"},"containmentActions":{"maxLength":6000,"type":"string"}},"required":["title","description","severity"]},"BreachUpdateDto":{"type":"object","properties":{"status":{"type":"string","enum":["INVESTIGATING","CONTAINED","NOTIFIED","CLOSED"]},"severity":{"type":"string","enum":["LOW","MEDIUM","HIGH","CRITICAL"]},"affectedCount":{"minimum":0,"type":"integer"},"dataCategories":{"maxLength":500,"type":"string"},"containmentActions":{"maxLength":6000,"type":"string"},"boardNotified":{"type":"boolean"}}},"BulkAssignmentDto":{"type":"object","properties":{"employeeIds":{"type":"array","items":{"type":"string"},"minItems":1},"salaryStructureId":{"type":"string"},"fromDate":{"type":"string","description":"ISO 8601 date or date-time"},"taxRegime":{"type":"string","enum":["OLD","NEW"]}},"required":["employeeIds","salaryStructureId","fromDate"]},"ChangePasswordDto":{"type":"object","properties":{"currentPassword":{"minLength":1,"type":"string"},"newPassword":{"type":"string","pattern":"^(?=.*[A-Za-z])(?=.*\\d).{8,}$"}},"required":["currentPassword","newPassword"]},"ChatDto":{"type":"object","properties":{"message":{"maxLength":500,"minLength":1,"type":"string"}},"required":["message"]},"CheckoutDto":{"type":"object","properties":{"plan":{"enum":["STANDARD","PROFESSIONAL"],"type":"string"},"cycle":{"type":"string","enum":["MONTHLY","ANNUAL"]},"seats":{"maximum":100000,"minimum":1,"type":"integer"}},"required":["plan","cycle","seats"]},"ClearanceUpdateDto":{"type":"object","properties":{"status":{"enum":["PENDING","CLEARED","NOT_APPLICABLE"],"type":"string"},"remarks":{"type":"string"}},"required":["status"]},"CommentDto":{"type":"object","properties":{"message":{"minLength":1,"type":"string"}},"required":["message"]},"CompOffDto":{"type":"object","properties":{"workFromDate":{"type":"string","description":"ISO 8601 date or date-time"},"workEndDate":{"type":"string","description":"ISO 8601 date or date-time"},"halfDay":{"type":"boolean"},"reason":{"minLength":3,"type":"string"}},"required":["workFromDate","reason"]},"ConfirmCheckoutDto":{"type":"object","properties":{"razorpay_payment_id":{"type":"string"},"razorpay_subscription_id":{"type":"string"},"razorpay_signature":{"type":"string"}}},"ConsentDto":{"type":"object","properties":{"granted":{"type":"boolean"}},"required":["granted"]},"CreateEmployeeDto":{"type":"object","properties":{"employeeCode":{"maxLength":50,"type":"string"},"firstName":{"maxLength":100,"minLength":1,"type":"string"},"middleName":{"type":"string"},"lastName":{"maxLength":100,"type":"string"},"email":{"type":"string","format":"email"},"personalEmail":{"type":"string","format":"email"},"phone":{"type":"string","pattern":"^\\+?[0-9]{10,13}$"},"dateOfBirth":{"type":"string","description":"ISO 8601 date or date-time"},"gender":{"type":"string","enum":["MALE","FEMALE","OTHER"]},"maritalStatus":{"type":"string","enum":["SINGLE","MARRIED","DIVORCED","WIDOWED"]},"bloodGroup":{"type":"string"},"nationality":{"type":"string"},"religion":{"type":"string"},"fatherName":{"type":"string"},"motherName":{"type":"string"},"spouseName":{"type":"string"},"currentAddress":{"type":"string"},"permanentAddress":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"pincode":{"type":"string"},"emergencyContactName":{"type":"string"},"emergencyContactPhone":{"type":"string"},"emergencyContactRelation":{"type":"string"},"dateOfJoining":{"type":"string","description":"ISO 8601 date or date-time"},"dateOfConfirmation":{"type":"string","description":"ISO 8601 date or date-time"},"probationEndDate":{"type":"string","description":"ISO 8601 date or date-time"},"noticeperiodDays":{"minimum":0,"type":"integer"},"status":{"type":"string","enum":["ACTIVE","INACTIVE","SUSPENDED","LEFT"]},"employmentType":{"type":"string"},"departmentId":{"type":"string"},"designationId":{"type":"string"},"reportingManagerId":{"type":"string"},"leaveApproverId":{"type":"string"},"workLocation":{"type":"string"},"defaultShiftId":{"type":"string"},"bankName":{"type":"string"},"bankAccountNumber":{"type":"string","pattern":"^[0-9]{6,20}$"},"ifscCode":{"type":"string","pattern":"^[A-Z]{4}0[A-Z0-9]{6}$"},"bankBranch":{"type":"string"},"panNumber":{"type":"string","pattern":"^[A-Z]{5}[0-9]{4}[A-Z]$"},"aadhaarNumber":{"type":"string","pattern":"^[0-9]{12}$"},"uanNumber":{"type":"string"},"esicNumber":{"type":"string"},"pfAccountNumber":{"type":"string"},"professionalTaxState":{"type":"string"},"ctc":{"minimum":0,"type":"number"},"pfApplicable":{"type":"boolean"},"esiApplicable":{"type":"boolean"},"ptApplicable":{"type":"boolean"},"role":{"enum":["EMPLOYEE","MANAGER","PAYROLL_ADMIN","HR_ADMIN","AUDITOR","SUPER_ADMIN"],"type":"string"},"password":{"minLength":8,"type":"string"}},"required":["firstName","lastName","email","gender","dateOfJoining"]},"CustomReportDto":{"type":"object","properties":{"entity":{"enum":["employees","leave","attendance","payroll"],"type":"string"},"columns":{"type":"array","items":{"type":"string"},"maxItems":30,"minItems":1},"filters":{"type":"array","items":{"$ref":"#/components/schemas/FilterDto"},"maxItems":10},"sortBy":{"type":"string"},"sortDir":{"enum":["asc","desc"],"type":"string"},"format":{"enum":["json","csv"],"type":"string"}},"required":["entity","columns"]},"CycleDto":{"type":"object","properties":{"name":{"minLength":2,"type":"string"},"startDate":{"type":"string","description":"ISO 8601 date or date-time"},"endDate":{"type":"string","description":"ISO 8601 date or date-time"},"isActive":{"type":"boolean"}},"required":["name","startDate","endDate"]},"DailyQueryDto":{"type":"object","properties":{"date":{"type":"string","description":"ISO 8601 date or date-time"},"departmentId":{"type":"string"},"page":{"minimum":1,"type":"integer"},"limit":{"maximum":200,"minimum":1,"type":"integer"},"search":{"type":"string"}}},"DecisionDto":{"type":"object","properties":{"comment":{"type":"string"}}},"DeclarationDetailDto":{"type":"object","properties":{"subCategoryId":{"type":"string"},"declaredAmount":{"minimum":0,"type":"number"}},"required":["subCategoryId","declaredAmount"]},"DeclarationDto":{"type":"object","properties":{"fyStartYear":{"type":"integer"},"taxRegime":{"type":"string","enum":["OLD","NEW"]},"monthlyRent":{"minimum":0,"type":"number"},"rentedInMetro":{"type":"boolean"},"childrenCount":{"maximum":10,"minimum":0,"type":"integer"},"homeLoanInterest":{"minimum":0,"type":"number"},"details":{"type":"array","items":{"$ref":"#/components/schemas/DeclarationDetailDto"}},"submit":{"type":"boolean"}},"required":["taxRegime"]},"DepartmentDto":{"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"type":"string"},"parentDepartmentId":{"type":"string"},"headId":{"type":"string"},"isGroup":{"type":"boolean"}},"required":["name"]},"DesignationDto":{"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"type":"string"},"description":{"type":"string"}},"required":["name"]},"DeviceDto":{"type":"object","properties":{"name":{"minLength":2,"type":"string"},"serialNo":{"minLength":3,"type":"string"},"vendor":{"enum":["ZKTECO","ESSL","BIOMAX","OTHER"],"type":"string"}},"required":["name","serialNo"]},"EmployeeFilterDto":{"type":"object","properties":{"departmentId":{"type":"string"},"designationId":{"type":"string"},"status":{"type":"string","enum":["ACTIVE","INACTIVE","SUSPENDED","LEFT"]},"employmentType":{"type":"string"},"managerId":{"type":"string"},"page":{"minimum":1,"type":"integer"},"limit":{"maximum":200,"minimum":1,"type":"integer"},"search":{"type":"string"}}},"EncashmentDto":{"type":"object","properties":{"leaveTypeId":{"type":"string"},"days":{"minimum":0.5,"type":"number"}},"required":["leaveTypeId","days"]},"EraseDto":{"type":"object","properties":{"confirmEmployeeCode":{"type":"string"},"requestId":{"type":"string"}},"required":["confirmEmployeeCode"]},"Error":{"type":"object","description":"Every error response has this shape.","required":["statusCode","error","message","path","timestamp"],"properties":{"statusCode":{"type":"integer","description":"The HTTP status code, repeated"},"error":{"type":"string","description":"Short name of the error, for example \"Forbidden\""},"message":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"What went wrong; a list when several fields failed validation"},"code":{"type":"string","description":"Machine-readable reason where one applies, for example PLAN_REQUIRED, SEAT_LIMIT, SESSION_INVALID or NO_ACCOUNT"},"feature":{"type":"string","description":"The plan feature the request needs, with code PLAN_REQUIRED"},"path":{"type":"string"},"timestamp":{"type":"string","format":"date-time"}}},"ExitInterviewDto":{"type":"object","properties":{"notes":{"minLength":3,"type":"string"}},"required":["notes"]},"ExpenseClaimDto":{"type":"object","properties":{"title":{"minLength":3,"type":"string"},"items":{"type":"array","items":{"$ref":"#/components/schemas/ExpenseItemDto"},"minItems":1},"submit":{}},"required":["title","items"]},"ExpenseDecisionDto":{"type":"object","properties":{"comment":{"type":"string"},"items":{"type":"array","items":{"$ref":"#/components/schemas/ApproveItemDto"}}}},"ExpenseItemDto":{"type":"object","properties":{"expenseDate":{"type":"string","description":"ISO 8601 date or date-time"},"category":{"type":"string"},"description":{"type":"string"},"amount":{"minimum":1,"type":"number"},"receiptUrl":{"type":"string"}},"required":["expenseDate","category","amount"]},"FilterDto":{"type":"object","properties":{"field":{"type":"string"},"op":{"enum":["eq","ne","contains","gte","lte","in"],"type":"string"},"value":{"type":"string"}},"required":["field","op","value"]},"FnfDto":{"type":"object","properties":{"bonusAmount":{"minimum":0,"type":"number"},"otherDeductions":{"minimum":0,"type":"number"}}},"GoalDto":{"type":"object","properties":{"employeeId":{"type":"string"},"title":{"minLength":2,"type":"string"},"description":{"type":"string"},"weightage":{"maximum":100,"minimum":0,"type":"number"},"targetValue":{"type":"string"},"startDate":{"type":"string","description":"ISO 8601 date or date-time"},"endDate":{"type":"string","description":"ISO 8601 date or date-time"}},"required":["title","weightage","startDate","endDate"]},"HireDto":{"type":"object","properties":{"offerId":{"type":"string"},"gender":{"type":"string","enum":["MALE","FEMALE","OTHER"]},"departmentId":{"type":"string"},"designationId":{"type":"string"}},"required":["offerId","gender"]},"HolidayItemDto":{"type":"object","properties":{"name":{"type":"string"},"date":{"type":"string","description":"ISO 8601 date or date-time"},"isOptional":{"type":"boolean"}},"required":["name","date"]},"HolidayListDto":{"type":"object","properties":{"name":{"type":"string"},"year":{"maximum":2100,"minimum":2000,"type":"integer"},"state":{"type":"string"},"isDefault":{"type":"boolean"},"holidays":{"type":"array","items":{"$ref":"#/components/schemas/HolidayItemDto"},"minItems":0}},"required":["name","year","holidays"]},"HrFinalizeDto":{"type":"object","properties":{"finalRating":{"maximum":5,"minimum":1,"type":"number"},"hrComment":{"type":"string"},"promotionRecommended":{"type":"boolean"},"salaryRevisionPercent":{"maximum":100,"minimum":0,"type":"number"}},"required":["finalRating"]},"ImportAttendanceDto":{"type":"object","properties":{"csv":{"minLength":10,"type":"string"}},"required":["csv"]},"ImportEmployeesDto":{"type":"object","properties":{"csv":{"minLength":10,"type":"string"}},"required":["csv"]},"InitiateSeparationDto":{"type":"object","properties":{"employeeId":{"type":"string"},"separationType":{"type":"string","enum":["RESIGNATION","TERMINATION","RETIREMENT","ABSCONDING","MUTUAL"]},"lastWorkingDate":{"type":"string","description":"ISO 8601 date or date-time"},"reason":{"type":"string"},"noticePeriodDays":{"minimum":0,"type":"integer"}},"required":["employeeId","separationType","lastWorkingDate"]},"InterviewDto":{"type":"object","properties":{"applicantId":{"type":"string"},"round":{"minLength":2,"type":"string"},"scheduledAt":{"type":"string","description":"ISO 8601 date or date-time"},"durationMins":{"minimum":10,"type":"integer"},"mode":{"type":"string"},"interviewerId":{"type":"string"}},"required":["applicantId","round","scheduledAt"]},"InterviewFeedbackDto":{"type":"object","properties":{"status":{"type":"string","enum":["SCHEDULED","COMPLETED","CANCELLED","NO_SHOW"]},"rating":{"maximum":5,"minimum":0,"type":"number"},"feedback":{"type":"string"}},"required":["status"]},"JobDto":{"type":"object","properties":{"title":{"minLength":3,"type":"string"},"departmentId":{"type":"string"},"designationId":{"type":"string"},"location":{"type":"string"},"employmentType":{"type":"string"},"experience":{"type":"string"},"description":{"minLength":10,"type":"string"},"vacancies":{"minimum":1,"type":"integer"},"salaryMin":{"minimum":0,"type":"number"},"salaryMax":{"minimum":0,"type":"number"},"closesOn":{"type":"string","description":"ISO 8601 date or date-time"},"status":{"enum":["DRAFT","OPEN","ON_HOLD","CLOSED"],"type":"string"}},"required":["title","description"]},"LaunchDto":{"type":"object","properties":{"departmentId":{"type":"string"}}},"LeaveListDto":{"type":"object","properties":{"scope":{"enum":["mine","team","all"],"type":"string"},"status":{"enum":["OPEN","APPROVED","REJECTED","CANCELLED"],"type":"string"},"employeeId":{"type":"string"},"from":{"type":"string","description":"ISO 8601 date or date-time"},"to":{"type":"string","description":"ISO 8601 date or date-time"},"page":{"minimum":1,"type":"integer"},"limit":{"maximum":200,"minimum":1,"type":"integer"},"search":{"type":"string"}}},"LeavePolicyDto":{"type":"object","properties":{"name":{"minLength":2,"type":"string"},"isActive":{"type":"boolean"},"details":{"type":"array","items":{"$ref":"#/components/schemas/PolicyDetailDto"},"minItems":1}},"required":["name","details"]},"LeaveTypeDto":{"type":"object","properties":{"name":{"minLength":2,"type":"string"},"maxDaysAllowed":{"minimum":0,"type":"number"},"isCarryForward":{"type":"boolean"},"maxCarryForwardDays":{"minimum":0,"type":"number"},"isEncashable":{"type":"boolean"},"maxEncashableDays":{"minimum":0,"type":"number"},"isEarnedLeave":{"type":"boolean"},"earnedLeaveFrequency":{"enum":["MONTHLY"],"type":"string"},"isLWP":{"type":"boolean"},"isCompensatory":{"type":"boolean"},"includeHolidays":{"type":"boolean"},"sandwichRule":{"type":"boolean"},"allowNegativeBalance":{"type":"boolean"},"isPaid":{"type":"boolean"},"maxContinuousDays":{"minimum":1,"type":"integer"},"applicableAfterDays":{"minimum":0,"type":"integer"},"applicableGender":{"type":"string","enum":["MALE","FEMALE","OTHER"]}},"required":["name"]},"LoanDto":{"type":"object","properties":{"employeeId":{"type":"string"},"loanType":{"enum":["LOAN","ADVANCE"],"type":"string"},"principal":{"minimum":1,"type":"number"},"totalInstallments":{"maximum":120,"minimum":1,"type":"integer"},"startDate":{"type":"string","description":"ISO 8601 date or date-time"},"reason":{"type":"string"}},"required":["employeeId","principal","totalInstallments","startDate"]},"ManagerReviewDto":{"type":"object","properties":{"managerRating":{"maximum":5,"minimum":1,"type":"number"},"managerComment":{"minLength":3,"type":"string"},"promotionRecommended":{"type":"boolean"}},"required":["managerRating","managerComment"]},"ManualAllocationDto":{"type":"object","properties":{"employeeId":{"type":"string"},"leaveTypeId":{"type":"string"},"days":{"maximum":400,"minimum":0.5,"type":"number"},"fromDate":{"type":"string","description":"ISO 8601 date or date-time"},"toDate":{"type":"string","description":"ISO 8601 date or date-time"},"reason":{"type":"string"}},"required":["employeeId","leaveTypeId","days","fromDate","toDate"]},"ManualMarkDto":{"type":"object","properties":{"employeeId":{"type":"string"},"date":{"type":"string","description":"ISO 8601 date or date-time"},"status":{"enum":["PRESENT","ABSENT","HALF_DAY","ON_LEAVE","WORK_FROM_HOME","HOLIDAY"],"type":"string"},"inTime":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"},"outTime":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"},"remarks":{"type":"string"}},"required":["employeeId","date","status"]},"MarkFiledDto":{"type":"object","properties":{"reference":{"maxLength":120,"type":"string"}}},"OfferDto":{"type":"object","properties":{"applicantId":{"type":"string"},"designation":{"type":"string"},"ctc":{"minimum":1,"type":"number"},"joiningDate":{"type":"string","description":"ISO 8601 date or date-time"}},"required":["applicantId","designation","ctc","joiningDate"]},"OnboardingTemplateDto":{"type":"object","properties":{"name":{"minLength":2,"type":"string"},"isActive":{"type":"boolean"},"tasks":{"type":"array","items":{"$ref":"#/components/schemas/TemplateTaskDto"},"minItems":1}},"required":["name","tasks"]},"PeriodQueryDto":{"type":"object","properties":{"month":{"maximum":12,"minimum":1,"type":"integer"},"year":{"maximum":2100,"minimum":2000,"type":"integer"},"format":{"type":"string"}},"required":["month","year"]},"PolicyDetailDto":{"type":"object","properties":{"leaveTypeId":{"type":"string"},"annualAllocation":{"maximum":400,"minimum":0,"type":"number"}},"required":["leaveTypeId","annualAllocation"]},"PolicyDto":{"type":"object","properties":{"title":{"minLength":2,"type":"string"},"category":{"type":"string"},"content":{"minLength":2,"type":"string"},"isActive":{"type":"boolean"}},"required":["title","content"]},"PrivacyRequestDto":{"type":"object","properties":{"type":{"type":"string","enum":["ACCESS","CORRECTION","ERASURE","GRIEVANCE","NOMINATION"]},"details":{"maxLength":4000,"minLength":10,"type":"string"}},"required":["type","details"]},"PrivacyRequestUpdateDto":{"type":"object","properties":{"status":{"type":"string","enum":["OPEN","IN_PROGRESS","COMPLETED","REJECTED"]},"resolution":{"maxLength":4000,"type":"string"}}},"ProvisionCompanyDto":{"type":"object","properties":{"companyName":{"maxLength":255,"minLength":2,"type":"string"},"state":{"type":"string"},"firstName":{"minLength":2,"type":"string"},"lastName":{"type":"string"},"gender":{"type":"string","enum":["MALE","FEMALE","OTHER"]},"maritalStatus":{"type":"string","enum":["SINGLE","MARRIED","DIVORCED","WIDOWED"]}},"required":["companyName","firstName"]},"PunchDto":{"type":"object","properties":{"logType":{"enum":["IN","OUT"],"type":"string"},"latitude":{"maximum":90,"minimum":-90,"type":"number"},"longitude":{"maximum":180,"minimum":-180,"type":"number"},"selfie":{"type":"string"},"source":{"enum":["WEB","MOBILE"],"type":"string"}}},"RangeDto":{"type":"object","properties":{"from":{"type":"string","description":"ISO 8601 date or date-time"},"to":{"type":"string","description":"ISO 8601 date or date-time"}},"required":["from","to"]},"RegularizationDto":{"type":"object","properties":{"fromDate":{"type":"string","description":"ISO 8601 date or date-time"},"toDate":{"type":"string","description":"ISO 8601 date or date-time"},"requestType":{"enum":["REGULARIZE","ON_DUTY","WFH"],"type":"string"},"halfDay":{"type":"boolean"},"reason":{"minLength":3,"type":"string"}},"required":["fromDate","requestType","reason"]},"ResignDto":{"type":"object","properties":{"reason":{"minLength":3,"type":"string"},"lastWorkingDate":{"type":"string","description":"ISO 8601 date or date-time"}},"required":["reason"]},"RosterDto":{"type":"object","properties":{"employeeIds":{"type":"array","items":{"type":"string"},"minItems":1},"pattern":{"type":"array","items":{"type":"string"},"minItems":1},"startDate":{"type":"string","description":"ISO 8601 date or date-time"},"weeks":{"maximum":52,"minimum":1,"type":"integer"}},"required":["employeeIds","pattern","startDate","weeks"]},"RunDto":{"type":"object","properties":{"month":{"maximum":12,"minimum":1,"type":"integer"},"year":{"maximum":2100,"minimum":2000,"type":"integer"},"departmentId":{"type":"string"},"treatUnmarkedAsLop":{"type":"boolean"}},"required":["month","year"]},"SalaryComponentDto":{"type":"object","properties":{"name":{"minLength":2,"type":"string"},"abbr":{"minLength":2,"type":"string"},"type":{"type":"string","enum":["EARNING","DEDUCTION"]},"description":{"type":"string"},"isTaxApplicable":{"type":"boolean"},"dependsOnPaymentDays":{"type":"boolean"},"isPfApplicable":{"type":"boolean"},"isEsiApplicable":{"type":"boolean"},"isPtApplicable":{"type":"boolean"},"componentType":{"type":"string"},"formula":{"type":"string"},"sortOrder":{"type":"integer"},"exemptionCode":{"enum":["CHILD_EDUCATION","HOSTEL","MEAL",null],"type":"string"}},"required":["name","abbr","type"]},"SalaryStructureDto":{"type":"object","properties":{"name":{"minLength":2,"type":"string"},"description":{"type":"string"},"payrollFrequency":{"type":"string","enum":["MONTHLY","BIMONTHLY","FORTNIGHTLY","WEEKLY"]},"isActive":{"type":"boolean"},"components":{"type":"array","items":{"$ref":"#/components/schemas/StructureComponentDto"},"minItems":1}},"required":["name","components"]},"SeatsDto":{"type":"object","properties":{"seats":{"maximum":100000,"minimum":1,"type":"integer"}},"required":["seats"]},"SelfReviewDto":{"type":"object","properties":{"selfRating":{"maximum":5,"minimum":1,"type":"number"},"selfComment":{"minLength":3,"type":"string"}},"required":["selfRating","selfComment"]},"SeparationDecisionDto":{"type":"object","properties":{"lastWorkingDate":{"type":"string","description":"ISO 8601 date or date-time"},"comment":{"type":"string"}}},"SetPasswordDto":{"type":"object","properties":{"newPassword":{"type":"string","pattern":"^(?=.*[A-Za-z])(?=.*\\d).{8,}$"}},"required":["newPassword"]},"SetStatusDto":{"type":"object","properties":{"status":{"type":"string","enum":["ACTIVE","INACTIVE","SUSPENDED","LEFT"]}},"required":["status"]},"ShiftAssignmentDto":{"type":"object","properties":{"employeeIds":{"type":"array","items":{"type":"string"},"minItems":1},"shiftTypeId":{"type":"string"},"startDate":{"type":"string","description":"ISO 8601 date or date-time"},"endDate":{"type":"string","description":"ISO 8601 date or date-time"}},"required":["employeeIds","shiftTypeId","startDate"]},"ShiftLocationDto":{"type":"object","properties":{"name":{"minLength":2,"type":"string"},"latitude":{"maximum":90,"minimum":-90,"type":"number"},"longitude":{"maximum":180,"minimum":-180,"type":"number"},"radiusMeters":{"maximum":5000,"minimum":20,"type":"integer"}},"required":["name","latitude","longitude"]},"ShiftTypeDto":{"type":"object","properties":{"name":{"minLength":2,"type":"string"},"startTime":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"},"endTime":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"},"workingHours":{"maximum":24,"minimum":1,"type":"number"},"halfDayThresholdHours":{"maximum":24,"minimum":0,"type":"number"},"lateEntryGraceMinutes":{"minimum":0,"type":"integer"},"earlyExitGraceMinutes":{"minimum":0,"type":"integer"},"allowCheckInBeforeMinutes":{"minimum":0,"type":"integer"},"allowCheckOutAfterMinutes":{"minimum":0,"type":"integer"},"isNightShift":{"type":"boolean"},"status":{"enum":["ACTIVE","INACTIVE"],"type":"string"}},"required":["name","startTime","endTime","workingHours","halfDayThresholdHours"]},"SignUploadDto":{"type":"object","properties":{"fileName":{"maxLength":200,"type":"string"},"mime":{"maxLength":120,"type":"string"},"size":{"minimum":1,"type":"integer"}},"required":["fileName","mime","size"]},"StageDto":{"type":"object","properties":{"stage":{"type":"string","enum":["APPLIED","SCREENING","INTERVIEW","OFFER","HIRED","REJECTED"]},"rating":{"maximum":5,"minimum":0,"type":"number"}},"required":["stage"]},"StructureComponentDto":{"type":"object","properties":{"componentId":{"type":"string"},"formula":{"type":"string"},"amount":{"minimum":0,"type":"number"}},"required":["componentId"]},"StructurePreviewDto":{"type":"object","properties":{"salaryStructureId":{"type":"string"},"ctc":{"minimum":1,"type":"number"},"employeeId":{"type":"string"}},"required":["salaryStructureId","ctc"]},"TaskUpdateDto":{"type":"object","properties":{"status":{"enum":["PENDING","IN_PROGRESS","COMPLETED","SKIPPED"],"type":"string"},"remarks":{"type":"string"}},"required":["status"]},"TemplateTaskDto":{"type":"object","properties":{"title":{"minLength":2,"type":"string"},"description":{"type":"string"},"assignedRole":{"type":"string"},"dueInDays":{"minimum":0,"type":"integer"}},"required":["title"]},"TicketDto":{"type":"object","properties":{"subject":{"minLength":3,"type":"string"},"description":{"minLength":3,"type":"string"},"category":{"type":"string"},"priority":{"type":"string","enum":["LOW","MEDIUM","HIGH","URGENT"]}},"required":["subject","description"]},"TicketUpdateDto":{"type":"object","properties":{"status":{"type":"string","enum":["OPEN","IN_PROGRESS","RESOLVED","CLOSED"]},"assignedToId":{"type":"string"},"resolution":{"type":"string"},"priority":{"type":"string","enum":["LOW","MEDIUM","HIGH","URGENT"]}}},"TravelRequestDto":{"type":"object","properties":{"purpose":{"minLength":3,"type":"string"},"fromLocation":{"type":"string"},"toLocation":{"type":"string"},"departureDate":{"type":"string","description":"ISO 8601 date or date-time"},"returnDate":{"type":"string","description":"ISO 8601 date or date-time"},"estimatedCost":{"minimum":0,"type":"number"},"advanceRequired":{"minimum":0,"type":"number"}},"required":["purpose","fromLocation","toLocation","departureDate","returnDate"]},"UpdateAnnouncementDto":{"type":"object","properties":{"title":{"minLength":2,"type":"string"},"body":{"minLength":2,"type":"string"},"pinned":{"type":"boolean"},"publishAt":{"type":"string","description":"ISO 8601 date or date-time"},"expiresAt":{"type":"string","description":"ISO 8601 date or date-time"}}},"UpdateCompanyDto":{"type":"object","properties":{"name":{"type":"string"},"legalName":{"type":"string"},"registrationNumber":{"type":"string"},"pan":{"type":"string","pattern":"^[A-Z]{5}[0-9]{4}[A-Z]$"},"tan":{"type":"string","pattern":"^[A-Z]{4}[0-9]{5}[A-Z]$"},"pfNumber":{"type":"string"},"esiNumber":{"type":"string"},"ptRegistration":{"type":"string"},"gstin":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"pincode":{"type":"string"},"phone":{"type":"string"},"email":{"type":"string"},"website":{"type":"string"},"pfEnabled":{"type":"boolean"},"labourCodeWages":{"type":"boolean"},"esiEnabled":{"type":"boolean"},"ptEnabled":{"type":"boolean"},"lwfEnabled":{"type":"boolean"},"isMetroCity":{"type":"boolean"},"weeklyOffDays":{"type":"array","items":{"maximum":6,"minimum":0,"type":"integer"},"maxItems":6}}},"UpdateCycleDto":{"type":"object","properties":{"name":{"minLength":2,"type":"string"},"startDate":{"type":"string","description":"ISO 8601 date or date-time"},"endDate":{"type":"string","description":"ISO 8601 date or date-time"},"isActive":{"type":"boolean"}}},"UpdateDepartmentDto":{"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"type":"string"},"parentDepartmentId":{"type":"string"},"headId":{"type":"string"},"isGroup":{"type":"boolean"}}},"UpdateDesignationDto":{"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"type":"string"},"description":{"type":"string"}}},"UpdateEmployeeDto":{"type":"object","properties":{"employeeCode":{"maxLength":50,"type":"string"},"firstName":{"maxLength":100,"minLength":1,"type":"string"},"middleName":{"type":"string"},"lastName":{"maxLength":100,"type":"string"},"email":{"type":"string","format":"email"},"personalEmail":{"type":"string","format":"email"},"phone":{"type":"string","pattern":"^\\+?[0-9]{10,13}$"},"dateOfBirth":{"type":"string","description":"ISO 8601 date or date-time"},"gender":{"type":"string","enum":["MALE","FEMALE","OTHER"]},"maritalStatus":{"type":"string","enum":["SINGLE","MARRIED","DIVORCED","WIDOWED"]},"bloodGroup":{"type":"string"},"nationality":{"type":"string"},"religion":{"type":"string"},"fatherName":{"type":"string"},"motherName":{"type":"string"},"spouseName":{"type":"string"},"currentAddress":{"type":"string"},"permanentAddress":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"pincode":{"type":"string"},"emergencyContactName":{"type":"string"},"emergencyContactPhone":{"type":"string"},"emergencyContactRelation":{"type":"string"},"dateOfJoining":{"type":"string","description":"ISO 8601 date or date-time"},"dateOfConfirmation":{"type":"string","description":"ISO 8601 date or date-time"},"probationEndDate":{"type":"string","description":"ISO 8601 date or date-time"},"noticeperiodDays":{"minimum":0,"type":"integer"},"status":{"type":"string","enum":["ACTIVE","INACTIVE","SUSPENDED","LEFT"]},"employmentType":{"type":"string"},"departmentId":{"type":"string"},"designationId":{"type":"string"},"reportingManagerId":{"type":"string"},"leaveApproverId":{"type":"string"},"workLocation":{"type":"string"},"defaultShiftId":{"type":"string"},"bankName":{"type":"string"},"bankAccountNumber":{"type":"string","pattern":"^[0-9]{6,20}$"},"ifscCode":{"type":"string","pattern":"^[A-Z]{4}0[A-Z0-9]{6}$"},"bankBranch":{"type":"string"},"panNumber":{"type":"string","pattern":"^[A-Z]{5}[0-9]{4}[A-Z]$"},"aadhaarNumber":{"type":"string","pattern":"^[0-9]{12}$"},"uanNumber":{"type":"string"},"esicNumber":{"type":"string"},"pfAccountNumber":{"type":"string"},"professionalTaxState":{"type":"string"},"ctc":{"minimum":0,"type":"number"},"pfApplicable":{"type":"boolean"},"esiApplicable":{"type":"boolean"},"ptApplicable":{"type":"boolean"},"role":{"enum":["EMPLOYEE","MANAGER","PAYROLL_ADMIN","HR_ADMIN","AUDITOR","SUPER_ADMIN"],"type":"string"},"password":{"minLength":8,"type":"string"}}},"UpdateExpenseClaimDto":{"type":"object","properties":{"title":{"minLength":3,"type":"string"},"items":{"type":"array","items":{"$ref":"#/components/schemas/ExpenseItemDto"},"minItems":1},"submit":{}}},"UpdateGoalDto":{"type":"object","properties":{"achievedValue":{"type":"string"},"selfRating":{"maximum":5,"minimum":1,"type":"number"},"selfComment":{"type":"string"},"managerRating":{"maximum":5,"minimum":1,"type":"number"},"managerComment":{"type":"string"},"employeeId":{"type":"string"},"title":{"minLength":2,"type":"string"},"description":{"type":"string"},"weightage":{"maximum":100,"minimum":0,"type":"number"},"targetValue":{"type":"string"},"startDate":{"type":"string","description":"ISO 8601 date or date-time"},"endDate":{"type":"string","description":"ISO 8601 date or date-time"}}},"UpdateHolidayListDto":{"type":"object","properties":{"name":{"type":"string"},"year":{"maximum":2100,"minimum":2000,"type":"integer"},"state":{"type":"string"},"isDefault":{"type":"boolean"},"holidays":{"type":"array","items":{"$ref":"#/components/schemas/HolidayItemDto"},"minItems":0}}},"UpdateJobDto":{"type":"object","properties":{"title":{"minLength":3,"type":"string"},"departmentId":{"type":"string"},"designationId":{"type":"string"},"location":{"type":"string"},"employmentType":{"type":"string"},"experience":{"type":"string"},"description":{"minLength":10,"type":"string"},"vacancies":{"minimum":1,"type":"integer"},"salaryMin":{"minimum":0,"type":"number"},"salaryMax":{"minimum":0,"type":"number"},"closesOn":{"type":"string","description":"ISO 8601 date or date-time"},"status":{"enum":["DRAFT","OPEN","ON_HOLD","CLOSED"],"type":"string"}}},"UpdateLeavePolicyDto":{"type":"object","properties":{"name":{"minLength":2,"type":"string"},"isActive":{"type":"boolean"},"details":{"type":"array","items":{"$ref":"#/components/schemas/PolicyDetailDto"},"minItems":1}}},"UpdateLeaveTypeDto":{"type":"object","properties":{"name":{"minLength":2,"type":"string"},"maxDaysAllowed":{"minimum":0,"type":"number"},"isCarryForward":{"type":"boolean"},"maxCarryForwardDays":{"minimum":0,"type":"number"},"isEncashable":{"type":"boolean"},"maxEncashableDays":{"minimum":0,"type":"number"},"isEarnedLeave":{"type":"boolean"},"earnedLeaveFrequency":{"enum":["MONTHLY"],"type":"string"},"isLWP":{"type":"boolean"},"isCompensatory":{"type":"boolean"},"includeHolidays":{"type":"boolean"},"sandwichRule":{"type":"boolean"},"allowNegativeBalance":{"type":"boolean"},"isPaid":{"type":"boolean"},"maxContinuousDays":{"minimum":1,"type":"integer"},"applicableAfterDays":{"minimum":0,"type":"integer"},"applicableGender":{"type":"string","enum":["MALE","FEMALE","OTHER"]}}},"UpdateOnboardingTemplateDto":{"type":"object","properties":{"name":{"minLength":2,"type":"string"},"isActive":{"type":"boolean"},"tasks":{"type":"array","items":{"$ref":"#/components/schemas/TemplateTaskDto"},"minItems":1}}},"UpdatePolicyDto":{"type":"object","properties":{"title":{"minLength":2,"type":"string"},"category":{"type":"string"},"content":{"minLength":2,"type":"string"},"isActive":{"type":"boolean"}}},"UpdateSalaryComponentDto":{"type":"object","properties":{"name":{"minLength":2,"type":"string"},"abbr":{"minLength":2,"type":"string"},"type":{"type":"string","enum":["EARNING","DEDUCTION"]},"description":{"type":"string"},"isTaxApplicable":{"type":"boolean"},"dependsOnPaymentDays":{"type":"boolean"},"isPfApplicable":{"type":"boolean"},"isEsiApplicable":{"type":"boolean"},"isPtApplicable":{"type":"boolean"},"componentType":{"type":"string"},"formula":{"type":"string"},"sortOrder":{"type":"integer"},"exemptionCode":{"enum":["CHILD_EDUCATION","HOSTEL","MEAL",null],"type":"string"}}},"UpdateSalaryStructureDto":{"type":"object","properties":{"name":{"minLength":2,"type":"string"},"description":{"type":"string"},"payrollFrequency":{"type":"string","enum":["MONTHLY","BIMONTHLY","FORTNIGHTLY","WEEKLY"]},"isActive":{"type":"boolean"},"components":{"type":"array","items":{"$ref":"#/components/schemas/StructureComponentDto"},"minItems":1}}},"UpdateSelfDto":{"type":"object","properties":{"phone":{"type":"string","pattern":"^\\+?[0-9]{10,13}$"},"personalEmail":{"type":"string","format":"email"},"currentAddress":{"type":"string"},"permanentAddress":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"pincode":{"type":"string"},"bloodGroup":{"type":"string"},"emergencyContactName":{"type":"string"},"emergencyContactPhone":{"type":"string"},"emergencyContactRelation":{"type":"string"},"maritalStatus":{"type":"string","enum":["SINGLE","MARRIED","DIVORCED","WIDOWED"]}}},"UpdateShiftLocationDto":{"type":"object","properties":{"name":{"minLength":2,"type":"string"},"latitude":{"maximum":90,"minimum":-90,"type":"number"},"longitude":{"maximum":180,"minimum":-180,"type":"number"},"radiusMeters":{"maximum":5000,"minimum":20,"type":"integer"}}},"UpdateShiftTypeDto":{"type":"object","properties":{"name":{"minLength":2,"type":"string"},"startTime":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"},"endTime":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"},"workingHours":{"maximum":24,"minimum":1,"type":"number"},"halfDayThresholdHours":{"maximum":24,"minimum":0,"type":"number"},"lateEntryGraceMinutes":{"minimum":0,"type":"integer"},"earlyExitGraceMinutes":{"minimum":0,"type":"integer"},"allowCheckInBeforeMinutes":{"minimum":0,"type":"integer"},"allowCheckOutAfterMinutes":{"minimum":0,"type":"integer"},"isNightShift":{"type":"boolean"},"status":{"enum":["ACTIVE","INACTIVE"],"type":"string"}}}},"responses":{"BadRequest":{"description":"The request body or a parameter failed validation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Unauthorized":{"description":"No valid access token was sent, or the session has ended.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Forbidden":{"description":"The signed-in user’s role or the company’s plan does not allow this.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"NotFound":{"description":"No such record in this company.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"TooManyRequests":{"description":"More than 300 requests in 60 seconds from one address.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"x-rate-limit":{"limit":300,"windowSeconds":60,"scope":"per client address"}}