Deel subpackage_eorWorkerOffboarding API

openapi: 3.1.0
info:
  title: Endpoints subpackage_eorWorkerOffboarding API
  version: 1.0.0
servers:
- url: https://api.letsdeel.com/rest/v2
- url: https://api-staging.letsdeel.com/rest/v2
tags:
- name: subpackage_eorWorkerOffboarding
paths:
  /eor/workers/contracts/{contract_id}/offboarding/resignation-letter:
    get:
      operationId: download-employee-resignation-letter
      summary: Preview Resignation Letter
      description: "This endpoint allows workers to preview a resignation letter for an EOR Contract.\n **Token scopes**: `worker:read`"
      tags:
      - subpackage_eorWorkerOffboarding
      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:
        '200':
          description: File download successful
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PreviewResignationLetterRequestBadRequestError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PreviewResignationLetterRequestUnauthorizedError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PreviewResignationLetterRequestForbiddenError'
        '404':
          description: Operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorContainer'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PreviewResignationLetterRequestInternalServerError'
  /eor/contracts/{contract_id}/offboarding/resignation:
    post:
      operationId: create-employee-resignation
      summary: Request contract resignation
      description: "Enable clients to initiate a resignation request for an Employee of Record (EOR) contract within their team\n **Token scopes**: `contracts:write`"
      tags:
      - subpackage_eorWorkerOffboarding
      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: Resignation request submitted successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/eor-worker-offboarding_createEmployeeResignation_Response_201'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequestContractResignationRequestBadRequestError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequestContractResignationRequestUnauthorizedError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequestContractResignationRequestForbiddenError'
        '404':
          description: Operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorContainer'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequestContractResignationRequestInternalServerError'
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                data:
                  $ref: '#/components/schemas/EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaData'
              required:
              - data
  /eor/workers/resignations:
    get:
      operationId: get-employee-resignations
      summary: Retrieve worker resignations
      description: "Use this endpoint to retrieve resignations submitted by Employer of Record (EOR) workers. Use it when you need to review resignation progress, confirm desired and confirmed end dates, and access resignation letter details. Filter results by resignation letter status using the query parameter\n **Token scopes**: `worker:read`"
      tags:
      - subpackage_eorWorkerOffboarding
      parameters:
      - name: status
        in: query
        description: Filter by resignation letter status
        required: false
        schema:
          $ref: '#/components/schemas/EorWorkersResignationsGetParametersStatus'
      - 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: Successful operation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/eor-worker-offboarding_getEmployeeResignations_Response_200'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetrieveWorkerResignationsRequestBadRequestError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetrieveWorkerResignationsRequestUnauthorizedError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetrieveWorkerResignationsRequestForbiddenError'
        '404':
          description: Operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorContainer'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetrieveWorkerResignationsRequestInternalServerError'
  /eor/workers/contracts/{contract_id}/offboarding/resignation-letter/sign:
    post:
      operationId: sign-employee-resignation-letter
      summary: Sign Resignation Letter
      description: "This endpoint allows workers to provide their signature for a resignation letter. The signature is required to finalize the resignation process. Upon successful submission, the resignation letter is queued for PDF generation and further processing.\n **Token scopes**: `worker:write`"
      tags:
      - subpackage_eorWorkerOffboarding
      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: Resignation signed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/eor-worker-offboarding_signEmployeeResignationLetter_Response_201'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SignResignationLetterRequestBadRequestError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SignResignationLetterRequestUnauthorizedError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SignResignationLetterRequestForbiddenError'
        '404':
          description: Operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorContainer'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SignResignationLetterRequestInternalServerError'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                data:
                  $ref: '#/components/schemas/EorWorkersContractsContractIdOffboardingResignationLetterSignPostRequestBodyContentApplicationJsonSchemaData'
              required:
              - data
  /eor/workers/contracts/{contract_id}/offboarding:
    post:
      operationId: submit-eor-worker-resignation
      summary: Submit EOR Worker Resignation
      description: "This endpoint allows workers to formally request the resignation of their EOR contract\n **Token scopes**: `worker:write`"
      tags:
      - subpackage_eorWorkerOffboarding
      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-worker-offboarding_submitEORWorkerResignation_Response_201'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubmitEorWorkerResignationRequestBadRequestError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubmitEorWorkerResignationRequestUnauthorizedError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubmitEorWorkerResignationRequestForbiddenError'
        '404':
          description: Operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorContainer'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubmitEorWorkerResignationRequestInternalServerError'
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                data:
                  $ref: '#/components/schemas/EorWorkersContractsContractIdOffboardingPostRequestBodyContentMultipartFormDataSchemaData'
              required:
              - data
