Workday Advanced Compensation Compensation Budgets API

openapi: 3.0.3
info:
  title: Workday Advanced Compensation Bonus Plans Compensation Budgets 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 Budgets
  description: Manage compensation budgets and allocations
paths:
  /compensationBudgets:
    get:
      operationId: listCompensationBudgets
      summary: Workday List Compensation Budgets
      description: Retrieves compensation budgets with allocation amounts, utilization rates, and organizational scope.
      tags:
      - Compensation Budgets
      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: year
        in: query
        description: Filter by budget year
        schema:
          type: integer
        example: 2026
      responses:
        '200':
          description: A list of compensation budgets
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompensationBudgetsResponse'
              examples:
                ListCompensationBudgets200Example:
                  summary: Default listCompensationBudgets 200 response
                  x-microcks-default: true
                  value:
                    total: 8
                    data:
                    - id: CB-001
                      name: Engineering Merit Budget 2026
                      totalAmount: 2500000
                      allocatedAmount: 1875000
                      remainingAmount: 625000
                      currency: USD
                      year: 2026
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    CompensationBudget:
      type: object
      description: A compensation budget with allocation and utilization data
      properties:
        id:
          type: string
          description: Unique identifier for the budget
          example: CB-001
        name:
          type: string
          description: Name of the budget
          example: Engineering Merit Budget 2026
        totalAmount:
          type: number
          description: Total budget amount
          example: 2500000
        allocatedAmount:
          type: number
          description: Amount already allocated
          example: 1875000
        remainingAmount:
          type: number
          description: Remaining unallocated budget
          example: 625000
        currency:
          type: string
          description: Currency code
          example: USD
        year:
          type: integer
          description: Budget year
          example: 2026
    CompensationBudgetsResponse:
      type: object
      description: Paginated response containing compensation budgets
      properties:
        total:
          type: integer
          description: Total number of budgets
          example: 8
        data:
          type: array
          items:
            $ref: '#/components/schemas/CompensationBudget'
    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
  responses:
    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
  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