Endpoints — subpackage_paystubs

naftiko: 1.0.0-alpha2
info:
  label: Endpoints — subpackage_paystubs
  description: 'Endpoints — subpackage_paystubs. 1 operations. Lead operation: Get paystubs from legal entity integrated with
    external benefits vendor. Self-contained Naftiko capability covering one Deel business surface.'
  tags:
  - Deel
  - subpackage_paystubs
  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-paystubs
    baseUri: https://api.letsdeel.com/rest/v2
    description: Endpoints — subpackage_paystubs business capability. Self-contained, no shared references.
    resources:
    - name: benefits-legal-entities-legal_entity_id-paystubs
      path: /benefits/legal-entities/{legal_entity_id}/paystubs
      operations:
      - name: getpaystubsfromlegalentityintegratedwithexternalbenefitsvendorv20260101
        method: GET
        description: Get paystubs from legal entity integrated with external benefits vendor
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: legal_entity_id
          in: path
          type: string
          description: Id from the legal entity to fetch data
          required: true
        - name: states
          in: query
          type: array
          description: 'Payroll states: OPEN | LOCKED | CLOSED (OPEN doesn''t have `employees` info)'
        - name: date_start
          in: query
          type: string
          description: Start date to fectch the paystubs from
        - name: date_end
          in: query
          type: string
          description: End date to fectch the paystubs
        - name: items_per_page
          in: query
          type: integer
          description: Items per page
        - name: cursor
          in: query
          type: string
          description: The last fetched id to start querying from
        - 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-paystubs-rest
    port: 8080
    description: REST adapter for Endpoints — subpackage_paystubs. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/benefits/legal-entities/{legal-entity-id}/paystubs
      name: benefits-legal-entities-legal-entity-id-paystubs
      description: REST surface for benefits-legal-entities-legal_entity_id-paystubs.
      operations:
      - method: GET
        name: getpaystubsfromlegalentityintegratedwithexternalbenefitsvendorv20260101
        description: Get paystubs from legal entity integrated with external benefits vendor
        call: platform-endpoints-subpackage-paystubs.getpaystubsfromlegalentityintegratedwithexternalbenefitsvendorv20260101
        with:
          legal_entity_id: rest.legal_entity_id
          states: rest.states
          date_start: rest.date_start
          date_end: rest.date_end
          items_per_page: rest.items_per_page
          cursor: rest.cursor
          Authorization: rest.Authorization
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: platform-endpoints-subpackage-paystubs-mcp
    port: 9090
    transport: http
    description: MCP adapter for Endpoints — subpackage_paystubs. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: get-paystubs-legal-entity-integrated
      description: Get paystubs from legal entity integrated with external benefits vendor
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: platform-endpoints-subpackage-paystubs.getpaystubsfromlegalentityintegratedwithexternalbenefitsvendorv20260101
      with:
        legal_entity_id: tools.legal_entity_id
        states: tools.states
        date_start: tools.date_start
        date_end: tools.date_end
        items_per_page: tools.items_per_page
        cursor: tools.cursor
        Authorization: tools.Authorization
      outputParameters:
      - type: object
        mapping: $.