Deel subpackage_eorTerminations API

openapi: 3.2.0
info:
  title: Endpoints Subpackage Eor Terminations API
  version: 1.0.0
servers:
- url: https://api.letsdeel.com/rest/v2
- url: https://api-staging.letsdeel.com/rest/v2
tags:
- name: subpackage_eorTerminations
paths:
  /eor/{oid}/terminations/{terminationId}:
    get:
      operationId: get-termination
      summary: Get termination
      description: "This API allows clients and employees with viewer permissions to retrieve termination data. It ensures that only authorized users can access sensitive information related to terminations.\n **Token scopes**: `contracts:read`"
      tags:
      - subpackage_eorTerminations
      parameters:
      - name: oid
        in: path
        description: Public contract oid
        required: true
        schema:
          type: string
      - name: terminationId
        in: path
        description: Termination id
        required: true
        schema:
          type: string
      - name: Authorization
        in: header
        description: "## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n"
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Ok response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/eor-terminations_getTermination_Response_200'
        '400':
          description: Operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorContainer'
        '401':
          description: Unauthorized response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/EorOidTerminationsTerminationIdGetResponsesContentApplicationJsonSchemaItems'
        '403':
          description: Forbidden response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/EorOidTerminationsTerminationIdGetResponsesContentApplicationJsonSchemaItems'
        '404':
          description: Not Found response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/EorOidTerminationsTerminationIdGetResponsesContentApplicationJsonSchemaItems'
        '500':
          description: Operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorContainer'
  /eor/contracts/{contract_id}/offboarding/termination:
    post:
      operationId: create-offboarding-termination
      summary: Initiate EOR contract termination request
      description: "Enables clients to initiate a request for the termination of an Employee of Record (EOR) contract for members of their team.\n **Token scopes**: `contracts:write`"
      tags:
      - subpackage_eorTerminations
      parameters:
      - name: contract_id
        in: path
        description: The unique identifier of the employee contract.
        required: true
        schema:
          type: string
      - name: Authorization
        in: header
        description: "## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n"
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Ok response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/eor-terminations_createOffboardingTermination_Response_201'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InitiateEorContractTerminationRequestRequestBadRequestError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InitiateEorContractTerminationRequestRequestUnauthorizedError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InitiateEorContractTerminationRequestRequestForbiddenError'
        '404':
          description: Operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorContainer'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InitiateEorContractTerminationRequestRequestInternalServerError'
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                data:
                  $ref: '#/components/schemas/EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaData'
              required:
              - data
  /eor/{oid}/terminations/resignation:
    post:
      operationId: create-resignation
      summary: Request EOR Contract Resignation
      description: "Enable clients with group admin and people manager permissions to initiate a resignation request for an Employee of Record (EOR) contract within their team.\n **Token scopes**: `contracts:read`, `contracts:write`"
      tags:
      - subpackage_eorTerminations
      parameters:
      - name: oid
        in: path
        description: Public contract oid
        required: true
        schema:
          type: string
      - name: Authorization
        in: header
        description: "## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n"
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Ok response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/eor-terminations_createResignation_Response_200'
        '400':
          description: Operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorContainer'
        '401':
          description: Unauthorized response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/EorOidTerminationsResignationPostResponsesContentApplicationJsonSchemaItems'
        '403':
          description: Forbidden response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/EorOidTerminationsResignationPostResponsesContentApplicationJsonSchemaItems'
        '404':
          description: Not Found response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/EorOidTerminationsResignationPostResponsesContentApplicationJsonSchemaItems'
        '500':
          description: Operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorContainer'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                data:
                  $ref: '#/components/schemas/EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaData'
              required:
              - data
  /eor/{oid}/terminations/regular:
    post:
      operationId: create-regular-termination
      summary: Termination Request
      description: "This API enables clients with group admin and people manager permissions to initiate a request for the termination of an Employee of Record (EOR) contract for members of their team.\n **Token scopes**: `contracts:read`, `contracts:write`"
      tags:
      - subpackage_eorTerminations
      parameters:
      - name: oid
        in: path
        description: Public contract id
        required: true
        schema:
          type: string
      - name: Authorization
        in: header
        description: "## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n"
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Ok response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/eor-terminations_createRegularTermination_Response_200'
        '400':
          description: Operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorContainer'
        '401':
          description: Unauthorized response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/EorOidTerminationsRegularPostResponsesContentApplicationJsonSchemaItems'
        '403':
          description: Forbidden response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/EorOidTerminationsRegularPostResponsesContentApplicationJsonSchemaItems'
        '404':
          description: Not Found response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/EorOidTerminationsRegularPostResponsesContentApplicationJsonSchemaItems'
        '500':
          description: Operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorContainer'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                data:
                  $ref: '#/components/schemas/EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaData'
              required:
              - data
