Workday Payroll Payroll Adjustments API

openapi: 3.1.0
info:
  title: Workday Payroll Input Deductions Payroll Adjustments API
  description: API for submitting and managing payroll input data within the Workday platform, including one-time payments, payroll adjustments, supplemental earnings, and batch input submissions.
  version: v1
  contact:
    name: Workday Support
    url: https://www.workday.com/en-us/company/customer-support.html
    email: support@workday.com
  termsOfService: https://www.workday.com/en-us/legal.html
servers:
- url: https://api.workday.com/payroll-input/v1
  description: Workday Payroll Input Production
- url: https://{tenant}.workday.com/api/payroll-input/v1
  description: Workday Payroll Input Tenant-Specific
  variables:
    tenant:
      description: Workday tenant identifier
      default: your-tenant
security:
- bearerAuth: []
tags:
- name: Payroll Adjustments
  description: Create and manage payroll adjustments and corrections
paths:
  /adjustments:
    get:
      operationId: listPayrollAdjustments
      summary: Workday Payroll List Payroll Adjustments
      description: Retrieve all payroll adjustment records, optionally filtered by worker, type, or status.
      tags:
      - Payroll Adjustments
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      - name: workerId
        in: query
        description: Filter by worker identifier
        schema:
          type: string
        example: w_100542
      - name: adjustmentType
        in: query
        description: Filter by adjustment type
        schema:
          type: string
          enum:
          - Correction
          - Retroactive
          - Reversal
          - Reclass
        example: Correction
      responses:
        '200':
          description: Collection of payroll adjustments
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdjustmentCollection'
              examples:
                ListPayrollAdjustments200Example:
                  summary: Default listPayrollAdjustments 200 response
                  x-microcks-default: true
                  value:
                    data:
                    - id: adj_20260415_00012
                      worker:
                        id: w_100542
                        descriptor: Weekly USD Pay Group
                      adjustmentType: Correction
                      originalPayRunId: pr_20260430_weekly_001
                      earningCode: REGULAR
                      deductionCode: MEDICAL_PRETAX
                      amount: 2500.0
                      currency: USD
                      reason: Q1 2026 performance bonus
                      effectiveDate: '2026-04-30'
                      status: Pending
                      createdOn: '2026-04-30T16:45:00Z'
                    total: 52
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: createPayrollAdjustment
      summary: Workday Payroll Create a Payroll Adjustment
      description: Submit a payroll adjustment to correct, reverse, or reclassify previously processed payroll data.
      tags:
      - Payroll Adjustments
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateAdjustmentRequest'
            examples:
              CreatePayrollAdjustmentRequestExample:
                summary: Default createPayrollAdjustment request
                x-microcks-default: true
                value:
                  workerId: w_100542
                  adjustmentType: Correction
                  originalPayRunId: pr_20260430_weekly_001
                  earningCode: REGULAR
                  deductionCode: MEDICAL_PRETAX
                  amount: 2500.0
                  currency: USD
                  reason: Q1 2026 performance bonus
                  effectiveDate: '2026-04-30'
      responses:
        '201':
          description: Adjustment created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Adjustment'
              examples:
                CreatePayrollAdjustment201Example:
                  summary: Default createPayrollAdjustment 201 response
                  x-microcks-default: true
                  value:
                    id: adj_20260415_00012
                    worker:
                      id: w_100542
                      descriptor: Weekly USD Pay Group
                    adjustmentType: Correction
                    originalPayRunId: pr_20260430_weekly_001
                    earningCode: REGULAR
                    deductionCode: MEDICAL_PRETAX
                    amount: 2500.0
                    currency: USD
                    reason: Q1 2026 performance bonus
                    effectiveDate: '2026-04-30'
                    status: Pending
                    createdOn: '2026-04-30T16:45:00Z'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /adjustments/{adjustmentId}:
    get:
      operationId: getPayrollAdjustment
      summary: Workday Payroll Get a Payroll Adjustment
      description: Retrieve details of a specific payroll adjustment.
      tags:
      - Payroll Adjustments
      parameters:
      - $ref: '#/components/parameters/adjustmentId'
      responses:
        '200':
          description: Adjustment details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Adjustment'
              examples:
                GetPayrollAdjustment200Example:
                  summary: Default getPayrollAdjustment 200 response
                  x-microcks-default: true
                  value:
                    id: adj_20260415_00012
                    worker:
                      id: w_100542
                      descriptor: Weekly USD Pay Group
                    adjustmentType: Correction
                    originalPayRunId: pr_20260430_weekly_001
                    earningCode: REGULAR
                    deductionCode: MEDICAL_PRETAX
                    amount: 2500.0
                    currency: USD
                    reason: Q1 2026 performance bonus
                    effectiveDate: '2026-04-30'
                    status: Pending
                    createdOn: '2026-04-30T16:45:00Z'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  responses:
    Unauthorized:
      description: Authentication required or token expired
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            UnauthorizedExample:
              summary: Default Unauthorized response
              x-microcks-default: true
              value:
                error: INVALID_REQUEST
                message: Validation failed for the provided fields.
    BadRequest:
      description: Invalid request parameters
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            BadRequestExample:
              summary: Default BadRequest response
              x-microcks-default: true
              value:
                error: INVALID_REQUEST
                message: Validation failed for the provided fields.
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            NotFoundExample:
              summary: Default NotFound response
              x-microcks-default: true
              value:
                error: INVALID_REQUEST
                message: Validation failed for the provided fields.
  schemas:
    AdjustmentCollection:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Adjustment'
        total:
          type: integer
          description: Total number of adjustments
          example: 52
    WorkerRef:
      type: object
      properties:
        id:
          type: string
          description: Worker identifier
          example: w_100542
        descriptor:
          type: string
          description: Worker display name
          example: Weekly USD Pay Group
    Error:
      type: object
      properties:
        error:
          type: string
          description: Error code
          example: INVALID_REQUEST
        message:
          type: string
          description: Human-readable error message
          example: Validation failed for the provided fields.
    CreateAdjustmentRequest:
      type: object
      required:
      - workerId
      - adjustmentType
      - amount
      properties:
        workerId:
          type: string
          description: Worker identifier
          example: w_100542
        adjustmentType:
          type: string
          enum:
          - Correction
          - Retroactive
          - Reversal
          - Reclass
          description: Type of adjustment
          example: Correction
        originalPayRunId:
          type: string
          description: Original pay run being adjusted
          example: pr_20260430_weekly_001
        earningCode:
          type: string
          description: Earning code to adjust
          example: REGULAR
        deductionCode:
          type: string
          description: Deduction code to adjust
          example: MEDICAL_PRETAX
        amount:
          type: number
          format: double
          description: Adjustment amount
          example: 2500.0
        currency:
          type: string
          description: ISO 4217 currency code
          example: USD
        reason:
          type: string
          description: Reason for the adjustment
          example: Q1 2026 performance bonus
        effectiveDate:
          type: string
          format: date
          description: Effective date
          example: '2026-04-30'
    Adjustment:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the adjustment
          example: adj_20260415_00012
        worker:
          $ref: '#/components/schemas/WorkerRef'
        adjustmentType:
          type: string
          enum:
          - Correction
          - Retroactive
          - Reversal
          - Reclass
          description: Type of adjustment
          example: Correction
        originalPayRunId:
          type: string
          description: Reference to the original pay run being adjusted
          example: pr_20260430_weekly_001
        earningCode:
          type: string
          description: Earning code affected
          example: REGULAR
        deductionCode:
          type: string
          description: Deduction code affected
          example: MEDICAL_PRETAX
        amount:
          type: number
          format: double
          description: Adjustment amount (positive or negative)
          example: 2500.0
        currency:
          type: string
          description: ISO 4217 currency code
          example: USD
        reason:
          type: string
          description: Reason for the adjustment
          example: Q1 2026 performance bonus
        effectiveDate:
          type: string
          format: date
          description: Effective date of the adjustment
          example: '2026-04-30'
        status:
          type: string
          enum:
          - Pending
          - Approved
          - Processed
          - Rejected
          description: Current status
          example: Pending
        createdOn:
          type: string
          format: date-time
          description: When the adjustment was created
          example: '2026-04-30T16:45:00Z'
  parameters:
    adjustmentId:
      name: adjustmentId
      in: path
      required: true
      description: Unique identifier for the payroll adjustment
      schema:
        type: string
      example: adj_20260415_00012
    offset:
      name: offset
      in: query
      description: Number of results to skip for pagination
      schema:
        type: integer
        minimum: 0
        default: 0
      example: 0
    limit:
      name: limit
      in: query
      description: Maximum number of results to return
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 20
      example: 20
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: OAuth 2.0 bearer token obtained through Workday authentication.
externalDocs:
  description: Workday Payroll Input API Documentation
  url: https://community.workday.com/sites/default/files/file-hosting/productionapi/index.html