Endpoints — subpackage_offCycle

naftiko: 1.0.0-alpha2
info:
  label: Endpoints — subpackage_offCycle
  description: 'Endpoints — subpackage_offCycle. 3 operations. Lead operation: Add off-cycle payment. Self-contained Naftiko
    capability covering one Deel business surface.'
  tags:
  - Deel
  - subpackage_offCycle
  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-offcycle
    baseUri: https://api.letsdeel.com/rest/v2
    description: Endpoints — subpackage_offCycle business capability. Self-contained, no shared references.
    resources:
    - name: contracts-contract_id-off-cycle-payments
      path: /contracts/{contract_id}/off-cycle-payments
      operations:
      - name: createcontractoffcyclepayment
        method: POST
        description: Add off-cycle payment
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: contract_id
          in: path
          type: string
          description: The unique identifier (ID) of the Deel contract for which the off-cycle payment is being created.
          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: getcontractoffcyclepayments
        method: GET
        description: List of off-cycle payments
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: contract_id
          in: path
          type: string
          description: The unique identifier (ID) of the Deel contract for which to retrieve off-cycle payments.
          required: true
        - name: Authorization
          in: header
          type: string
          description: '## Authentication'
          required: true
    - name: contracts-contract_id-off-cycle-payments-id
      path: /contracts/{contract_id}/off-cycle-payments/{id}
      operations:
      - name: getcontractoffcyclepaymentbyid
        method: GET
        description: Retrieve a single off-cycle payment
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: contract_id
          in: path
          type: string
          description: Deel contract id.
          required: true
        - name: id
          in: path
          type: string
          description: Deel off-cycle payment id.
          required: true
        - 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-offcycle-rest
    port: 8080
    description: REST adapter for Endpoints — subpackage_offCycle. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/contracts/{contract-id}/off-cycle-payments
      name: contracts-contract-id-off-cycle-payments
      description: REST surface for contracts-contract_id-off-cycle-payments.
      operations:
      - method: POST
        name: createcontractoffcyclepayment
        description: Add off-cycle payment
        call: platform-endpoints-subpackage-offcycle.createcontractoffcyclepayment
        with:
          contract_id: rest.contract_id
          Authorization: rest.Authorization
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: getcontractoffcyclepayments
        description: List of off-cycle payments
        call: platform-endpoints-subpackage-offcycle.getcontractoffcyclepayments
        with:
          contract_id: rest.contract_id
          Authorization: rest.Authorization
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/contracts/{contract-id}/off-cycle-payments/{id}
      name: contracts-contract-id-off-cycle-payments-id
      description: REST surface for contracts-contract_id-off-cycle-payments-id.
      operations:
      - method: GET
        name: getcontractoffcyclepaymentbyid
        description: Retrieve a single off-cycle payment
        call: platform-endpoints-subpackage-offcycle.getcontractoffcyclepaymentbyid
        with:
          contract_id: rest.contract_id
          id: rest.id
          Authorization: rest.Authorization
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: platform-endpoints-subpackage-offcycle-mcp
    port: 9090
    transport: http
    description: MCP adapter for Endpoints — subpackage_offCycle. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: add-off-cycle-payment
      description: Add off-cycle payment
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: platform-endpoints-subpackage-offcycle.createcontractoffcyclepayment
      with:
        contract_id: tools.contract_id
        Authorization: tools.Authorization
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: list-off-cycle-payments
      description: List of off-cycle payments
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: platform-endpoints-subpackage-offcycle.getcontractoffcyclepayments
      with:
        contract_id: tools.contract_id
        Authorization: tools.Authorization
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-single-off-cycle-payment
      description: Retrieve a single off-cycle payment
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: platform-endpoints-subpackage-offcycle.getcontractoffcyclepaymentbyid
      with:
        contract_id: tools.contract_id
        id: tools.id
        Authorization: tools.Authorization
      outputParameters:
      - type: object
        mapping: $.