openapi: 3.1.0
info:
  title: Workday Payroll Input Deductions Payroll Calculations 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 Calculations
  description: Trigger and monitor payroll calculation processes
paths:
  /payRuns/{payRunId}/calculate:
    post:
      operationId: calculatePayRun
      summary: Workday Payroll Calculate a Pay Run
      description: Trigger payroll calculations for a specific pay run, processing all earnings, deductions, and taxes for included workers.
      tags:
      - Payroll Calculations
      parameters:
      - $ref: '#/components/parameters/payRunId'
      responses:
        '202':
          description: Calculation initiated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CalculationStatus'
              examples:
                CalculatePayRun202Example:
                  summary: Default calculatePayRun 202 response
                  x-microcks-default: true
                  value:
                    id: calc_20260430_00012
                    payRunId: pr_20260430_weekly_001
                    status: Queued
                    startedAt: '2026-04-30T16:45:00Z'
                    completedAt: '2026-04-30T16:45:00Z'
                    errors:
                    - error: INVALID_REQUEST
                      message: Validation failed for the provided fields.
                      details:
                      - field: amount
                        message: Validation failed for the provided fields.
        '400':
          $ref: '#/components/responses/BadRequest'
        '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.
                details:
                - field: amount
                  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.
                details:
                - field: amount
                  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.
                details:
                - field: amount
                  message: Validation failed for the provided fields.
  parameters:
    payRunId:
      name: payRunId
      in: path
      required: true
      description: Unique identifier for the pay run
      schema:
        type: string
      example: pr_20260430_weekly_001
  schemas:
    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.
        details:
          type: array
          items:
            type: object
            properties:
              field:
                type: string
              message:
                type: string
          description: Detailed error information
    CalculationStatus:
      type: object
      properties:
        id:
          type: string
          description: Calculation job identifier
          example: calc_20260430_00012
        payRunId:
          type: string
          description: Associated pay run identifier
          example: pr_20260430_weekly_001
        status:
          type: string
          enum:
          - Queued
          - Processing
          - Completed
          - Failed
          description: Current status of the calculation
          example: Queued
        startedAt:
          type: string
          format: date-time
          description: When the calculation started
          example: '2026-04-30T16:45:00Z'
        completedAt:
          type: string
          format: date-time
          description: When the calculation completed
          example: '2026-04-30T16:45:00Z'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
          description: Any errors encountered during calculation
  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