openapi: 3.1.0
info:
  title: Workday Payroll Input Deductions Tax Withholdings 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: Tax Withholdings
  description: Manage worker tax withholding configurations
paths:
  /workers/{workerId}/taxWithholdings:
    get:
      operationId: listWorkerTaxWithholdings
      summary: Workday Payroll List Worker Tax Withholdings
      description: Retrieve all tax withholding configurations for a specific worker, including federal, state, and local withholdings.
      tags:
      - Tax Withholdings
      parameters:
      - $ref: '#/components/parameters/workerId'
      responses:
        '200':
          description: Collection of tax withholdings
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaxWithholdingCollection'
              examples:
                ListWorkerTaxWithholdings200Example:
                  summary: Default listWorkerTaxWithholdings 200 response
                  x-microcks-default: true
                  value:
                    data:
                    - id: twh_w100542_federal
                      jurisdiction:
                        id: tjur_us_federal
                        descriptor: Weekly USD Pay Group
                      taxType: FederalIncome
                      filingStatus: Single
                      allowances: 2
                      additionalWithholding: 50.0
                      exempt: false
                      effectiveDate: '2026-04-30'
                      currency: USD
                    total: 52
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /workers/{workerId}/taxWithholdings/{withholdingId}:
    get:
      operationId: getWorkerTaxWithholding
      summary: Workday Payroll Get a Worker Tax Withholding
      description: Retrieve details of a specific tax withholding configuration for a worker.
      tags:
      - Tax Withholdings
      parameters:
      - $ref: '#/components/parameters/workerId'
      - $ref: '#/components/parameters/withholdingId'
      responses:
        '200':
          description: Tax withholding details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaxWithholding'
              examples:
                GetWorkerTaxWithholding200Example:
                  summary: Default getWorkerTaxWithholding 200 response
                  x-microcks-default: true
                  value:
                    id: twh_w100542_federal
                    jurisdiction:
                      id: tjur_us_federal
                      descriptor: Weekly USD Pay Group
                    taxType: FederalIncome
                    filingStatus: Single
                    allowances: 2
                    additionalWithholding: 50.0
                    exempt: false
                    effectiveDate: '2026-04-30'
                    currency: USD
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    patch:
      operationId: updateWorkerTaxWithholding
      summary: Workday Payroll Update a Worker Tax Withholding
      description: Update a tax withholding configuration for a worker, such as changing filing status or additional withholding amounts.
      tags:
      - Tax Withholdings
      parameters:
      - $ref: '#/components/parameters/workerId'
      - $ref: '#/components/parameters/withholdingId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateTaxWithholdingRequest'
            examples:
              UpdateWorkerTaxWithholdingRequestExample:
                summary: Default updateWorkerTaxWithholding request
                x-microcks-default: true
                value:
                  filingStatus: Single
                  allowances: 2
                  additionalWithholding: 50.0
                  exempt: false
      responses:
        '200':
          description: Tax withholding updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaxWithholding'
              examples:
                UpdateWorkerTaxWithholding200Example:
                  summary: Default updateWorkerTaxWithholding 200 response
                  x-microcks-default: true
                  value:
                    id: twh_w100542_federal
                    jurisdiction:
                      id: tjur_us_federal
                      descriptor: Weekly USD Pay Group
                    taxType: FederalIncome
                    filingStatus: Single
                    allowances: 2
                    additionalWithholding: 50.0
                    exempt: false
                    effectiveDate: '2026-04-30'
                    currency: USD
        '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:
    TaxJurisdictionRef:
      type: object
      properties:
        id:
          type: string
          description: Jurisdiction identifier
          example: tjur_us_federal
        descriptor:
          type: string
          description: Jurisdiction display name
          example: Weekly USD Pay Group
    TaxWithholding:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the tax withholding
          example: twh_w100542_federal
        jurisdiction:
          $ref: '#/components/schemas/TaxJurisdictionRef'
        taxType:
          type: string
          enum:
          - FederalIncome
          - StateIncome
          - LocalIncome
          - SocialSecurity
          - Medicare
          - FUTA
          - SUTA
          - Other
          description: Type of tax
          example: FederalIncome
        filingStatus:
          type: string
          enum:
          - Single
          - MarriedFilingJointly
          - MarriedFilingSeparately
          - HeadOfHousehold
          - QualifyingWidower
          description: Tax filing status
          example: Single
        allowances:
          type: integer
          description: Number of withholding allowances claimed
          example: 2
        additionalWithholding:
          type: number
          format: double
          description: Additional flat withholding amount per pay period
          example: 50.0
        exempt:
          type: boolean
          description: Whether the worker claims exempt status
          example: false
        effectiveDate:
          type: string
          format: date
          description: Date the withholding configuration took effect
          example: '2026-04-30'
        currency:
          type: string
          description: ISO 4217 currency code
          example: USD
    UpdateTaxWithholdingRequest:
      type: object
      properties:
        filingStatus:
          type: string
          enum:
          - Single
          - MarriedFilingJointly
          - MarriedFilingSeparately
          - HeadOfHousehold
          - QualifyingWidower
          description: Updated filing status
          example: Single
        allowances:
          type: integer
          description: Updated number of allowances
          example: 2
        additionalWithholding:
          type: number
          format: double
          description: Updated additional withholding amount
          example: 50.0
        exempt:
          type: boolean
          description: Updated exempt status
          example: false
    TaxWithholdingCollection:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/TaxWithholding'
        total:
          type: integer
          description: Total number of tax withholdings
          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.
  parameters:
    workerId:
      name: workerId
      in: path
      required: true
      description: Unique identifier for the worker
      schema:
        type: string
      example: w_100542
    withholdingId:
      name: withholdingId
      in: path
      required: true
      description: Unique identifier for the tax withholding
      schema:
        type: string
      example: twh_w100542_federal
  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