---
title: "Update a taxwithholding"
method: PUT
path: "/hris/{connection_id}/taxwithholding/{id}"
tags: ["hris", "taxwithholding"]
---

# Update a taxwithholding

`PUT /hris/{connection_id}/taxwithholding/{id}`

## Request

- Base URL: `https://api.unified.to`
- URL: `https://api.unified.to/hris/{connection_id}/taxwithholding/{id}`
- Auth: API key in header `authorization`

Updates the HrisTaxwithholding identified by `id`. Provide the unified HrisTaxwithholding fields to change in the request body.

## Path parameters

- `connection_id` string, required
- `id` string, required

## Query parameters

- `fields` string[]
- `raw` string

## Request body

- HrisTaxwithholding: Employee tax withholding settings for one jurisdiction (eg. W-4)
  - `id` string
  - `created_at` string, date-time: (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
  - `updated_at` string, date-time: (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
  - `user_id` string: employee ID (reference to HrisEmployee)
  - `company_id` string: (reference to HrisCompany)
  - `country` string: ISO 3166-1 alpha-2 country code of the taxing authority (eg. US, CA)
  - `jurisdiction_type` 'FEDERAL' | 'STATE' | 'LOCAL'
  - `jurisdiction` string: region/locality code within the country (eg. CA, NY, NY-NYC); empty for FEDERAL
  - `is_resident` boolean: true for the resident (home) jurisdiction, false for a work-only jurisdiction
  - `form` 'W4_2020' | 'W4_LEGACY' | 'STATE_FORM' | 'TD1' | 'OTHER': withholding form the values come from (eg. 2020+ W-4)
  - `filing_status` 'SINGLE' | 'MARRIED_JOINTLY' | 'MARRIED_SEPARATELY' | 'HEAD_OF_HOUSEHOLD' | 'QUALIFYING_SURVIVOR' | 'OTHER'
  - `tax_code` string: jurisdiction-specific tax code (eg. UK 1257L)
  - `allowances` number: withholding allowances (pre-2020 W-4 and most state forms)
  - `claim_amount` number: dollar exemption / claim amount (eg. Canada TD1, Illinois IL-W-4)
  - `has_multiple_jobs` boolean: W-4 step 2: multiple jobs or spouse works
  - `dependents_amount` number: W-4 step 3: dependents credit amount
  - `other_income_amount` number: W-4 step 4a: other income amount
  - `other_deductions_amount` number: W-4 step 4b: deductions amount
  - `extra_withholding_amount` number: W-4 step 4c: additional amount withheld each pay period
  - `extra_withholding_percent` number: additional percentage of wages withheld each pay period
  - `override_type` 'NONE' | 'FIXED_AMOUNT' | 'PERCENT': replaces the calculated withholding with a flat amount or percentage
  - `override_amount` number: money (FIXED_AMOUNT) or percentage (PERCENT) withheld instead of the calculated amount
  - `is_exempt` boolean: employee claims exemption from withholding in this jurisdiction
  - `effective_at` string, date-time: date these withholding settings take effect (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
  - `metadata` HrisMetadata[]
    - `id` string: The ID of the custom field definition (from the metadata/metadata endpoint).
    - `value` union: The field's value, typed by `format`: DATE as ISO-8601 (`YYYY-MM-DD`, or `YYYY-MM-DDTHH:MM:SSZ` for date-times); NUMBER, PRICE and CURRENCY as a number; BOOLEAN and YES_NO as true/false; MULTIPLE_SELECT as an array of option values; otherwise a string.
      - object
      - string
      - number
      - boolean
      - union[]
        - union
          - object
          - string
          - number
          - boolean
    - `namespace` string
    - `format` 'TEXT' | 'NUMBER' | 'DATE' | 'BOOLEAN' | 'FILE' | 'TEXTAREA' | 'SINGLE_SELECT' | 'MULTIPLE_SELECT' | 'MEASUREMENT' | 'PRICE' | 'YES_NO' | 'CURRENCY' | 'URL': The data type of the custom field, which determines how `value` is formatted.
    - `extra_data` union
      - object
      - string
      - number
      - boolean
      - union[]
        - union
          - object
          - string
          - number
          - boolean
    - `slug` string: The integration's API name (key) of an existing custom field. List valid slugs for this object with the metadata/metadata endpoint; unknown slugs are rejected by the integration.
  - `raw` object

## Response `200`

Successful

- HrisTaxwithholding: Employee tax withholding settings for one jurisdiction (eg. W-4)
  - `id` string
  - `created_at` string, date-time: (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
  - `updated_at` string, date-time: (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
  - `user_id` string: employee ID (reference to HrisEmployee)
  - `company_id` string: (reference to HrisCompany)
  - `country` string: ISO 3166-1 alpha-2 country code of the taxing authority (eg. US, CA)
  - `jurisdiction_type` 'FEDERAL' | 'STATE' | 'LOCAL'
  - `jurisdiction` string: region/locality code within the country (eg. CA, NY, NY-NYC); empty for FEDERAL
  - `is_resident` boolean: true for the resident (home) jurisdiction, false for a work-only jurisdiction
  - `form` 'W4_2020' | 'W4_LEGACY' | 'STATE_FORM' | 'TD1' | 'OTHER': withholding form the values come from (eg. 2020+ W-4)
  - `filing_status` 'SINGLE' | 'MARRIED_JOINTLY' | 'MARRIED_SEPARATELY' | 'HEAD_OF_HOUSEHOLD' | 'QUALIFYING_SURVIVOR' | 'OTHER'
  - `tax_code` string: jurisdiction-specific tax code (eg. UK 1257L)
  - `allowances` number: withholding allowances (pre-2020 W-4 and most state forms)
  - `claim_amount` number: dollar exemption / claim amount (eg. Canada TD1, Illinois IL-W-4)
  - `has_multiple_jobs` boolean: W-4 step 2: multiple jobs or spouse works
  - `dependents_amount` number: W-4 step 3: dependents credit amount
  - `other_income_amount` number: W-4 step 4a: other income amount
  - `other_deductions_amount` number: W-4 step 4b: deductions amount
  - `extra_withholding_amount` number: W-4 step 4c: additional amount withheld each pay period
  - `extra_withholding_percent` number: additional percentage of wages withheld each pay period
  - `override_type` 'NONE' | 'FIXED_AMOUNT' | 'PERCENT': replaces the calculated withholding with a flat amount or percentage
  - `override_amount` number: money (FIXED_AMOUNT) or percentage (PERCENT) withheld instead of the calculated amount
  - `is_exempt` boolean: employee claims exemption from withholding in this jurisdiction
  - `effective_at` string, date-time: date these withholding settings take effect (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
  - `metadata` HrisMetadata[]
    - `id` string: The ID of the custom field definition (from the metadata/metadata endpoint).
    - `value` union: The field's value, typed by `format`: DATE as ISO-8601 (`YYYY-MM-DD`, or `YYYY-MM-DDTHH:MM:SSZ` for date-times); NUMBER, PRICE and CURRENCY as a number; BOOLEAN and YES_NO as true/false; MULTIPLE_SELECT as an array of option values; otherwise a string.
      - object
      - string
      - number
      - boolean
      - union[]
        - union
          - object
          - string
          - number
          - boolean
    - `namespace` string
    - `format` 'TEXT' | 'NUMBER' | 'DATE' | 'BOOLEAN' | 'FILE' | 'TEXTAREA' | 'SINGLE_SELECT' | 'MULTIPLE_SELECT' | 'MEASUREMENT' | 'PRICE' | 'YES_NO' | 'CURRENCY' | 'URL': The data type of the custom field, which determines how `value` is formatted.
    - `extra_data` union
      - object
      - string
      - number
      - boolean
      - union[]
        - union
          - object
          - string
          - number
          - boolean
    - `slug` string: The integration's API name (key) of an existing custom field. List valid slugs for this object with the metadata/metadata endpoint; unknown slugs are rejected by the integration.
  - `raw` object

## Changes

- **2026-11-16** `63124139fb53`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/unified/apis/unified-to-api/changes/hris/:connection_id/taxwithholding/:id/put.md)

---

[API](https://skmtc.dev/unified/apis/unified-to-api.md) - [All operations](https://skmtc.dev/unified/apis/unified-to-api/llms.txt) - [OpenAPI document](https://skmtc.dev/unified/apis/unified-to-api/revisions/63124139fb53?raw)
