Workday Payroll Pay Groups API

openapi: 3.1.0
info:
  title: Workday Payroll Input Deductions Pay Groups 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: Pay Groups
  description: Configure and manage pay groups for organizing payroll
paths:
  /payGroups:
    get:
      operationId: listPayGroups
      summary: Workday Payroll List Pay Groups
      description: Retrieve all configured pay groups, which organize workers for payroll processing by frequency, currency, or other criteria.
      tags:
      - Pay Groups
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      responses:
        '200':
          description: Collection of pay groups
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayGroupCollection'
              examples:
                ListPayGroups200Example:
                  summary: Default listPayGroups 200 response
                  x-microcks-default: true
                  value:
                    data:
                    - id: pg_weekly_usd
                      descriptor: Weekly USD Pay Group
                      payFrequency: Weekly
                      currency: USD
                      country: US
                      runCategory: example
                      workerCount: 87
                      inactive: false
                    total: 52
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /payGroups/{payGroupId}:
    get:
      operationId: getPayGroup
      summary: Workday Payroll Get a Pay Group
      description: Retrieve details of a specific pay group by its identifier.
      tags:
      - Pay Groups
      parameters:
      - $ref: '#/components/parameters/payGroupId'
      responses:
        '200':
          description: Pay group details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayGroup'
              examples:
                GetPayGroup200Example:
                  summary: Default getPayGroup 200 response
                  x-microcks-default: true
                  value:
                    id: pg_weekly_usd
                    descriptor: Weekly USD Pay Group
                    payFrequency: Weekly
                    currency: USD
                    country: US
                    runCategory: example
                    workerCount: 87
                    inactive: false
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /payGroups/{payGroupId}/workers:
    get:
      operationId: listPayGroupWorkers
      summary: Workday Payroll List Workers in a Pay Group
      description: Retrieve all workers assigned to a specific pay group.
      tags:
      - Pay Groups
      parameters:
      - $ref: '#/components/parameters/payGroupId'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      responses:
        '200':
          description: Collection of workers in the pay group
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkerCollection'
              examples:
                ListPayGroupWorkers200Example:
                  summary: Default listPayGroupWorkers 200 response
                  x-microcks-default: true
                  value:
                    data:
                    - id: w_100542
                      descriptor: Weekly USD Pay Group
                    total: 52
        '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.
    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:
    offset:
      name: offset
      in: query
      description: Number of results to skip for pagination
      schema:
        type: integer
        minimum: 0
        default: 0
      example: 0
    payGroupId:
      name: payGroupId
      in: path
      required: true
      description: Unique identifier for the pay group
      schema:
        type: string
      example: pg_weekly_usd
    limit:
      name: limit
      in: query
      description: Maximum number of results to return
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 20
      example: 20
  schemas:
    WorkerCollection:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/WorkerRef'
        total:
          type: integer
          description: Total number of workers
          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
    PayGroup:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the pay group
          example: pg_weekly_usd
        descriptor:
          type: string
          description: Human-readable name of the pay group
          example: Weekly USD Pay Group
        payFrequency:
          type: string
          enum:
          - Weekly
          - BiWeekly
          - SemiMonthly
          - Monthly
          description: How often payroll is processed
          example: Weekly
        currency:
          type: string
          description: ISO 4217 currency code for the pay group
          example: USD
        country:
          type: string
          description: ISO 3166-1 country code
          example: US
        runCategory:
          type: string
          description: Default run category for this pay group
          example: example
        workerCount:
          type: integer
          description: Number of workers in the pay group
          example: 87
        inactive:
          type: boolean
          description: Whether the pay group is inactive
          example: false
    PayGroupCollection:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/PayGroup'
        total:
          type: integer
          description: Total number of pay groups
          example: 52
    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
  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