openapi.yaml

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