Workday Advanced Compensation Compensation Plans API

openapi: 3.0.3
info:
  title: Workday Advanced Compensation Bonus Plans Compensation Plans API
  description: The Workday Advanced Compensation API provides RESTful access to compensation management capabilities including compensation plans, merit increases, bonuses, stock awards, compensation grades, budgets, and review processes. The API enables organizations to programmatically manage their total compensation strategy, administer compensation cycles, and integrate compensation data with other systems.
  version: v41.1
  contact:
    name: Workday Developer Support
    url: https://community.workday.com/
  x-generated-from: documentation
servers:
- url: https://{tenant}.workday.com/api/compensation/v1
  description: Workday tenant REST API endpoint
  variables:
    tenant:
      default: wd2-impl-services1
      description: Your Workday tenant hostname
security:
- oauth2: []
tags:
- name: Compensation Plans
  description: Manage compensation plans and eligibility rules
paths:
  /compensationPlans:
    get:
      operationId: listCompensationPlans
      summary: Workday List Compensation Plans
      description: Retrieves a collection of compensation plans including eligibility rules, effective dates, and plan types.
      tags:
      - Compensation Plans
      parameters:
      - name: limit
        in: query
        description: Maximum number of records to return
        schema:
          type: integer
          default: 100
        example: 100
      - name: offset
        in: query
        description: Number of records to skip
        schema:
          type: integer
          default: 0
        example: 0
      - name: planType
        in: query
        description: Filter by compensation plan type
        schema:
          type: string
        example: MERIT
      responses:
        '200':
          description: A list of compensation plans
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompensationPlansResponse'
              examples:
                ListCompensationPlans200Example:
                  summary: Default listCompensationPlans 200 response
                  x-microcks-default: true
                  value:
                    total: 15
                    data:
                    - id: CP-001
                      name: Annual Merit Plan 2026
                      type: MERIT
                      effectiveDate: '2026-01-01'
                      status: ACTIVE
                      currency: USD
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /compensationPlans/{planId}:
    get:
      operationId: getCompensationPlan
      summary: Workday Get Compensation Plan
      description: Retrieves details for a specific compensation plan including eligibility criteria, budget pools, and plan components.
      tags:
      - Compensation Plans
      parameters:
      - name: planId
        in: path
        required: true
        description: Unique identifier for the compensation plan
        schema:
          type: string
        example: CP-001
      responses:
        '200':
          description: A compensation plan
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompensationPlan'
              examples:
                GetCompensationPlan200Example:
                  summary: Default getCompensationPlan 200 response
                  x-microcks-default: true
                  value:
                    id: CP-001
                    name: Annual Merit Plan 2026
                    type: MERIT
                    effectiveDate: '2026-01-01'
                    status: ACTIVE
                    currency: USD
                    budgetPool: 3.5
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  responses:
    Forbidden:
      description: Insufficient permissions
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            Forbidden403Example:
              summary: Forbidden example
              x-microcks-default: true
              value:
                error: FORBIDDEN
                message: Insufficient permissions to access this resource
    Unauthorized:
      description: Authentication required
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            Unauthorized401Example:
              summary: Unauthorized example
              x-microcks-default: true
              value:
                error: UNAUTHORIZED
                message: Authentication required
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            NotFound404Example:
              summary: Not found example
              x-microcks-default: true
              value:
                error: NOT_FOUND
                message: The requested resource was not found
  schemas:
    CompensationPlansResponse:
      type: object
      description: Paginated response containing compensation plans
      properties:
        total:
          type: integer
          description: Total number of compensation plans
          example: 15
        data:
          type: array
          items:
            $ref: '#/components/schemas/CompensationPlan'
    CompensationPlan:
      type: object
      description: A Workday compensation plan defining structure and eligibility
      properties:
        id:
          type: string
          description: Unique identifier for the compensation plan
          example: CP-001
        name:
          type: string
          description: Name of the compensation plan
          example: Annual Merit Plan 2026
        type:
          type: string
          description: Type of compensation plan
          enum:
          - MERIT
          - BONUS
          - STOCK
          - SALARY
          - ALLOWANCE
          example: MERIT
        effectiveDate:
          type: string
          format: date
          description: Date when the plan becomes effective
          example: '2026-01-01'
        endDate:
          type: string
          format: date
          description: Date when the plan expires
          example: '2026-12-31'
        status:
          type: string
          description: Current status of the plan
          enum:
          - ACTIVE
          - INACTIVE
          - DRAFT
          - ARCHIVED
          example: ACTIVE
        currency:
          type: string
          description: Currency code for monetary values
          example: USD
        budgetPool:
          type: number
          description: Total budget pool percentage for merit plans
          example: 3.5
        description:
          type: string
          description: Description of the compensation plan
          example: Annual merit increase plan for all eligible employees
    ErrorResponse:
      type: object
      description: Workday API error response
      properties:
        error:
          type: string
          description: Error code
          example: INVALID_REQUEST
        message:
          type: string
          description: Human-readable error message
          example: Invalid compensation plan ID
        details:
          type: array
          items:
            type: string
          description: Additional error details
  securitySchemes:
    oauth2:
      type: oauth2
      description: Workday OAuth 2.0 authentication
      flows:
        clientCredentials:
          tokenUrl: https://{tenant}.workday.com/ccx/oauth2/{tenant}/token
          scopes:
            compensation.read: Read compensation data
            compensation.write: Write compensation data