Workday Payroll API — Pay Runs

naftiko: 1.0.0-alpha2
info:
  label: Workday Payroll API — Pay Runs
  description: 'Workday Payroll API — Pay Runs. 5 operations. Lead operation: Workday Payroll List Pay Runs. Self-contained
    Naftiko capability covering one Workday Payroll business surface.'
  tags:
  - Workday Payroll
  - Pay Runs
  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-pay-runs
    baseUri: https://api.workday.com/payroll/v1
    description: Workday Payroll API — Pay Runs business capability. Self-contained, no shared references.
    resources:
    - name: payRuns
      path: /payRuns
      operations:
      - name: listpayruns
        method: GET
        description: Workday Payroll List Pay Runs
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: payGroupId
          in: query
          type: string
          description: Filter by pay group identifier
        - name: status
          in: query
          type: string
          description: Filter by pay run status
        - name: fromDate
          in: query
          type: string
          description: Filter pay runs starting from this date
        - name: toDate
          in: query
          type: string
          description: Filter pay runs up to this date
      - name: createpayrun
        method: POST
        description: Workday Payroll Create a Pay Run
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: payRuns-payRunId
      path: /payRuns/{payRunId}
      operations:
      - name: getpayrun
        method: GET
        description: Workday Payroll Get a Pay Run
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updatepayrun
        method: PATCH
        description: Workday Payroll Update a Pay Run
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: payRuns-payRunId-complete
      path: /payRuns/{payRunId}/complete
      operations:
      - name: completepayrun
        method: POST
        description: Workday Payroll Complete 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-pay-runs-rest
    port: 8080
    description: REST adapter for Workday Payroll API — Pay Runs. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/payruns
      name: payruns
      description: REST surface for payRuns.
      operations:
      - method: GET
        name: listpayruns
        description: Workday Payroll List Pay Runs
        call: payroll-pay-runs.listpayruns
        with:
          payGroupId: rest.payGroupId
          status: rest.status
          fromDate: rest.fromDate
          toDate: rest.toDate
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createpayrun
        description: Workday Payroll Create a Pay Run
        call: payroll-pay-runs.createpayrun
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/payruns/{payrunid}
      name: payruns-payrunid
      description: REST surface for payRuns-payRunId.
      operations:
      - method: GET
        name: getpayrun
        description: Workday Payroll Get a Pay Run
        call: payroll-pay-runs.getpayrun
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updatepayrun
        description: Workday Payroll Update a Pay Run
        call: payroll-pay-runs.updatepayrun
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/payruns/{payrunid}/complete
      name: payruns-payrunid-complete
      description: REST surface for payRuns-payRunId-complete.
      operations:
      - method: POST
        name: completepayrun
        description: Workday Payroll Complete a Pay Run
        call: payroll-pay-runs.completepayrun
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: payroll-pay-runs-mcp
    port: 9090
    transport: http
    description: MCP adapter for Workday Payroll API — Pay Runs. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: workday-payroll-list-pay-runs
      description: Workday Payroll List Pay Runs
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: payroll-pay-runs.listpayruns
      with:
        payGroupId: tools.payGroupId
        status: tools.status
        fromDate: tools.fromDate
        toDate: tools.toDate
      outputParameters:
      - type: object
        mapping: $.
    - name: workday-payroll-create-pay-run
      description: Workday Payroll Create a Pay Run
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: payroll-pay-runs.createpayrun
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: workday-payroll-get-pay-run
      description: Workday Payroll Get a Pay Run
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: payroll-pay-runs.getpayrun
      outputParameters:
      - type: object
        mapping: $.
    - name: workday-payroll-update-pay-run
      description: Workday Payroll Update a Pay Run
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: payroll-pay-runs.updatepayrun
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: workday-payroll-complete-pay-run
      description: Workday Payroll Complete a Pay Run
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: payroll-pay-runs.completepayrun
      outputParameters:
      - type: object
        mapping: $.