components:
  schemas:
    PreviewResignationLetterRequestForbiddenError:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/EorWorkersContractsContractIdOffboardingResignationLetterGetResponsesContentApplicationJsonSchemaErrorsItems'
      title: PreviewResignationLetterRequestForbiddenError
    ? EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsFilesItems
    : type: object
      properties:
        id:
          type: string
          format: cuid
          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
      required:
      - id
      - name
      - type
      - created_at
      title: EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsFilesItems
    ? EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOffOffPlatformUsedTimeOff
    : type: object
      properties:
        entitlements:
          type: array
          items:
            $ref: '#/components/schemas/EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOffOffPlatformUsedTimeOffEntitlementsItems'
          description: Array of time off entitlements for different tracking periods
        total_scheduled:
          type: number
          format: double
          description: Total amount of time off scheduled until the end date
        entitlement_unit:
          $ref: '#/components/schemas/EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOffOffPlatformUsedTimeOffEntitlementUnit'
          description: Unit of measurement for the time off entitlements
      required:
      - entitlements
      - total_scheduled
      - entitlement_unit
      description: Required when tracking_type is OFF_PLATFORM, null otherwise
      title: EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOffOffPlatformUsedTimeOff
    ? EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsReviewerType
    : type: string
      enum:
      - CLIENT
      - EMPLOYEE
      description: The type of reviewer for this document
      title: EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsReviewerType
    EorWorkersResignationsGetResponsesContentApplicationJsonSchemaDataItems:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: The unique identifier of the resignation
        status:
          $ref: '#/components/schemas/EorWorkersResignationsGetResponsesContentApplicationJsonSchemaDataItemsStatus'
          description: The status of the resignation
        end_date:
          type:
          - string
          - 'null'
          format: date-time
          description: The confirmed end date of the resignation
        created_at:
          type: string
          format: date-time
          description: The date and time the resignation was created
        updated_at:
          type: string
          format: date-time
          description: The date and time the resignation was updated
        contract_id:
          type: string
          description: The unique identifier of the employee contract.
        desired_end_date:
          type:
          - string
          - 'null'
          format: date-time
          description: The desired end date of the resignation
        resignation_letter:
          oneOf:
          - $ref: '#/components/schemas/EorWorkersResignationsGetResponsesContentApplicationJsonSchemaDataItemsResignationLetter'
          - type: 'null'
      required:
      - id
      - status
      - end_date
      - created_at
      - updated_at
      - contract_id
      - desired_end_date
      - resignation_letter
      title: EorWorkersResignationsGetResponsesContentApplicationJsonSchemaDataItems
    ? EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsUnit
    : type: string
      enum:
      - BUSINESS_DAY
      - CALENDAR_DAY
      - HOUR
      description: The unit of measurement for time off tracking
      title: EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsUnit
    ? EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataRequestDataEligibleForRehire
    : 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: EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataRequestDataEligibleForRehire
    EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOff:
      type: object
      properties:
        time_offs:
          type: array
          items:
            $ref: '#/components/schemas/EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItems'
        additional_details:
          oneOf:
          - $ref: '#/components/schemas/EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffAdditionalDetails'
          - 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: EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOff
    ? EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataDocumentsSupportingItems
    : type: object
      properties:
        id:
          type: string
          format: cuid
          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: EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataDocumentsSupportingItems
    RetrieveWorkerResignationsRequestBadRequestError:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/EorWorkersResignationsGetResponsesContentApplicationJsonSchemaErrorsItems'
      title: RetrieveWorkerResignationsRequestBadRequestError
    SubmitEorWorkerResignationRequestUnauthorizedError:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaErrorsItems'
      title: SubmitEorWorkerResignationRequestUnauthorizedError
    eor-worker-offboarding_getEmployeeResignations_Response_200:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/EorWorkersResignationsGetResponsesContentApplicationJsonSchemaDataItems'
      required:
      - data
      title: eor-worker-offboarding_getEmployeeResignations_Response_200
    PreviewResignationLetterRequestInternalServerError:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/EorWorkersContractsContractIdOffboardingResignationLetterGetResponsesContentApplicationJsonSchemaErrorsItems'
      title: PreviewResignationLetterRequestInternalServerError
    ? EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataRequestDataReason
    : type: string
      enum:
      - 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: The reason for the termination
      title: EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataRequestDataReason
    EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataRequestDataReason:
      type: string
      enum:
      - 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: The reason for the termination
      title: EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataRequestDataReason
    ? EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOff
    : type: object
      properties:
        time_offs:
          type: array
          items:
            $ref: '#/components/schemas/EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItems'
        additional_details:
          oneOf:
          - $ref: '#/components/schemas/EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffAdditionalDetails'
          - 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: EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOff
    EorWorkersResignationsGetParametersStatus:
      type: string
      enum:
      - AWAITING_SIGNATURE
      - SIGNED
      title: EorWorkersResignationsGetParametersStatus
    EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsReviewerType:
      type: string
      enum:
      - CLIENT
      - EMPLOYEE
      description: The type of reviewer for this document
      title: EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsReviewerType
    EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataDocumentsSupportingItems:
      type: object
      properties:
        id:
          type: string
          format: cuid
          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: EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataDocumentsSupportingItems
    EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItems:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: The unique identifier of the document set shared with the employee.
        files:
          type: array
          items:
            $ref: '#/components/schemas/EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsFilesItems'
        status:
          $ref: '#/components/schemas/EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsStatus'
          description: The current status of the document review
        created_at:
          type: string
          format: date-time
          description: The date and time the document set was created
        updated_at:
          type: string
          format: date-time
          description: The date and time the document set was updated
        reviewed_at:
          type:
          - string
          - 'null'
          format: date-time
          description: The date and time when the document was reviewed
        reviewed_by:
          type:
          - string
          - 'null'
          description: The name of the reviewer for this document. If the reviewer is not an employee, it will be the name of the client
        reviewer_type:
          $ref: '#/components/schemas/EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsReviewerType'
          description: The type of reviewer for this document
        reviewer_feedback:
          type:
          - string
          - 'null'
          description: Feedback provided by the reviewer
        notification_instructions:
          type:
          - string
          - 'null'
          description: HTML instructions for the reviewer notification
        is_employee_notification_required:
          type: boolean
          description: Indicates if the employee should be notified about this document review
      required:
      - files
      - status
      - reviewer_type
      - is_employee_notification_required
      title: EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItems
    EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataRequestData:
      type: object
      properties:
        reason:
          $ref: '#/components/schemas/EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataRequestDataReason'
          description: The reason for the termination
        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
        used_time_off:
          $ref: '#/components/schemas/EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOff'
          description: Time-off usage data including policy information and tracking periods
        desired_end_date:
          type:
          - string
          - 'null'
          format: date
          description: The desired end date. If the date is not provided, it will be selected by HRX the closest date possible
        eligible_for_rehire:
          oneOf:
          - $ref: '#/components/schemas/EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataRequestDataEligibleForRehire'
          - type: 'null'
          description: Parameter to inform whether it would be possible for the client to hire the employee again
        eligible_for_rehire_reason:
          type:
          - string
          - 'null'
          description: Describe if the option DONT_KNOW was selected on eligible_for_rehire
      title: EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataRequestData
    RetrieveWorkerResignationsRequestInternalServerError:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/EorWorkersResignationsGetResponsesContentApplicationJsonSchemaErrorsItems'
      title: RetrieveWorkerResignationsRequestInternalServerError
    EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaDataReason:
      type: string
      enum:
      - EMPLOYEE_IS_MOVING_TO_ANO

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