Workday Integration Workday Payroll API — Pay Groups

naftiko: 1.0.0-alpha2
info:
  label: Workday Integration Workday Payroll API — Pay Groups
  description: 'Workday Integration Workday Payroll API — Pay Groups. 5 operations. Lead operation: Workday Integration Retrieve
    the pay group for a job. Self-contained Naftiko capability covering one Workday Integration business surface.'
  tags:
  - Workday Integration
  - Pay Groups
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    WORKDAY_INTEGRATION_API_KEY: WORKDAY_INTEGRATION_API_KEY
capability:
  consumes:
  - type: http
    namespace: payroll-pay-groups
    baseUri: https://{baseUrl}/ccx/api/payroll/v2/{tenant}
    description: Workday Integration Workday Payroll API — Pay Groups business capability. Self-contained, no shared references.
    resources:
    - name: jobs-ID-payGroup
      path: /jobs/{ID}/payGroup
      operations:
      - name: getpaygroupforjob
        method: GET
        description: Workday Integration Retrieve the pay group for a job
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: payGroupDetails
      path: /payGroupDetails
      operations:
      - name: getpaygroupdetails
        method: GET
        description: Workday Integration Retrieve pay group details
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: payGroupDetails-ID
      path: /payGroupDetails/{ID}
      operations:
      - name: getpaygroupdetailbyid
        method: GET
        description: Workday Integration Retrieve specific pay group detail
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: payGroups
      path: /payGroups
      operations:
      - name: getpaygroups
        method: GET
        description: Workday Integration Retrieve a collection of pay groups
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: payGroups-ID
      path: /payGroups/{ID}
      operations:
      - name: getpaygroupbyid
        method: GET
        description: Workday Integration Retrieve a specific pay group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: bearer
      token: '{{env.WORKDAY_INTEGRATION_API_KEY}}'
  exposes:
  - type: rest
    namespace: payroll-pay-groups-rest
    port: 8080
    description: REST adapter for Workday Integration Workday Payroll API — Pay Groups. One Spectral-compliant resource per
      consumed operation, prefixed with /v1.
    resources:
    - path: /v1/jobs/{id}/paygroup
      name: jobs-id-paygroup
      description: REST surface for jobs-ID-payGroup.
      operations:
      - method: GET
        name: getpaygroupforjob
        description: Workday Integration Retrieve the pay group for a job
        call: payroll-pay-groups.getpaygroupforjob
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/paygroupdetails
      name: paygroupdetails
      description: REST surface for payGroupDetails.
      operations:
      - method: GET
        name: getpaygroupdetails
        description: Workday Integration Retrieve pay group details
        call: payroll-pay-groups.getpaygroupdetails
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/paygroupdetails/{id}
      name: paygroupdetails-id
      description: REST surface for payGroupDetails-ID.
      operations:
      - method: GET
        name: getpaygroupdetailbyid
        description: Workday Integration Retrieve specific pay group detail
        call: payroll-pay-groups.getpaygroupdetailbyid
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/paygroups
      name: paygroups
      description: REST surface for payGroups.
      operations:
      - method: GET
        name: getpaygroups
        description: Workday Integration Retrieve a collection of pay groups
        call: payroll-pay-groups.getpaygroups
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/paygroups/{id}
      name: paygroups-id
      description: REST surface for payGroups-ID.
      operations:
      - method: GET
        name: getpaygroupbyid
        description: Workday Integration Retrieve a specific pay group
        call: payroll-pay-groups.getpaygroupbyid
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: payroll-pay-groups-mcp
    port: 9090
    transport: http
    description: MCP adapter for Workday Integration Workday Payroll API — Pay Groups. One tool per consumed operation, routed
      inline through this capability's consumes block.
    tools:
    - name: workday-integration-retrieve-pay-group
      description: Workday Integration Retrieve the pay group for a job
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: payroll-pay-groups.getpaygroupforjob
      outputParameters:
      - type: object
        mapping: $.
    - name: workday-integration-retrieve-pay-group-2
      description: Workday Integration Retrieve pay group details
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: payroll-pay-groups.getpaygroupdetails
      outputParameters:
      - type: object
        mapping: $.
    - name: workday-integration-retrieve-specific-pay
      description: Workday Integration Retrieve specific pay group detail
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: payroll-pay-groups.getpaygroupdetailbyid
      outputParameters:
      - type: object
        mapping: $.
    - name: workday-integration-retrieve-collection-pay
      description: Workday Integration Retrieve a collection of pay groups
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: payroll-pay-groups.getpaygroups
      outputParameters:
      - type: object
        mapping: $.
    - name: workday-integration-retrieve-specific-pay-2
      description: Workday Integration Retrieve a specific pay group
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: payroll-pay-groups.getpaygroupbyid
      outputParameters:
      - type: object
        mapping: $.