Workday Payroll Tax Jurisdictions API

openapi: 3.1.0
info:
  title: Workday Payroll Input Deductions Tax Jurisdictions 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 Jurisdictions
  description: Retrieve tax jurisdiction and authority information
paths:
  /taxJurisdictions:
    get:
      operationId: listTaxJurisdictions
      summary: Workday Payroll List Tax Jurisdictions
      description: Retrieve all configured tax jurisdictions, including federal, state, and local tax authorities.
      tags:
      - Tax Jurisdictions
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      - name: level
        in: query
        description: Filter by jurisdiction level
        schema:
          type: string
          enum:
          - Federal
          - State
          - Local
          - Other
        example: Federal
      - name: country
        in: query
        description: Filter by country code
        schema:
          type: string
        example: US
      responses:
        '200':
          description: Collection of tax jurisdictions
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaxJurisdictionCollection'
              examples:
                ListTaxJurisdictions200Example:
                  summary: Default listTaxJurisdictions 200 response
                  x-microcks-default: true
                  value:
                    data:
                    - id: tjur_us_federal
                      descriptor: Weekly USD Pay Group
                      level: Federal
                      country: US
                      stateCode: CA
                      localityName: San Francisco
                      taxTypes:
                      - FederalIncome
                      active: true
                    total: 52
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /taxJurisdictions/{jurisdictionId}:
    get:
      operationId: getTaxJurisdiction
      summary: Workday Payroll Get a Tax Jurisdiction
      description: Retrieve details of a specific tax jurisdiction, including applicable tax types and rates.
      tags:
      - Tax Jurisdictions
      parameters:
      - $ref: '#/components/parameters/jurisdictionId'
      responses:
        '200':
          description: Tax jurisdiction details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaxJurisdiction'
              examples:
                GetTaxJurisdiction200Example:
                  summary: Default getTaxJurisdiction 200 response
                  x-microcks-default: true
                  value:
                    id: tjur_us_federal
                    descriptor: Weekly USD Pay Group
                    level: Federal
                    country: US
                    stateCode: CA
                    localityName: San Francisco
                    taxTypes:
                    - FederalIncome
                    active: true
        '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.
    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.
  parameters:
    offset:
      name: offset
      in: query
      description: Number of results to skip for pagination
      schema:
        type: integer
        minimum: 0
        default: 0
      example: 0
    jurisdictionId:
      name: jurisdictionId
      in: path
      required: true
      description: Unique identifier for the tax jurisdiction
      schema:
        type: string
      example: tjur_us_federal
    limit:
      name: limit
      in: query
      description: Maximum number of results to return
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 20
      example: 20
  schemas:
    TaxJurisdictionCollection:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/TaxJurisdiction'
        total:
          type: integer
          description: Total number of tax jurisdictions
          example: 52
    TaxJurisdiction:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the tax jurisdiction
          example: tjur_us_federal
        descriptor:
          type: string
          description: Display name of the jurisdiction
          example: Weekly USD Pay Group
        level:
          type: string
          enum:
          - Federal
          - State
          - Local
          - Other
          description: Jurisdiction level
          example: Federal
        country:
          type: string
          description: ISO 3166-1 country code
          example: US
        stateCode:
          type: string
          description: State or province code
          example: CA
        localityName:
          type: string
          description: Local jurisdiction name
          example: San Francisco
        taxTypes:
          type: array
          items:
            type: string
          description: Applicable tax types in this jurisdiction
          example:
          - FederalIncome
        active:
          type: boolean
          description: Whether the jurisdiction is currently active
          example: true
    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.
  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