Endpoints — subpackage_payroll

naftiko: 1.0.0-alpha2
info:
  label: Endpoints — subpackage_payroll
  description: 'Endpoints — subpackage_payroll. 2 operations. Lead operation: Get pay stub from employees from organization
    integrated with external benefits vendor. Self-contained Naftiko capability covering one Deel business surface.'
  tags:
  - Deel
  - subpackage_payroll
  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-payroll
    baseUri: https://api.letsdeel.com/rest/v2
    description: Endpoints — subpackage_payroll business capability. Self-contained, no shared references.
    resources:
    - name: benefits-legal-entities-id-pay-stub
      path: /benefits/legal-entities/{id}/pay-stub
      operations:
      - name: getpaystubfromemployeesfromorganizationintegratedwithexternalbenefitsvendorv20260101
        method: GET
        description: Get pay stub from employees from organization integrated with external benefits vendor
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: Id from the legal entity to fetch data
          required: true
        - name: payroll_start_date
          in: query
          type: string
          description: Payroll start date
        - name: payroll_end_date
          in: query
          type: string
          description: Payroll end date
        - name: status
          in: query
          type: string
          description: Payroll status
        - name: items_per_page
          in: query
          type: integer
          description: Items per page
        - name: offset
          in: query
          type: integer
          description: Items to be skipped when searching
        - name: Authorization
          in: header
          type: string
          description: '## Authentication'
          required: true
    - name: benefits-legal-entities-id-year-to-date-pay
      path: /benefits/legal-entities/{id}/year-to-date-pay
      operations:
      - name: getyeartodatepay
        method: GET
        description: Get year to date payment for benefits 401k.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: Id from the legal entity to fetch data
          required: true
        - name: date_start
          in: query
          type: string
          description: Start date to fetch aggregated pay data
          required: true
        - name: date_end
          in: query
          type: string
          description: End date to fetch aggregated pay data
          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-payroll-rest
    port: 8080
    description: REST adapter for Endpoints — subpackage_payroll. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/benefits/legal-entities/{id}/pay-stub
      name: benefits-legal-entities-id-pay-stub
      description: REST surface for benefits-legal-entities-id-pay-stub.
      operations:
      - method: GET
        name: getpaystubfromemployeesfromorganizationintegratedwithexternalbenefitsvendorv20260101
        description: Get pay stub from employees from organization integrated with external benefits vendor
        call: platform-endpoints-subpackage-payroll.getpaystubfromemployeesfromorganizationintegratedwithexternalbenefitsvendorv20260101
        with:
          id: rest.id
          payroll_start_date: rest.payroll_start_date
          payroll_end_date: rest.payroll_end_date
          status: rest.status
          items_per_page: rest.items_per_page
          offset: rest.offset
          Authorization: rest.Authorization
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/benefits/legal-entities/{id}/year-to-date-pay
      name: benefits-legal-entities-id-year-to-date-pay
      description: REST surface for benefits-legal-entities-id-year-to-date-pay.
      operations:
      - method: GET
        name: getyeartodatepay
        description: Get year to date payment for benefits 401k.
        call: platform-endpoints-subpackage-payroll.getyeartodatepay
        with:
          id: rest.id
          date_start: rest.date_start
          date_end: rest.date_end
          Authorization: rest.Authorization
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: platform-endpoints-subpackage-payroll-mcp
    port: 9090
    transport: http
    description: MCP adapter for Endpoints — subpackage_payroll. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: get-pay-stub-employees-organization
      description: Get pay stub from employees from organization integrated with external benefits vendor
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: platform-endpoints-subpackage-payroll.getpaystubfromemployeesfromorganizationintegratedwithexternalbenefitsvendorv20260101
      with:
        id: tools.id
        payroll_start_date: tools.payroll_start_date
        payroll_end_date: tools.payroll_end_date
        status: tools.status
        items_per_page: tools.items_per_page
        offset: tools.offset
        Authorization: tools.Authorization
      outputParameters:
      - type: object
        mapping: $.
    - name: get-year-date-payment-benefits
      description: Get year to date payment for benefits 401k.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: platform-endpoints-subpackage-payroll.getyeartodatepay
      with:
        id: tools.id
        date_start: tools.date_start
        date_end: tools.date_end
        Authorization: tools.Authorization
      outputParameters:
      - type: object
        mapping: $.