components:
  schemas:
    EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataUsedTimeOffTimeOffsItems:
      type: object
      properties:
        unit:
          $ref: '#/components/schemas/EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataUsedTimeOffTimeOffsItemsUnit'
          description: Time off unit
        policy_type:
          $ref: '#/components/schemas/EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataUsedTimeOffTimeOffsItemsPolicyType'
          description: Time off policy type
        tracking_periods:
          type: array
          items:
            $ref: '#/components/schemas/EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems'
        scheduled_until_end_date:
          type: number
          format: double
          description: Time off escheduled until contract end date
      required:
      - unit
      title: EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataUsedTimeOffTimeOffsItems
    InitiateEorContractTerminationRequestRequestForbiddenError:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaErrorsItems'
      title: InitiateEorContractTerminationRequestRequestForbiddenError
    EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataDocumentsSupportingItems:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier of the file
        name:
          type: string
          description: The name of the file
        type:
          type: string
          description: The type/extension of the file
        created_at:
          type: string
          format: date-time
          description: The date and time the file was created
        updated_at:
          type: string
          format: date-time
          description: The date and time the file was updated
        is_additional_supporting_document:
          type: boolean
          description: Indicates if this is an additional supporting document added after the initial submission
      required:
      - id
      - name
      - type
      - created_at
      - updated_at
      - is_additional_supporting_document
      title: EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataDocumentsSupportingItems
    EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOffTimeOffsItemsUnit:
      type: string
      enum:
      - BUSINESS_DAY
      - CALENDAR_DAY
      - HOUR
      - WEEK
      - MONTH
      - YEAR
      description: Time off unit
      title: EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOffTimeOffsItemsUnit
    EorOidTerminationsTerminationIdGetResponsesContentApplicationJsonSchemaRequestDataEligibleForRehire:
      type: string
      enum:
      - 'YES'
      - 'NO'
      - DONT_KNOW
      description: Parameter to inform whether it would be possible for the client to hire the employee again
      title: EorOidTerminationsTerminationIdGetResponsesContentApplicationJsonSchemaRequestDataEligibleForRehire
    EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataUsedTimeOffTimeOffsItemsUnit:
      type: string
      enum:
      - BUSINESS_DAY
      - CALENDAR_DAY
      - HOUR
      - WEEK
      - MONTH
      - YEAR
      description: Time off unit
      title: EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataUsedTimeOffTimeOffsItemsUnit
    ? EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOffOffPlatformUsedTimeOffEntitlementUnit
    : type: string
      enum:
      - BUSINESS_DAY
      - CALENDAR_DAY
      - HOUR
      - WEEK
      - MONTH
      - YEAR
      description: Unit of measurement for the time off entitlements
      title: EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOffOffPlatformUsedTimeOffEntitlementUnit
    EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaData:
      type: object
      properties:
        reason:
          $ref: '#/components/schemas/EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataReason'
          description: Reason why the contract is being terminated
        attachments:
          type: string
          format: binary
          description: This field allows for uploading multiple files at once. Attach any document that is important for the request to terminate the contract. Includes common image formats (JPG, JPEG, PNG, HEIC) and PDF documents.
        is_sensitive:
          type: boolean
          description: Defines whether the termination is sensitive. In this case, only the person requesting the termination will be able to view the termination, receive emails or notifications.
        reason_detail:
          type: string
          description: Field to better explain how communication with the employee will be and/or their reaction to the communication, or other necessary information
        used_time_off:
          $ref: '#/components/schemas/EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOff'
        severance_type:
          $ref: '#/components/schemas/EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataSeveranceType'
          description: The type of severance selected by the client. It's an optional field
        desired_end_date:
          type: string
          format: date
          description: The desired end date of the contract. If the date is not provided, Deel HRX team will select the nearest possible date.
        severance_amount:
          type: integer
          description: The amount of severance needed
        additional_reason:
          oneOf:
          - $ref: '#/components/schemas/EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataAdditionalReason'
          - type: 'null'
          description: An additional reason can be provided in case the reason selected is NO_LONGER_WISH_TO_WORK_WITH_DEEL
        termination_notes:
          type: array
          items:
            type: string
          description: Additional notes can be provided regarding the termination for Deel, like questions and doubts
        eligible_for_rehire:
          oneOf:
          - $ref: '#/components/schemas/EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataEligibleForRehire'
          - type: 'null'
          description: Parameter to inform whether it would be possible for the client to hire the employee again
        is_employee_notified:
          type: boolean
          description: Defines if employee was informed by client or not before the termination
        required_information:
          type: array
          items:
            $ref: '#/components/schemas/EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataRequiredInformationItems'
          description: For some countries some data is needed to help to process the termination. The questions comes from another endpoint to get the required information. See GET /eor/:oid/offboarding/required-information to get the questions.
        termination_impact_id:
          type: string
          format: uuid
          description: Termination impact data if there is some configured on HR module
        employee_notification_detail:
          type:
          - string
          - 'null'
          description: If it's an termination contract ending and employee was already informed, should detail the notification to the employee
        additional_supporting_documents:
          type: string
          format: binary
          description: This field allows for uploading multiple files at once. Any proof such as correspondence, documentation of previous warnings or attendance records for the reason select above. Includes common image formats (JPG, JPEG, PNG, HEIC) and PDF documents.
      required:
      - reason
      - reason_detail
      - used_time_off
      - is_employee_notified
      title: EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaData
    ? EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsReviewerType
    : type: string
      enum:
      - CLIENT
      - EMPLOYEE
      description: The type of reviewer for this document
      title: EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsReviewerType
    EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataReason:
      type: string
      enum:
      - DEEL_COLLECTIONS
      - STATUS_CHANGE
      - RELOCATION
      - COMPENSATION
      - RETIREMENT
      - JOB_ABANDONMENT
      - WORK_RELATED
      - PERSONAL
      - OTHER_OPPORTUNITY
      - NON_RENEWAL
      - PROBATION
      - ASSIGNMENT_ENDED
      - POSITION_ELIMINATION
      - FORCE_REDUCTION
      - DEATH
      - FOR_CAUSE
      - PERFORMANCE
      - MEDICAL
      - PERFORMANCE_ISSUES
      - ATTENDANCE_ISSUES
      - REORGANIZATION_DOWNSIZING_BUDGET_OR_REDUCTION_OF_WORKFORCE
      - ROLE_BECAME_REDUNDANT_OR_ROLE_CHANGED
      - OFFER_WAS_REVOKED
      - EXITING_THE_MARKET
      - NO_LONGER_WISH_TO_WORK_WITH_DEEL
      - COMPANY_ACQUIRED
      - STEALING
      - MISCONDUCT
      - FALSIFYING
      - HARASSMENT
      - VIOLENCE
      - REORGANIZATION_DOWNSIZING_BUDGET_OR_REDUCTION_OF_WORKFORCE_OR_ROLE_BECAME_REDUNDANT_OR_ROLE_CHANGED
      - UNAUTHORIZED_ABSENCES_OR_LACK_OF_ATTENDANCE
      - STANDARD_RESELLER_PRACTICE
      - MOVING_EMPLOYEE_TO_INTERNAL_ENTITY
      - MOVING_EMPLOYEE_TO_DEEL_PEO
      - OTHER
      description: Reason why the contract is being terminated
      title: EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataReason
    EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataAdditionalSupportingDocumentsItems:
      type: object
      properties:
        key:
          type: string
        file_name:
          type: string
      required:
      - key
      title: EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataAdditionalSupportingDocumentsItems
    EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOff:
      type: object
      properties:
        time_offs:
          type: array
          items:
            $ref: '#/components/schemas/EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOffTimeOffsItems'
          description: All time-off used by the employee during contract period
        additional_details:
          type:
          - string
          - 'null'
          description: Any additional details regarding time off that HRX should know
        is_deel_pto_confirmed:
          type: boolean
          description: Defines whether the client agrees with the time off values ​​that are registered in Deel. If false, it means that the client changed the values.
      title: EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOff
    EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOff:
      type: object
      properties:
        tracking_type:
          $ref: '#/components/schemas/EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOffTrackingType'
          description: Type of time off tracking - whether it's tracked on Deel platform or off platform
        off_platform_used_time_off:
          oneOf:
          - $ref: '#/components/schemas/EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOffOffPlatformUsedTimeOff'
          - type: 'null'
          description: Required when tracking_type is OFF_PLATFORM, null otherwise
      title: EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOff
    EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataReason:
      type: string
      enum:
      - EMPLOYEE_IS_MOVING_TO_ANOTHER_COUNTRY
      - MOVING_EMPLOYEE_TO_INTERNAL_ENTITY
      - MOVING_EMPLOYEE_TO_DEEL_PEO
      - EMPLOYEE_FOUND_ANOTHER_JOB
      - EMPLOYEE_NOT_HAPPY_WITH_BENEFITS
      - EMPLOYEE_NOT_HAPPY_WITH_SALARY
      - EMPLOYEE_NOT_HAPPY_WITH_THE_ROLE
      - EMPLOYEE_NOT_HAPPY_WITH_COMPANY_CULTURE
      - EMPLOYEE_NOT_HAPPY_WITH_DEEL
      - EMPLOYEE_PROJECT_ENDED
      - EMPLOYEE_SWITCHING_TO_OTHER_EOR_PROVIDER
      - EMPLOYEE_LEFT_ROLE_FOR_PERSONAL_MATTERS
      - EMPLOYEE_MOVING_FROM_EOR_TO_CONTRACTOR_OR_FREELANCE
      - WORKER_TYPE_CHANGE
      - DEEL_COLLECTIONS
      - EMPLOYEE_DID_NOT_TAKE_THE_OFFER
      - EMPLOYEE_PROVIDED_NO_REASON
      - OTHER_BUSINESS_REASONS
      description: Reason why the contract is being terminated
      title: EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataReason
    EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataData:
      type: object
      properties:
        reason:
          $ref: '#/components/schemas/EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataReason'
          description: Reason why the contract is being terminated
        attachments:
          type: array
          items:
            $ref: '#/components/schemas/EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataAttachmentsItems'
          description: Any document that is important for the request to terminate the contract
        is_sensitive:
          type: boolean
          description: Defines whether the termination is sensitive. In this case, only the person requesting the termination will be able to view the termination, receive emails or notifications.
        reason_detail:
          type: string
          description: Optional field to describe the reason behind the resignation request
        used_time_off:
          $ref: '#/components/schemas/EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataUsedTimeOff'
        severance_type:
          $ref: '#/components/schemas/EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataSeveranceType'
          description: The type of severance selected by the client. It's an optional field
        desired_end_date:
          type: string
          description: The desired end date. If the date is not provided, it will be selected by HRX the closest date possible
        severance_amount:
          type: number
          format: double
          description: The amount of severance needed
        additional_reason:
          oneOf:
          - $ref: '#/components/schemas/EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataAdditionalReason'
          - type: 'null'
          description: An additional reason can be provided in case the reason selected is MOVING_EMPLOYEE_TO_INTERNAL_ENTITY
        termination_notes:
          type: array
          items:
            type: string
          description: Additional notes can be provided regarding the termination for Deel, like questions and doubts
        eligible_for_rehire:
          oneOf:
          - $ref: '#/components/schemas/EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataEligibleForRehire'
          - type: 'null'
          description: Parameter to inform whether it would be possible for the client to hire the employee again
        termination_impact_id:
          type: string
          format: uuid
          description: Termination impact data if there is some configured on HR module
        eligible_for_rehire_reason:
          type:
          - string
          - 'null'
          description: Describe if the option DONT_KNOW was selected on eligibleForRehire
        custom_termination_reason_id:
          type:
          - string
          - 'null'
          format: uuid
          description: Custom termination reason ID. A custom termination reason can be added on Client HR module
        is_employee_staying_with_deel:
          type:
          - boolean
          - 'null'
          description: Defines if employee will keep using Deel as provider
      required:
      - reason
      - used_time_off
      - is_employee_staying_with_deel
      title: EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataData
    EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsStatus:
      type: string
      enum:
      - AWAITING_REVIEW
      - AWAITING_FEEDBACK
      - FEEDBACK_PROVIDED
      - APPROVED
      - CHANGES_REQUESTED_BY_CLIENT
      - CHANGES_REQUESTED_BY_EMPLOYEE
      - WAIVED_REVIEW
      - NOT_RESPONDED
      - CANCELLED
      description: The current status of the document review
      title: EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsStatus
    EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOff:
      type: object
      properties:
        time_offs:
          type: array
          items:
            $ref: '#/components/schemas/EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItems'
        additional_details:
          oneOf:
          - $ref: '#/components/schemas/EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffAdditionalDetails'
          - type: 'null'
        is_deel_pto_confirmed:
          type: boolean
          description: Indicates whether the PTO allocation has been confirmed by Deel's system
      required:
      - time_offs
      - is_deel_pto_confirmed
      description: Time-off usage data including policy information and tracking periods
      title: EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOff
    EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataEligibleForRehire:
      type: string
      enum:
      - 'YES'
      - 'NO'
      - DONT_KNOW
      description: Parameter to inform whether it would be possible for the client to hire the employee again
      title: EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataEligibleForRehire
    EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataUsedTimeOff:
      type: object
      properties:
        time_offs:
          type: array
          items:
            $ref: '#/components/schemas/EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataUsedTimeOffTimeOffsItems'
          description: All time-off used by the employee during contract period
        additional_details:
          type:
          - string
          - 'null'
          description: Any additional details regarding time off that HRX should know
        is_deel_pto_confirmed:
          type: boolean
          description: Defines whether the client agrees with the time off values that are registered in Deel. If false, it means that the client changed the values.
      title: EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataUsedTimeOff
    EorOidTerminationsResignationPostResponsesContentApplicationJsonSchemaDataRequestDataEligibleForRehire:
      type: string
      enum:
      - 'YES'
      - 'NO'
      - DONT_KNOW
      description: Parameter to inform whether it would be possible for the client to hire the employee again
      title: EorOidTerminationsResignationPostResponsesContentApplicationJsonSchemaDataRequestDataEligibleForRehire
    EorOidTerminationsRegularPostResponsesContentApplicationJsonSchemaItems:
      type: object
      properties:
        message:
          type: string
      required:
      - message
      title: EorOidTerminationsRegularPostResponsesContentApplicationJsonSchemaItems
    EorOidTerminationsRegularPostResponsesContentApplicationJsonSchemaRequestData:
      type: object
      properties:
        reason:
          type:
          - string
          - 'null'
        end_date:
          type:
          - string
          - 'null'
          format: date-time
          description: The definitive contract end date
        reason_detail:
          type:
          - string
          - 'null'
          description: Optional field to describe the reason behind the resignation request
        desired_end_date:
          ty

# --- truncated at 32 KB (77 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/deel-com/refs/heads/main/openapi/deel-subpackage-eorterminations-api-openapi.yml