Endpoints — subpackage_workers

naftiko: 1.0.0-alpha2
info:
  label: Endpoints — subpackage_workers
  description: 'Endpoints — subpackage_workers. 5 operations. Lead operation: Get invoice details by ID. Self-contained Naftiko
    capability covering one Deel business surface.'
  tags:
  - Deel
  - subpackage_workers
  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-workers
    baseUri: https://api.letsdeel.com/rest/v2
    description: Endpoints — subpackage_workers business capability. Self-contained, no shared references.
    resources:
    - name: ic-workers-invoices-invoice_id
      path: /ic/workers/invoices/{invoice_id}
      operations:
      - name: getinvoicedetailsbyidv20260427
        method: GET
        description: Get invoice details by ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: invoice_id
          in: path
          type: string
          description: Public invoice id for the invoice to return.
          required: true
        - name: Authorization
          in: header
          type: string
          description: '## Authentication'
          required: true
    - name: ic-workers-invoices-invoice_id-pdf
      path: /ic/workers/invoices/{invoice_id}/pdf
      operations:
      - name: icworkersinvoicesinvoiceidpdfv20260420
        method: GET
        description: /ic/workers/invoices/:invoice_id/pdf
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: invoice_id
          in: path
          type: string
          description: Public invoice identifier (UUID) for the invoice whose PDF URL is returned.
          required: true
        - name: Authorization
          in: header
          type: string
          description: '## Authentication'
          required: true
    - name: ic-workers-transactions
      path: /ic/workers/transactions
      operations:
      - name: retrieveworkertransactionhistoryv20260430
        method: GET
        description: Retrieve worker transaction history
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: limit
          in: query
          type: integer
          description: Maximum number of transactions to return in this page (page size).
        - name: filter
          in: query
          type: string
          description: Subset of transactions by processing state. Public enum is UPPER_SNAKE; the server lowercases for validation
            (legacy lowercase query values are still accepted).
        - name: from
          in: query
          type: string
          description: Lower bound on transaction `created_at` (inclusive), ISO-8601 date-time.
        - name: to
          in: query
          type: string
          description: Upper bound on transaction `created_at` (inclusive), ISO-8601 date-time.
        - name: cursor
          in: query
          type: string
          description: Opaque pagination cursor from the previous response field `next_cursor`. Omit on the first page; pass
            the last `next_cursor` value as `cursor` to fetch the next
        - name: statuses
          in: query
          type: array
          description: Filter listed transactions to these mapped status values (applied after fetch; may affect how rows
            align with `total_count`).
        - name: amount_from
          in: query
          type: number
          description: Minimum transaction amount to include.
        - name: amount_to
          in: query
          type: number
          description: Maximum transaction amount to include.
        - name: currencies
          in: query
          type: array
          description: Only include transactions in one of these currency codes.
        - name: transaction_type
          in: query
          type: string
          description: Restrict to pay-in or pay-out. Public enum is UPPER_SNAKE; the server lowercases for validation (legacy
            lowercase query values are still accepted).
        - name: withdrawal_methods
          in: query
          type: array
          description: Filter by withdrawal / payout method identifiers.
        - name: last_days
          in: query
          type: integer
          description: Only include transactions created in the last N days.
        - name: type
          in: query
          type: string
          description: Additional transaction type filter (backend-specific string).
        - name: include_running_total
          in: query
          type: boolean
          description: When true, each row may include a running total over the result set.
        - name: Authorization
          in: header
          type: string
          description: '## Authentication'
          required: true
    - name: worker
      path: /worker
      operations:
      - name: createworker
        method: POST
        description: Create a new worker
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Authorization
          in: header
          type: string
          description: '## Authentication'
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: workers-compliance-documents
      path: /workers/compliance-documents
      operations:
      - name: listofworkercompliancedocumentsv20260423
        method: GET
        description: List of worker compliance documents
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - 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-workers-rest
    port: 8080
    description: REST adapter for Endpoints — subpackage_workers. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/ic/workers/invoices/{invoice-id}
      name: ic-workers-invoices-invoice-id
      description: REST surface for ic-workers-invoices-invoice_id.
      operations:
      - method: GET
        name: getinvoicedetailsbyidv20260427
        description: Get invoice details by ID
        call: platform-endpoints-subpackage-workers.getinvoicedetailsbyidv20260427
        with:
          invoice_id: rest.invoice_id
          Authorization: rest.Authorization
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/ic/workers/invoices/{invoice-id}/pdf
      name: ic-workers-invoices-invoice-id-pdf
      description: REST surface for ic-workers-invoices-invoice_id-pdf.
      operations:
      - method: GET
        name: icworkersinvoicesinvoiceidpdfv20260420
        description: /ic/workers/invoices/:invoice_id/pdf
        call: platform-endpoints-subpackage-workers.icworkersinvoicesinvoiceidpdfv20260420
        with:
          invoice_id: rest.invoice_id
          Authorization: rest.Authorization
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/ic/workers/transactions
      name: ic-workers-transactions
      description: REST surface for ic-workers-transactions.
      operations:
      - method: GET
        name: retrieveworkertransactionhistoryv20260430
        description: Retrieve worker transaction history
        call: platform-endpoints-subpackage-workers.retrieveworkertransactionhistoryv20260430
        with:
          limit: rest.limit
          filter: rest.filter
          from: rest.from
          to: rest.to
          cursor: rest.cursor
          statuses: rest.statuses
          amount_from: rest.amount_from
          amount_to: rest.amount_to
          currencies: rest.currencies
          transaction_type: rest.transaction_type
          withdrawal_methods: rest.withdrawal_methods
          last_days: rest.last_days
          type: rest.type
          include_running_total: rest.include_running_total
          Authorization: rest.Authorization
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/worker
      name: worker
      description: REST surface for worker.
      operations:
      - method: POST
        name: createworker
        description: Create a new worker
        call: platform-endpoints-subpackage-workers.createworker
        with:
          Authorization: rest.Authorization
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/workers/compliance-documents
      name: workers-compliance-documents
      description: REST surface for workers-compliance-documents.
      operations:
      - method: GET
        name: listofworkercompliancedocumentsv20260423
        description: List of worker compliance documents
        call: platform-endpoints-subpackage-workers.listofworkercompliancedocumentsv20260423
        with:
          Authorization: rest.Authorization
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: platform-endpoints-subpackage-workers-mcp
    port: 9090
    transport: http
    description: MCP adapter for Endpoints — subpackage_workers. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: get-invoice-details-id
      description: Get invoice details by ID
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: platform-endpoints-subpackage-workers.getinvoicedetailsbyidv20260427
      with:
        invoice_id: tools.invoice_id
        Authorization: tools.Authorization
      outputParameters:
      - type: object
        mapping: $.
    - name: ic-workers-invoices-invoice-id
      description: /ic/workers/invoices/:invoice_id/pdf
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: platform-endpoints-subpackage-workers.icworkersinvoicesinvoiceidpdfv20260420
      with:
        invoice_id: tools.invoice_id
        Authorization: tools.Authorization
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-worker-transaction-history
      description: Retrieve worker transaction history
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: platform-endpoints-subpackage-workers.retrieveworkertransactionhistoryv20260430
      with:
        limit: tools.limit
        filter: tools.filter
        from: tools.from
        to: tools.to
        cursor: tools.cursor
        statuses: tools.statuses
        amount_from: tools.amount_from
        amount_to: tools.amount_to
        currencies: tools.currencies
        transaction_type: tools.transaction_type
        withdrawal_methods: tools.withdrawal_methods
        last_days: tools.last_days
        type: tools.type
        include_running_total: tools.include_running_total
        Authorization: tools.Authorization
      outputParameters:
      - type: object
        mapping: $.
    - name: create-new-worker
      description: Create a new worker
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: platform-endpoints-subpackage-workers.createworker
      with:
        Authorization: tools.Authorization
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: list-worker-compliance-documents
      description: List of worker compliance documents
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: platform-endpoints-subpackage-workers.listofworkercompliancedocumentsv20260423
      with:
        Authorization: tools.Authorization
      outputParameters:
      - type: object
        mapping: $.