Workday Payroll Results API — Payroll Summaries

naftiko: 1.0.0-alpha2
info:
  label: Workday Payroll Results API — Payroll Summaries
  description: 'Workday Payroll Results API — Payroll Summaries. 3 operations. Lead operation: Workday Payroll Get Pay Run
    Results. Self-contained Naftiko capability covering one Workday Payroll business surface.'
  tags:
  - Workday Payroll
  - Payroll Summaries
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    WORKDAY_PAYROLL_API_KEY: WORKDAY_PAYROLL_API_KEY
capability:
  consumes:
  - type: http
    namespace: payroll-results-payroll-summaries
    baseUri: https://api.workday.com/payroll-results/v1
    description: Workday Payroll Results API — Payroll Summaries business capability. Self-contained, no shared references.
    resources:
    - name: payRuns-payRunId-results
      path: /payRuns/{payRunId}/results
      operations:
      - name: getpayrunresults
        method: GET
        description: Workday Payroll Get Pay Run Results
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: payRuns-payRunId-results-workers
      path: /payRuns/{payRunId}/results/workers
      operations:
      - name: listpayrunworkerresults
        method: GET
        description: Workday Payroll List Worker-level Results for a Pay Run
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: payRuns-payRunId-results-workers-workerId
      path: /payRuns/{payRunId}/results/workers/{workerId}
      operations:
      - name: getpayrunworkerresult
        method: GET
        description: Workday Payroll Get a Worker Result for a Pay Run
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: bearer
      token: '{{env.WORKDAY_PAYROLL_API_KEY}}'
  exposes:
  - type: rest
    namespace: payroll-results-payroll-summaries-rest
    port: 8080
    description: REST adapter for Workday Payroll Results API — Payroll Summaries. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/payruns/{payrunid}/results
      name: payruns-payrunid-results
      description: REST surface for payRuns-payRunId-results.
      operations:
      - method: GET
        name: getpayrunresults
        description: Workday Payroll Get Pay Run Results
        call: payroll-results-payroll-summaries.getpayrunresults
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/payruns/{payrunid}/results/workers
      name: payruns-payrunid-results-workers
      description: REST surface for payRuns-payRunId-results-workers.
      operations:
      - method: GET
        name: listpayrunworkerresults
        description: Workday Payroll List Worker-level Results for a Pay Run
        call: payroll-results-payroll-summaries.listpayrunworkerresults
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/payruns/{payrunid}/results/workers/{workerid}
      name: payruns-payrunid-results-workers-workerid
      description: REST surface for payRuns-payRunId-results-workers-workerId.
      operations:
      - method: GET
        name: getpayrunworkerresult
        description: Workday Payroll Get a Worker Result for a Pay Run
        call: payroll-results-payroll-summaries.getpayrunworkerresult
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: payroll-results-payroll-summaries-mcp
    port: 9090
    transport: http
    description: MCP adapter for Workday Payroll Results API — Payroll Summaries. One tool per consumed operation, routed
      inline through this capability's consumes block.
    tools:
    - name: workday-payroll-get-pay-run
      description: Workday Payroll Get Pay Run Results
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: payroll-results-payroll-summaries.getpayrunresults
      outputParameters:
      - type: object
        mapping: $.
    - name: workday-payroll-list-worker-level
      description: Workday Payroll List Worker-level Results for a Pay Run
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: payroll-results-payroll-summaries.listpayrunworkerresults
      outputParameters:
      - type: object
        mapping: $.
    - name: workday-payroll-get-worker-result
      description: Workday Payroll Get a Worker Result for a Pay Run
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: payroll-results-payroll-summaries.getpayrunworkerresult
      outputParameters:
      - type: object
        mapping: $.