Workday Payroll · Schema

TaxWithholding

TaxWithholding schema from Workday Payroll Workday Tax API

CompensationEnterpriseHuman ResourcesPayrollSaaSTax

Properties

Name Type Description
id string Unique identifier for the tax withholding
jurisdiction object
taxType string Type of tax
filingStatus string Tax filing status
allowances integer Number of withholding allowances claimed
additionalWithholding number Additional flat withholding amount per pay period
exempt boolean Whether the worker claims exempt status
effectiveDate string Date the withholding configuration took effect
currency string ISO 4217 currency code
View JSON Schema on GitHub

JSON Schema

tax-tax-withholding-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/workday-payroll/refs/heads/main/json-schema/tax-tax-withholding-schema.json",
  "title": "TaxWithholding",
  "description": "TaxWithholding schema from Workday Payroll Workday Tax API",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier for the tax withholding",
      "example": "twh_w100542_federal"
    },
    "jurisdiction": {
      "$ref": "#/$defs/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"
    }
  },
  "$defs": {
    "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"
        }
      }
    }
  }
}