Endpoints — subpackage_eorOffboarding

naftiko: 1.0.0-alpha2
info:
  label: Endpoints — subpackage_eorOffboarding
  description: 'Endpoints — subpackage_eorOffboarding. 8 operations. Lead operation: Retrieve Offboarding Request. Self-contained
    Naftiko capability covering one Deel business surface.'
  tags:
  - Deel
  - subpackage_eorOffboarding
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    DEEL_API_KEY: DEEL_API_KEY
capability:
  consumes:
  - type: http
    namespace: platform-endpoints-subpackage-eoroffboarding
    baseUri: https://api.letsdeel.com/rest/v2
    description: Endpoints — subpackage_eorOffboarding business capability. Self-contained, no shared references.
    resources:
    - name: eor-contracts-contract_id-offboarding
      path: /eor/contracts/{contract_id}/offboarding
      operations:
      - name: getcontractoffboarding
        method: GET
        description: Retrieve Offboarding Request
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: contract_id
          in: path
          type: string
          description: The unique identifier of the employee contract.
          required: true
        - name: Authorization
          in: header
          type: string
          description: '## Authentication'
          required: true
    - name: eor-contracts-contract_id-offboarding-attachments-attachment_id
      path: /eor/contracts/{contract_id}/offboarding/attachments/{attachment_id}
      operations:
      - name: getcontractoffboardingattachmentbyid
        method: GET
        description: Retrieve offboarding attachment
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: contract_id
          in: path
          type: string
          description: The unique identifier of the employee contract.
          required: true
        - name: attachment_id
          in: path
          type: string
          description: The unique identifier of the attachment to download.
          required: true
        - name: Authorization
          in: header
          type: string
          description: '## Authentication'
          required: true
    - name: eor-contracts-contract_id-offboarding-required-information
      path: /eor/contracts/{contract_id}/offboarding/required-information
      operations:
      - name: geteorcontractoffboardingrequiredinformation
        method: GET
        description: Get additional information required to request employee termination
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: contract_id
          in: path
          type: string
          description: The unique identifier of the employee contract.
          required: true
        - name: Authorization
          in: header
          type: string
          description: '## Authentication'
          required: true
    - name: eor-contracts-contract_id-offboarding-resignations-review-pto
      path: /eor/contracts/{contract_id}/offboarding/resignations/review-pto
      operations:
      - name: revieweoroffboardingpto
        method: POST
        description: Submit employee resignation PTO review
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: contract_id
          in: path
          type: string
          description: The unique identifier of the employee contract.
          required: true
        - name: Authorization
          in: header
          type: string
          description: '## Authentication'
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: eor-contracts-contract_id-offboarding-restricted-dates
      path: /eor/contracts/{contract_id}/offboarding/restricted-dates
      operations:
      - name: getcontractoffboardingrestricteddates
        method: GET
        description: Retrieve restricted offboarding dates
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: contract_id
          in: path
          type: string
          description: The unique identifier of the employee contract.
          required: true
        - name: termination_type
          in: query
          type: string
          description: Type of offboarding.
        - name: Authorization
          in: header
          type: string
          description: '## Authentication'
          required: true
    - name: eor-contracts-contract_id-offboarding-review-client-sign-offs
      path: /eor/contracts/{contract_id}/offboarding/review-client-sign-offs
      operations:
      - name: createeoroffboardingclientsignoff
        method: POST
        description: Create client sign off
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: contract_id
          in: path
          type: string
          description: The unique identifier of the employee contract.
          required: true
        - name: Authorization
          in: header
          type: string
          description: '## Authentication'
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: eor-contracts-contract_id-offboarding-review-employee-sign-offs
      path: /eor/contracts/{contract_id}/offboarding/review-employee-sign-offs
      operations:
      - name: revieweoroffboardingemployeesignoffs
        method: POST
        description: Submit employee sign-off review for offboarding documents
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: contract_id
          in: path
          type: string
          description: The unique identifier of the employee contract.
          required: true
        - name: Authorization
          in: header
          type: string
          description: '## Authentication'
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: eor-contracts-contract_id-offboarding-time-offs
      path: /eor/contracts/{contract_id}/offboarding/time-offs
      operations:
      - name: getcontractoffboardingtimeoffs
        method: GET
        description: Retrieve Employee Time Off Data for Offboarding
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: contract_id
          in: path
          type: string
          description: The unique identifier of the employee contract.
          required: true
        - name: end_date
          in: query
          type: string
          description: Desired end date for offboarding
        - name: Authorization
          in: header
          type: string
          description: '## Authentication'
          required: true
    authentication:
      type: bearer
      token: '{{env.DEEL_API_KEY}}'
  exposes:
  - type: rest
    namespace: platform-endpoints-subpackage-eoroffboarding-rest
    port: 8080
    description: REST adapter for Endpoints — subpackage_eorOffboarding. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/eor/contracts/{contract-id}/offboarding
      name: eor-contracts-contract-id-offboarding
      description: REST surface for eor-contracts-contract_id-offboarding.
      operations:
      - method: GET
        name: getcontractoffboarding
        description: Retrieve Offboarding Request
        call: platform-endpoints-subpackage-eoroffboarding.getcontractoffboarding
        with:
          contract_id: rest.contract_id
          Authorization: rest.Authorization
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/eor/contracts/{contract-id}/offboarding/attachments/{attachment-id}
      name: eor-contracts-contract-id-offboarding-attachments-attachment-id
      description: REST surface for eor-contracts-contract_id-offboarding-attachments-attachment_id.
      operations:
      - method: GET
        name: getcontractoffboardingattachmentbyid
        description: Retrieve offboarding attachment
        call: platform-endpoints-subpackage-eoroffboarding.getcontractoffboardingattachmentbyid
        with:
          contract_id: rest.contract_id
          attachment_id: rest.attachment_id
          Authorization: rest.Authorization
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/eor/contracts/{contract-id}/offboarding/required-information
      name: eor-contracts-contract-id-offboarding-required-information
      description: REST surface for eor-contracts-contract_id-offboarding-required-information.
      operations:
      - method: GET
        name: geteorcontractoffboardingrequiredinformation
        description: Get additional information required to request employee termination
        call: platform-endpoints-subpackage-eoroffboarding.geteorcontractoffboardingrequiredinformation
        with:
          contract_id: rest.contract_id
          Authorization: rest.Authorization
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/eor/contracts/{contract-id}/offboarding/resignations/review-pto
      name: eor-contracts-contract-id-offboarding-resignations-review-pto
      description: REST surface for eor-contracts-contract_id-offboarding-resignations-review-pto.
      operations:
      - method: POST
        name: revieweoroffboardingpto
        description: Submit employee resignation PTO review
        call: platform-endpoints-subpackage-eoroffboarding.revieweoroffboardingpto
        with:
          contract_id: rest.contract_id
          Authorization: rest.Authorization
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/eor/contracts/{contract-id}/offboarding/restricted-dates
      name: eor-contracts-contract-id-offboarding-restricted-dates
      description: REST surface for eor-contracts-contract_id-offboarding-restricted-dates.
      operations:
      - method: GET
        name: getcontractoffboardingrestricteddates
        description: Retrieve restricted offboarding dates
        call: platform-endpoints-subpackage-eoroffboarding.getcontractoffboardingrestricteddates
        with:
          contract_id: rest.contract_id
          termination_type: rest.termination_type
          Authorization: rest.Authorization
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/eor/contracts/{contract-id}/offboarding/review-client-sign-offs
      name: eor-contracts-contract-id-offboarding-review-client-sign-offs
      description: REST surface for eor-contracts-contract_id-offboarding-review-client-sign-offs.
      operations:
      - method: POST
        name: createeoroffboardingclientsignoff
        description: Create client sign off
        call: platform-endpoints-subpackage-eoroffboarding.createeoroffboardingclientsignoff
        with:
          contract_id: rest.contract_id
          Authorization: rest.Authorization
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/eor/contracts/{contract-id}/offboarding/review-employee-sign-offs
      name: eor-contracts-contract-id-offboarding-review-employee-sign-offs
      description: REST surface for eor-contracts-contract_id-offboarding-review-employee-sign-offs.
      operations:
      - method: POST
        name: revieweoroffboardingemployeesignoffs
        description: Submit employee sign-off review for offboarding documents
        call: platform-endpoints-subpackage-eoroffboarding.revieweoroffboardingemployeesignoffs
        with:
          contract_id: rest.contract_id
          Authorization: rest.Authorization
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/eor/contracts/{contract-id}/offboarding/time-offs
      name: eor-contracts-contract-id-offboarding-time-offs
      description: REST surface for eor-contracts-contract_id-offboarding-time-offs.
      operations:
      - method: GET
        name: getcontractoffboardingtimeoffs
        description: Retrieve Employee Time Off Data for Offboarding
        call: platform-endpoints-subpackage-eoroffboarding.getcontractoffboardingtimeoffs
        with:
          contract_id: rest.contract_id
          end_date: rest.end_date
          Authorization: rest.Authorization
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: platform-endpoints-subpackage-eoroffboarding-mcp
    port: 9090
    transport: http
    description: MCP adapter for Endpoints — subpackage_eorOffboarding. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: retrieve-offboarding-request
      description: Retrieve Offboarding Request
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: platform-endpoints-subpackage-eoroffboarding.getcontractoffboarding
      with:
        contract_id: tools.contract_id
        Authorization: tools.Authorization
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-offboarding-attachment
      description: Retrieve offboarding attachment
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: platform-endpoints-subpackage-eoroffboarding.getcontractoffboardingattachmentbyid
      with:
        contract_id: tools.contract_id
        attachment_id: tools.attachment_id
        Authorization: tools.Authorization
      outputParameters:
      - type: object
        mapping: $.
    - name: get-additional-information-required-request
      description: Get additional information required to request employee termination
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: platform-endpoints-subpackage-eoroffboarding.geteorcontractoffboardingrequiredinformation
      with:
        contract_id: tools.contract_id
        Authorization: tools.Authorization
      outputParameters:
      - type: object
        mapping: $.
    - name: submit-employee-resignation-pto-review
      description: Submit employee resignation PTO review
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: platform-endpoints-subpackage-eoroffboarding.revieweoroffboardingpto
      with:
        contract_id: tools.contract_id
        Authorization: tools.Authorization
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-restricted-offboarding-dates
      description: Retrieve restricted offboarding dates
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: platform-endpoints-subpackage-eoroffboarding.getcontractoffboardingrestricteddates
      with:
        contract_id: tools.contract_id
        termination_type: tools.termination_type
        Authorization: tools.Authorization
      outputParameters:
      - type: object
        mapping: $.
    - name: create-client-sign-off
      description: Create client sign off
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: platform-endpoints-subpackage-eoroffboarding.createeoroffboardingclientsignoff
      with:
        contract_id: tools.contract_id
        Authorization: tools.Authorization
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: submit-employee-sign-off-review
      description: Submit employee sign-off review for offboarding documents
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: platform-endpoints-subpackage-eoroffboarding.revieweoroffboardingemployeesignoffs
      with:
        contract_id: tools.contract_id
        Authorization: tools.Authorization
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-employee-time-off-data
      description: Retrieve Employee Time Off Data for Offboarding
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: platform-endpoints-subpackage-eoroffboarding.getcontractoffboardingtimeoffs
      with:
        contract_id: tools.contract_id
        end_date: tools.end_date
        Authorization: tools.Authorization
      outputParameters:
      - type: object
        mapping: $.