openapi: 3.1.0
info:
  title: Workday Payroll Input Deductions Time Off Inputs 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: Time Off Inputs
  description: Submit time off and leave inputs for payroll processing
paths:
  /workers/{workerId}/timeOffInputs:
    get:
      operationId: listWorkerTimeOffInputs
      summary: Workday Payroll List Worker Time Off Inputs
      description: Retrieve time off input records for a specific worker that affect payroll calculations.
      tags:
      - Time Off Inputs
      parameters:
      - $ref: '#/components/parameters/workerId'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      responses:
        '200':
          description: Collection of time off inputs
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TimeOffInputCollection'
              examples:
                ListWorkerTimeOffInputs200Example:
                  summary: Default listWorkerTimeOffInputs 200 response
                  x-microcks-default: true
                  value:
                    data:
                    - id: to_w100542_20260415
                      worker:
                        id: w_100542
                        descriptor: Weekly USD Pay Group
                      timeOffType: Vacation
                      startDate: '2026-04-30'
                      endDate: '2026-04-30'
                      hours: 40.0
                      status: Pending
                      paid: true
                    total: 52
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: createWorkerTimeOffInput
      summary: Workday Payroll Create a Time Off Input
      description: Submit a time off input for a worker to be reflected in payroll processing.
      tags:
      - Time Off Inputs
      parameters:
      - $ref: '#/components/parameters/workerId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateTimeOffInputRequest'
            examples:
              CreateWorkerTimeOffInputRequestExample:
                summary: Default createWorkerTimeOffInput request
                x-microcks-default: true
                value:
                  timeOffType: Vacation
                  startDate: '2026-04-30'
                  endDate: '2026-04-30'
                  hours: 40.0
                  paid: true
      responses:
        '201':
          description: Time off input created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TimeOffInput'
              examples:
                CreateWorkerTimeOffInput201Example:
                  summary: Default createWorkerTimeOffInput 201 response
                  x-microcks-default: true
                  value:
                    id: to_w100542_20260415
                    worker:
                      id: w_100542
                      descriptor: Weekly USD Pay Group
                    timeOffType: Vacation
                    startDate: '2026-04-30'
                    endDate: '2026-04-30'
                    hours: 40.0
                    status: Pending
                    paid: true
        '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.
    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:
    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
    CreateTimeOffInputRequest:
      type: object
      required:
      - timeOffType
      - startDate
      - hours
      properties:
        timeOffType:
          type: string
          description: Type of time off
          example: Vacation
        startDate:
          type: string
          format: date
          description: Start date
          example: '2026-04-30'
        endDate:
          type: string
          format: date
          description: End date
          example: '2026-04-30'
        hours:
          type: number
          format: double
          description: Hours of time off
          example: 40.0
        paid:
          type: boolean
          description: Whether the time off is paid
          example: true
    TimeOffInputCollection:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/TimeOffInput'
        total:
          type: integer
          description: Total number of time off inputs
          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.
    TimeOffInput:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the time off input
          example: to_w100542_20260415
        worker:
          $ref: '#/components/schemas/WorkerRef'
        timeOffType:
          type: string
          description: Type of time off
          example: Vacation
        startDate:
          type: string
          format: date
          description: Start date of time off
          example: '2026-04-30'
        endDate:
          type: string
          format: date
          description: End date of time off
          example: '2026-04-30'
        hours:
          type: number
          format: double
          description: Total hours of time off
          example: 40.0
        status:
          type: string
          enum:
          - Pending
          - Approved
          - Processed
          description: Current status
          example: Pending
        paid:
          type: boolean
          description: Whether the time off is paid
          example: true
  parameters:
    workerId:
      name: workerId
      in: path
      required: true
      description: Unique identifier for the worker
      schema:
        type: string
      example: w_100542
    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