openapi: 3.0.0 info: description: "All requests are required to be sent to your subdomain. To learn how\ \ to enable API in your Sage HR account, please visit https://support.sage.hr/en/articles/3246469-how-does-cakehr-api-work" title: Sage HR API version: "1.0" x-konfig-ignore: potential-incorrect-type: true x-konfig-uses-multipart-form-data: true servers: - url: https://subdomain.sage.hr/api tags: - name: Integrations - name: Employee - name: Leave management - name: Recruitment - name: Performance - name: KIT days - name: Policies - name: Documents - name: Onboarding - name: Offboarding - name: Positions - name: Teams - name: Timesheets - name: Terminations reasons paths: /employees: get: operationId: Employee_listActiveEmployees parameters: - example: 2 explode: true in: query name: page required: false schema: type: integer style: form x-konfig-original-example: 2 - example: true explode: true in: query name: team_history required: false schema: type: boolean style: form x-konfig-original-example: true - example: true explode: true in: query name: employment_status_history required: false schema: type: boolean style: form x-konfig-original-example: true - example: true explode: true in: query name: position_history required: false schema: type: boolean style: form x-konfig-original-example: true responses: "200": content: application/json: examples: response: value: data: - id: 19 email: john@example.com first_name: John last_name: Doe picture_url: https://example.com/john.png employment_start_date: 2014-08-25 date_of_birth: 1991-02-13 team: Sage HR team_id: 1 position: Api developer position_id: 123 reports_to_employee_id: 5 work_phone: 555-0505 home_phone: 555-0506 mobile_phone: 555-0507 gender: Male street_first: 84 Glenwood Street street_second: Peoria city: London post_code: 99999 country: GB employee_number: A01 employment_status: Full-time team_history: - team_id: 1 start_date: 2018-01-01 end_date: 201-01-01 team_name: Some Team employment_status_history: - employment_status_id: 1 start_date: 2018-01-01 end_date: 201-01-01 employment_statu_name: Full time position_history: - position_id: 1 start_date: 2018-01-01 end_date: 201-01-01 position_name: Developer position_code: "1234" meta: current_page: 1 next_page: 2 previous_page: null total_pages: 2 per_page: 50 total_entries: 75 schema: $ref: '#/components/schemas/EmployeeListActiveEmployeesResponse' description: "Successful Response, team_history/employment_status_history/position_history\ \ collections are returned only if regarding optional paramters are provided\ \ in query" security: - api_key: [] summary: List active employees in company tags: - Employee x-konfig-operation-can-have-single-parameter: true x-konfig-single-parameter-schema: konfig-generated-schema-single-parameter-schema-get--employees x-accepts: application/json post: operationId: Employee_createNewEmployee requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/EmployeeCreateNewEmployeeRequest' required: true responses: "201": content: application/json: examples: response: value: data: id: 1 schema: $ref: '#/components/schemas/EmployeeCreateNewEmployeeResponse' description: Successful Response summary: Create new employee tags: - Employee x-konfig-operation-can-have-single-parameter: true x-konfig-single-parameter-schema: konfig-generated-schema-single-parameter-schema-post--employees x-content-type: application/x-www-form-urlencoded x-accepts: application/json summary: Employees /employees/{id}: get: operationId: Employee_getById parameters: - description: Numeric ID of the user to get. explode: false in: path name: id required: true schema: type: integer style: simple - example: true explode: true in: query name: team_history required: false schema: type: boolean style: form x-konfig-original-example: true - example: true explode: true in: query name: employment_status_history required: false schema: type: boolean style: form x-konfig-original-example: true - example: true explode: true in: query name: position_history required: false schema: type: boolean style: form x-konfig-original-example: true responses: "200": content: application/json: examples: response: value: data: id: 19 email: john@example.com first_name: John last_name: Doe picture_url: https://example.com/john.png employment_start_date: 2014-08-25 date_of_birth: 1991-02-13 team: Sage HR team_id: 6742 position: Api developer position_id: 123 reports_to_employee_id: 5 work_phone: 555-0505 home_phone: 555-0506 mobile_phone: 555-0507 gender: Male street_first: 84 Glenwood Street street_second: Peoria city: London post_code: 99999 country: GB employee_number: A1 employment_status: Full-time team_history: - team_id: 1 start_date: 2018-01-01 end_date: 201-01-01 team_name: Some Team employment_status_history: - employment_status_id: 1 start_date: 2018-01-01 end_date: 201-01-01 employment_statu_name: Full time position_history: - position_id: 1 start_date: 2018-01-01 end_date: 201-01-01 position_name: Developer position_code: "1234" schema: $ref: '#/components/schemas/EmployeeGetByIdResponse' description: "Successful Response, team_history/employment_status_history/position_history\ \ collections are returned only if regarding optional paramters are provided\ \ in query" security: - api_key: [] summary: Single active employee in company tags: - Employee x-konfig-operation-can-have-single-parameter: true x-konfig-single-parameter-schema: konfig-generated-schema-single-parameter-schema-get--employees-id x-accepts: application/json put: operationId: Employee_updateById parameters: - description: Numeric ID of the user to update. explode: false in: path name: id required: true schema: type: integer style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/EmployeeUpdateByIdRequest' responses: "202": content: application/json: examples: response: value: data: id: 1711 schema: $ref: '#/components/schemas/EmployeeUpdateByIdResponse' description: Accepted "404": content: application/json: examples: response: value: error_code: not_found errors: [] schema: $ref: '#/components/schemas/EmployeeUpdateById404Response' description: Not Found x-do-not-generate: true summary: Update Employee tags: - Employee x-konfig-operation-can-have-single-parameter: true x-konfig-single-parameter-schema: konfig-generated-schema-single-parameter-schema-put--employees-id x-content-type: application/json x-accepts: application/json summary: Employee /employees/{id}/custom-fields: get: operationId: Employee_getCustomFields parameters: - description: Numeric ID of the user to get. explode: false in: path name: id required: true schema: type: integer style: simple responses: "200": content: application/json: examples: response: value: data: - id: 1 label: Hobby type: CustomDropdownField value: Hockey options: - Hockey - Football - Voleyball - id: 2 label: Languages type: CustomTags options: null value: - English - Latvian - Estonian schema: $ref: '#/components/schemas/EmployeeGetCustomFieldsResponse' description: Successful Response security: - api_key: [] summary: Employee custom fields tags: - Employee x-konfig-operation-can-have-single-parameter: true x-konfig-single-parameter-schema: konfig-generated-schema-single-parameter-schema-get--employees-id-custom-fields x-accepts: application/json summary: Custom fields /employees/{id}/custom-fields/{custom_field_id}: put: description: Update employee custom field operationId: Employee_updateCustomField parameters: - description: Employee identifier explode: false in: path name: id required: true schema: type: integer style: simple - description: Custom field identifier explode: false in: path name: custom_field_id required: true schema: type: integer style: simple requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/EmployeeUpdateCustomFieldRequest' required: true responses: "200": content: application/json: examples: response: value: data: null schema: $ref: '#/components/schemas/EmployeeUpdateCustomFieldResponse' description: Successful Response "422": content: application/json: examples: response: value: error_code: validation_failed errors: - Custom field text too long (max 250 characters) schema: $ref: '#/components/schemas/EmployeeUpdateCustomField422Response' description: Unprocessable entity x-do-not-generate: true summary: Update custom field tags: - Employee x-konfig-operation-can-have-single-parameter: true x-konfig-single-parameter-schema: konfig-generated-schema-single-parameter-schema-put--employees-id-custom-fields-custom_field_id x-content-type: application/x-www-form-urlencoded x-accepts: application/json summary: Custom field /employees/{id}/terminations: post: operationId: Employee_terminateEmployee parameters: - description: Numeric ID of the user explode: false in: path name: id required: true schema: type: integer style: simple requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/EmployeeTerminateEmployeeRequest' required: true responses: "201": content: application/json: examples: response: value: data: {} schema: $ref: '#/components/schemas/EmployeeTerminateEmployeeResponse' description: Successful Response security: - api_key: [] summary: Terminate employee tags: - Employee x-konfig-operation-can-have-single-parameter: true x-konfig-single-parameter-schema: konfig-generated-schema-single-parameter-schema-post--employees-id-terminations x-content-type: application/x-www-form-urlencoded x-accepts: application/json summary: Terminate employee /terminated-employees: get: operationId: Employee_listTerminatedEmployees parameters: - example: 2 explode: true in: query name: page required: false schema: type: integer style: form x-konfig-original-example: 2 responses: "200": content: application/json: examples: response: value: data: - id: 19 termination_date: 2015-05-28 employee_number: "123" email: john@example.com first_name: John last_name: Doe picture_url: https://example.com/john.png employment_start_date: 2014-08-25 date_of_birth: 1991-02-13 position: Api developer meta: current_page: 1 next_page: 2 previous_page: null total_pages: 2 per_page: 50 total_entries: 75 schema: $ref: '#/components/schemas/EmployeeListTerminatedEmployeesResponse' description: Successful Response security: - api_key: [] summary: List terminated employees in company tags: - Employee x-konfig-operation-can-have-single-parameter: true x-konfig-single-parameter-schema: konfig-generated-schema-single-parameter-schema-get--terminated-employees x-accepts: application/json summary: Terminated employees /terminated-employees/{id}: get: operationId: Employee_getTerminatedEmployee parameters: - description: Numeric ID of the user to get. explode: false in: path name: id required: true schema: type: integer style: simple responses: "200": content: application/json: examples: response: value: data: id: 19 termination_date: 2015-05-28 email: john@example.com first_name: John last_name: Doe picture_url: https://example.com/john.png employment_start_date: 2014-08-25 date_of_birth: 1991-02-13 position: Api developer termination: reason: Moving location comments: Moving to schema: $ref: '#/components/schemas/EmployeeGetTerminatedEmployeeResponse' description: Successful Response security: - api_key: [] summary: Single terminated employee in company tags: - Employee x-konfig-operation-can-have-single-parameter: true x-konfig-single-parameter-schema: konfig-generated-schema-single-parameter-schema-get--terminated-employees-id x-accepts: application/json summary: Terminated employee /leave-management/policies: get: operationId: LeaveManagement_listTimeOffPolicies parameters: [] responses: "200": content: application/json: examples: response: value: data: - id: 1 name: Vacation color: '#49B284' do_not_accrue: false unit: days default_allowance: "26" max_carryover: "100.0" accrue_type: yearly - id: 2 name: Sickday color: '#DB263F' do_not_accrue: true unit: days default_allowance: "0.0" max_carryover: "0.0" accrue_type: no_tracking schema: $ref: '#/components/schemas/LeaveManagementListTimeOffPoliciesResponse' description: Successful Response security: - api_key: [] summary: List time off policies tags: - Leave management x-konfig-operation-can-have-single-parameter: true x-konfig-single-parameter-schema: konfig-generated-schema-single-parameter-schema-get--leave-management-policies x-accepts: application/json summary: Time off policies /leave-management/policies/{id}: get: operationId: LeaveManagement_getTimeOffPolicyById parameters: - description: Numeric ID of the policy to get. explode: false in: path name: id required: true schema: type: integer style: simple responses: "200": content: application/json: examples: response: value: data: - id: 1 name: Vacation color: '#3a7dd8' do_not_accrue: false unit: days default_allowance: "25.0" max_carryover: "100.0" accrue_type: yearly enable_employee_access: true only_full_days: false enable_probation_period: false dont_allow_negative_amount: false requests_in_advance_required: false enable_minimum_days: false enable_limited_days: false enable_dependent_policy": false blocks_enabled: false no_reset: false termination_recalculation: true enable_service_accruals: false child_allowance_enabled: false enable_negative_carryover: false max_accrual: false accrue_at_start: true enable_monthly_expiration: false starter_monthly_accrual_limitation: false starter_yearly_accrual_limitation: false auto_approves: false enable_specific_approvers: false override_approvers_enabled: false enable_duplicate_time_offs: false enable_replacement: false replacement_required: false enable_scopped_replacement: false enable_replacement_away: false enable_details: true require_details: false additional_field: true enable_attachment: false schema: $ref: '#/components/schemas/LeaveManagementGetTimeOffPolicyByIdResponse' description: Successful Response security: - api_key: [] summary: Details about a time off policy tags: - Leave management x-konfig-operation-can-have-single-parameter: true x-konfig-single-parameter-schema: konfig-generated-schema-single-parameter-schema-get--leave-management-policies-id x-accepts: application/json patch: operationId: LeaveManagement_updateKitDaysConfiguration parameters: - description: Numeric ID of the policy to get. explode: false in: path name: id required: true schema: type: integer style: simple requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/LeaveManagementUpdateKitDaysConfigurationRequest' required: true responses: "200": description: Successful Response "422": content: application/json: examples: response: value: error_code: invalid_policy_type errors: - The policy specified is not an event-based policy schema: $ref: '#/components/schemas/LeaveManagementUpdateKitDaysConfigurationResponse' description: Unprocessable entity x-do-not-generate: true security: - api_key: [] summary: Update KIT days configuration of a time off policy tags: - Leave management - KIT days x-konfig-operation-can-have-single-parameter: true x-konfig-single-parameter-schema: konfig-generated-schema-single-parameter-schema-patch--leave-management-policies-id x-content-type: application/x-www-form-urlencoded x-accepts: application/json summary: Time off policy /leave-management/kit-days: get: operationId: LeaveManagement_getKitDays parameters: - description: Time-off policy identifier example: 1 explode: true in: query name: policy_id required: true schema: type: integer style: form x-konfig-original-example: 1 - description: Employee identifier example: 2 explode: true in: query name: employee_id required: true schema: type: integer style: form x-konfig-original-example: 2 responses: "200": content: application/json: examples: response: value: data: - id: 1 status: declined start_date: 2021-03-09 end_date: 2021-03-10 - id: 2 status: approved start_date: 2021-03-09 end_date: 2021-03-10 schema: $ref: '#/components/schemas/LeaveManagementGetKitDaysResponse' description: Successful Response security: - api_key: [] summary: View all the KIT days of an employee in a policy tags: - Leave management - KIT days - Policies x-konfig-operation-can-have-single-parameter: true x-konfig-single-parameter-schema: konfig-generated-schema-single-parameter-schema-get--leave-management-kit-days x-accepts: application/json post: operationId: LeaveManagement_createKitDay parameters: [] requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/LeaveManagementCreateKitDayRequest' required: true responses: "200": content: application/json: examples: response: value: data: - id: 1 schema: $ref: '#/components/schemas/LeaveManagementCreateKitDayResponse' description: Successful Response "422": content: application/json: examples: response: value: error_code: validation_failed errors: - First error - Second error schema: $ref: '#/components/schemas/LeaveManagementCreateKitDay422Response' description: Unprocessable entity x-do-not-generate: true security: - api_key: [] summary: Create a KIT day in a leave tags: - Leave management - KIT days - Policies x-konfig-operation-can-have-single-parameter: true x-konfig-single-parameter-schema: konfig-generated-schema-single-parameter-schema-post--leave-management-kit-days x-content-type: application/x-www-form-urlencoded x-accepts: application/json summary: KIT days /leave-management/kit-days/{id}: patch: operationId: LeaveManagement_processKitDay parameters: - description: KIT day identifier explode: false in: path name: id required: true schema: type: integer style: simple requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/LeaveManagementProcessKitDayRequest' required: true responses: "200": description: Successful Response security: - api_key: [] summary: "Approve, decline or cancel a KIT day" tags: - Leave management - KIT days - Policies x-konfig-operation-can-have-single-parameter: true x-konfig-single-parameter-schema: konfig-generated-schema-single-parameter-schema-patch--leave-management-kit-days-id x-content-type: application/x-www-form-urlencoded x-accepts: application/json summary: KIT days /leave-management/reports/individual-allowances: get: operationId: LeaveManagement_getIndividualAllowances parameters: - example: 2 explode: true in: query name: page required: false schema: type: integer style: form x-konfig-original-example: 2 - example: 25 explode: true in: query name: per_page required: false schema: type: integer style: form x-konfig-original-example: 25 - description: Limit the reports to employees in specified location ids example: - 14 - 13 explode: false in: query name: location_ids required: false schema: items: type: integer type: array style: form x-konfig-original-example: - 14 - 13 - description: Limit the reports to selected employee ids example: - 1 - 2 - 3 explode: false in: query name: employee_ids required: false schema: items: type: integer type: array style: form x-konfig-original-example: - 1 - 2 - 3 - description: Limit the reports to employees in specified team ids example: - 1 explode: false in: query name: team_ids required: false schema: items: type: integer type: array style: form x-konfig-original-example: - 1 responses: "200": content: application/json: examples: response: value: data: - full_name: Joe Doe id: 11 eligibilities: - policy: name: Sickday id: 2 quantity: "0.0" unit: days carryover: "0.0" - policy: name: Vacation id: 1 quantity: "25.0" unit: days carryover: "100.0" - full_name: Jane Doe id: 13 eligibilities: - policy: name: Custom Policy id: 4 quantity: "0.0" unit: days carryover: "0.0" - policy: name: Vacation id: 1 quantity: "25.0" unit: days carryover: "100.0" meta: current_page: 1 next_page: null previous_page: null total_pages: 1 per_page: 25 total_entries: 1 schema: $ref: '#/components/schemas/LeaveManagementGetIndividualAllowancesResponse' description: Successful Response security: - api_key: [] summary: Report with individual allowances tags: - Leave management x-konfig-operation-can-have-single-parameter: true x-konfig-single-parameter-schema: konfig-generated-schema-single-parameter-schema-get--leave-management-reports-individual-allowances x-accepts: application/json summary: Individual Allowances /employees/{id}/leave-management/balances: get: operationId: LeaveManagement_getTimeOffBalances parameters: - description: Numeric ID of the user to get. explode: false in: path name: id required: true schema: type: integer style: simple responses: "200": content: application/json: examples: response: value: data: - policy_id: 1 used: 5.6 available: 2 - policy_id: 2 used: 75 available: null schema: $ref: '#/components/schemas/LeaveManagementGetTimeOffBalancesResponse' description: Successful Response security: - api_key: [] summary: Employee time off balances tags: - Leave management - Employee x-konfig-operation-can-have-single-parameter: true x-konfig-single-parameter-schema: konfig-generated-schema-single-parameter-schema-get--employees-id-leave-management-balances x-accepts: application/json summary: Employee time off balances /leave-management/requests: get: operationId: LeaveManagement_listTimeOffRequests parameters: - example: 2 explode: true in: query name: page required: false schema: type: integer style: form x-konfig-original-example: 2 - description: If not specified defaults to beginning of current month example: 2018-05-20 explode: true in: query name: from required: false schema: type: string style: form x-konfig-original-example: 2018-05-20 - description: If not specified defaults to end of current month. Days between from date and to date must be less than 65. If you need info for larger period of time make multiple requests; example: 2018-06-20 explode: true in: query name: to required: false schema: type: string style: form x-konfig-original-example: 2018-06-20 responses: "200": content: application/json: examples: response: value: data: - id: 2902504 status: Approved status_code: approved policy_id: 1 employee_id: 1 details: Birthday lunch is_multi_date: false is_single_day: true is_part_of_day: true first_part_of_day: false second_part_of_day: true start_date: 2018-05-24 end_date: 2018-05-24 request_date: 2018-05-22 approval_date: null hours: 3.5 fields: - title: Approved by manager? answer: true meta: current_page: 1 next_page: 2 previous_page: null total_pages: 2 per_page: 50 total_entries: 75 schema: $ref: '#/components/schemas/LeaveManagementListTimeOffRequestsResponse' description: Successful Response security: - api_key: [] summary: List time off requests tags: - Leave management x-konfig-operation-can-have-single-parameter: true x-konfig-single-parameter-schema: konfig-generated-schema-single-parameter-schema-get--leave-management-requests x-accepts: application/json post: operationId: LeaveManagement_newTimeOffRequest requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/LeaveManagementNewTimeOffRequestRequest' required: true responses: "201": content: application/json: examples: response: value: data: id: 1 schema: $ref: '#/components/schemas/LeaveManagementNewTimeOffRequestResponse' description: Successful Response "422": content: application/json: examples: response: value: error_code: validation_failed errors: - Error message schema: $ref: '#/components/schemas/LeaveManagementNewTimeOffRequest422Response' description: Validation Failed Response x-do-not-generate: true summary: Create new time off request tags: - Leave management x-konfig-operation-can-have-single-parameter: true x-konfig-single-parameter-schema: konfig-generated-schema-single-parameter-schema-post--leave-management-requests x-content-type: application/x-www-form-urlencoded x-accepts: application/json summary: Time off requests /leave-management/out-of-office-today: get: operationId: LeaveManagement_listEmployeesOutToday parameters: - description: "Optional date, defauls to today" example: 2018-11-23 explode: true in: query name: date required: false schema: type: string style: form x-konfig-original-example: 2018-11-23 responses: "200": content: application/json: examples: response: value: data: - id: 2902504 policy_id: 2 policy: name: Vacation employee_id: 5 employee: first_name: John last_name: Doe details: Birthday lunch is_multi_date: false is_single_day: true is_part_of_day: true first_part_of_day: false second_part_of_day: true start_date: 2018-05-24 end_date: 2018-05-24 hours: 3.5 schema: $ref: '#/components/schemas/LeaveManagementListEmployeesOutTodayResponse' description: Successful Response security: - api_key: [] summary: List employees out of office today tags: - Leave management x-konfig-operation-can-have-single-parameter: true x-konfig-single-parameter-schema: konfig-generated-schema-single-parameter-schema-get--leave-management-out-of-office-today x-accepts: application/json summary: Out of office today /documents/categories: get: operationId: Documents_listCategories responses: "200": content: application/json: examples: response: value: data: - id: 1 name: General documents_count: 10 - id: 2 name: Job contracts documents_count: 1 schema: $ref: '#/components/schemas/DocumentsListCategoriesResponse' description: Successful Response summary: List document categories tags: - Documents x-konfig-operation-can-have-single-parameter: true x-konfig-single-parameter-schema: konfig-generated-schema-single-parameter-schema-get--documents-categories x-accepts: application/json summary: Document categories /documents: post: description: Document will only be visible to employee themselves operationId: Documents_createNewDocument requestBody: content: multipart/form-data: schema: $ref: '#/components/schemas/DocumentsCreateNewDocumentRequest' required: true responses: "201": content: application/json: examples: response: value: data: id: 1 schema: $ref: '#/components/schemas/DocumentsCreateNewDocumentResponse' description: Successful Response summary: Create new document tags: - Documents x-konfig-operation-can-have-single-parameter: true x-konfig-single-parameter-schema: konfig-generated-schema-single-parameter-schema-post--documents x-content-type: multipart/form-data x-accepts: application/json summary: Document /positions: get: operationId: Positions_listCompanyPositions parameters: - example: 2 explode: true in: query name: page required: false schema: type: integer style: form x-konfig-original-example: 2 responses: "200": content: application/json: examples: response: value: data: - title: CFO description: '...' id: 19 code: X2 - title: CEO description: null id: 20 code: null meta: current_page: 1 next_page: 2 previous_page: null total_pages: 2 per_page: 50 total_entries: 75 schema: $ref: '#/components/schemas/PositionsListCompanyPositionsResponse' description: Successful Response security: - api_key: [] summary: List positions in company tags: - Positions x-konfig-operation-can-have-single-parameter: true x-konfig-single-parameter-schema: konfig-generated-schema-single-parameter-schema-get--positions x-accepts: application/json summary: Positions /teams: get: operationId: Teams_listInCompany parameters: - example: 2 explode: true in: query name: page required: false schema: type: integer style: form x-konfig-original-example: 2 responses: "200": content: application/json: examples: response: value: data: - id: 19 name: Sales manager_ids: - 1 - 2 employee_ids: - 5 - 7 - 90 meta: current_page: 1 next_page: 2 previous_page: null total_pages: 2 per_page: 50 total_entries: 75 schema: $ref: '#/components/schemas/TeamsListInCompanyResponse' description: Successful Response security: - api_key: [] summary: List teams in company tags: - Teams x-konfig-operation-can-have-single-parameter: true x-konfig-single-parameter-schema: konfig-generated-schema-single-parameter-schema-get--teams x-accepts: application/json summary: Teams /performance/goals/quarterly-progress/overall: get: operationId: Performance_overviewQuarterlyProgress parameters: [] responses: "200": content: application/json: examples: response: value: data: company: adjusted: 18 actual: 15 individual: adjusted: 31 actual: 26 team: adjusted: 42 actual: 37 schema: $ref: '#/components/schemas/PerformanceOverviewQuarterlyProgressResponse' description: Successful Response security: - api_key: [] summary: Overview of quarterly goal progress tags: - Performance x-konfig-operation-can-have-single-parameter: true x-konfig-single-parameter-schema: konfig-generated-schema-single-parameter-schema-get--performance-goals-quarterly-progress-overall x-accepts: application/json summary: Overview of quarterly goal progress /performance/goals/quarterly-progress/company-goals: get: operationId: Performance_getQuarterlyCompanyGoals parameters: [] responses: "200": content: application/json: examples: response: value: data: - title: Optimize data storage progress: actual: 10 to_date: 34 schema: $ref: '#/components/schemas/PerformanceGetQuarterlyCompanyGoalsResponse' description: Successful Response security: - api_key: [] summary: Quarterly company goals tags: - Performance x-konfig-operation-can-have-single-parameter: true x-konfig-single-parameter-schema: konfig-generated-schema-single-parameter-schema-get--performance-goals-quarterly-progress-company-goals x-accepts: application/json summary: Quarterly company goals /performance/goals/quarterly-progress/team-goals: get: operationId: Performance_getQuarterlyTeamGoals parameters: [] responses: "200": content: application/json: examples: response: value: data: - name: HR team progress: actual: 10 to_date: 34 goals: - title: Optimize data storage progress: actual: 10 to_date: 34 schema: $ref: '#/components/schemas/PerformanceGetQuarterlyTeamGoalsResponse' description: Successful Response security: - api_key: [] summary: Quarterly team goals tags: - Performance x-konfig-operation-can-have-single-parameter: true x-konfig-single-parameter-schema: konfig-generated-schema-single-parameter-schema-get--performance-goals-quarterly-progress-team-goals x-accepts: application/json summary: Quarterly team goals /performance/goals/quarterly-progress/individual-goals: get: operationId: Performance_getQuarterlyIndividualGoals parameters: [] responses: "200": content: application/json: examples: response: value: data: - name: John Doe progress: actual: 10 to_date: 34 goals: - title: Optimize data storage progress: actual: 10 to_date: 34 schema: $ref: '#/components/schemas/PerformanceGetQuarterlyIndividualGoalsResponse' description: Successful Response security: - api_key: [] summary: Quarterly individual goals tags: - Performance x-konfig-operation-can-have-single-parameter: true x-konfig-single-parameter-schema: konfig-generated-schema-single-parameter-schema-get--performance-goals-quarterly-progress-individual-goals x-accepts: application/json summary: Quarterly individual goals /employees/{id}/compensations: get: operationId: Employee_getCompensations parameters: - description: Numeric ID of the user to get. explode: false in: path name: id required: true schema: type: integer style: simple responses: "200": content: application/json: examples: response: value: data: - start_date: 2017-01-01 end_date: 2019-01-01 currency: EUR amount: 1234 period: monthly comment: Starting salary category: Salary meta: current_page: 1 next_page: 2 previous_page: null total_pages: 2 per_page: 50 total_entries: 75 schema: $ref: '#/components/schemas/EmployeeGetCompensationsResponse' description: Successful Response security: - api_key: [] summary: Employee compensations tags: - Employee x-konfig-operation-can-have-single-parameter: true x-konfig-single-parameter-schema: konfig-generated-schema-single-parameter-schema-get--employees-id-compensations x-accepts: application/json summary: Compensation /recruitment/positions: get: description: | Posible recruitment position statuses: `draft`, `published`, `internal`, `completed`, `cancelled` operationId: Recruitment_listPositions parameters: - description: | Filter by status, see list of possible statuses `?status=open` example: completed explode: true in: query name: status required: false schema: type: string style: form x-konfig-original-example: completed - description: | Filter by hiring manager id, can appear multiple times `hiring_manager_ids[]=251&hiring_manager_ids[]=121` example: - "251" - "121" explode: false in: query name: hiring_manager_ids required: false schema: items: type: string type: array style: form x-konfig-original-example: - "251" - "121" - description: | Filter by group id, can appear multiple times `group_ids[]=27&group_ids[]=761` example: - "27" - "761" explode: false in: query name: group_ids required: false schema: items: type: string type: array style: form x-konfig-original-example: - "27" - "761" - description: | Filter by location id, can appear multiple times `location_ids[]=1&location_ids[]=12` example: - "1" - "12" explode: false in: query name: location_ids required: false schema: items: type: string type: array style: form x-konfig-original-example: - "1" - "12" - description: "Pagination: fetch page at given offset" example: 2 explode: true in: query name: page required: false schema: type: integer style: form x-konfig-original-example: 2 - description: | Pagination: amount of positions to return in 1 call, default: 30, max: 100 example: 25 explode: true in: query name: per_page required: false schema: type: integer style: form x-konfig-original-example: 25 responses: "200": content: application/json: examples: response: value: data: - title: CEO id: 2902504 status: published visibility: Published created_at: 2019-09-01 internal_date: 2019-10-01 completed_at: null link: https://talent.sage.hr/jobs/xxx team: Management applicants_required: 1 applicants_count: 3 employment_type: Full-time location: London location_id: 9182712 group: Hiring Group group_id: 871621 priority: 1 description_blocks: - title: Requirements content: Html content goes here - title: CFO id: 212 status: completed visibility: Completed created_at: 2019-09-01 internal_date: 2019-10-21 completed_at: 2019-10-12 link: null team: "" applicants_required: 2 applicants_count: 4 employment_type: null location: null location_id: null group: Hiring Group group_id: 871621 priority: 9800 description_blocks: - title: Description content:
This is a CFO position.
- title: Requirements content:Be a CFO
- title: Benefits content:iPhone 12
meta: current_page: 1 next_page: 2 previous_page: null total_pages: 2 per_page: 20 total_entries: 34 schema: $ref: '#/components/schemas/RecruitmentListPositionsResponse' description: Successful Response security: - api_key: [] summary: List recruitment positions tags: - Recruitment x-konfig-operation-can-have-single-parameter: true x-konfig-single-parameter-schema: konfig-generated-schema-single-parameter-schema-get--recruitment-positions x-accepts: application/json summary: Positions /recruitment/positions/{id}: get: operationId: Recruitment_getPositionDetails parameters: - description: Numeric ID of position explode: false in: path name: id required: true schema: type: integer style: simple responses: "200": content: application/json: examples: response: value: data: title: CTO id: 1 status: completed visibility: Completed created_at: 2020-10-15 internal_date: 2020-10-31 completed_at: 2020-10-28 link: null team: "" applicants_required: 1 applicants_count: 2 employment_type: Full-time location: New York location_id: 4 group: Hiring Group group_id: 1 priority: 1 description_blocks: - title: Description content:This is what we required.
- title: Benefits content:Here are some benefits.
- title: More Details content:A custom block.
applicants: - id: 1 full_name: Jon Vondrak email: jon.vondrak@example.com - id: 2 full_name: Samantha Cross email: sam.cross@example.com hiring_team: - id: 12 full_name: Manel Lopez-Bru role: hiring_manager - id: 1 full_name: Pau Capdevilla role: interviewer schema: $ref: '#/components/schemas/RecruitmentGetPositionDetailsResponse' description: Successful Response security: - api_key: [] summary: Position details tags: - Recruitment x-konfig-operation-can-have-single-parameter: true x-konfig-single-parameter-schema: konfig-generated-schema-single-parameter-schema-get--recruitment-positions-id x-accepts: application/json summary: Position details /recruitment/positions/{id}/applicants: get: operationId: Recruitment_listApplicants parameters: - description: Numeric ID of position explode: false in: path name: id required: true schema: type: integer style: simple - description: Optional filter by stage e.g. `?stage_id=25` example: 25 explode: true in: query name: stage_id required: false schema: type: integer style: form x-konfig-original-example: 25 - description: "Pagination: fetch page at given offset, default 1" example: 2 explode: true in: query name: page required: false schema: type: integer style: form x-konfig-original-example: 2 - description: | Pagination: amount of applicants to return in 1 call, default: 30, max: 100 example: 25 explode: true in: query name: per_page required: false schema: type: integer style: form x-konfig-original-example: 25 responses: "200": content: application/json: examples: response: value: data: - summary: null id: 1 full_name: Jon Vondrak first_name: Jon last_name: Vondrak email: jon.vondrak@example.com address: null phone_number: null source: recruiters created_at: 2020-10-15T10:58:57Z disqualified_date: null hired_date: null stage: title: Reference check id: 6 created_at: 2020-10-15T10:57:34Z - summary: null id: 2 full_name: Samantha Cross first_name: Samantha last_name: Cross email: sam.cross@example.com address: null phone_number: null source: recruiters created_at: 2020-10-15T11:02:34Z disqualified_date: null hired_date: 2020-10-28 stage: title: Hired id: 10 created_at: 2020-10-15T10:57:34Z meta: current_page: 1 next_page: null previous_page: null total_pages: 1 per_page: 30 total_entries: 3 schema: $ref: '#/components/schemas/RecruitmentListApplicantsResponse' description: Successful Response security: - api_key: [] summary: List applicants tags: - Recruitment x-konfig-operation-can-have-single-parameter: true x-konfig-single-parameter-schema: konfig-generated-schema-single-parameter-schema-get--recruitment-positions-id-applicants x-accepts: application/json post: description: "Tracking applicant's source:\n * if left blank, source will be\ \ automatically set to `api`\n * set source to a special keyword (`company_marketing`,\ \ `recruiters`, `referral`, `sourced`) to have it mapped to corresponding\ \ values \n * set source to a desired reference to create a custom source,\ \ e.g. `source=linkedin` will create a custom source called linkedin if it\ \ does not exist already\n * passing a referral object as a parameter will\ \ set the source to `referral`\n\n \nExample of creating an applicant with\ \ a refferal object:\n```\ncurl -X POST -H 'X-AUTH-TOKEN:***' -H 'Content-Type:application/json'\ \ \\\n \"https://***/api/recruitment/positions/2/applicants\" \\\n -d '{\"\ applicant\": \\\n {\"referral\": {\"email\": \"recruitment@example.com\"\ , \"full_name\": \"Alice L\"}, \\\n \"address\": \"BD23 8UL\", \"\ summary\":\"An applicant\", \\\n \"first_name\": \"Applicant Name\"\ }}'\n```\n" operationId: Recruitment_createApplicantWithReferral parameters: - description: Numeric ID of position (must not be closed or completed). explode: false in: path name: id required: true schema: type: integer style: simple requestBody: content: multipart/form-data: schema: $ref: '#/components/schemas/RecruitmentCreateApplicantWithReferralRequest' responses: "201": content: application/json: examples: response: value: data: id: 1 schema: $ref: '#/components/schemas/RecruitmentCreateApplicantWithReferralResponse' description: Successful Response "422": content: application/json: examples: response: value: error_code: validation_failed errors: - Email has already been taken schema: $ref: '#/components/schemas/RecruitmentCreateApplicantWithReferral422Response' description: Validation x-do-not-generate: true security: - api_key: [] summary: Create new applicant tags: - Recruitment x-konfig-operation-can-have-single-parameter: true x-konfig-single-parameter-schema: konfig-generated-schema-single-parameter-schema-post--recruitment-positions-id-applicants x-content-type: multipart/form-data x-accepts: application/json summary: Applicants /recruitment/applicants/{id}: get: operationId: Recruitment_getApplicantDetails parameters: - description: Numeric ID of applicant explode: false in: path name: id required: true schema: type: integer style: simple responses: "200": content: application/json: examples: response: value: data: summary: null id: 3 full_name: Fritzgerard Stachie first_name: Fritzgerard last_name: Stachie email: fritzgerard@example.com address: null phone_number: null source: referral created_at: 2020-10-21T12:58:43Z disqualified_date: 2020-10-28 hired_date: null stage: title: Interview id: 4 created_at: 2020-10-15T10:57:34Z position_id: 1 added_by: id: 1 full_name: Vlad Hendrik email: vlad@example.com referrer: id: 1 full_name: Josh Pascuale email: josh@example.com phone_number: 67876162 schema: $ref: '#/components/schemas/RecruitmentGetApplicantDetailsResponse' description: Successful Response security: - api_key: [] summary: Applicant details tags: - Recruitment x-konfig-operation-can-have-single-parameter: true x-konfig-single-parameter-schema: konfig-generated-schema-single-parameter-schema-get--recruitment-applicants-id x-accepts: application/json summary: Applicant details /recruitment/applicants/{id}/actions: get: description: | List applicant's process throught the recruitment pipeline. Newest, first. operationId: Recruitment_listApplicantActions parameters: - description: Numeric ID of applicant explode: false in: path name: id required: true schema: type: integer style: simple - description: "Pagination: fetch page at given offset" example: 2 explode: true in: query name: page required: false schema: type: integer style: form x-konfig-original-example: 2 - description: | Pagination: amount of actions to return in 1 call, default: 30, max: 100 example: 25 explode: true in: query name: per_page required: false schema: type: integer style: form x-konfig-original-example: 25 responses: "200": content: application/json: examples: response: value: data: - action: moved_between_stages message: Applicant moved from "Interview" to "Reference check" created_at: 2020-10-28T09:05:45Z - action: moved_between_stages message: Applicant moved from "CV review" to "Interview" created_at: 2020-10-27T10:59:23Z - action: moved_between_stages message: Applicant moved from "New" to "CV review" created_at: 2020-10-15T11:01:39Z - action: document_created message: Uploaded "empty-document.pdf" created_at: 2020-10-15T10:59:15Z - action: applicant_created message: Applicant created created_at: 2020-10-15T10:58:57Z meta: current_page: 1 next_page: null previous_page: null total_pages: 1 per_page: 30 total_entries: 5 schema: $ref: '#/components/schemas/RecruitmentListApplicantActionsResponse' description: Successful Response security: - api_key: [] summary: Applicant actions tags: - Recruitment x-konfig-operation-can-have-single-parameter: true x-konfig-single-parameter-schema: konfig-generated-schema-single-parameter-schema-get--recruitment-applicants-id-actions x-accepts: application/json summary: Applicant actions /timesheets/clock-in: post: description: Employees will be only clocked in & out if API time clocking is enabled for Timesheet group operationId: Timesheets_clockInOut parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/TimesheetsClockInOutRequest' description: Times on specific dates for specific employees as json required: true responses: "200": content: application/json: examples: response: value: errors: - error 1 - error 2 schema: $ref: '#/components/schemas/TimesheetsClockInOutResponse' description: Successful Response security: - api_key: [] summary: Clock in & out employees on specific days tags: - Timesheets x-konfig-operation-can-have-single-parameter: true x-konfig-single-parameter-schema: konfig-generated-schema-single-parameter-schema-post--timesheets-clock-in x-content-type: application/json x-accepts: application/json summary: Time clocking /termination-reasons: get: operationId: TerminationsReasons_listInCompany parameters: - example: 2 explode: true in: query name: page required: false schema: type: integer style: form x-konfig-original-example: 2 responses: "200": content: application/json: examples: response: value: data: - id: 19 name: New job code: NJ type: voluntary - id: 20 name: End of Internship code: null type: involuntary meta: current_page: 1 next_page: 2 previous_page: null total_pages: 2 per_page: 50 total_entries: 75 schema: $ref: '#/components/schemas/TerminationsReasonsListInCompanyResponse' description: Successful Response security: - api_key: [] summary: List termination reasons in company tags: - Terminations reasons x-konfig-operation-can-have-single-parameter: true x-konfig-single-parameter-schema: konfig-generated-schema-single-parameter-schema-get--termination-reasons x-accepts: application/json summary: Termination reasons /onboarding/categories: get: operationId: Onboarding_listTaskCategories responses: "200": content: application/json: examples: response: value: data: - title: General id: 1 - title: Platform id: 2 schema: $ref: '#/components/schemas/OnboardingListTaskCategoriesResponse' description: Successful Response summary: List onboarding task categories tags: - Onboarding x-konfig-operation-can-have-single-parameter: true x-konfig-single-parameter-schema: konfig-generated-schema-single-parameter-schema-get--onboarding-categories x-accepts: application/json summary: Onboarding task categories /onboarding/tasks: post: operationId: Onboarding_createNewTask requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/OnboardingCreateNewTaskRequest' required: true responses: "201": content: application/json: examples: response: value: data: id: 1 schema: $ref: '#/components/schemas/OnboardingCreateNewTaskResponse' description: Successful Response summary: Create new onboarding task tags: - Onboarding x-konfig-operation-can-have-single-parameter: true x-konfig-single-parameter-schema: konfig-generated-schema-single-parameter-schema-post--onboarding-tasks x-content-type: application/x-www-form-urlencoded x-accepts: application/json summary: Onboarding task /offboarding/categories: get: operationId: Offboarding_listCategories responses: "200": content: application/json: examples: response: value: data: - title: General id: 1 - title: Platform id: 2 schema: $ref: '#/components/schemas/OffboardingListCategoriesResponse' description: Successful Response summary: List offboarding task categories tags: - Offboarding x-konfig-operation-can-have-single-parameter: true x-konfig-single-parameter-schema: konfig-generated-schema-single-parameter-schema-get--offboarding-categories x-accepts: application/json summary: Offboarding task categories /offboarding/tasks: post: operationId: Offboarding_createTask requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/OffboardingCreateTaskRequest' required: true responses: "201": content: application/json: examples: response: value: data: id: 1 schema: $ref: '#/components/schemas/OffboardingCreateTaskResponse' description: Successful Response summary: Create new offboarding task tags: - Offboarding x-konfig-operation-can-have-single-parameter: true x-konfig-single-parameter-schema: konfig-generated-schema-single-parameter-schema-post--offboarding-tasks x-content-type: application/x-www-form-urlencoded x-accepts: application/json summary: Offboarding task /vikarina/job-positions: post: operationId: Integrations_transferJobPositionFromSageToVikarina responses: "200": content: application/json: examples: response: value: data: title: Job title id: 1 status: 1 schema: $ref: '#/components/schemas/IntegrationsTransferJobPositionFromSageToVikarinaResponse' description: Successful Response summary: Job position transfer from Sage HR to Vikarina tags: - Integrations x-konfig-operation-can-have-single-parameter: true x-konfig-single-parameter-schema: konfig-generated-schema-single-parameter-schema-post--vikarina-job-positions x-accepts: application/json summary: Vikarina job positions /vikarina/organization-structure: post: operationId: Integrations_transferOrganizationalStructureFromSageToVikarina responses: "200": content: application/json: examples: response: value: data: employee_id: 1 department_code: department code (custom_field) department_name: department name (custom_field) section_code: section code (custom_field) section_title: section title (custom_field) subsection_code: subsection code (custom_field) subsection_title: Test Team cost_center_code: cost center code (custom_field) cost_center_title: cost center tile (custom_field) work_address: employee address (custom_field) work_city: employee city (custom_field) status: 1 schema: $ref: '#/components/schemas/IntegrationsTransferOrganizationalStructureFromSageToVikarinaResponse' description: Successful Response summary: Organizational structure transfer from Sage HR to Vikarina tags: - Integrations x-konfig-operation-can-have-single-parameter: true x-konfig-single-parameter-schema: konfig-generated-schema-single-parameter-schema-post--vikarina-organization-structure x-accepts: application/json summary: Vikarina organization data /vikarina/newstarter-employees: post: operationId: Integrations_importNewStartersList parameters: - example: 2020-01-01 explode: true in: query name: start_date required: false schema: type: string style: form x-konfig-original-example: 2020-01-01 - example: 2020-02-01 explode: true in: query name: end_date required: false schema: type: string style: form x-konfig-original-example: 2020-02-01 responses: "200": content: application/json: examples: response: value: data: employee_id: 1 employee_number: 123 work_start_date: 2020-10-10T00:00:00.000Z first_name: John last_name: Doe gender: male personal_code: personal code (custom_field) social_security_code: social security code (custom_field) address: "Street 1, City" home_city: employee home city (custom_field) country_id: country id (GB) npd: NPD email: test@test.com status: 1 schema: $ref: '#/components/schemas/IntegrationsImportNewStartersListResponse' description: Successful Response summary: New starters list from Sage HR to Vikarina tags: - Integrations x-konfig-operation-can-have-single-parameter: true x-konfig-single-parameter-schema: konfig-generated-schema-single-parameter-schema-post--vikarina-newstarter-employees x-accepts: application/json summary: Vikarina new employees /vikarina/contract-information: post: operationId: Integrations_transferContractInformationToVikarina responses: "200": content: application/json: examples: response: value: data: employee_id: 1 employee_number: 123 work_start_date: 2020-10-10T00:00:00.000Z contract_number: contract number (custom_field) termination_date: 2020-10-11T00:00:00.000Z employment_status: Full-time contract_type: contract type (custom_field) status: 1 schema: $ref: '#/components/schemas/IntegrationsTransferContractInformationToVikarinaResponse' description: Successful Response summary: Contract (custom field) information transfer from Sage HR to Vikarina tags: - Integrations x-konfig-operation-can-have-single-parameter: true x-konfig-single-parameter-schema: konfig-generated-schema-single-parameter-schema-post--vikarina-contract-information x-accepts: application/json summary: Vikarina employee contracts /vikarina/appointments: post: operationId: Integrations_transferAppointmentInfo parameters: - example: 2020-01-01 explode: true in: query name: start_date required: false schema: type: string style: form x-konfig-original-example: 2020-01-01 - example: 2020-02-01 explode: true in: query name: end_date required: false schema: type: string style: form x-konfig-original-example: 2020-02-01 responses: "200": content: application/json: examples: response: value: data: employee_id: 1 employee_number: 123 work_start_date: 2020-01-10 position_start_date: 2020-10-10 last_position_end_date: 2020-09-10 cost_center_code: cost center code (custom_field) position_id: 1 schedule_id: scheduled id (custom_field) employment_status: Full-time job_type: job type (custom_field) status: 1 schema: $ref: '#/components/schemas/IntegrationsTransferAppointmentInfoResponse' description: Successful Response summary: New appointment (position changes) information transfer from Sage HR to Vikarina tags: - Integrations x-konfig-operation-can-have-single-parameter: true x-konfig-single-parameter-schema: konfig-generated-schema-single-parameter-schema-post--vikarina-appointments x-accepts: application/json summary: Vikarina employees appointments /vikarina/salaries: post: operationId: Integrations_transferSalaryInformation parameters: - example: 2020-01-01 explode: true in: query name: start_date required: false schema: type: string style: form x-konfig-original-example: 2020-01-01 - example: 2020-02-01 explode: true in: query name: end_date required: false schema: type: string style: form x-konfig-original-example: 2020-02-01 responses: "200": content: application/json: examples: response: value: data: compensation_id: 1 employee_number: 123 contract_number: contract number (custom_field) type: Salary start_date: 2020-09-10 end_date: 2020-10-10 amount: 1000 status: 1 schema: $ref: '#/components/schemas/IntegrationsTransferSalaryInformationResponse' description: Successful Response summary: Salary information transfer from Sage HR to Vikarina to Vikarina tags: - Integrations x-konfig-operation-can-have-single-parameter: true x-konfig-single-parameter-schema: konfig-generated-schema-single-parameter-schema-post--vikarina-salaries x-accepts: application/json summary: Vikarina employees salaries /vikarina/bank-accounts: post: operationId: Integrations_transferBankAccountInfo responses: "200": content: application/json: examples: response: value: data: employee_id: 1 employee_number: 123 bank_code: bank code (custom_field) bank_account: bank account (custom_field) last_change: 2020-09-10 status: 1 schema: $ref: '#/components/schemas/IntegrationsTransferBankAccountInfoResponse' description: Successful Response summary: Bank account information transfer (Custom field) from Sage HR to Vikarina tags: - Integrations x-konfig-operation-can-have-single-parameter: true x-konfig-single-parameter-schema: konfig-generated-schema-single-parameter-schema-post--vikarina-bank-accounts x-accepts: application/json summary: Vikarina employees bank accounts /vikarina/terminated-employees: post: operationId: Integrations_transferTerminationInfoToVikarina parameters: - example: 2020-01-01 explode: true in: query name: start_date required: false schema: type: string style: form x-konfig-original-example: 2020-01-01 - example: 2020-02-01 explode: true in: query name: end_date required: false schema: type: string style: form x-konfig-original-example: 2020-02-01 responses: "200": content: application/json: examples: response: value: data: employee_id: 1 employee_number: 123 contract_number: contract number (custom_field) termination_date: 2020-09-10 termination_reason: New job unused_days: 5 termination_comment: Was good employee compensation: 1000 status: 1 schema: $ref: '#/components/schemas/IntegrationsTransferTerminationInfoToVikarinaResponse' description: Successful Response summary: Termination information transfer from Sage HR to Vikarina tags: - Integrations x-konfig-operation-can-have-single-parameter: true x-konfig-single-parameter-schema: konfig-generated-schema-single-parameter-schema-post--vikarina-terminated-employees x-accepts: application/json summary: Vikarina terminated employees /vikarina/unused-days: post: operationId: Integrations_transferUnusedVacationDaysToVikarina responses: "200": content: application/json: examples: response: value: data: employee_id: 1 employee_number: 123 unused_days: 5 date: 2020-10-10 status: 1 schema: $ref: '#/components/schemas/IntegrationsTransferUnusedVacationDaysToVikarinaResponse' description: Successful Response summary: Unused vacation days transfer from Sage HR to Vikarina tags: - Integrations x-konfig-operation-can-have-single-parameter: true x-konfig-single-parameter-schema: konfig-generated-schema-single-parameter-schema-post--vikarina-unused-days x-accepts: application/json summary: Vikarina employee unused days /vikarina/leave-types: post: operationId: Integrations_transferLeaveInformationToVikarina parameters: - example: 2020-01-01 explode: true in: query name: start_date required: false schema: type: string style: form x-konfig-original-example: 2020-01-01 - example: 2020-02-01 explode: true in: query name: end_date required: false schema: type: string style: form x-konfig-original-example: 2020-02-01 responses: "200": content: application/json: examples: response: value: data: calendar_event_id: 1 employee_number: 123 leave_type: Vacation days: 2 start_date: 2020-10-10 end_date: 2020-10-10 status: 1 schema: $ref: '#/components/schemas/IntegrationsTransferLeaveInformationToVikarinaResponse' description: Successful Response summary: Leaves information transfer from Sage HR to Vikarina tags: - Integrations x-konfig-operation-can-have-single-parameter: true x-konfig-single-parameter-schema: konfig-generated-schema-single-parameter-schema-post--vikarina-leave-types x-accepts: application/json summary: Vikarina employees time offs /vikarina/timesheets: post: operationId: Integrations_transferTimeScheduleInformation parameters: - example: 2020-01-01 explode: true in: query name: start_date required: false schema: type: string style: form x-konfig-original-example: 2020-01-01 - example: 2020-02-01 explode: true in: query name: end_date required: false schema: type: string style: form x-konfig-original-example: 2020-02-01 responses: "200": content: application/json: examples: response: value: data: employee_id: 1 employee_number: 123 date: 2020-10-10 stand_by: 8 hours: 8.5 nightours: 0.5 cost_center_code: cost center code (custom field) overtime_title: 0.5 status: 1 schema: $ref: '#/components/schemas/IntegrationsTransferTimeScheduleInformationResponse' description: Successful Response summary: Time Schedule information transfer from Sage HR to Vikarina tags: - Integrations x-konfig-operation-can-have-single-parameter: true x-konfig-single-parameter-schema: konfig-generated-schema-single-parameter-schema-post--vikarina-timesheets x-accepts: application/json summary: Vikarina employee timesheets /vikarina/bonuses: post: operationId: Integrations_sendBonusesToVikarina parameters: - example: 2020-01-01 explode: true in: query name: start_date required: false schema: type: string style: form x-konfig-original-example: 2020-01-01 - example: 2020-02-01 explode: true in: query name: end_date required: false schema: type: string style: form x-konfig-original-example: 2020-02-01 responses: "200": content: application/json: examples: response: value: data: compensation_id: 1 employee_number: 123 contract_number: contract number (custom_field) type: Bonus start_date: 2020-09-10 end_date: 2020-10-10 amount: 1000 status: 1 schema: $ref: '#/components/schemas/IntegrationsSendBonusesToVikarinaResponse' description: Successful Response summary: "Sending bonuses [payed once] to Vikarina" tags: - Integrations x-konfig-operation-can-have-single-parameter: true x-konfig-single-parameter-schema: konfig-generated-schema-single-parameter-schema-post--vikarina-bonuses x-accepts: application/json summary: Vikarina employees bonuses components: schemas: EmployeeCreateNewEmployeeRequest: properties: email: description: Employees email type: string first_name: description: Employees first name type: string last_name: description: Employees last name type: string work_start_date: description: "Employees work start date, format: YYYY-MM-DD, leave empty\ \ to use todays date" type: string send_email: description: '''true'' to send welcome email to employee' type: string required: - email - first_name - last_name type: object EmployeeUpdateByIdRequest: example: last_name: Doe employee_number: "0123456" approver_ids: - 1 - 1 leader_id: 3 selected_leave_types: - 2 - 2 team_id: 2 first_name: Jane work_start_date: 2020-01-28 location_id: 1 position_id: 101 properties: first_name: example: Jane type: string x-konfig-original-example: Jane x-konfig-generated-schema: konfig-generated-schema-components-schemas-EmployeeUpdateByIdRequest-properties-first_name last_name: example: Doe type: string x-konfig-original-example: Doe x-konfig-generated-schema: konfig-generated-schema-components-schemas-EmployeeUpdateByIdRequest-properties-last_name work_start_date: example: 2020-01-28 type: string x-konfig-original-example: 2020-01-28 x-konfig-generated-schema: konfig-generated-schema-components-schemas-EmployeeUpdateByIdRequest-properties-work_start_date location_id: example: 1 type: integer x-konfig-original-example: 1 x-konfig-generated-schema: konfig-generated-schema-components-schemas-EmployeeUpdateByIdRequest-properties-location_id team_id: example: 2 type: integer x-konfig-original-example: 2 x-konfig-generated-schema: konfig-generated-schema-components-schemas-EmployeeUpdateByIdRequest-properties-team_id leader_id: example: 3 type: integer x-konfig-original-example: 3 x-konfig-generated-schema: konfig-generated-schema-components-schemas-EmployeeUpdateByIdRequest-properties-leader_id position_id: example: 101 type: integer x-konfig-original-example: 101 x-konfig-generated-schema: konfig-generated-schema-components-schemas-EmployeeUpdateByIdRequest-properties-position_id employee_number: example: "0123456" type: string x-konfig-original-example: "0123456" x-konfig-generated-schema: konfig-generated-schema-components-schemas-EmployeeUpdateByIdRequest-properties-employee_number approver_ids: items: example: 1 type: integer x-konfig-original-example: 1 x-konfig-generated-schema: konfig-generated-schema-components-schemas-EmployeeUpdateByIdRequest-properties-approver_ids-items type: array selected_leave_types: items: example: 2 type: integer x-konfig-original-example: 2 x-konfig-generated-schema: konfig-generated-schema-components-schemas-EmployeeUpdateByIdRequest-properties-selected_leave_types-items type: array type: object EmployeeUpdateCustomFieldRequest: properties: value: description: String or array (for tags) type: string required: - value type: object EmployeeTerminateEmployeeRequest: properties: date: description: "Last working day; format: YYYY-MM-DD" type: string termination_reason_id: description: Termination reason ID type: number comments: description: Comments type: string required: - date - termination_reason_id type: object LeaveManagementUpdateKitDaysConfigurationRequest: properties: kit_days_enabled: description: Whether the policy allows Kit days or not enum: - true - false example: true type: boolean x-konfig-original-example: true x-konfig-generated-schema: konfig-generated-schema-components-schemas-LeaveManagementUpdateKitDaysConfigurationRequest-properties-kit_days_enabled kit_days_quantity: description: Maximum number of Kit days allowed in the policy example: 5 type: integer x-konfig-original-example: 5 x-konfig-generated-schema: konfig-generated-schema-components-schemas-LeaveManagementUpdateKitDaysConfigurationRequest-properties-kit_days_quantity required: - kit_days_enabled - kit_days_quantity type: object LeaveManagementCreateKitDayRequest: properties: policy_id: description: Time-off policy identifier type: integer employee_id: description: Employee identifier type: integer date: description: Date of single-day KIT day example: 2020-01-01 type: string x-konfig-original-example: 2020-01-01 x-konfig-generated-schema: konfig-generated-schema-components-schemas-LeaveManagementCreateKitDayRequest-properties-date date_from: description: Start date of a multi-day KIT day example: 2020-01-01 type: string x-konfig-original-example: 2020-01-01 x-konfig-generated-schema: konfig-generated-schema-components-schemas-LeaveManagementCreateKitDayRequest-properties-date_from date_to: description: End date of a multi-day KIT day example: 2020-01-01 type: string x-konfig-original-example: 2020-01-01 x-konfig-generated-schema: konfig-generated-schema-components-schemas-LeaveManagementCreateKitDayRequest-properties-date_to required: - employee_id - policy_id type: object LeaveManagementProcessKitDayRequest: properties: status: description: Action to apply to the specified KIT day enum: - cancel - approve - decline type: string required: - status type: object LeaveManagementNewTimeOffRequestRequest: properties: type: enum: - single - multi type: string time_off_policy_id: type: integer employee_id: type: integer date: description: "format: YYYY-MM-DD; required if type is single" type: string date_from: description: "format: YYYY-MM-DD; required if type is multi" type: string date_to: description: "format: YYYY-MM-DD; required if type is multi" type: string part_of_day: description: required if type is single enum: - all_day - first_part_of_day - second_part_of_day - specific_timespan type: string hours: description: required if type is single & part_of_day is first_part_of_day or second_part_of_day type: number time_from: description: "format: H:M; required if part_of_day is specific_timespan" example: 07:30 type: string x-konfig-original-example: 07:30 x-konfig-generated-schema: konfig-generated-schema-components-schemas-LeaveManagementNewTimeOffRequestRequest-properties-time_from time_to: description: "format: H:M; required if part_of_day is specific_timespan" example: "900" type: string x-konfig-original-example: 900 x-konfig-generated-schema: konfig-generated-schema-components-schemas-LeaveManagementNewTimeOffRequestRequest-properties-time_to details: description: required based on policy settings type: string required: - employee_id - part_of_day - time_off_policy_id - type type: object DocumentsCreateNewDocumentRequest: properties: description: description: Document description type: string file: description: The file to upload. format: binary type: string employee_id: description: Employee identifier type: integer category_id: description: "Category identifier, leave empty for default category" type: integer notify: description: '''true'' to notify employee by email' type: string required: - employee_id - file type: object RecruitmentCreateApplicantWithReferralRequest: properties: send_thank_you_email: description: '''true'' to send thank you email to applicant' type: string applicant[first_name]: type: string applicant[last_name]: type: string applicant[email]: type: string applicant[referral]: type: string applicant[phone_number]: type: string applicant[source]: type: string applicant[address]: type: string applicant[summary]: type: string applicant[attachment]: description: The file to upload. format: binary type: string required: - "applicant[first_name]" type: object TimesheetsClockInOutRequest: example: clocked_time: YYYY/MM/DD: employee_id: - clock_in: clock_in clock_out: clock_out - clock_in: clock_in clock_out: clock_out override: override properties: override: description: '''true'' if override provided days clocked entries' type: string clocked_time: $ref: '#/components/schemas/TimesheetsClockInOutRequest_clocked_time' type: object OnboardingCreateNewTaskRequest: properties: title: type: string description: type: string boarding_task_template_category_id: type: number due_in: description: Due date in days after employee start date example: 30 type: number x-konfig-original-example: 30 x-konfig-generated-schema: konfig-generated-schema-components-schemas-OnboardingCreateNewTaskRequest-properties-due_in default_assignee_type: description: "Default: self; leader - direct manager; employee - specific\ \ employee via assignee_id" enum: - self - leader - employee type: string assignee_id: description: Specific assignee if default_assignee_type is 'employee' type: number require_attachment: description: '''true'' to enabled required attachment' type: string add_after: description: Task start date in days after employee start date type: number required: - boarding_task_template_category_id - due_in - title type: object OffboardingCreateTaskRequest: properties: title: type: string description: type: string boarding_task_template_category_id: type: number due_in: description: Due date in days before employee last working day example: 30 type: number x-konfig-original-example: 30 x-konfig-generated-schema: konfig-generated-schema-components-schemas-OffboardingCreateTaskRequest-properties-due_in default_assignee_type: description: "Default: self; leader - direct manager; employee - specific\ \ employee via assignee_id" enum: - self - leader - employee type: string assignee_id: description: Specific assignee if default_assignee_type is 'employee' type: number require_attachment: description: '''true'' to enabled required attachment' type: string required: - boarding_task_template_category_id - due_in - title type: object EmployeeListActiveEmployeesResponse: example: data: - id: 19 email: john@example.com first_name: John last_name: Doe picture_url: https://example.com/john.png employment_start_date: 2014-08-25 date_of_birth: 1991-02-13 team: Sage HR team_id: 1 position: Api developer position_id: 123 reports_to_employee_id: 5 work_phone: 555-0505 home_phone: 555-0506 mobile_phone: 555-0507 gender: Male street_first: 84 Glenwood Street street_second: Peoria city: London post_code: 99999 country: GB employee_number: A01 employment_status: Full-time team_history: - team_id: 1 start_date: 2018-01-01 end_date: 201-01-01 team_name: Some Team employment_status_history: - employment_status_id: 1 start_date: 2018-01-01 end_date: 201-01-01 employment_statu_name: Full time position_history: - position_id: 1 start_date: 2018-01-01 end_date: 201-01-01 position_name: Developer position_code: "1234" meta: current_page: 1 next_page: 2 previous_page: null total_pages: 2 per_page: 50 total_entries: 75 properties: data: items: $ref: '#/components/schemas/EmployeeListActiveEmployeesResponse_data_inner' type: array meta: $ref: '#/components/schemas/EmployeeListActiveEmployeesResponse_meta' type: object x-konfig-original-example: data: - id: 19 email: john@example.com first_name: John last_name: Doe picture_url: https://example.com/john.png employment_start_date: 2014-08-25 date_of_birth: 1991-02-13 team: Sage HR team_id: 1 position: Api developer position_id: 123 reports_to_employee_id: 5 work_phone: 555-0505 home_phone: 555-0506 mobile_phone: 555-0507 gender: Male street_first: 84 Glenwood Street street_second: Peoria city: London post_code: 99999 country: GB employee_number: A01 employment_status: Full-time team_history: - team_id: 1 start_date: 2018-01-01 end_date: 201-01-01 team_name: Some Team employment_status_history: - employment_status_id: 1 start_date: 2018-01-01 end_date: 201-01-01 employment_statu_name: Full time position_history: - position_id: 1 start_date: 2018-01-01 end_date: 201-01-01 position_name: Developer position_code: "1234" meta: current_page: 1 next_page: 2 total_pages: 2 per_page: 50 total_entries: 75 x-konfig-generated-schema: konfig-generated-schema-components-schemas-EmployeeListActiveEmployeesResponse x-konfig-is-used-in-successful-response: true EmployeeCreateNewEmployeeResponse: example: data: id: 1 properties: data: $ref: '#/components/schemas/EmployeeCreateNewEmployeeResponse_data' type: object x-konfig-original-example: data: id: 1 x-konfig-generated-schema: konfig-generated-schema-components-schemas-EmployeeCreateNewEmployeeResponse x-konfig-is-used-in-successful-response: true EmployeeGetByIdResponse: example: data: id: 19 email: john@example.com first_name: John last_name: Doe picture_url: https://example.com/john.png employment_start_date: 2014-08-25 date_of_birth: 1991-02-13 team: Sage HR team_id: 6742 position: Api developer position_id: 123 reports_to_employee_id: 5 work_phone: 555-0505 home_phone: 555-0506 mobile_phone: 555-0507 gender: Male street_first: 84 Glenwood Street street_second: Peoria city: London post_code: 99999 country: GB employee_number: A1 employment_status: Full-time team_history: - team_id: 1 start_date: 2018-01-01 end_date: 201-01-01 team_name: Some Team employment_status_history: - employment_status_id: 1 start_date: 2018-01-01 end_date: 201-01-01 employment_statu_name: Full time position_history: - position_id: 1 start_date: 2018-01-01 end_date: 201-01-01 position_name: Developer position_code: "1234" properties: data: $ref: '#/components/schemas/EmployeeGetByIdResponse_data' type: object x-konfig-original-example: data: id: 19 email: john@example.com first_name: John last_name: Doe picture_url: https://example.com/john.png employment_start_date: 2014-08-25 date_of_birth: 1991-02-13 team: Sage HR team_id: 6742 position: Api developer position_id: 123 reports_to_employee_id: 5 work_phone: 555-0505 home_phone: 555-0506 mobile_phone: 555-0507 gender: Male street_first: 84 Glenwood Street street_second: Peoria city: London post_code: 99999 country: GB employee_number: A1 employment_status: Full-time team_history: - team_id: 1 start_date: 2018-01-01 end_date: 201-01-01 team_name: Some Team employment_status_history: - employment_status_id: 1 start_date: 2018-01-01 end_date: 201-01-01 employment_statu_name: Full time position_history: - position_id: 1 start_date: 2018-01-01 end_date: 201-01-01 position_name: Developer position_code: "1234" x-konfig-generated-schema: konfig-generated-schema-components-schemas-EmployeeGetByIdResponse x-konfig-is-used-in-successful-response: true EmployeeUpdateByIdResponse: example: data: id: 1711 properties: data: $ref: '#/components/schemas/EmployeeUpdateByIdResponse_data' type: object x-konfig-original-example: data: id: 1711 x-konfig-generated-schema: konfig-generated-schema-components-schemas-EmployeeUpdateByIdResponse x-konfig-is-used-in-successful-response: true EmployeeUpdateById404Response: example: error_code: not_found errors: [] properties: error_code: example: not_found type: string x-konfig-original-example: not_found x-konfig-generated-schema: konfig-generated-schema-components-schemas-EmployeeUpdateById404Response-properties-error_code errors: items: type: string type: array type: object x-konfig-original-example: error_code: not_found errors: [] x-konfig-generated-schema: konfig-generated-schema-components-schemas-EmployeeUpdateById404Response x-konfig-is-used-in-non-successful-response: true x-do-not-generate: true EmployeeGetCustomFieldsResponse: example: data: - id: 1 label: Hobby type: CustomDropdownField value: Hockey options: - Hockey - Football - Voleyball - id: 2 label: Languages type: CustomTags options: null value: - English - Latvian - Estonian properties: data: items: $ref: '#/components/schemas/EmployeeGetCustomFieldsResponse_data_inner' type: array type: object x-konfig-original-example: data: - id: 1 label: Hobby type: CustomDropdownField value: Hockey options: - Hockey - Football - Voleyball - id: 2 label: Languages type: CustomTags value: - English - Latvian - Estonian x-konfig-generated-schema: konfig-generated-schema-components-schemas-EmployeeGetCustomFieldsResponse x-konfig-is-used-in-successful-response: true EmployeeUpdateCustomFieldResponse: example: data: null properties: data: nullable: true type: string x-konfig-null-placeholder: true x-konfig-generated-schema: konfig-generated-schema-components-schemas-EmployeeUpdateCustomFieldResponse-properties-data example: null type: object x-konfig-original-example: {} x-konfig-generated-schema: konfig-generated-schema-components-schemas-EmployeeUpdateCustomFieldResponse x-konfig-is-used-in-successful-response: true EmployeeUpdateCustomField422Response: example: error_code: validation_failed errors: - Custom field text too long (max 250 characters) properties: error_code: example: validation_failed type: string x-konfig-original-example: validation_failed x-konfig-generated-schema: konfig-generated-schema-components-schemas-EmployeeUpdateCustomField422Response-properties-error_code errors: items: example: Custom field text too long (max 250 characters) type: string x-konfig-original-example: Custom field text too long (max 250 characters) x-konfig-generated-schema: konfig-generated-schema-components-schemas-EmployeeUpdateCustomField422Response-properties-errors-items type: array type: object x-konfig-original-example: error_code: validation_failed errors: - Custom field text too long (max 250 characters) x-konfig-generated-schema: konfig-generated-schema-components-schemas-EmployeeUpdateCustomField422Response x-konfig-is-used-in-non-successful-response: true x-do-not-generate: true EmployeeTerminateEmployeeResponse: example: data: {} properties: data: properties: {} type: object type: object x-konfig-original-example: data: {} x-konfig-generated-schema: konfig-generated-schema-components-schemas-EmployeeTerminateEmployeeResponse x-konfig-is-used-in-successful-response: true EmployeeListTerminatedEmployeesResponse: example: data: - id: 19 termination_date: 2015-05-28 employee_number: "123" email: john@example.com first_name: John last_name: Doe picture_url: https://example.com/john.png employment_start_date: 2014-08-25 date_of_birth: 1991-02-13 position: Api developer meta: current_page: 1 next_page: 2 previous_page: null total_pages: 2 per_page: 50 total_entries: 75 properties: data: items: $ref: '#/components/schemas/EmployeeListTerminatedEmployeesResponse_data_inner' type: array meta: $ref: '#/components/schemas/EmployeeListTerminatedEmployeesResponse_meta' type: object x-konfig-original-example: data: - id: 19 termination_date: 2015-05-28 employee_number: "123" email: john@example.com first_name: John last_name: Doe picture_url: https://example.com/john.png employment_start_date: 2014-08-25 date_of_birth: 1991-02-13 position: Api developer meta: current_page: 1 next_page: 2 total_pages: 2 per_page: 50 total_entries: 75 x-konfig-generated-schema: konfig-generated-schema-components-schemas-EmployeeListTerminatedEmployeesResponse x-konfig-is-used-in-successful-response: true EmployeeGetTerminatedEmployeeResponse: example: data: id: 19 termination_date: 2015-05-28 email: john@example.com first_name: John last_name: Doe picture_url: https://example.com/john.png employment_start_date: 2014-08-25 date_of_birth: 1991-02-13 position: Api developer termination: reason: Moving location comments: Moving to properties: data: $ref: '#/components/schemas/EmployeeGetTerminatedEmployeeResponse_data' type: object x-konfig-original-example: data: id: 19 termination_date: 2015-05-28 email: john@example.com first_name: John last_name: Doe picture_url: https://example.com/john.png employment_start_date: 2014-08-25 date_of_birth: 1991-02-13 position: Api developer termination: reason: Moving location comments: Moving to x-konfig-generated-schema: konfig-generated-schema-components-schemas-EmployeeGetTerminatedEmployeeResponse x-konfig-is-used-in-successful-response: true LeaveManagementListTimeOffPoliciesResponse: example: data: - id: 1 name: Vacation color: '#49B284' do_not_accrue: false unit: days default_allowance: "26" max_carryover: "100.0" accrue_type: yearly - id: 2 name: Sickday color: '#DB263F' do_not_accrue: true unit: days default_allowance: "0.0" max_carryover: "0.0" accrue_type: no_tracking properties: data: items: $ref: '#/components/schemas/LeaveManagementListTimeOffPoliciesResponse_data_inner' type: array type: object x-konfig-original-example: data: - id: 1 name: Vacation color: '#49B284' do_not_accrue: false unit: days default_allowance: "26" max_carryover: "100.0" accrue_type: yearly - id: 2 name: Sickday color: '#DB263F' do_not_accrue: true unit: days default_allowance: "0.0" max_carryover: "0.0" accrue_type: no_tracking x-konfig-generated-schema: konfig-generated-schema-components-schemas-LeaveManagementListTimeOffPoliciesResponse x-konfig-is-used-in-successful-response: true LeaveManagementGetTimeOffPolicyByIdResponse: example: data: - id: 1 name: Vacation color: '#3a7dd8' do_not_accrue: false unit: days default_allowance: "25.0" max_carryover: "100.0" accrue_type: yearly enable_employee_access: true only_full_days: false enable_probation_period: false dont_allow_negative_amount: false requests_in_advance_required: false enable_minimum_days: false enable_limited_days: false enable_dependent_policy": false blocks_enabled: false no_reset: false termination_recalculation: true enable_service_accruals: false child_allowance_enabled: false enable_negative_carryover: false max_accrual: false accrue_at_start: true enable_monthly_expiration: false starter_monthly_accrual_limitation: false starter_yearly_accrual_limitation: false auto_approves: false enable_specific_approvers: false override_approvers_enabled: false enable_duplicate_time_offs: false enable_replacement: false replacement_required: false enable_scopped_replacement: false enable_replacement_away: false enable_details: true require_details: false additional_field: true enable_attachment: false properties: data: items: $ref: '#/components/schemas/LeaveManagementGetTimeOffPolicyByIdResponse_data_inner' type: array type: object x-konfig-original-example: data: - id: 1 name: Vacation color: '#3a7dd8' do_not_accrue: false unit: days default_allowance: "25.0" max_carryover: "100.0" accrue_type: yearly enable_employee_access: true only_full_days: false enable_probation_period: false dont_allow_negative_amount: false requests_in_advance_required: false enable_minimum_days: false enable_limited_days: false enable_dependent_policy": false blocks_enabled: false no_reset: false termination_recalculation: true enable_service_accruals: false child_allowance_enabled: false enable_negative_carryover: false max_accrual: false accrue_at_start: true enable_monthly_expiration: false starter_monthly_accrual_limitation: false starter_yearly_accrual_limitation: false auto_approves: false enable_specific_approvers: false override_approvers_enabled: false enable_duplicate_time_offs: false enable_replacement: false replacement_required: false enable_scopped_replacement: false enable_replacement_away: false enable_details: true require_details: false additional_field: true enable_attachment: false x-konfig-generated-schema: konfig-generated-schema-components-schemas-LeaveManagementGetTimeOffPolicyByIdResponse x-konfig-is-used-in-successful-response: true LeaveManagementUpdateKitDaysConfigurationResponse: example: error_code: invalid_policy_type errors: - The policy specified is not an event-based policy properties: error_code: example: invalid_policy_type type: string x-konfig-original-example: invalid_policy_type x-konfig-generated-schema: konfig-generated-schema-components-schemas-LeaveManagementUpdateKitDaysConfigurationResponse-properties-error_code errors: items: example: The policy specified is not an event-based policy type: string x-konfig-original-example: The policy specified is not an event-based policy x-konfig-generated-schema: konfig-generated-schema-components-schemas-LeaveManagementUpdateKitDaysConfigurationResponse-properties-errors-items type: array type: object x-konfig-original-example: error_code: invalid_policy_type errors: - The policy specified is not an event-based policy x-konfig-generated-schema: konfig-generated-schema-components-schemas-LeaveManagementUpdateKitDaysConfigurationResponse x-konfig-is-used-in-non-successful-response: true x-do-not-generate: true LeaveManagementGetKitDaysResponse: example: data: - id: 1 status: declined start_date: 2021-03-09 end_date: 2021-03-10 - id: 2 status: approved start_date: 2021-03-09 end_date: 2021-03-10 properties: data: items: $ref: '#/components/schemas/LeaveManagementGetKitDaysResponse_data_inner' type: array type: object x-konfig-original-example: data: - id: 1 status: declined start_date: 2021-03-09 end_date: 2021-03-10 - id: 2 status: approved start_date: 2021-03-09 end_date: 2021-03-10 x-konfig-generated-schema: konfig-generated-schema-components-schemas-LeaveManagementGetKitDaysResponse x-konfig-is-used-in-successful-response: true LeaveManagementCreateKitDayResponse: example: data: - id: 1 properties: data: items: $ref: '#/components/schemas/LeaveManagementCreateKitDayResponse_data_inner' type: array type: object x-konfig-original-example: data: - id: 1 x-konfig-generated-schema: konfig-generated-schema-components-schemas-LeaveManagementCreateKitDayResponse x-konfig-is-used-in-successful-response: true LeaveManagementCreateKitDay422Response: example: error_code: validation_failed errors: - First error - Second error properties: error_code: example: validation_failed type: string x-konfig-original-example: validation_failed x-konfig-generated-schema: konfig-generated-schema-components-schemas-LeaveManagementCreateKitDay422Response-properties-error_code errors: items: example: First error type: string x-konfig-original-example: First error x-konfig-generated-schema: konfig-generated-schema-components-schemas-LeaveManagementCreateKitDay422Response-properties-errors-items type: array type: object x-konfig-original-example: error_code: validation_failed errors: - First error - Second error x-konfig-generated-schema: konfig-generated-schema-components-schemas-LeaveManagementCreateKitDay422Response x-konfig-is-used-in-non-successful-response: true x-do-not-generate: true LeaveManagementGetIndividualAllowancesResponse: example: data: - full_name: Joe Doe id: 11 eligibilities: - policy: name: Sickday id: 2 quantity: "0.0" unit: days carryover: "0.0" - policy: name: Vacation id: 1 quantity: "25.0" unit: days carryover: "100.0" - full_name: Jane Doe id: 13 eligibilities: - policy: name: Custom Policy id: 4 quantity: "0.0" unit: days carryover: "0.0" - policy: name: Vacation id: 1 quantity: "25.0" unit: days carryover: "100.0" meta: current_page: 1 next_page: null previous_page: null total_pages: 1 per_page: 25 total_entries: 1 properties: data: items: $ref: '#/components/schemas/LeaveManagementGetIndividualAllowancesResponse_data_inner' type: array meta: $ref: '#/components/schemas/LeaveManagementGetIndividualAllowancesResponse_meta' type: object x-konfig-original-example: data: - full_name: Joe Doe id: 11 eligibilities: - policy: name: Sickday id: 2 quantity: "0.0" unit: days carryover: "0.0" - policy: name: Vacation id: 1 quantity: "25.0" unit: days carryover: "100.0" - full_name: Jane Doe id: 13 eligibilities: - policy: name: Custom Policy id: 4 quantity: "0.0" unit: days carryover: "0.0" - policy: name: Vacation id: 1 quantity: "25.0" unit: days carryover: "100.0" meta: current_page: 1 total_pages: 1 per_page: 25 total_entries: 1 x-konfig-generated-schema: konfig-generated-schema-components-schemas-LeaveManagementGetIndividualAllowancesResponse x-konfig-is-used-in-successful-response: true LeaveManagementGetTimeOffBalancesResponse: example: data: - policy_id: 1 used: 5.6 available: 2 - policy_id: 2 used: 75 available: null properties: data: items: $ref: '#/components/schemas/LeaveManagementGetTimeOffBalancesResponse_data_inner' type: array type: object x-konfig-original-example: data: - policy_id: 1 used: 5.6 available: 2 - policy_id: 2 used: 75 x-konfig-generated-schema: konfig-generated-schema-components-schemas-LeaveManagementGetTimeOffBalancesResponse x-konfig-is-used-in-successful-response: true LeaveManagementListTimeOffRequestsResponse: example: data: - id: 2902504 status: Approved status_code: approved policy_id: 1 employee_id: 1 details: Birthday lunch is_multi_date: false is_single_day: true is_part_of_day: true first_part_of_day: false second_part_of_day: true start_date: 2018-05-24 end_date: 2018-05-24 request_date: 2018-05-22 approval_date: null hours: 3.5 fields: - title: Approved by manager? answer: true meta: current_page: 1 next_page: 2 previous_page: null total_pages: 2 per_page: 50 total_entries: 75 properties: data: items: $ref: '#/components/schemas/LeaveManagementListTimeOffRequestsResponse_data_inner' type: array meta: $ref: '#/components/schemas/LeaveManagementListTimeOffRequestsResponse_meta' type: object x-konfig-original-example: data: - id: 2902504 status: Approved status_code: approved policy_id: 1 employee_id: 1 details: Birthday lunch is_multi_date: false is_single_day: true is_part_of_day: true first_part_of_day: false second_part_of_day: true start_date: 2018-05-24 end_date: 2018-05-24 request_date: 2018-05-22 hours: 3.5 fields: - title: Approved by manager? answer: true meta: current_page: 1 next_page: 2 total_pages: 2 per_page: 50 total_entries: 75 x-konfig-generated-schema: konfig-generated-schema-components-schemas-LeaveManagementListTimeOffRequestsResponse x-konfig-is-used-in-successful-response: true LeaveManagementNewTimeOffRequestResponse: example: data: id: 1 properties: data: $ref: '#/components/schemas/LeaveManagementNewTimeOffRequestResponse_data' type: object x-konfig-original-example: data: id: 1 x-konfig-generated-schema: konfig-generated-schema-components-schemas-LeaveManagementNewTimeOffRequestResponse x-konfig-is-used-in-successful-response: true LeaveManagementNewTimeOffRequest422Response: example: error_code: validation_failed errors: - Error message properties: error_code: example: validation_failed type: string x-konfig-original-example: validation_failed x-konfig-generated-schema: konfig-generated-schema-components-schemas-LeaveManagementNewTimeOffRequest422Response-properties-error_code errors: items: example: Error message type: string x-konfig-original-example: Error message x-konfig-generated-schema: konfig-generated-schema-components-schemas-LeaveManagementNewTimeOffRequest422Response-properties-errors-items type: array type: object x-konfig-original-example: error_code: validation_failed errors: - Error message x-konfig-generated-schema: konfig-generated-schema-components-schemas-LeaveManagementNewTimeOffRequest422Response x-konfig-is-used-in-non-successful-response: true x-do-not-generate: true LeaveManagementListEmployeesOutTodayResponse: example: data: - id: 2902504 policy_id: 2 policy: name: Vacation employee_id: 5 employee: first_name: John last_name: Doe details: Birthday lunch is_multi_date: false is_single_day: true is_part_of_day: true first_part_of_day: false second_part_of_day: true start_date: 2018-05-24 end_date: 2018-05-24 hours: 3.5 properties: data: items: $ref: '#/components/schemas/LeaveManagementListEmployeesOutTodayResponse_data_inner' type: array type: object x-konfig-original-example: data: - id: 2902504 policy_id: 2 policy: name: Vacation employee_id: 5 employee: first_name: John last_name: Doe details: Birthday lunch is_multi_date: false is_single_day: true is_part_of_day: true first_part_of_day: false second_part_of_day: true start_date: 2018-05-24 end_date: 2018-05-24 hours: 3.5 x-konfig-generated-schema: konfig-generated-schema-components-schemas-LeaveManagementListEmployeesOutTodayResponse x-konfig-is-used-in-successful-response: true DocumentsListCategoriesResponse: example: data: - id: 1 name: General documents_count: 10 - id: 2 name: Job contracts documents_count: 1 properties: data: items: $ref: '#/components/schemas/DocumentsListCategoriesResponse_data_inner' type: array type: object x-konfig-original-example: data: - id: 1 name: General documents_count: 10 - id: 2 name: Job contracts documents_count: 1 x-konfig-generated-schema: konfig-generated-schema-components-schemas-DocumentsListCategoriesResponse x-konfig-is-used-in-successful-response: true DocumentsCreateNewDocumentResponse: example: data: id: 1 properties: data: $ref: '#/components/schemas/DocumentsCreateNewDocumentResponse_data' type: object x-konfig-original-example: data: id: 1 x-konfig-generated-schema: konfig-generated-schema-components-schemas-DocumentsCreateNewDocumentResponse x-konfig-is-used-in-successful-response: true PositionsListCompanyPositionsResponse: example: data: - title: CFO description: '...' id: 19 code: X2 - title: CEO description: null id: 20 code: null meta: current_page: 1 next_page: 2 previous_page: null total_pages: 2 per_page: 50 total_entries: 75 properties: data: items: $ref: '#/components/schemas/PositionsListCompanyPositionsResponse_data_inner' type: array meta: $ref: '#/components/schemas/PositionsListCompanyPositionsResponse_meta' type: object x-konfig-original-example: data: - title: CFO description: '...' id: 19 code: X2 - title: CEO id: 20 meta: current_page: 1 next_page: 2 total_pages: 2 per_page: 50 total_entries: 75 x-konfig-generated-schema: konfig-generated-schema-components-schemas-PositionsListCompanyPositionsResponse x-konfig-is-used-in-successful-response: true TeamsListInCompanyResponse: example: data: - id: 19 name: Sales manager_ids: - 1 - 2 employee_ids: - 5 - 7 - 90 meta: current_page: 1 next_page: 2 previous_page: null total_pages: 2 per_page: 50 total_entries: 75 properties: data: items: $ref: '#/components/schemas/TeamsListInCompanyResponse_data_inner' type: array meta: $ref: '#/components/schemas/TeamsListInCompanyResponse_meta' type: object x-konfig-original-example: data: - id: 19 name: Sales manager_ids: - 1 - 2 employee_ids: - 5 - 7 - 90 meta: current_page: 1 next_page: 2 total_pages: 2 per_page: 50 total_entries: 75 x-konfig-generated-schema: konfig-generated-schema-components-schemas-TeamsListInCompanyResponse x-konfig-is-used-in-successful-response: true PerformanceOverviewQuarterlyProgressResponse: example: data: company: adjusted: 18 actual: 15 individual: adjusted: 31 actual: 26 team: adjusted: 42 actual: 37 properties: data: $ref: '#/components/schemas/PerformanceOverviewQuarterlyProgressResponse_data' type: object x-konfig-original-example: data: company: adjusted: 18 actual: 15 individual: adjusted: 31 actual: 26 team: adjusted: 42 actual: 37 x-konfig-generated-schema: konfig-generated-schema-components-schemas-PerformanceOverviewQuarterlyProgressResponse x-konfig-is-used-in-successful-response: true PerformanceGetQuarterlyCompanyGoalsResponse: example: data: - title: Optimize data storage progress: actual: 10 to_date: 34 properties: data: items: $ref: '#/components/schemas/PerformanceGetQuarterlyCompanyGoalsResponse_data_inner' type: array type: object x-konfig-original-example: data: - title: Optimize data storage progress: actual: 10 to_date: 34 x-konfig-generated-schema: konfig-generated-schema-components-schemas-PerformanceGetQuarterlyCompanyGoalsResponse x-konfig-is-used-in-successful-response: true PerformanceGetQuarterlyTeamGoalsResponse: example: data: - name: HR team progress: actual: 10 to_date: 34 goals: - title: Optimize data storage progress: actual: 10 to_date: 34 properties: data: items: $ref: '#/components/schemas/PerformanceGetQuarterlyTeamGoalsResponse_data_inner' type: array type: object x-konfig-original-example: data: - name: HR team progress: actual: 10 to_date: 34 goals: - title: Optimize data storage progress: actual: 10 to_date: 34 x-konfig-generated-schema: konfig-generated-schema-components-schemas-PerformanceGetQuarterlyTeamGoalsResponse x-konfig-is-used-in-successful-response: true PerformanceGetQuarterlyIndividualGoalsResponse: example: data: - name: John Doe progress: actual: 10 to_date: 34 goals: - title: Optimize data storage progress: actual: 10 to_date: 34 properties: data: items: $ref: '#/components/schemas/PerformanceGetQuarterlyIndividualGoalsResponse_data_inner' type: array type: object x-konfig-original-example: data: - name: John Doe progress: actual: 10 to_date: 34 goals: - title: Optimize data storage progress: actual: 10 to_date: 34 x-konfig-generated-schema: konfig-generated-schema-components-schemas-PerformanceGetQuarterlyIndividualGoalsResponse x-konfig-is-used-in-successful-response: true EmployeeGetCompensationsResponse: example: data: - start_date: 2017-01-01 end_date: 2019-01-01 currency: EUR amount: 1234 period: monthly comment: Starting salary category: Salary meta: current_page: 1 next_page: 2 previous_page: null total_pages: 2 per_page: 50 total_entries: 75 properties: data: items: $ref: '#/components/schemas/EmployeeGetCompensationsResponse_data_inner' type: array meta: $ref: '#/components/schemas/EmployeeGetCompensationsResponse_meta' type: object x-konfig-original-example: data: - start_date: 2017-01-01 end_date: 2019-01-01 currency: EUR amount: 1234 period: monthly comment: Starting salary category: Salary meta: current_page: 1 next_page: 2 total_pages: 2 per_page: 50 total_entries: 75 x-konfig-generated-schema: konfig-generated-schema-components-schemas-EmployeeGetCompensationsResponse x-konfig-is-used-in-successful-response: true RecruitmentListPositionsResponse: example: data: - title: CEO id: 2902504 status: published visibility: Published created_at: 2019-09-01 internal_date: 2019-10-01 completed_at: null link: https://talent.sage.hr/jobs/xxx team: Management applicants_required: 1 applicants_count: 3 employment_type: Full-time location: London location_id: 9182712 group: Hiring Group group_id: 871621 priority: 1 description_blocks: - title: Requirements content: Html content goes here - title: CFO id: 212 status: completed visibility: Completed created_at: 2019-09-01 internal_date: 2019-10-21 completed_at: 2019-10-12 link: null team: "" applicants_required: 2 applicants_count: 4 employment_type: null location: null location_id: null group: Hiring Group group_id: 871621 priority: 9800 description_blocks: - title: Description content:This is a CFO position.
- title: Requirements content:Be a CFO
- title: Benefits content:iPhone 12
meta: current_page: 1 next_page: 2 previous_page: null total_pages: 2 per_page: 20 total_entries: 34 properties: data: items: $ref: '#/components/schemas/RecruitmentListPositionsResponse_data_inner' type: array meta: $ref: '#/components/schemas/RecruitmentListPositionsResponse_meta' type: object x-konfig-original-example: data: - title: CEO id: 2902504 status: published visibility: Published created_at: 2019-09-01 internal_date: 2019-10-01 link: https://talent.sage.hr/jobs/xxx team: Management applicants_required: 1 applicants_count: 3 employment_type: Full-time location: London location_id: 9182712 group: Hiring Group group_id: 871621 priority: 1 description_blocks: - title: Requirements content: Html content goes here - title: CFO id: 212 status: completed visibility: Completed created_at: 2019-09-01 internal_date: 2019-10-21 completed_at: 2019-10-12 team: "" applicants_required: 2 applicants_count: 4 group: Hiring Group group_id: 871621 priority: 9800 description_blocks: - title: Description content:This is a CFO position.
- title: Requirements content:Be a CFO
- title: Benefits content:iPhone 12
meta: current_page: 1 next_page: 2 total_pages: 2 per_page: 20 total_entries: 34 x-konfig-generated-schema: konfig-generated-schema-components-schemas-RecruitmentListPositionsResponse x-konfig-is-used-in-successful-response: true RecruitmentGetPositionDetailsResponse: example: data: title: CTO id: 1 status: completed visibility: Completed created_at: 2020-10-15 internal_date: 2020-10-31 completed_at: 2020-10-28 link: null team: "" applicants_required: 1 applicants_count: 2 employment_type: Full-time location: New York location_id: 4 group: Hiring Group group_id: 1 priority: 1 description_blocks: - title: Description content:This is what we required.
- title: Benefits content:Here are some benefits.
- title: More Details content:A custom block.
applicants: - id: 1 full_name: Jon Vondrak email: jon.vondrak@example.com - id: 2 full_name: Samantha Cross email: sam.cross@example.com hiring_team: - id: 12 full_name: Manel Lopez-Bru role: hiring_manager - id: 1 full_name: Pau Capdevilla role: interviewer properties: data: $ref: '#/components/schemas/RecruitmentGetPositionDetailsResponse_data' type: object x-konfig-original-example: data: title: CTO id: 1 status: completed visibility: Completed created_at: 2020-10-15 internal_date: 2020-10-31 completed_at: 2020-10-28 team: "" applicants_required: 1 applicants_count: 2 employment_type: Full-time location: New York location_id: 4 group: Hiring Group group_id: 1 priority: 1 description_blocks: - title: Description content:This is what we required.
- title: Benefits content:Here are some benefits.
- title: More Details content:A custom block.
applicants: - id: 1 full_name: Jon Vondrak email: jon.vondrak@example.com - id: 2 full_name: Samantha Cross email: sam.cross@example.com hiring_team: - id: 12 full_name: Manel Lopez-Bru role: hiring_manager - id: 1 full_name: Pau Capdevilla role: interviewer x-konfig-generated-schema: konfig-generated-schema-components-schemas-RecruitmentGetPositionDetailsResponse x-konfig-is-used-in-successful-response: true RecruitmentListApplicantsResponse: example: data: - summary: null id: 1 full_name: Jon Vondrak first_name: Jon last_name: Vondrak email: jon.vondrak@example.com address: null phone_number: null source: recruiters created_at: 2020-10-15T10:58:57Z disqualified_date: null hired_date: null stage: title: Reference check id: 6 created_at: 2020-10-15T10:57:34Z - summary: null id: 2 full_name: Samantha Cross first_name: Samantha last_name: Cross email: sam.cross@example.com address: null phone_number: null source: recruiters created_at: 2020-10-15T11:02:34Z disqualified_date: null hired_date: 2020-10-28 stage: title: Hired id: 10 created_at: 2020-10-15T10:57:34Z meta: current_page: 1 next_page: null previous_page: null total_pages: 1 per_page: 30 total_entries: 3 properties: data: items: $ref: '#/components/schemas/RecruitmentListApplicantsResponse_data_inner' type: array meta: $ref: '#/components/schemas/RecruitmentListApplicantsResponse_meta' type: object x-konfig-original-example: data: - id: 1 full_name: Jon Vondrak first_name: Jon last_name: Vondrak email: jon.vondrak@example.com source: recruiters created_at: 2020-10-15T10:58:57Z stage: title: Reference check id: 6 created_at: 2020-10-15T10:57:34Z - id: 2 full_name: Samantha Cross first_name: Samantha last_name: Cross email: sam.cross@example.com source: recruiters created_at: 2020-10-15T11:02:34Z hired_date: 2020-10-28 stage: title: Hired id: 10 created_at: 2020-10-15T10:57:34Z meta: current_page: 1 total_pages: 1 per_page: 30 total_entries: 3 x-konfig-generated-schema: konfig-generated-schema-components-schemas-RecruitmentListApplicantsResponse x-konfig-is-used-in-successful-response: true RecruitmentCreateApplicantWithReferralResponse: example: data: id: 1 properties: data: $ref: '#/components/schemas/RecruitmentCreateApplicantWithReferralResponse_data' type: object x-konfig-original-example: data: id: 1 x-konfig-generated-schema: konfig-generated-schema-components-schemas-RecruitmentCreateApplicantWithReferralResponse x-konfig-is-used-in-successful-response: true RecruitmentCreateApplicantWithReferral422Response: example: error_code: validation_failed errors: - Email has already been taken properties: error_code: example: validation_failed type: string x-konfig-original-example: validation_failed x-konfig-generated-schema: konfig-generated-schema-components-schemas-RecruitmentCreateApplicantWithReferral422Response-properties-error_code errors: items: example: Email has already been taken type: string x-konfig-original-example: Email has already been taken x-konfig-generated-schema: konfig-generated-schema-components-schemas-RecruitmentCreateApplicantWithReferral422Response-properties-errors-items type: array type: object x-konfig-original-example: error_code: validation_failed errors: - Email has already been taken x-konfig-generated-schema: konfig-generated-schema-components-schemas-RecruitmentCreateApplicantWithReferral422Response x-konfig-is-used-in-non-successful-response: true x-do-not-generate: true RecruitmentGetApplicantDetailsResponse: example: data: summary: null id: 3 full_name: Fritzgerard Stachie first_name: Fritzgerard last_name: Stachie email: fritzgerard@example.com address: null phone_number: null source: referral created_at: 2020-10-21T12:58:43Z disqualified_date: 2020-10-28 hired_date: null stage: title: Interview id: 4 created_at: 2020-10-15T10:57:34Z position_id: 1 added_by: id: 1 full_name: Vlad Hendrik email: vlad@example.com referrer: id: 1 full_name: Josh Pascuale email: josh@example.com phone_number: 67876162 properties: data: $ref: '#/components/schemas/RecruitmentGetApplicantDetailsResponse_data' type: object x-konfig-original-example: data: id: 3 full_name: Fritzgerard Stachie first_name: Fritzgerard last_name: Stachie email: fritzgerard@example.com source: referral created_at: 2020-10-21T12:58:43Z disqualified_date: 2020-10-28 stage: title: Interview id: 4 created_at: 2020-10-15T10:57:34Z position_id: 1 added_by: id: 1 full_name: Vlad Hendrik email: vlad@example.com referrer: id: 1 full_name: Josh Pascuale email: josh@example.com phone_number: 67876162 x-konfig-generated-schema: konfig-generated-schema-components-schemas-RecruitmentGetApplicantDetailsResponse x-konfig-is-used-in-successful-response: true RecruitmentListApplicantActionsResponse: example: data: - action: moved_between_stages message: Applicant moved from "Interview" to "Reference check" created_at: 2020-10-28T09:05:45Z - action: moved_between_stages message: Applicant moved from "CV review" to "Interview" created_at: 2020-10-27T10:59:23Z - action: moved_between_stages message: Applicant moved from "New" to "CV review" created_at: 2020-10-15T11:01:39Z - action: document_created message: Uploaded "empty-document.pdf" created_at: 2020-10-15T10:59:15Z - action: applicant_created message: Applicant created created_at: 2020-10-15T10:58:57Z meta: current_page: 1 next_page: null previous_page: null total_pages: 1 per_page: 30 total_entries: 5 properties: data: items: $ref: '#/components/schemas/RecruitmentListApplicantActionsResponse_data_inner' type: array meta: $ref: '#/components/schemas/RecruitmentListApplicantActionsResponse_meta' type: object x-konfig-original-example: data: - action: moved_between_stages message: Applicant moved from "Interview" to "Reference check" created_at: 2020-10-28T09:05:45Z - action: moved_between_stages message: Applicant moved from "CV review" to "Interview" created_at: 2020-10-27T10:59:23Z - action: moved_between_stages message: Applicant moved from "New" to "CV review" created_at: 2020-10-15T11:01:39Z - action: document_created message: Uploaded "empty-document.pdf" created_at: 2020-10-15T10:59:15Z - action: applicant_created message: Applicant created created_at: 2020-10-15T10:58:57Z meta: current_page: 1 total_pages: 1 per_page: 30 total_entries: 5 x-konfig-generated-schema: konfig-generated-schema-components-schemas-RecruitmentListApplicantActionsResponse x-konfig-is-used-in-successful-response: true TimesheetsClockInOutResponse: example: errors: - error 1 - error 2 properties: errors: items: example: error 1 type: string x-konfig-original-example: error 1 x-konfig-generated-schema: konfig-generated-schema-components-schemas-TimesheetsClockInOutResponse-properties-errors-items type: array type: object x-konfig-original-example: errors: - error 1 - error 2 x-konfig-generated-schema: konfig-generated-schema-components-schemas-TimesheetsClockInOutResponse x-konfig-is-used-in-successful-response: true TerminationsReasonsListInCompanyResponse: example: data: - id: 19 name: New job code: NJ type: voluntary - id: 20 name: End of Internship code: null type: involuntary meta: current_page: 1 next_page: 2 previous_page: null total_pages: 2 per_page: 50 total_entries: 75 properties: data: items: $ref: '#/components/schemas/TerminationsReasonsListInCompanyResponse_data_inner' type: array meta: $ref: '#/components/schemas/TerminationsReasonsListInCompanyResponse_meta' type: object x-konfig-original-example: data: - id: 19 name: New job code: NJ type: voluntary - id: 20 name: End of Internship type: involuntary meta: current_page: 1 next_page: 2 total_pages: 2 per_page: 50 total_entries: 75 x-konfig-generated-schema: konfig-generated-schema-components-schemas-TerminationsReasonsListInCompanyResponse x-konfig-is-used-in-successful-response: true OnboardingListTaskCategoriesResponse: example: data: - title: General id: 1 - title: Platform id: 2 properties: data: items: $ref: '#/components/schemas/OnboardingListTaskCategoriesResponse_data_inner' type: array type: object x-konfig-original-example: data: - title: General id: 1 - title: Platform id: 2 x-konfig-generated-schema: konfig-generated-schema-components-schemas-OnboardingListTaskCategoriesResponse x-konfig-is-used-in-successful-response: true OnboardingCreateNewTaskResponse: example: data: id: 1 properties: data: $ref: '#/components/schemas/OnboardingCreateNewTaskResponse_data' type: object x-konfig-original-example: data: id: 1 x-konfig-generated-schema: konfig-generated-schema-components-schemas-OnboardingCreateNewTaskResponse x-konfig-is-used-in-successful-response: true OffboardingListCategoriesResponse: example: data: - title: General id: 1 - title: Platform id: 2 properties: data: items: $ref: '#/components/schemas/OffboardingListCategoriesResponse_data_inner' type: array type: object x-konfig-original-example: data: - title: General id: 1 - title: Platform id: 2 x-konfig-generated-schema: konfig-generated-schema-components-schemas-OffboardingListCategoriesResponse x-konfig-is-used-in-successful-response: true OffboardingCreateTaskResponse: example: data: id: 1 properties: data: $ref: '#/components/schemas/OffboardingCreateTaskResponse_data' type: object x-konfig-original-example: data: id: 1 x-konfig-generated-schema: konfig-generated-schema-components-schemas-OffboardingCreateTaskResponse x-konfig-is-used-in-successful-response: true IntegrationsTransferJobPositionFromSageToVikarinaResponse: example: data: title: Job title id: 1 status: 1 properties: data: $ref: '#/components/schemas/IntegrationsTransferJobPositionFromSageToVikarinaResponse_data' type: object x-konfig-original-example: data: title: Job title id: 1 status: 1 x-konfig-generated-schema: konfig-generated-schema-components-schemas-IntegrationsTransferJobPositionFromSageToVikarinaResponse x-konfig-is-used-in-successful-response: true IntegrationsTransferOrganizationalStructureFromSageToVikarinaResponse: example: data: employee_id: 1 department_code: department code (custom_field) department_name: department name (custom_field) section_code: section code (custom_field) section_title: section title (custom_field) subsection_code: subsection code (custom_field) subsection_title: Test Team cost_center_code: cost center code (custom_field) cost_center_title: cost center tile (custom_field) work_address: employee address (custom_field) work_city: employee city (custom_field) status: 1 properties: data: $ref: '#/components/schemas/IntegrationsTransferOrganizationalStructureFromSageToVikarinaResponse_data' type: object x-konfig-original-example: data: employee_id: 1 department_code: department code (custom_field) department_name: department name (custom_field) section_code: section code (custom_field) section_title: section title (custom_field) subsection_code: subsection code (custom_field) subsection_title: Test Team cost_center_code: cost center code (custom_field) cost_center_title: cost center tile (custom_field) work_address: employee address (custom_field) work_city: employee city (custom_field) status: 1 x-konfig-generated-schema: konfig-generated-schema-components-schemas-IntegrationsTransferOrganizationalStructureFromSageToVikarinaResponse x-konfig-is-used-in-successful-response: true IntegrationsImportNewStartersListResponse: example: data: employee_id: 1 employee_number: 123 work_start_date: 2020-10-10T00:00:00.000Z first_name: John last_name: Doe gender: male personal_code: personal code (custom_field) social_security_code: social security code (custom_field) address: "Street 1, City" home_city: employee home city (custom_field) country_id: country id (GB) npd: NPD email: test@test.com status: 1 properties: data: $ref: '#/components/schemas/IntegrationsImportNewStartersListResponse_data' type: object x-konfig-original-example: data: employee_id: 1 employee_number: 123 work_start_date: 2020-10-10T00:00:00.000Z first_name: John last_name: Doe gender: male personal_code: personal code (custom_field) social_security_code: social security code (custom_field) address: "Street 1, City" home_city: employee home city (custom_field) country_id: country id (GB) npd: NPD email: test@test.com status: 1 x-konfig-generated-schema: konfig-generated-schema-components-schemas-IntegrationsImportNewStartersListResponse x-konfig-is-used-in-successful-response: true IntegrationsTransferContractInformationToVikarinaResponse: example: data: employee_id: 1 employee_number: 123 work_start_date: 2020-10-10T00:00:00.000Z contract_number: contract number (custom_field) termination_date: 2020-10-11T00:00:00.000Z employment_status: Full-time contract_type: contract type (custom_field) status: 1 properties: data: $ref: '#/components/schemas/IntegrationsTransferContractInformationToVikarinaResponse_data' type: object x-konfig-original-example: data: employee_id: 1 employee_number: 123 work_start_date: 2020-10-10T00:00:00.000Z contract_number: contract number (custom_field) termination_date: 2020-10-11T00:00:00.000Z employment_status: Full-time contract_type: contract type (custom_field) status: 1 x-konfig-generated-schema: konfig-generated-schema-components-schemas-IntegrationsTransferContractInformationToVikarinaResponse x-konfig-is-used-in-successful-response: true IntegrationsTransferAppointmentInfoResponse: example: data: employee_id: 1 employee_number: 123 work_start_date: 2020-01-10 position_start_date: 2020-10-10 last_position_end_date: 2020-09-10 cost_center_code: cost center code (custom_field) position_id: 1 schedule_id: scheduled id (custom_field) employment_status: Full-time job_type: job type (custom_field) status: 1 properties: data: $ref: '#/components/schemas/IntegrationsTransferAppointmentInfoResponse_data' type: object x-konfig-original-example: data: employee_id: 1 employee_number: 123 work_start_date: 2020-01-10 position_start_date: 2020-10-10 last_position_end_date: 2020-09-10 cost_center_code: cost center code (custom_field) position_id: 1 schedule_id: scheduled id (custom_field) employment_status: Full-time job_type: job type (custom_field) status: 1 x-konfig-generated-schema: konfig-generated-schema-components-schemas-IntegrationsTransferAppointmentInfoResponse x-konfig-is-used-in-successful-response: true IntegrationsTransferSalaryInformationResponse: example: data: compensation_id: 1 employee_number: 123 contract_number: contract number (custom_field) type: Salary start_date: 2020-09-10 end_date: 2020-10-10 amount: 1000 status: 1 properties: data: $ref: '#/components/schemas/IntegrationsTransferSalaryInformationResponse_data' type: object x-konfig-original-example: data: compensation_id: 1 employee_number: 123 contract_number: contract number (custom_field) type: Salary start_date: 2020-09-10 end_date: 2020-10-10 amount: 1000 status: 1 x-konfig-generated-schema: konfig-generated-schema-components-schemas-IntegrationsTransferSalaryInformationResponse x-konfig-is-used-in-successful-response: true IntegrationsTransferBankAccountInfoResponse: example: data: employee_id: 1 employee_number: 123 bank_code: bank code (custom_field) bank_account: bank account (custom_field) last_change: 2020-09-10 status: 1 properties: data: $ref: '#/components/schemas/IntegrationsTransferBankAccountInfoResponse_data' type: object x-konfig-original-example: data: employee_id: 1 employee_number: 123 bank_code: bank code (custom_field) bank_account: bank account (custom_field) last_change: 2020-09-10 status: 1 x-konfig-generated-schema: konfig-generated-schema-components-schemas-IntegrationsTransferBankAccountInfoResponse x-konfig-is-used-in-successful-response: true IntegrationsTransferTerminationInfoToVikarinaResponse: example: data: employee_id: 1 employee_number: 123 contract_number: contract number (custom_field) termination_date: 2020-09-10 termination_reason: New job unused_days: 5 termination_comment: Was good employee compensation: 1000 status: 1 properties: data: $ref: '#/components/schemas/IntegrationsTransferTerminationInfoToVikarinaResponse_data' type: object x-konfig-original-example: data: employee_id: 1 employee_number: 123 contract_number: contract number (custom_field) termination_date: 2020-09-10 termination_reason: New job unused_days: 5 termination_comment: Was good employee compensation: 1000 status: 1 x-konfig-generated-schema: konfig-generated-schema-components-schemas-IntegrationsTransferTerminationInfoToVikarinaResponse x-konfig-is-used-in-successful-response: true IntegrationsTransferUnusedVacationDaysToVikarinaResponse: example: data: employee_id: 1 employee_number: 123 unused_days: 5 date: 2020-10-10 status: 1 properties: data: $ref: '#/components/schemas/IntegrationsTransferUnusedVacationDaysToVikarinaResponse_data' type: object x-konfig-original-example: data: employee_id: 1 employee_number: 123 unused_days: 5 date: 2020-10-10 status: 1 x-konfig-generated-schema: konfig-generated-schema-components-schemas-IntegrationsTransferUnusedVacationDaysToVikarinaResponse x-konfig-is-used-in-successful-response: true IntegrationsTransferLeaveInformationToVikarinaResponse: example: data: calendar_event_id: 1 employee_number: 123 leave_type: Vacation days: 2 start_date: 2020-10-10 end_date: 2020-10-10 status: 1 properties: data: $ref: '#/components/schemas/IntegrationsTransferLeaveInformationToVikarinaResponse_data' type: object x-konfig-original-example: data: calendar_event_id: 1 employee_number: 123 leave_type: Vacation days: 2 start_date: 2020-10-10 end_date: 2020-10-10 status: 1 x-konfig-generated-schema: konfig-generated-schema-components-schemas-IntegrationsTransferLeaveInformationToVikarinaResponse x-konfig-is-used-in-successful-response: true IntegrationsTransferTimeScheduleInformationResponse: example: data: employee_id: 1 employee_number: 123 date: 2020-10-10 stand_by: 8 hours: 8.5 nightours: 0.5 cost_center_code: cost center code (custom field) overtime_title: 0.5 status: 1 properties: data: $ref: '#/components/schemas/IntegrationsTransferTimeScheduleInformationResponse_data' type: object x-konfig-original-example: data: employee_id: 1 employee_number: 123 date: 2020-10-10 stand_by: 8 hours: 8.5 nightours: 0.5 cost_center_code: cost center code (custom field) overtime_title: 0.5 status: 1 x-konfig-generated-schema: konfig-generated-schema-components-schemas-IntegrationsTransferTimeScheduleInformationResponse x-konfig-is-used-in-successful-response: true IntegrationsSendBonusesToVikarinaResponse: example: data: compensation_id: 1 employee_number: 123 contract_number: contract number (custom_field) type: Bonus start_date: 2020-09-10 end_date: 2020-10-10 amount: 1000 status: 1 properties: data: $ref: '#/components/schemas/IntegrationsSendBonusesToVikarinaResponse_data' type: object x-konfig-original-example: data: compensation_id: 1 employee_number: 123 contract_number: contract number (custom_field) type: Bonus start_date: 2020-09-10 end_date: 2020-10-10 amount: 1000 status: 1 x-konfig-generated-schema: konfig-generated-schema-components-schemas-IntegrationsSendBonusesToVikarinaResponse x-konfig-is-used-in-successful-response: true konfig-generated-schema-components-schemas-EmployeeUpdateByIdRequest-properties-first_name: example: Jane type: string x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeUpdateByIdRequest-properties-last_name: example: Doe type: string x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeUpdateByIdRequest-properties-work_start_date: example: 2020-01-28 type: string x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeUpdateByIdRequest-properties-location_id: example: 1 type: number x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeUpdateByIdRequest-properties-team_id: example: 2 type: number x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeUpdateByIdRequest-properties-leader_id: example: 3 type: number x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeUpdateByIdRequest-properties-position_id: example: 101 type: number x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeUpdateByIdRequest-properties-employee_number: example: "0123456" type: string x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeUpdateByIdRequest-properties-approver_ids-items: example: 1 type: number x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeUpdateByIdRequest-properties-selected_leave_types-items: example: 2 type: number x-do-not-generate: true konfig-generated-schema-components-schemas-LeaveManagementUpdateKitDaysConfigurationRequest-properties-kit_days_enabled: example: true type: boolean x-do-not-generate: true konfig-generated-schema-components-schemas-LeaveManagementUpdateKitDaysConfigurationRequest-properties-kit_days_quantity: example: 5 type: number x-do-not-generate: true konfig-generated-schema-components-schemas-LeaveManagementCreateKitDayRequest-properties-date: example: 2020-01-01 type: string x-do-not-generate: true konfig-generated-schema-components-schemas-LeaveManagementCreateKitDayRequest-properties-date_from: example: 2020-01-01 type: string x-do-not-generate: true konfig-generated-schema-components-schemas-LeaveManagementCreateKitDayRequest-properties-date_to: example: 2020-01-01 type: string x-do-not-generate: true konfig-generated-schema-components-schemas-LeaveManagementNewTimeOffRequestRequest-properties-time_from: example: 07:30 type: string x-do-not-generate: true konfig-generated-schema-components-schemas-LeaveManagementNewTimeOffRequestRequest-properties-time_to: example: "900" type: string x-do-not-generate: true konfig-generated-schema-components-schemas-OnboardingCreateNewTaskRequest-properties-due_in: example: 30 type: number x-do-not-generate: true konfig-generated-schema-components-schemas-OffboardingCreateTaskRequest-properties-due_in: example: 30 type: number x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeListActiveEmployeesResponse: example: data: - id: 19 email: john@example.com first_name: John last_name: Doe picture_url: https://example.com/john.png employment_start_date: 2014-08-25 date_of_birth: 1991-02-13 team: Sage HR team_id: 1 position: Api developer position_id: 123 reports_to_employee_id: 5 work_phone: 555-0505 home_phone: 555-0506 mobile_phone: 555-0507 gender: Male street_first: 84 Glenwood Street street_second: Peoria city: London post_code: 99999 country: GB employee_number: A01 employment_status: Full-time team_history: - team_id: 1 start_date: 2018-01-01 end_date: 201-01-01 team_name: Some Team employment_status_history: - employment_status_id: 1 start_date: 2018-01-01 end_date: 201-01-01 employment_statu_name: Full time position_history: - position_id: 1 start_date: 2018-01-01 end_date: 201-01-01 position_name: Developer position_code: "1234" meta: current_page: 1 next_page: 2 previous_page: null total_pages: 2 per_page: 50 total_entries: 75 properties: data: items: properties: id: example: 19 type: number email: example: john@example.com type: string first_name: example: John type: string last_name: example: Doe type: string picture_url: example: https://example.com/john.png type: string employment_start_date: example: 2014-08-25 type: string date_of_birth: example: 1991-02-13 type: string team: example: Sage HR type: string team_id: example: 1 type: number position: example: Api developer type: string position_id: example: 123 type: number reports_to_employee_id: example: 5 type: number work_phone: example: 555-0505 type: string home_phone: example: 555-0506 type: string mobile_phone: example: 555-0507 type: string gender: example: Male type: string street_first: example: 84 Glenwood Street type: string street_second: example: Peoria type: string city: example: London type: string post_code: example: 99999 type: number country: example: GB type: string employee_number: example: A01 type: string employment_status: example: Full-time type: string team_history: items: properties: team_id: example: 1 type: number start_date: example: 2018-01-01 type: string end_date: example: 201-01-01 type: string team_name: example: Some Team type: string type: object type: array employment_status_history: items: properties: employment_status_id: example: 1 type: number start_date: example: 2018-01-01 type: string end_date: example: 201-01-01 type: string employment_statu_name: example: Full time type: string type: object type: array position_history: items: properties: position_id: example: 1 type: number start_date: example: 2018-01-01 type: string end_date: example: 201-01-01 type: string position_name: example: Developer type: string position_code: example: "1234" type: string type: object type: array type: object type: array meta: properties: current_page: example: 1 type: number next_page: example: 2 type: number previous_page: nullable: true type: string x-konfig-null-placeholder: true total_pages: example: 2 type: number per_page: example: 50 type: number total_entries: example: 75 type: number type: object type: object x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeListActiveEmployeesResponse-properties-data-items-properties-id: example: 19 type: number x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeListActiveEmployeesResponse-properties-data-items-properties-email: example: john@example.com type: string x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeListActiveEmployeesResponse-properties-data-items-properties-first_name: example: John type: string x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeListActiveEmployeesResponse-properties-data-items-properties-last_name: example: Doe type: string x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeListActiveEmployeesResponse-properties-data-items-properties-picture_url: example: https://example.com/john.png type: string x-do-not-generate: true ? konfig-generated-schema-components-schemas-EmployeeListActiveEmployeesResponse-properties-data-items-properties-employment_start_date : example: 2014-08-25 type: string x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeListActiveEmployeesResponse-properties-data-items-properties-date_of_birth: example: 1991-02-13 type: string x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeListActiveEmployeesResponse-properties-data-items-properties-team: example: Sage HR type: string x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeListActiveEmployeesResponse-properties-data-items-properties-team_id: example: 1 type: number x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeListActiveEmployeesResponse-properties-data-items-properties-position: example: Api developer type: string x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeListActiveEmployeesResponse-properties-data-items-properties-position_id: example: 123 type: number x-do-not-generate: true ? konfig-generated-schema-components-schemas-EmployeeListActiveEmployeesResponse-properties-data-items-properties-reports_to_employee_id : example: 5 type: number x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeListActiveEmployeesResponse-properties-data-items-properties-work_phone: example: 555-0505 type: string x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeListActiveEmployeesResponse-properties-data-items-properties-home_phone: example: 555-0506 type: string x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeListActiveEmployeesResponse-properties-data-items-properties-mobile_phone: example: 555-0507 type: string x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeListActiveEmployeesResponse-properties-data-items-properties-gender: example: Male type: string x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeListActiveEmployeesResponse-properties-data-items-properties-street_first: example: 84 Glenwood Street type: string x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeListActiveEmployeesResponse-properties-data-items-properties-street_second: example: Peoria type: string x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeListActiveEmployeesResponse-properties-data-items-properties-city: example: London type: string x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeListActiveEmployeesResponse-properties-data-items-properties-post_code: example: 99999 type: number x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeListActiveEmployeesResponse-properties-data-items-properties-country: example: GB type: string x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeListActiveEmployeesResponse-properties-data-items-properties-employee_number: example: A01 type: string x-do-not-generate: true ? konfig-generated-schema-components-schemas-EmployeeListActiveEmployeesResponse-properties-data-items-properties-employment_status : example: Full-time type: string x-do-not-generate: true ? konfig-generated-schema-components-schemas-EmployeeListActiveEmployeesResponse-properties-data-items-properties-team_history-items-properties-team_id : example: 1 type: number x-do-not-generate: true ? konfig-generated-schema-components-schemas-EmployeeListActiveEmployeesResponse-properties-data-items-properties-team_history-items-properties-start_date : example: 2018-01-01 type: string x-do-not-generate: true ? konfig-generated-schema-components-schemas-EmployeeListActiveEmployeesResponse-properties-data-items-properties-team_history-items-properties-end_date : example: 201-01-01 type: string x-do-not-generate: true ? konfig-generated-schema-components-schemas-EmployeeListActiveEmployeesResponse-properties-data-items-properties-team_history-items-properties-team_name : example: Some Team type: string x-do-not-generate: true ? konfig-generated-schema-components-schemas-EmployeeListActiveEmployeesResponse-properties-data-items-properties-employment_status_history-items-properties-employment_status_id : example: 1 type: number x-do-not-generate: true ? konfig-generated-schema-components-schemas-EmployeeListActiveEmployeesResponse-properties-data-items-properties-employment_status_history-items-properties-start_date : example: 2018-01-01 type: string x-do-not-generate: true ? konfig-generated-schema-components-schemas-EmployeeListActiveEmployeesResponse-properties-data-items-properties-employment_status_history-items-properties-end_date : example: 201-01-01 type: string x-do-not-generate: true ? konfig-generated-schema-components-schemas-EmployeeListActiveEmployeesResponse-properties-data-items-properties-employment_status_history-items-properties-employment_statu_name : example: Full time type: string x-do-not-generate: true ? konfig-generated-schema-components-schemas-EmployeeListActiveEmployeesResponse-properties-data-items-properties-position_history-items-properties-position_id : example: 1 type: number x-do-not-generate: true ? konfig-generated-schema-components-schemas-EmployeeListActiveEmployeesResponse-properties-data-items-properties-position_history-items-properties-start_date : example: 2018-01-01 type: string x-do-not-generate: true ? konfig-generated-schema-components-schemas-EmployeeListActiveEmployeesResponse-properties-data-items-properties-position_history-items-properties-end_date : example: 201-01-01 type: string x-do-not-generate: true ? konfig-generated-schema-components-schemas-EmployeeListActiveEmployeesResponse-properties-data-items-properties-position_history-items-properties-position_name : example: Developer type: string x-do-not-generate: true ? konfig-generated-schema-components-schemas-EmployeeListActiveEmployeesResponse-properties-data-items-properties-position_history-items-properties-position_code : example: "1234" type: string x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeListActiveEmployeesResponse-properties-meta-properties-current_page: example: 1 type: number x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeListActiveEmployeesResponse-properties-meta-properties-next_page: example: 2 type: number x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeListActiveEmployeesResponse-properties-meta-properties-previous_page: nullable: true type: string x-konfig-null-placeholder: true x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeListActiveEmployeesResponse-properties-meta-properties-total_pages: example: 2 type: number x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeListActiveEmployeesResponse-properties-meta-properties-per_page: example: 50 type: number x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeListActiveEmployeesResponse-properties-meta-properties-total_entries: example: 75 type: number x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeCreateNewEmployeeResponse: example: data: id: 1 properties: data: properties: id: example: 1 type: number type: object type: object x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeCreateNewEmployeeResponse-properties-data-properties-id: example: 1 type: number x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeGetByIdResponse: example: data: id: 19 email: john@example.com first_name: John last_name: Doe picture_url: https://example.com/john.png employment_start_date: 2014-08-25 date_of_birth: 1991-02-13 team: Sage HR team_id: 6742 position: Api developer position_id: 123 reports_to_employee_id: 5 work_phone: 555-0505 home_phone: 555-0506 mobile_phone: 555-0507 gender: Male street_first: 84 Glenwood Street street_second: Peoria city: London post_code: 99999 country: GB employee_number: A1 employment_status: Full-time team_history: - team_id: 1 start_date: 2018-01-01 end_date: 201-01-01 team_name: Some Team employment_status_history: - employment_status_id: 1 start_date: 2018-01-01 end_date: 201-01-01 employment_statu_name: Full time position_history: - position_id: 1 start_date: 2018-01-01 end_date: 201-01-01 position_name: Developer position_code: "1234" properties: data: properties: id: example: 19 type: number email: example: john@example.com type: string first_name: example: John type: string last_name: example: Doe type: string picture_url: example: https://example.com/john.png type: string employment_start_date: example: 2014-08-25 type: string date_of_birth: example: 1991-02-13 type: string team: example: Sage HR type: string team_id: example: 6742 type: number position: example: Api developer type: string position_id: example: 123 type: number reports_to_employee_id: example: 5 type: number work_phone: example: 555-0505 type: string home_phone: example: 555-0506 type: string mobile_phone: example: 555-0507 type: string gender: example: Male type: string street_first: example: 84 Glenwood Street type: string street_second: example: Peoria type: string city: example: London type: string post_code: example: 99999 type: number country: example: GB type: string employee_number: example: A1 type: string employment_status: example: Full-time type: string team_history: items: properties: team_id: example: 1 type: number start_date: example: 2018-01-01 type: string end_date: example: 201-01-01 type: string team_name: example: Some Team type: string type: object type: array employment_status_history: items: properties: employment_status_id: example: 1 type: number start_date: example: 2018-01-01 type: string end_date: example: 201-01-01 type: string employment_statu_name: example: Full time type: string type: object type: array position_history: items: properties: position_id: example: 1 type: number start_date: example: 2018-01-01 type: string end_date: example: 201-01-01 type: string position_name: example: Developer type: string position_code: example: "1234" type: string type: object type: array type: object type: object x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeGetByIdResponse-properties-data-properties-id: example: 19 type: number x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeGetByIdResponse-properties-data-properties-email: example: john@example.com type: string x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeGetByIdResponse-properties-data-properties-first_name: example: John type: string x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeGetByIdResponse-properties-data-properties-last_name: example: Doe type: string x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeGetByIdResponse-properties-data-properties-picture_url: example: https://example.com/john.png type: string x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeGetByIdResponse-properties-data-properties-employment_start_date: example: 2014-08-25 type: string x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeGetByIdResponse-properties-data-properties-date_of_birth: example: 1991-02-13 type: string x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeGetByIdResponse-properties-data-properties-team: example: Sage HR type: string x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeGetByIdResponse-properties-data-properties-team_id: example: 6742 type: number x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeGetByIdResponse-properties-data-properties-position: example: Api developer type: string x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeGetByIdResponse-properties-data-properties-position_id: example: 123 type: number x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeGetByIdResponse-properties-data-properties-reports_to_employee_id: example: 5 type: number x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeGetByIdResponse-properties-data-properties-work_phone: example: 555-0505 type: string x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeGetByIdResponse-properties-data-properties-home_phone: example: 555-0506 type: string x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeGetByIdResponse-properties-data-properties-mobile_phone: example: 555-0507 type: string x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeGetByIdResponse-properties-data-properties-gender: example: Male type: string x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeGetByIdResponse-properties-data-properties-street_first: example: 84 Glenwood Street type: string x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeGetByIdResponse-properties-data-properties-street_second: example: Peoria type: string x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeGetByIdResponse-properties-data-properties-city: example: London type: string x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeGetByIdResponse-properties-data-properties-post_code: example: 99999 type: number x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeGetByIdResponse-properties-data-properties-country: example: GB type: string x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeGetByIdResponse-properties-data-properties-employee_number: example: A1 type: string x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeGetByIdResponse-properties-data-properties-employment_status: example: Full-time type: string x-do-not-generate: true ? konfig-generated-schema-components-schemas-EmployeeGetByIdResponse-properties-data-properties-team_history-items-properties-team_id : example: 1 type: number x-do-not-generate: true ? konfig-generated-schema-components-schemas-EmployeeGetByIdResponse-properties-data-properties-team_history-items-properties-start_date : example: 2018-01-01 type: string x-do-not-generate: true ? konfig-generated-schema-components-schemas-EmployeeGetByIdResponse-properties-data-properties-team_history-items-properties-end_date : example: 201-01-01 type: string x-do-not-generate: true ? konfig-generated-schema-components-schemas-EmployeeGetByIdResponse-properties-data-properties-team_history-items-properties-team_name : example: Some Team type: string x-do-not-generate: true ? konfig-generated-schema-components-schemas-EmployeeGetByIdResponse-properties-data-properties-employment_status_history-items-properties-employment_status_id : example: 1 type: number x-do-not-generate: true ? konfig-generated-schema-components-schemas-EmployeeGetByIdResponse-properties-data-properties-employment_status_history-items-properties-start_date : example: 2018-01-01 type: string x-do-not-generate: true ? konfig-generated-schema-components-schemas-EmployeeGetByIdResponse-properties-data-properties-employment_status_history-items-properties-end_date : example: 201-01-01 type: string x-do-not-generate: true ? konfig-generated-schema-components-schemas-EmployeeGetByIdResponse-properties-data-properties-employment_status_history-items-properties-employment_statu_name : example: Full time type: string x-do-not-generate: true ? konfig-generated-schema-components-schemas-EmployeeGetByIdResponse-properties-data-properties-position_history-items-properties-position_id : example: 1 type: number x-do-not-generate: true ? konfig-generated-schema-components-schemas-EmployeeGetByIdResponse-properties-data-properties-position_history-items-properties-start_date : example: 2018-01-01 type: string x-do-not-generate: true ? konfig-generated-schema-components-schemas-EmployeeGetByIdResponse-properties-data-properties-position_history-items-properties-end_date : example: 201-01-01 type: string x-do-not-generate: true ? konfig-generated-schema-components-schemas-EmployeeGetByIdResponse-properties-data-properties-position_history-items-properties-position_name : example: Developer type: string x-do-not-generate: true ? konfig-generated-schema-components-schemas-EmployeeGetByIdResponse-properties-data-properties-position_history-items-properties-position_code : example: "1234" type: string x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeUpdateByIdResponse: example: data: id: 1711 properties: data: properties: id: example: 1711 type: number type: object type: object x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeUpdateByIdResponse-properties-data-properties-id: example: 1711 type: number x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeUpdateById404Response: example: error_code: not_found errors: [] properties: error_code: example: not_found type: string errors: items: type: string type: array type: object x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeUpdateById404Response-properties-error_code: example: not_found type: string x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeGetCustomFieldsResponse: example: data: - id: 1 label: Hobby type: CustomDropdownField value: Hockey options: - Hockey - Football - Voleyball - id: 2 label: Languages type: CustomTags options: null value: - English - Latvian - Estonian properties: data: items: properties: id: example: 1 type: number label: example: Hobby type: string type: example: CustomDropdownField type: string value: {} options: items: example: Hockey type: string nullable: true type: array type: object type: array type: object x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeGetCustomFieldsResponse-properties-data-items-properties-id: example: 1 type: number x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeGetCustomFieldsResponse-properties-data-items-properties-label: example: Hobby type: string x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeGetCustomFieldsResponse-properties-data-items-properties-type: example: CustomDropdownField type: string x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeGetCustomFieldsResponse-properties-data-items-properties-value-oneOf-0: example: Hockey type: string x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeGetCustomFieldsResponse-properties-data-items-properties-value-oneOf-1-items: example: English type: string x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeGetCustomFieldsResponse-properties-data-items-properties-options-items: example: Hockey type: string x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeUpdateCustomFieldResponse: example: data: null properties: data: nullable: true type: string x-konfig-null-placeholder: true type: object x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeUpdateCustomFieldResponse-properties-data: nullable: true type: string x-konfig-null-placeholder: true x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeUpdateCustomField422Response: example: error_code: validation_failed errors: - Custom field text too long (max 250 characters) properties: error_code: example: validation_failed type: string errors: items: example: Custom field text too long (max 250 characters) type: string type: array type: object x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeUpdateCustomField422Response-properties-error_code: example: validation_failed type: string x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeUpdateCustomField422Response-properties-errors-items: example: Custom field text too long (max 250 characters) type: string x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeTerminateEmployeeResponse: example: data: {} properties: data: properties: {} type: object type: object x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeListTerminatedEmployeesResponse: example: data: - id: 19 termination_date: 2015-05-28 employee_number: "123" email: john@example.com first_name: John last_name: Doe picture_url: https://example.com/john.png employment_start_date: 2014-08-25 date_of_birth: 1991-02-13 position: Api developer meta: current_page: 1 next_page: 2 previous_page: null total_pages: 2 per_page: 50 total_entries: 75 properties: data: items: properties: id: example: 19 type: number termination_date: example: 2015-05-28 type: string employee_number: example: "123" type: string email: example: john@example.com type: string first_name: example: John type: string last_name: example: Doe type: string picture_url: example: https://example.com/john.png type: string employment_start_date: example: 2014-08-25 type: string date_of_birth: example: 1991-02-13 type: string position: example: Api developer type: string type: object type: array meta: properties: current_page: example: 1 type: number next_page: example: 2 type: number previous_page: nullable: true type: string x-konfig-null-placeholder: true total_pages: example: 2 type: number per_page: example: 50 type: number total_entries: example: 75 type: number type: object type: object x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeListTerminatedEmployeesResponse-properties-data-items-properties-id: example: 19 type: number x-do-not-generate: true ? konfig-generated-schema-components-schemas-EmployeeListTerminatedEmployeesResponse-properties-data-items-properties-termination_date : example: 2015-05-28 type: string x-do-not-generate: true ? konfig-generated-schema-components-schemas-EmployeeListTerminatedEmployeesResponse-properties-data-items-properties-employee_number : example: "123" type: string x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeListTerminatedEmployeesResponse-properties-data-items-properties-email: example: john@example.com type: string x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeListTerminatedEmployeesResponse-properties-data-items-properties-first_name: example: John type: string x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeListTerminatedEmployeesResponse-properties-data-items-properties-last_name: example: Doe type: string x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeListTerminatedEmployeesResponse-properties-data-items-properties-picture_url: example: https://example.com/john.png type: string x-do-not-generate: true ? konfig-generated-schema-components-schemas-EmployeeListTerminatedEmployeesResponse-properties-data-items-properties-employment_start_date : example: 2014-08-25 type: string x-do-not-generate: true ? konfig-generated-schema-components-schemas-EmployeeListTerminatedEmployeesResponse-properties-data-items-properties-date_of_birth : example: 1991-02-13 type: string x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeListTerminatedEmployeesResponse-properties-data-items-properties-position: example: Api developer type: string x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeListTerminatedEmployeesResponse-properties-meta-properties-current_page: example: 1 type: number x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeListTerminatedEmployeesResponse-properties-meta-properties-next_page: example: 2 type: number x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeListTerminatedEmployeesResponse-properties-meta-properties-previous_page: nullable: true type: string x-konfig-null-placeholder: true x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeListTerminatedEmployeesResponse-properties-meta-properties-total_pages: example: 2 type: number x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeListTerminatedEmployeesResponse-properties-meta-properties-per_page: example: 50 type: number x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeListTerminatedEmployeesResponse-properties-meta-properties-total_entries: example: 75 type: number x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeGetTerminatedEmployeeResponse: example: data: id: 19 termination_date: 2015-05-28 email: john@example.com first_name: John last_name: Doe picture_url: https://example.com/john.png employment_start_date: 2014-08-25 date_of_birth: 1991-02-13 position: Api developer termination: reason: Moving location comments: Moving to properties: data: properties: id: example: 19 type: number termination_date: example: 2015-05-28 type: string email: example: john@example.com type: string first_name: example: John type: string last_name: example: Doe type: string picture_url: example: https://example.com/john.png type: string employment_start_date: example: 2014-08-25 type: string date_of_birth: example: 1991-02-13 type: string position: example: Api developer type: string termination: properties: reason: example: Moving location type: string comments: example: Moving to type: string type: object type: object type: object x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeGetTerminatedEmployeeResponse-properties-data-properties-id: example: 19 type: number x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeGetTerminatedEmployeeResponse-properties-data-properties-termination_date: example: 2015-05-28 type: string x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeGetTerminatedEmployeeResponse-properties-data-properties-email: example: john@example.com type: string x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeGetTerminatedEmployeeResponse-properties-data-properties-first_name: example: John type: string x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeGetTerminatedEmployeeResponse-properties-data-properties-last_name: example: Doe type: string x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeGetTerminatedEmployeeResponse-properties-data-properties-picture_url: example: https://example.com/john.png type: string x-do-not-generate: true ? konfig-generated-schema-components-schemas-EmployeeGetTerminatedEmployeeResponse-properties-data-properties-employment_start_date : example: 2014-08-25 type: string x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeGetTerminatedEmployeeResponse-properties-data-properties-date_of_birth: example: 1991-02-13 type: string x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeGetTerminatedEmployeeResponse-properties-data-properties-position: example: Api developer type: string x-do-not-generate: true ? konfig-generated-schema-components-schemas-EmployeeGetTerminatedEmployeeResponse-properties-data-properties-termination-properties-reason : example: Moving location type: string x-do-not-generate: true ? konfig-generated-schema-components-schemas-EmployeeGetTerminatedEmployeeResponse-properties-data-properties-termination-properties-comments : example: Moving to type: string x-do-not-generate: true konfig-generated-schema-components-schemas-LeaveManagementListTimeOffPoliciesResponse: example: data: - id: 1 name: Vacation color: '#49B284' do_not_accrue: false unit: days default_allowance: "26" max_carryover: "100.0" accrue_type: yearly - id: 2 name: Sickday color: '#DB263F' do_not_accrue: true unit: days default_allowance: "0.0" max_carryover: "0.0" accrue_type: no_tracking properties: data: items: properties: id: example: 1 type: number name: example: Vacation type: string color: example: '#49B284' type: string do_not_accrue: example: false type: boolean unit: example: days type: string default_allowance: example: "26" type: string max_carryover: example: "100.0" type: string accrue_type: example: yearly type: string type: object type: array type: object x-do-not-generate: true konfig-generated-schema-components-schemas-LeaveManagementListTimeOffPoliciesResponse-properties-data-items-properties-id: example: 1 type: number x-do-not-generate: true konfig-generated-schema-components-schemas-LeaveManagementListTimeOffPoliciesResponse-properties-data-items-properties-name: example: Vacation type: string x-do-not-generate: true konfig-generated-schema-components-schemas-LeaveManagementListTimeOffPoliciesResponse-properties-data-items-properties-color: example: '#49B284' type: string x-do-not-generate: true ? konfig-generated-schema-components-schemas-LeaveManagementListTimeOffPoliciesResponse-properties-data-items-properties-do_not_accrue : example: false type: boolean x-do-not-generate: true konfig-generated-schema-components-schemas-LeaveManagementListTimeOffPoliciesResponse-properties-data-items-properties-unit: example: days type: string x-do-not-generate: true ? konfig-generated-schema-components-schemas-LeaveManagementListTimeOffPoliciesResponse-properties-data-items-properties-default_allowance : example: "26" type: string x-do-not-generate: true ? konfig-generated-schema-components-schemas-LeaveManagementListTimeOffPoliciesResponse-properties-data-items-properties-max_carryover : example: "100.0" type: string x-do-not-generate: true ? konfig-generated-schema-components-schemas-LeaveManagementListTimeOffPoliciesResponse-properties-data-items-properties-accrue_type : example: yearly type: string x-do-not-generate: true konfig-generated-schema-components-schemas-LeaveManagementGetTimeOffPolicyByIdResponse: example: data: - id: 1 name: Vacation color: '#3a7dd8' do_not_accrue: false unit: days default_allowance: "25.0" max_carryover: "100.0" accrue_type: yearly enable_employee_access: true only_full_days: false enable_probation_period: false dont_allow_negative_amount: false requests_in_advance_required: false enable_minimum_days: false enable_limited_days: false enable_dependent_policy": false blocks_enabled: false no_reset: false termination_recalculation: true enable_service_accruals: false child_allowance_enabled: false enable_negative_carryover: false max_accrual: false accrue_at_start: true enable_monthly_expiration: false starter_monthly_accrual_limitation: false starter_yearly_accrual_limitation: false auto_approves: false enable_specific_approvers: false override_approvers_enabled: false enable_duplicate_time_offs: false enable_replacement: false replacement_required: false enable_scopped_replacement: false enable_replacement_away: false enable_details: true require_details: false additional_field: true enable_attachment: false properties: data: items: properties: id: example: 1 type: number name: example: Vacation type: string color: example: '#3a7dd8' type: string do_not_accrue: example: false type: boolean unit: example: days type: string default_allowance: example: "25.0" type: string max_carryover: example: "100.0" type: string accrue_type: example: yearly type: string enable_employee_access: example: true type: boolean only_full_days: example: false type: boolean enable_probation_period: example: false type: boolean dont_allow_negative_amount: example: false type: boolean requests_in_advance_required: example: false type: boolean enable_minimum_days: example: false type: boolean enable_limited_days: example: false type: boolean enable_dependent_policy": example: false type: boolean blocks_enabled: example: false type: boolean no_reset: example: false type: boolean termination_recalculation: example: true type: boolean enable_service_accruals: example: false type: boolean child_allowance_enabled: example: false type: boolean enable_negative_carryover: example: false type: boolean max_accrual: example: false type: boolean accrue_at_start: example: true type: boolean enable_monthly_expiration: example: false type: boolean starter_monthly_accrual_limitation: example: false type: boolean starter_yearly_accrual_limitation: example: false type: boolean auto_approves: example: false type: boolean enable_specific_approvers: example: false type: boolean override_approvers_enabled: example: false type: boolean enable_duplicate_time_offs: example: false type: boolean enable_replacement: example: false type: boolean replacement_required: example: false type: boolean enable_scopped_replacement: example: false type: boolean enable_replacement_away: example: false type: boolean enable_details: example: true type: boolean require_details: example: false type: boolean additional_field: example: true type: boolean enable_attachment: example: false type: boolean type: object type: array type: object x-do-not-generate: true konfig-generated-schema-components-schemas-LeaveManagementGetTimeOffPolicyByIdResponse-properties-data-items-properties-id: example: 1 type: number x-do-not-generate: true konfig-generated-schema-components-schemas-LeaveManagementGetTimeOffPolicyByIdResponse-properties-data-items-properties-name: example: Vacation type: string x-do-not-generate: true konfig-generated-schema-components-schemas-LeaveManagementGetTimeOffPolicyByIdResponse-properties-data-items-properties-color: example: '#3a7dd8' type: string x-do-not-generate: true ? konfig-generated-schema-components-schemas-LeaveManagementGetTimeOffPolicyByIdResponse-properties-data-items-properties-do_not_accrue : example: false type: boolean x-do-not-generate: true konfig-generated-schema-components-schemas-LeaveManagementGetTimeOffPolicyByIdResponse-properties-data-items-properties-unit: example: days type: string x-do-not-generate: true ? konfig-generated-schema-components-schemas-LeaveManagementGetTimeOffPolicyByIdResponse-properties-data-items-properties-default_allowance : example: "25.0" type: string x-do-not-generate: true ? konfig-generated-schema-components-schemas-LeaveManagementGetTimeOffPolicyByIdResponse-properties-data-items-properties-max_carryover : example: "100.0" type: string x-do-not-generate: true ? konfig-generated-schema-components-schemas-LeaveManagementGetTimeOffPolicyByIdResponse-properties-data-items-properties-accrue_type : example: yearly type: string x-do-not-generate: true ? konfig-generated-schema-components-schemas-LeaveManagementGetTimeOffPolicyByIdResponse-properties-data-items-properties-enable_employee_access : example: true type: boolean x-do-not-generate: true ? konfig-generated-schema-components-schemas-LeaveManagementGetTimeOffPolicyByIdResponse-properties-data-items-properties-only_full_days : example: false type: boolean x-do-not-generate: true ? konfig-generated-schema-components-schemas-LeaveManagementGetTimeOffPolicyByIdResponse-properties-data-items-properties-enable_probation_period : example: false type: boolean x-do-not-generate: true ? konfig-generated-schema-components-schemas-LeaveManagementGetTimeOffPolicyByIdResponse-properties-data-items-properties-dont_allow_negative_amount : example: false type: boolean x-do-not-generate: true ? konfig-generated-schema-components-schemas-LeaveManagementGetTimeOffPolicyByIdResponse-properties-data-items-properties-requests_in_advance_required : example: false type: boolean x-do-not-generate: true ? konfig-generated-schema-components-schemas-LeaveManagementGetTimeOffPolicyByIdResponse-properties-data-items-properties-enable_minimum_days : example: false type: boolean x-do-not-generate: true ? konfig-generated-schema-components-schemas-LeaveManagementGetTimeOffPolicyByIdResponse-properties-data-items-properties-enable_limited_days : example: false type: boolean x-do-not-generate: true ? konfig-generated-schema-components-schemas-LeaveManagementGetTimeOffPolicyByIdResponse-properties-data-items-properties-enable_dependent_policy" : example: false type: boolean x-do-not-generate: true ? konfig-generated-schema-components-schemas-LeaveManagementGetTimeOffPolicyByIdResponse-properties-data-items-properties-blocks_enabled : example: false type: boolean x-do-not-generate: true ? konfig-generated-schema-components-schemas-LeaveManagementGetTimeOffPolicyByIdResponse-properties-data-items-properties-no_reset : example: false type: boolean x-do-not-generate: true ? konfig-generated-schema-components-schemas-LeaveManagementGetTimeOffPolicyByIdResponse-properties-data-items-properties-termination_recalculation : example: true type: boolean x-do-not-generate: true ? konfig-generated-schema-components-schemas-LeaveManagementGetTimeOffPolicyByIdResponse-properties-data-items-properties-enable_service_accruals : example: false type: boolean x-do-not-generate: true ? konfig-generated-schema-components-schemas-LeaveManagementGetTimeOffPolicyByIdResponse-properties-data-items-properties-child_allowance_enabled : example: false type: boolean x-do-not-generate: true ? konfig-generated-schema-components-schemas-LeaveManagementGetTimeOffPolicyByIdResponse-properties-data-items-properties-enable_negative_carryover : example: false type: boolean x-do-not-generate: true ? konfig-generated-schema-components-schemas-LeaveManagementGetTimeOffPolicyByIdResponse-properties-data-items-properties-max_accrual : example: false type: boolean x-do-not-generate: true ? konfig-generated-schema-components-schemas-LeaveManagementGetTimeOffPolicyByIdResponse-properties-data-items-properties-accrue_at_start : example: true type: boolean x-do-not-generate: true ? konfig-generated-schema-components-schemas-LeaveManagementGetTimeOffPolicyByIdResponse-properties-data-items-properties-enable_monthly_expiration : example: false type: boolean x-do-not-generate: true ? konfig-generated-schema-components-schemas-LeaveManagementGetTimeOffPolicyByIdResponse-properties-data-items-properties-starter_monthly_accrual_limitation : example: false type: boolean x-do-not-generate: true ? konfig-generated-schema-components-schemas-LeaveManagementGetTimeOffPolicyByIdResponse-properties-data-items-properties-starter_yearly_accrual_limitation : example: false type: boolean x-do-not-generate: true ? konfig-generated-schema-components-schemas-LeaveManagementGetTimeOffPolicyByIdResponse-properties-data-items-properties-auto_approves : example: false type: boolean x-do-not-generate: true ? konfig-generated-schema-components-schemas-LeaveManagementGetTimeOffPolicyByIdResponse-properties-data-items-properties-enable_specific_approvers : example: false type: boolean x-do-not-generate: true ? konfig-generated-schema-components-schemas-LeaveManagementGetTimeOffPolicyByIdResponse-properties-data-items-properties-override_approvers_enabled : example: false type: boolean x-do-not-generate: true ? konfig-generated-schema-components-schemas-LeaveManagementGetTimeOffPolicyByIdResponse-properties-data-items-properties-enable_duplicate_time_offs : example: false type: boolean x-do-not-generate: true ? konfig-generated-schema-components-schemas-LeaveManagementGetTimeOffPolicyByIdResponse-properties-data-items-properties-enable_replacement : example: false type: boolean x-do-not-generate: true ? konfig-generated-schema-components-schemas-LeaveManagementGetTimeOffPolicyByIdResponse-properties-data-items-properties-replacement_required : example: false type: boolean x-do-not-generate: true ? konfig-generated-schema-components-schemas-LeaveManagementGetTimeOffPolicyByIdResponse-properties-data-items-properties-enable_scopped_replacement : example: false type: boolean x-do-not-generate: true ? konfig-generated-schema-components-schemas-LeaveManagementGetTimeOffPolicyByIdResponse-properties-data-items-properties-enable_replacement_away : example: false type: boolean x-do-not-generate: true ? konfig-generated-schema-components-schemas-LeaveManagementGetTimeOffPolicyByIdResponse-properties-data-items-properties-enable_details : example: true type: boolean x-do-not-generate: true ? konfig-generated-schema-components-schemas-LeaveManagementGetTimeOffPolicyByIdResponse-properties-data-items-properties-require_details : example: false type: boolean x-do-not-generate: true ? konfig-generated-schema-components-schemas-LeaveManagementGetTimeOffPolicyByIdResponse-properties-data-items-properties-additional_field : example: true type: boolean x-do-not-generate: true ? konfig-generated-schema-components-schemas-LeaveManagementGetTimeOffPolicyByIdResponse-properties-data-items-properties-enable_attachment : example: false type: boolean x-do-not-generate: true konfig-generated-schema-components-schemas-LeaveManagementUpdateKitDaysConfigurationResponse: example: error_code: invalid_policy_type errors: - The policy specified is not an event-based policy properties: error_code: example: invalid_policy_type type: string errors: items: example: The policy specified is not an event-based policy type: string type: array type: object x-do-not-generate: true konfig-generated-schema-components-schemas-LeaveManagementUpdateKitDaysConfigurationResponse-properties-error_code: example: invalid_policy_type type: string x-do-not-generate: true konfig-generated-schema-components-schemas-LeaveManagementUpdateKitDaysConfigurationResponse-properties-errors-items: example: The policy specified is not an event-based policy type: string x-do-not-generate: true konfig-generated-schema-components-schemas-LeaveManagementGetKitDaysResponse: example: data: - id: 1 status: declined start_date: 2021-03-09 end_date: 2021-03-10 - id: 2 status: approved start_date: 2021-03-09 end_date: 2021-03-10 properties: data: items: properties: id: example: 1 type: number status: example: declined type: string start_date: example: 2021-03-09 type: string end_date: example: 2021-03-10 type: string type: object type: array type: object x-do-not-generate: true konfig-generated-schema-components-schemas-LeaveManagementGetKitDaysResponse-properties-data-items-properties-id: example: 1 type: number x-do-not-generate: true konfig-generated-schema-components-schemas-LeaveManagementGetKitDaysResponse-properties-data-items-properties-status: example: declined type: string x-do-not-generate: true konfig-generated-schema-components-schemas-LeaveManagementGetKitDaysResponse-properties-data-items-properties-start_date: example: 2021-03-09 type: string x-do-not-generate: true konfig-generated-schema-components-schemas-LeaveManagementGetKitDaysResponse-properties-data-items-properties-end_date: example: 2021-03-10 type: string x-do-not-generate: true konfig-generated-schema-components-schemas-LeaveManagementCreateKitDayResponse: example: data: - id: 1 properties: data: items: properties: id: example: 1 type: number type: object type: array type: object x-do-not-generate: true konfig-generated-schema-components-schemas-LeaveManagementCreateKitDayResponse-properties-data-items-properties-id: example: 1 type: number x-do-not-generate: true konfig-generated-schema-components-schemas-LeaveManagementCreateKitDay422Response: example: error_code: validation_failed errors: - First error - Second error properties: error_code: example: validation_failed type: string errors: items: example: First error type: string type: array type: object x-do-not-generate: true konfig-generated-schema-components-schemas-LeaveManagementCreateKitDay422Response-properties-error_code: example: validation_failed type: string x-do-not-generate: true konfig-generated-schema-components-schemas-LeaveManagementCreateKitDay422Response-properties-errors-items: example: First error type: string x-do-not-generate: true konfig-generated-schema-components-schemas-LeaveManagementGetIndividualAllowancesResponse: example: data: - full_name: Joe Doe id: 11 eligibilities: - policy: name: Sickday id: 2 quantity: "0.0" unit: days carryover: "0.0" - policy: name: Vacation id: 1 quantity: "25.0" unit: days carryover: "100.0" - full_name: Jane Doe id: 13 eligibilities: - policy: name: Custom Policy id: 4 quantity: "0.0" unit: days carryover: "0.0" - policy: name: Vacation id: 1 quantity: "25.0" unit: days carryover: "100.0" meta: current_page: 1 next_page: null previous_page: null total_pages: 1 per_page: 25 total_entries: 1 properties: data: items: properties: full_name: example: Joe Doe type: string id: example: 11 type: number eligibilities: items: properties: policy: properties: name: example: Sickday type: string id: example: 2 type: number type: object quantity: example: "0.0" type: string unit: example: days type: string carryover: example: "0.0" type: string type: object type: array type: object type: array meta: properties: current_page: example: 1 type: number next_page: nullable: true type: string x-konfig-null-placeholder: true previous_page: nullable: true type: string x-konfig-null-placeholder: true total_pages: example: 1 type: number per_page: example: 25 type: number total_entries: example: 1 type: number type: object type: object x-do-not-generate: true ? konfig-generated-schema-components-schemas-LeaveManagementGetIndividualAllowancesResponse-properties-data-items-properties-full_name : example: Joe Doe type: string x-do-not-generate: true konfig-generated-schema-components-schemas-LeaveManagementGetIndividualAllowancesResponse-properties-data-items-properties-id: example: 11 type: number x-do-not-generate: true ? konfig-generated-schema-components-schemas-LeaveManagementGetIndividualAllowancesResponse-properties-data-items-properties-eligibilities-items-properties-policy-properties-name : example: Sickday type: string x-do-not-generate: true ? konfig-generated-schema-components-schemas-LeaveManagementGetIndividualAllowancesResponse-properties-data-items-properties-eligibilities-items-properties-policy-properties-id : example: 2 type: number x-do-not-generate: true ? konfig-generated-schema-components-schemas-LeaveManagementGetIndividualAllowancesResponse-properties-data-items-properties-eligibilities-items-properties-quantity : example: "0.0" type: string x-do-not-generate: true ? konfig-generated-schema-components-schemas-LeaveManagementGetIndividualAllowancesResponse-properties-data-items-properties-eligibilities-items-properties-unit : example: days type: string x-do-not-generate: true ? konfig-generated-schema-components-schemas-LeaveManagementGetIndividualAllowancesResponse-properties-data-items-properties-eligibilities-items-properties-carryover : example: "0.0" type: string x-do-not-generate: true ? konfig-generated-schema-components-schemas-LeaveManagementGetIndividualAllowancesResponse-properties-meta-properties-current_page : example: 1 type: number x-do-not-generate: true konfig-generated-schema-components-schemas-LeaveManagementGetIndividualAllowancesResponse-properties-meta-properties-next_page: nullable: true type: string x-konfig-null-placeholder: true x-do-not-generate: true ? konfig-generated-schema-components-schemas-LeaveManagementGetIndividualAllowancesResponse-properties-meta-properties-previous_page : nullable: true type: string x-konfig-null-placeholder: true x-do-not-generate: true ? konfig-generated-schema-components-schemas-LeaveManagementGetIndividualAllowancesResponse-properties-meta-properties-total_pages : example: 1 type: number x-do-not-generate: true konfig-generated-schema-components-schemas-LeaveManagementGetIndividualAllowancesResponse-properties-meta-properties-per_page: example: 25 type: number x-do-not-generate: true ? konfig-generated-schema-components-schemas-LeaveManagementGetIndividualAllowancesResponse-properties-meta-properties-total_entries : example: 1 type: number x-do-not-generate: true konfig-generated-schema-components-schemas-LeaveManagementGetTimeOffBalancesResponse: example: data: - policy_id: 1 used: 5.6 available: 2 - policy_id: 2 used: 75 available: null properties: data: items: properties: policy_id: example: 1 type: number used: example: 5.6 type: number available: example: 2 nullable: true type: number type: object type: array type: object x-do-not-generate: true konfig-generated-schema-components-schemas-LeaveManagementGetTimeOffBalancesResponse-properties-data-items-properties-policy_id: example: 1 type: number x-do-not-generate: true konfig-generated-schema-components-schemas-LeaveManagementGetTimeOffBalancesResponse-properties-data-items-properties-used: example: 5.6 type: number x-do-not-generate: true konfig-generated-schema-components-schemas-LeaveManagementGetTimeOffBalancesResponse-properties-data-items-properties-available: example: 2 type: number x-do-not-generate: true konfig-generated-schema-components-schemas-LeaveManagementListTimeOffRequestsResponse: example: data: - id: 2902504 status: Approved status_code: approved policy_id: 1 employee_id: 1 details: Birthday lunch is_multi_date: false is_single_day: true is_part_of_day: true first_part_of_day: false second_part_of_day: true start_date: 2018-05-24 end_date: 2018-05-24 request_date: 2018-05-22 approval_date: null hours: 3.5 fields: - title: Approved by manager? answer: true meta: current_page: 1 next_page: 2 previous_page: null total_pages: 2 per_page: 50 total_entries: 75 properties: data: items: properties: id: example: 2902504 type: number status: example: Approved type: string status_code: example: approved type: string policy_id: example: 1 type: number employee_id: example: 1 type: number details: example: Birthday lunch type: string is_multi_date: example: false type: boolean is_single_day: example: true type: boolean is_part_of_day: example: true type: boolean first_part_of_day: example: false type: boolean second_part_of_day: example: true type: boolean start_date: example: 2018-05-24 type: string end_date: example: 2018-05-24 type: string request_date: example: 2018-05-22 type: string approval_date: nullable: true type: string x-konfig-null-placeholder: true hours: example: 3.5 type: number fields: items: properties: title: example: Approved by manager? type: string answer: example: "true" type: string type: object type: array type: object type: array meta: properties: current_page: example: 1 type: number next_page: example: 2 type: number previous_page: nullable: true type: string x-konfig-null-placeholder: true total_pages: example: 2 type: number per_page: example: 50 type: number total_entries: example: 75 type: number type: object type: object x-do-not-generate: true konfig-generated-schema-components-schemas-LeaveManagementListTimeOffRequestsResponse-properties-data-items-properties-id: example: 2902504 type: number x-do-not-generate: true konfig-generated-schema-components-schemas-LeaveManagementListTimeOffRequestsResponse-properties-data-items-properties-status: example: Approved type: string x-do-not-generate: true ? konfig-generated-schema-components-schemas-LeaveManagementListTimeOffRequestsResponse-properties-data-items-properties-status_code : example: approved type: string x-do-not-generate: true ? konfig-generated-schema-components-schemas-LeaveManagementListTimeOffRequestsResponse-properties-data-items-properties-policy_id : example: 1 type: number x-do-not-generate: true ? konfig-generated-schema-components-schemas-LeaveManagementListTimeOffRequestsResponse-properties-data-items-properties-employee_id : example: 1 type: number x-do-not-generate: true konfig-generated-schema-components-schemas-LeaveManagementListTimeOffRequestsResponse-properties-data-items-properties-details: example: Birthday lunch type: string x-do-not-generate: true ? konfig-generated-schema-components-schemas-LeaveManagementListTimeOffRequestsResponse-properties-data-items-properties-is_multi_date : example: false type: boolean x-do-not-generate: true ? konfig-generated-schema-components-schemas-LeaveManagementListTimeOffRequestsResponse-properties-data-items-properties-is_single_day : example: true type: boolean x-do-not-generate: true ? konfig-generated-schema-components-schemas-LeaveManagementListTimeOffRequestsResponse-properties-data-items-properties-is_part_of_day : example: true type: boolean x-do-not-generate: true ? konfig-generated-schema-components-schemas-LeaveManagementListTimeOffRequestsResponse-properties-data-items-properties-first_part_of_day : example: false type: boolean x-do-not-generate: true ? konfig-generated-schema-components-schemas-LeaveManagementListTimeOffRequestsResponse-properties-data-items-properties-second_part_of_day : example: true type: boolean x-do-not-generate: true ? konfig-generated-schema-components-schemas-LeaveManagementListTimeOffRequestsResponse-properties-data-items-properties-start_date : example: 2018-05-24 type: string x-do-not-generate: true konfig-generated-schema-components-schemas-LeaveManagementListTimeOffRequestsResponse-properties-data-items-properties-end_date: example: 2018-05-24 type: string x-do-not-generate: true ? konfig-generated-schema-components-schemas-LeaveManagementListTimeOffRequestsResponse-properties-data-items-properties-request_date : example: 2018-05-22 type: string x-do-not-generate: true konfig-generated-schema-components-schemas-LeaveManagementListTimeOffRequestsResponse-properties-data-items-properties-hours: example: 3.5 type: number x-do-not-generate: true ? konfig-generated-schema-components-schemas-LeaveManagementListTimeOffRequestsResponse-properties-data-items-properties-fields-items-properties-title : example: Approved by manager? type: string x-do-not-generate: true ? konfig-generated-schema-components-schemas-LeaveManagementListTimeOffRequestsResponse-properties-data-items-properties-fields-items-properties-answer : example: "true" type: string x-do-not-generate: true konfig-generated-schema-components-schemas-LeaveManagementListTimeOffRequestsResponse-properties-meta-properties-current_page: example: 1 type: number x-do-not-generate: true konfig-generated-schema-components-schemas-LeaveManagementListTimeOffRequestsResponse-properties-meta-properties-next_page: example: 2 type: number x-do-not-generate: true konfig-generated-schema-components-schemas-LeaveManagementListTimeOffRequestsResponse-properties-meta-properties-previous_page: nullable: true type: string x-konfig-null-placeholder: true x-do-not-generate: true konfig-generated-schema-components-schemas-LeaveManagementListTimeOffRequestsResponse-properties-meta-properties-total_pages: example: 2 type: number x-do-not-generate: true konfig-generated-schema-components-schemas-LeaveManagementListTimeOffRequestsResponse-properties-meta-properties-per_page: example: 50 type: number x-do-not-generate: true konfig-generated-schema-components-schemas-LeaveManagementListTimeOffRequestsResponse-properties-meta-properties-total_entries: example: 75 type: number x-do-not-generate: true konfig-generated-schema-components-schemas-LeaveManagementNewTimeOffRequestResponse: example: data: id: 1 properties: data: properties: id: example: 1 type: number type: object type: object x-do-not-generate: true konfig-generated-schema-components-schemas-LeaveManagementNewTimeOffRequestResponse-properties-data-properties-id: example: 1 type: number x-do-not-generate: true konfig-generated-schema-components-schemas-LeaveManagementNewTimeOffRequest422Response: example: error_code: validation_failed errors: - Error message properties: error_code: example: validation_failed type: string errors: items: example: Error message type: string type: array type: object x-do-not-generate: true konfig-generated-schema-components-schemas-LeaveManagementNewTimeOffRequest422Response-properties-error_code: example: validation_failed type: string x-do-not-generate: true konfig-generated-schema-components-schemas-LeaveManagementNewTimeOffRequest422Response-properties-errors-items: example: Error message type: string x-do-not-generate: true konfig-generated-schema-components-schemas-LeaveManagementListEmployeesOutTodayResponse: example: data: - id: 2902504 policy_id: 2 policy: name: Vacation employee_id: 5 employee: first_name: John last_name: Doe details: Birthday lunch is_multi_date: false is_single_day: true is_part_of_day: true first_part_of_day: false second_part_of_day: true start_date: 2018-05-24 end_date: 2018-05-24 hours: 3.5 properties: data: items: properties: id: example: 2902504 type: number policy_id: example: 2 type: number policy: properties: name: example: Vacation type: string type: object employee_id: example: 5 type: number employee: properties: first_name: example: John type: string last_name: example: Doe type: string type: object details: example: Birthday lunch type: string is_multi_date: example: false type: boolean is_single_day: example: true type: boolean is_part_of_day: example: true type: boolean first_part_of_day: example: false type: boolean second_part_of_day: example: true type: boolean start_date: example: 2018-05-24 type: string end_date: example: 2018-05-24 type: string hours: example: 3.5 type: number type: object type: array type: object x-do-not-generate: true konfig-generated-schema-components-schemas-LeaveManagementListEmployeesOutTodayResponse-properties-data-items-properties-id: example: 2902504 type: number x-do-not-generate: true ? konfig-generated-schema-components-schemas-LeaveManagementListEmployeesOutTodayResponse-properties-data-items-properties-policy_id : example: 2 type: number x-do-not-generate: true ? konfig-generated-schema-components-schemas-LeaveManagementListEmployeesOutTodayResponse-properties-data-items-properties-policy-properties-name : example: Vacation type: string x-do-not-generate: true ? konfig-generated-schema-components-schemas-LeaveManagementListEmployeesOutTodayResponse-properties-data-items-properties-employee_id : example: 5 type: number x-do-not-generate: true ? konfig-generated-schema-components-schemas-LeaveManagementListEmployeesOutTodayResponse-properties-data-items-properties-employee-properties-first_name : example: John type: string x-do-not-generate: true ? konfig-generated-schema-components-schemas-LeaveManagementListEmployeesOutTodayResponse-properties-data-items-properties-employee-properties-last_name : example: Doe type: string x-do-not-generate: true ? konfig-generated-schema-components-schemas-LeaveManagementListEmployeesOutTodayResponse-properties-data-items-properties-details : example: Birthday lunch type: string x-do-not-generate: true ? konfig-generated-schema-components-schemas-LeaveManagementListEmployeesOutTodayResponse-properties-data-items-properties-is_multi_date : example: false type: boolean x-do-not-generate: true ? konfig-generated-schema-components-schemas-LeaveManagementListEmployeesOutTodayResponse-properties-data-items-properties-is_single_day : example: true type: boolean x-do-not-generate: true ? konfig-generated-schema-components-schemas-LeaveManagementListEmployeesOutTodayResponse-properties-data-items-properties-is_part_of_day : example: true type: boolean x-do-not-generate: true ? konfig-generated-schema-components-schemas-LeaveManagementListEmployeesOutTodayResponse-properties-data-items-properties-first_part_of_day : example: false type: boolean x-do-not-generate: true ? konfig-generated-schema-components-schemas-LeaveManagementListEmployeesOutTodayResponse-properties-data-items-properties-second_part_of_day : example: true type: boolean x-do-not-generate: true ? konfig-generated-schema-components-schemas-LeaveManagementListEmployeesOutTodayResponse-properties-data-items-properties-start_date : example: 2018-05-24 type: string x-do-not-generate: true ? konfig-generated-schema-components-schemas-LeaveManagementListEmployeesOutTodayResponse-properties-data-items-properties-end_date : example: 2018-05-24 type: string x-do-not-generate: true konfig-generated-schema-components-schemas-LeaveManagementListEmployeesOutTodayResponse-properties-data-items-properties-hours: example: 3.5 type: number x-do-not-generate: true konfig-generated-schema-components-schemas-DocumentsListCategoriesResponse: example: data: - id: 1 name: General documents_count: 10 - id: 2 name: Job contracts documents_count: 1 properties: data: items: properties: id: example: 1 type: number name: example: General type: string documents_count: example: 10 type: number type: object type: array type: object x-do-not-generate: true konfig-generated-schema-components-schemas-DocumentsListCategoriesResponse-properties-data-items-properties-id: example: 1 type: number x-do-not-generate: true konfig-generated-schema-components-schemas-DocumentsListCategoriesResponse-properties-data-items-properties-name: example: General type: string x-do-not-generate: true konfig-generated-schema-components-schemas-DocumentsListCategoriesResponse-properties-data-items-properties-documents_count: example: 10 type: number x-do-not-generate: true konfig-generated-schema-components-schemas-DocumentsCreateNewDocumentResponse: example: data: id: 1 properties: data: properties: id: example: 1 type: number type: object type: object x-do-not-generate: true konfig-generated-schema-components-schemas-DocumentsCreateNewDocumentResponse-properties-data-properties-id: example: 1 type: number x-do-not-generate: true konfig-generated-schema-components-schemas-PositionsListCompanyPositionsResponse: example: data: - title: CFO description: '...' id: 19 code: X2 - title: CEO description: null id: 20 code: null meta: current_page: 1 next_page: 2 previous_page: null total_pages: 2 per_page: 50 total_entries: 75 properties: data: items: properties: title: example: CFO type: string description: example: '...' nullable: true type: string id: example: 19 type: number code: example: X2 nullable: true type: string type: object type: array meta: properties: current_page: example: 1 type: number next_page: example: 2 type: number previous_page: nullable: true type: string x-konfig-null-placeholder: true total_pages: example: 2 type: number per_page: example: 50 type: number total_entries: example: 75 type: number type: object type: object x-do-not-generate: true konfig-generated-schema-components-schemas-PositionsListCompanyPositionsResponse-properties-data-items-properties-title: example: CFO type: string x-do-not-generate: true konfig-generated-schema-components-schemas-PositionsListCompanyPositionsResponse-properties-data-items-properties-description: example: '...' type: string x-do-not-generate: true konfig-generated-schema-components-schemas-PositionsListCompanyPositionsResponse-properties-data-items-properties-id: example: 19 type: number x-do-not-generate: true konfig-generated-schema-components-schemas-PositionsListCompanyPositionsResponse-properties-data-items-properties-code: example: X2 type: string x-do-not-generate: true konfig-generated-schema-components-schemas-PositionsListCompanyPositionsResponse-properties-meta-properties-current_page: example: 1 type: number x-do-not-generate: true konfig-generated-schema-components-schemas-PositionsListCompanyPositionsResponse-properties-meta-properties-next_page: example: 2 type: number x-do-not-generate: true konfig-generated-schema-components-schemas-PositionsListCompanyPositionsResponse-properties-meta-properties-previous_page: nullable: true type: string x-konfig-null-placeholder: true x-do-not-generate: true konfig-generated-schema-components-schemas-PositionsListCompanyPositionsResponse-properties-meta-properties-total_pages: example: 2 type: number x-do-not-generate: true konfig-generated-schema-components-schemas-PositionsListCompanyPositionsResponse-properties-meta-properties-per_page: example: 50 type: number x-do-not-generate: true konfig-generated-schema-components-schemas-PositionsListCompanyPositionsResponse-properties-meta-properties-total_entries: example: 75 type: number x-do-not-generate: true konfig-generated-schema-components-schemas-TeamsListInCompanyResponse: example: data: - id: 19 name: Sales manager_ids: - 1 - 2 employee_ids: - 5 - 7 - 90 meta: current_page: 1 next_page: 2 previous_page: null total_pages: 2 per_page: 50 total_entries: 75 properties: data: items: properties: id: example: 19 type: number name: example: Sales type: string manager_ids: items: example: 1 type: number type: array employee_ids: items: example: 5 type: number type: array type: object type: array meta: properties: current_page: example: 1 type: number next_page: example: 2 type: number previous_page: nullable: true type: string x-konfig-null-placeholder: true total_pages: example: 2 type: number per_page: example: 50 type: number total_entries: example: 75 type: number type: object type: object x-do-not-generate: true konfig-generated-schema-components-schemas-TeamsListInCompanyResponse-properties-data-items-properties-id: example: 19 type: number x-do-not-generate: true konfig-generated-schema-components-schemas-TeamsListInCompanyResponse-properties-data-items-properties-name: example: Sales type: string x-do-not-generate: true konfig-generated-schema-components-schemas-TeamsListInCompanyResponse-properties-data-items-properties-manager_ids-items: example: 1 type: number x-do-not-generate: true konfig-generated-schema-components-schemas-TeamsListInCompanyResponse-properties-data-items-properties-employee_ids-items: example: 5 type: number x-do-not-generate: true konfig-generated-schema-components-schemas-TeamsListInCompanyResponse-properties-meta-properties-current_page: example: 1 type: number x-do-not-generate: true konfig-generated-schema-components-schemas-TeamsListInCompanyResponse-properties-meta-properties-next_page: example: 2 type: number x-do-not-generate: true konfig-generated-schema-components-schemas-TeamsListInCompanyResponse-properties-meta-properties-previous_page: nullable: true type: string x-konfig-null-placeholder: true x-do-not-generate: true konfig-generated-schema-components-schemas-TeamsListInCompanyResponse-properties-meta-properties-total_pages: example: 2 type: number x-do-not-generate: true konfig-generated-schema-components-schemas-TeamsListInCompanyResponse-properties-meta-properties-per_page: example: 50 type: number x-do-not-generate: true konfig-generated-schema-components-schemas-TeamsListInCompanyResponse-properties-meta-properties-total_entries: example: 75 type: number x-do-not-generate: true konfig-generated-schema-components-schemas-PerformanceOverviewQuarterlyProgressResponse: example: data: company: adjusted: 18 actual: 15 individual: adjusted: 31 actual: 26 team: adjusted: 42 actual: 37 properties: data: properties: company: properties: adjusted: example: 18 type: number actual: example: 15 type: number type: object individual: properties: adjusted: example: 31 type: number actual: example: 26 type: number type: object team: properties: adjusted: example: 42 type: number actual: example: 37 type: number type: object type: object type: object x-do-not-generate: true ? konfig-generated-schema-components-schemas-PerformanceOverviewQuarterlyProgressResponse-properties-data-properties-company-properties-adjusted : example: 18 type: number x-do-not-generate: true ? konfig-generated-schema-components-schemas-PerformanceOverviewQuarterlyProgressResponse-properties-data-properties-company-properties-actual : example: 15 type: number x-do-not-generate: true ? konfig-generated-schema-components-schemas-PerformanceOverviewQuarterlyProgressResponse-properties-data-properties-individual-properties-adjusted : example: 31 type: number x-do-not-generate: true ? konfig-generated-schema-components-schemas-PerformanceOverviewQuarterlyProgressResponse-properties-data-properties-individual-properties-actual : example: 26 type: number x-do-not-generate: true ? konfig-generated-schema-components-schemas-PerformanceOverviewQuarterlyProgressResponse-properties-data-properties-team-properties-adjusted : example: 42 type: number x-do-not-generate: true ? konfig-generated-schema-components-schemas-PerformanceOverviewQuarterlyProgressResponse-properties-data-properties-team-properties-actual : example: 37 type: number x-do-not-generate: true konfig-generated-schema-components-schemas-PerformanceGetQuarterlyCompanyGoalsResponse: example: data: - title: Optimize data storage progress: actual: 10 to_date: 34 properties: data: items: properties: title: example: Optimize data storage type: string progress: properties: actual: example: 10 type: number to_date: example: 34 type: number type: object type: object type: array type: object x-do-not-generate: true konfig-generated-schema-components-schemas-PerformanceGetQuarterlyCompanyGoalsResponse-properties-data-items-properties-title: example: Optimize data storage type: string x-do-not-generate: true ? konfig-generated-schema-components-schemas-PerformanceGetQuarterlyCompanyGoalsResponse-properties-data-items-properties-progress-properties-actual : example: 10 type: number x-do-not-generate: true ? konfig-generated-schema-components-schemas-PerformanceGetQuarterlyCompanyGoalsResponse-properties-data-items-properties-progress-properties-to_date : example: 34 type: number x-do-not-generate: true konfig-generated-schema-components-schemas-PerformanceGetQuarterlyTeamGoalsResponse: example: data: - name: HR team progress: actual: 10 to_date: 34 goals: - title: Optimize data storage progress: actual: 10 to_date: 34 properties: data: items: properties: name: example: HR team type: string progress: properties: actual: example: 10 type: number to_date: example: 34 type: number type: object goals: items: properties: title: example: Optimize data storage type: string progress: properties: actual: example: 10 type: number to_date: example: 34 type: number type: object type: object type: array type: object type: array type: object x-do-not-generate: true konfig-generated-schema-components-schemas-PerformanceGetQuarterlyTeamGoalsResponse-properties-data-items-properties-name: example: HR team type: string x-do-not-generate: true ? konfig-generated-schema-components-schemas-PerformanceGetQuarterlyTeamGoalsResponse-properties-data-items-properties-progress-properties-actual : example: 10 type: number x-do-not-generate: true ? konfig-generated-schema-components-schemas-PerformanceGetQuarterlyTeamGoalsResponse-properties-data-items-properties-progress-properties-to_date : example: 34 type: number x-do-not-generate: true ? konfig-generated-schema-components-schemas-PerformanceGetQuarterlyTeamGoalsResponse-properties-data-items-properties-goals-items-properties-title : example: Optimize data storage type: string x-do-not-generate: true ? konfig-generated-schema-components-schemas-PerformanceGetQuarterlyTeamGoalsResponse-properties-data-items-properties-goals-items-properties-progress-properties-actual : example: 10 type: number x-do-not-generate: true ? konfig-generated-schema-components-schemas-PerformanceGetQuarterlyTeamGoalsResponse-properties-data-items-properties-goals-items-properties-progress-properties-to_date : example: 34 type: number x-do-not-generate: true konfig-generated-schema-components-schemas-PerformanceGetQuarterlyIndividualGoalsResponse: example: data: - name: John Doe progress: actual: 10 to_date: 34 goals: - title: Optimize data storage progress: actual: 10 to_date: 34 properties: data: items: properties: name: example: John Doe type: string progress: properties: actual: example: 10 type: number to_date: example: 34 type: number type: object goals: items: properties: title: example: Optimize data storage type: string progress: properties: actual: example: 10 type: number to_date: example: 34 type: number type: object type: object type: array type: object type: array type: object x-do-not-generate: true konfig-generated-schema-components-schemas-PerformanceGetQuarterlyIndividualGoalsResponse-properties-data-items-properties-name: example: John Doe type: string x-do-not-generate: true ? konfig-generated-schema-components-schemas-PerformanceGetQuarterlyIndividualGoalsResponse-properties-data-items-properties-progress-properties-actual : example: 10 type: number x-do-not-generate: true ? konfig-generated-schema-components-schemas-PerformanceGetQuarterlyIndividualGoalsResponse-properties-data-items-properties-progress-properties-to_date : example: 34 type: number x-do-not-generate: true ? konfig-generated-schema-components-schemas-PerformanceGetQuarterlyIndividualGoalsResponse-properties-data-items-properties-goals-items-properties-title : example: Optimize data storage type: string x-do-not-generate: true ? konfig-generated-schema-components-schemas-PerformanceGetQuarterlyIndividualGoalsResponse-properties-data-items-properties-goals-items-properties-progress-properties-actual : example: 10 type: number x-do-not-generate: true ? konfig-generated-schema-components-schemas-PerformanceGetQuarterlyIndividualGoalsResponse-properties-data-items-properties-goals-items-properties-progress-properties-to_date : example: 34 type: number x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeGetCompensationsResponse: example: data: - start_date: 2017-01-01 end_date: 2019-01-01 currency: EUR amount: 1234 period: monthly comment: Starting salary category: Salary meta: current_page: 1 next_page: 2 previous_page: null total_pages: 2 per_page: 50 total_entries: 75 properties: data: items: properties: start_date: example: 2017-01-01 type: string end_date: example: 2019-01-01 type: string currency: example: EUR type: string amount: example: 1234 type: number period: example: monthly type: string comment: example: Starting salary type: string category: example: Salary type: string type: object type: array meta: properties: current_page: example: 1 type: number next_page: example: 2 type: number previous_page: nullable: true type: string x-konfig-null-placeholder: true total_pages: example: 2 type: number per_page: example: 50 type: number total_entries: example: 75 type: number type: object type: object x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeGetCompensationsResponse-properties-data-items-properties-start_date: example: 2017-01-01 type: string x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeGetCompensationsResponse-properties-data-items-properties-end_date: example: 2019-01-01 type: string x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeGetCompensationsResponse-properties-data-items-properties-currency: example: EUR type: string x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeGetCompensationsResponse-properties-data-items-properties-amount: example: 1234 type: number x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeGetCompensationsResponse-properties-data-items-properties-period: example: monthly type: string x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeGetCompensationsResponse-properties-data-items-properties-comment: example: Starting salary type: string x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeGetCompensationsResponse-properties-data-items-properties-category: example: Salary type: string x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeGetCompensationsResponse-properties-meta-properties-current_page: example: 1 type: number x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeGetCompensationsResponse-properties-meta-properties-next_page: example: 2 type: number x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeGetCompensationsResponse-properties-meta-properties-previous_page: nullable: true type: string x-konfig-null-placeholder: true x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeGetCompensationsResponse-properties-meta-properties-total_pages: example: 2 type: number x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeGetCompensationsResponse-properties-meta-properties-per_page: example: 50 type: number x-do-not-generate: true konfig-generated-schema-components-schemas-EmployeeGetCompensationsResponse-properties-meta-properties-total_entries: example: 75 type: number x-do-not-generate: true konfig-generated-schema-components-schemas-RecruitmentListPositionsResponse: example: data: - title: CEO id: 2902504 status: published visibility: Published created_at: 2019-09-01 internal_date: 2019-10-01 completed_at: null link: https://talent.sage.hr/jobs/xxx team: Management applicants_required: 1 applicants_count: 3 employment_type: Full-time location: London location_id: 9182712 group: Hiring Group group_id: 871621 priority: 1 description_blocks: - title: Requirements content: Html content goes here - title: CFO id: 212 status: completed visibility: Completed created_at: 2019-09-01 internal_date: 2019-10-21 completed_at: 2019-10-12 link: null team: "" applicants_required: 2 applicants_count: 4 employment_type: null location: null location_id: null group: Hiring Group group_id: 871621 priority: 9800 description_blocks: - title: Description content:This is a CFO position.
- title: Requirements content:Be a CFO
- title: Benefits content:iPhone 12
meta: current_page: 1 next_page: 2 previous_page: null total_pages: 2 per_page: 20 total_entries: 34 properties: data: items: properties: title: example: CEO type: string id: example: 2902504 type: number status: example: published type: string visibility: example: Published type: string created_at: example: 2019-09-01 type: string internal_date: example: 2019-10-01 type: string completed_at: example: 2019-10-12 nullable: true type: string link: example: https://talent.sage.hr/jobs/xxx nullable: true type: string team: example: Management type: string applicants_required: example: 1 type: number applicants_count: example: 3 type: number employment_type: example: Full-time nullable: true type: string location: example: London nullable: true type: string location_id: example: 9182712 nullable: true type: number group: example: Hiring Group type: string group_id: example: 871621 type: number priority: example: 1 type: number description_blocks: items: properties: title: example: Requirements type: string content: example: Html content goes here type: string type: object type: array type: object type: array meta: properties: current_page: example: 1 type: number next_page: example: 2 type: number previous_page: nullable: true type: string x-konfig-null-placeholder: true total_pages: example: 2 type: number per_page: example: 20 type: number total_entries: example: 34 type: number type: object type: object x-do-not-generate: true konfig-generated-schema-components-schemas-RecruitmentListPositionsResponse-properties-data-items-properties-title: example: CEO type: string x-do-not-generate: true konfig-generated-schema-components-schemas-RecruitmentListPositionsResponse-properties-data-items-properties-id: example: 2902504 type: number x-do-not-generate: true konfig-generated-schema-components-schemas-RecruitmentListPositionsResponse-properties-data-items-properties-status: example: published type: string x-do-not-generate: true konfig-generated-schema-components-schemas-RecruitmentListPositionsResponse-properties-data-items-properties-visibility: example: Published type: string x-do-not-generate: true konfig-generated-schema-components-schemas-RecruitmentListPositionsResponse-properties-data-items-properties-created_at: example: 2019-09-01 type: string x-do-not-generate: true konfig-generated-schema-components-schemas-RecruitmentListPositionsResponse-properties-data-items-properties-internal_date: example: 2019-10-01 type: string x-do-not-generate: true konfig-generated-schema-components-schemas-RecruitmentListPositionsResponse-properties-data-items-properties-completed_at: example: 2019-10-12 type: string x-do-not-generate: true konfig-generated-schema-components-schemas-RecruitmentListPositionsResponse-properties-data-items-properties-link: example: https://talent.sage.hr/jobs/xxx type: string x-do-not-generate: true konfig-generated-schema-components-schemas-RecruitmentListPositionsResponse-properties-data-items-properties-team: example: Management type: string x-do-not-generate: true ? konfig-generated-schema-components-schemas-RecruitmentListPositionsResponse-properties-data-items-properties-applicants_required : example: 1 type: number x-do-not-generate: true konfig-generated-schema-components-schemas-RecruitmentListPositionsResponse-properties-data-items-properties-applicants_count: example: 3 type: number x-do-not-generate: true konfig-generated-schema-components-schemas-RecruitmentListPositionsResponse-properties-data-items-properties-employment_type: example: Full-time type: string x-do-not-generate: true konfig-generated-schema-components-schemas-RecruitmentListPositionsResponse-properties-data-items-properties-location: example: London type: string x-do-not-generate: true konfig-generated-schema-components-schemas-RecruitmentListPositionsResponse-properties-data-items-properties-location_id: example: 9182712 type: number x-do-not-generate: true konfig-generated-schema-components-schemas-RecruitmentListPositionsResponse-properties-data-items-properties-group: example: Hiring Group type: string x-do-not-generate: true konfig-generated-schema-components-schemas-RecruitmentListPositionsResponse-properties-data-items-properties-group_id: example: 871621 type: number x-do-not-generate: true konfig-generated-schema-components-schemas-RecruitmentListPositionsResponse-properties-data-items-properties-priority: example: 1 type: number x-do-not-generate: true ? konfig-generated-schema-components-schemas-RecruitmentListPositionsResponse-properties-data-items-properties-description_blocks-items-properties-title : example: Requirements type: string x-do-not-generate: true ? konfig-generated-schema-components-schemas-RecruitmentListPositionsResponse-properties-data-items-properties-description_blocks-items-properties-content : example: Html content goes here type: string x-do-not-generate: true konfig-generated-schema-components-schemas-RecruitmentListPositionsResponse-properties-meta-properties-current_page: example: 1 type: number x-do-not-generate: true konfig-generated-schema-components-schemas-RecruitmentListPositionsResponse-properties-meta-properties-next_page: example: 2 type: number x-do-not-generate: true konfig-generated-schema-components-schemas-RecruitmentListPositionsResponse-properties-meta-properties-previous_page: nullable: true type: string x-konfig-null-placeholder: true x-do-not-generate: true konfig-generated-schema-components-schemas-RecruitmentListPositionsResponse-properties-meta-properties-total_pages: example: 2 type: number x-do-not-generate: true konfig-generated-schema-components-schemas-RecruitmentListPositionsResponse-properties-meta-properties-per_page: example: 20 type: number x-do-not-generate: true konfig-generated-schema-components-schemas-RecruitmentListPositionsResponse-properties-meta-properties-total_entries: example: 34 type: number x-do-not-generate: true konfig-generated-schema-components-schemas-RecruitmentGetPositionDetailsResponse: example: data: title: CTO id: 1 status: completed visibility: Completed created_at: 2020-10-15 internal_date: 2020-10-31 completed_at: 2020-10-28 link: null team: "" applicants_required: 1 applicants_count: 2 employment_type: Full-time location: New York location_id: 4 group: Hiring Group group_id: 1 priority: 1 description_blocks: - title: Description content:This is what we required.
- title: Benefits content:Here are some benefits.
- title: More Details content:A custom block.
applicants: - id: 1 full_name: Jon Vondrak email: jon.vondrak@example.com - id: 2 full_name: Samantha Cross email: sam.cross@example.com hiring_team: - id: 12 full_name: Manel Lopez-Bru role: hiring_manager - id: 1 full_name: Pau Capdevilla role: interviewer properties: data: properties: title: example: CTO type: string id: example: 1 type: number status: example: completed type: string visibility: example: Completed type: string created_at: example: 2020-10-15 type: string internal_date: example: 2020-10-31 type: string completed_at: example: 2020-10-28 type: string link: nullable: true type: string x-konfig-null-placeholder: true team: example: "" type: string applicants_required: example: 1 type: number applicants_count: example: 2 type: number employment_type: example: Full-time type: string location: example: New York type: string location_id: example: 4 type: number group: example: Hiring Group type: string group_id: example: 1 type: number priority: example: 1 type: number description_blocks: items: properties: title: example: Description type: string content: example: