Workday Advanced Compensation API — Compensation Plans

naftiko: 1.0.0-alpha2
info:
  label: Workday Advanced Compensation API — Compensation Plans
  description: 'Workday Advanced Compensation API — Compensation Plans. 2 operations. Lead operation: Workday List Compensation
    Plans. Self-contained Naftiko capability covering one Workday Advanced Compensation business surface.'
  tags:
  - Workday Advanced Compensation
  - Compensation Plans
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    WORKDAY_ADVANCED_COMPENSATION_API_KEY: WORKDAY_ADVANCED_COMPENSATION_API_KEY
capability:
  consumes:
  - type: http
    namespace: workday-advanced-compensation-compensation-plans
    baseUri: https://{tenant}.workday.com/api/compensation/v1
    description: Workday Advanced Compensation API — Compensation Plans business capability. Self-contained, no shared references.
    resources:
    - name: compensationPlans
      path: /compensationPlans
      operations:
      - name: listcompensationplans
        method: GET
        description: Workday List Compensation Plans
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: limit
          in: query
          type: integer
          description: Maximum number of records to return
        - name: offset
          in: query
          type: integer
          description: Number of records to skip
        - name: planType
          in: query
          type: string
          description: Filter by compensation plan type
    - name: compensationPlans-planId
      path: /compensationPlans/{planId}
      operations:
      - name: getcompensationplan
        method: GET
        description: Workday Get Compensation Plan
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: planId
          in: path
          type: string
          description: Unique identifier for the compensation plan
          required: true
    authentication:
      type: bearer
      token: '{{env.WORKDAY_ADVANCED_COMPENSATION_API_KEY}}'
  exposes:
  - type: rest
    namespace: workday-advanced-compensation-compensation-plans-rest
    port: 8080
    description: REST adapter for Workday Advanced Compensation API — Compensation Plans. One Spectral-compliant resource
      per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/compensationplans
      name: compensationplans
      description: REST surface for compensationPlans.
      operations:
      - method: GET
        name: listcompensationplans
        description: Workday List Compensation Plans
        call: workday-advanced-compensation-compensation-plans.listcompensationplans
        with:
          limit: rest.limit
          offset: rest.offset
          planType: rest.planType
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/compensationplans/{planid}
      name: compensationplans-planid
      description: REST surface for compensationPlans-planId.
      operations:
      - method: GET
        name: getcompensationplan
        description: Workday Get Compensation Plan
        call: workday-advanced-compensation-compensation-plans.getcompensationplan
        with:
          planId: rest.planId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: workday-advanced-compensation-compensation-plans-mcp
    port: 9090
    transport: http
    description: MCP adapter for Workday Advanced Compensation API — Compensation Plans. One tool per consumed operation,
      routed inline through this capability's consumes block.
    tools:
    - name: workday-list-compensation-plans
      description: Workday List Compensation Plans
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: workday-advanced-compensation-compensation-plans.listcompensationplans
      with:
        limit: tools.limit
        offset: tools.offset
        planType: tools.planType
      outputParameters:
      - type: object
        mapping: $.
    - name: workday-get-compensation-plan
      description: Workday Get Compensation Plan
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: workday-advanced-compensation-compensation-plans.getcompensationplan
      with:
        planId: tools.planId
      outputParameters:
      - type: object
        mapping: $.