---
title: "Update a taxwithholding"
url: "https://docs.unified.to/hris/taxwithholding/Update_a_taxwithholding"
description: "Update a taxwithholding with Unified's Taxwithholding API (PUT /hris/{connection_id}/taxwithholding/{id}). Filter by fields and raw. Supported by 3 Taxwithholding integrations."
date: "2026-11-16T23:13:16.218Z"
updated: "2026-11-16T23:13:16.218Z"
---
# Update a taxwithholding

Updated: November 16, 2026

 PUT/hris/{connection\_id}/taxwithholding/{id}

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

## Parameters

**fields**string array 

id

created\_at

updated\_at

user\_id

company\_id

country

jurisdiction\_type

jurisdiction

is\_resident

form

filing\_status

tax\_code

allowances

claim\_amount

has\_multiple\_jobs

dependents\_amount

other\_income\_amount

other\_deductions\_amount

extra\_withholding\_amount

extra\_withholding\_percent

override\_type

override\_amount

is\_exempt

effective\_at

metadata

raw

Fields to return

**raw**string 

Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar

**connection\_id**string  required 

ID of the connection

**id**string  required 

ID of the Taxwithholding

## Payload

Employee tax withholding settings for one jurisdiction (eg. W-4)

**id**string 

**created\_at**date-time 

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

**updated\_at**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** enum

Valid values:

 "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** enum

Valid values:

 "W4\_2020" 

 "W4\_LEGACY" 

 "STATE\_FORM" 

 "TD1" 

 "OTHER" 

withholding form the values come from (eg. 2020+ W-4)

**filing\_status** enum

Valid values:

 "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** enum

Valid values:

 "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**date-time 

date these withholding settings take effect (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

**metadata** array 

**raw** 

## Returns

[HrisTaxwithholding](https://docs.unified.to/hris/taxwithholding/model.md)

| Response field              | Type               | Required | Description                                                                                                                                                                                                                                              |
| --------------------------- | ------------------ | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| id                          | string             | No       |                                                                                                                                                                                                                                                          |
| created\_at                 | string (date-time) | No       | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)                                                                                                                                                                                                                 |
| updated\_at                 | string (date-time) | No       | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)                                                                                                                                                                                                                 |
| user\_id                    | string             | No       | employee ID (reference to HrisEmployee)                                                                                                                                                                                                                  |
| company\_id                 | string             | No       | (reference to HrisCompany)                                                                                                                                                                                                                               |
| country                     | string             | No       | ISO 3166-1 alpha-2 country code of the taxing authority (eg. US, CA)                                                                                                                                                                                     |
| jurisdiction\_type          | enum               | No       | Values: FEDERAL, STATE, LOCAL                                                                                                                                                                                                                            |
| jurisdiction                | string             | No       | region/locality code within the country (eg. CA, NY, NY-NYC); empty for FEDERAL                                                                                                                                                                          |
| is\_resident                | boolean            | No       | true for the resident (home) jurisdiction, false for a work-only jurisdiction                                                                                                                                                                            |
| form                        | enum               | No       | withholding form the values come from (eg. 2020+ W-4) Values: W4\_2020, W4\_LEGACY, STATE\_FORM, TD1, OTHER                                                                                                                                              |
| filing\_status              | enum               | No       | Values: SINGLE, MARRIED\_JOINTLY, MARRIED\_SEPARATELY, HEAD\_OF\_HOUSEHOLD, QUALIFYING\_SURVIVOR, OTHER                                                                                                                                                  |
| tax\_code                   | string             | No       | jurisdiction-specific tax code (eg. UK 1257L)                                                                                                                                                                                                            |
| allowances                  | number             | No       | withholding allowances (pre-2020 W-4 and most state forms)                                                                                                                                                                                               |
| claim\_amount               | number             | No       | dollar exemption / claim amount (eg. Canada TD1, Illinois IL-W-4)                                                                                                                                                                                        |
| has\_multiple\_jobs         | boolean            | No       | W-4 step 2: multiple jobs or spouse works                                                                                                                                                                                                                |
| dependents\_amount          | number             | No       | W-4 step 3: dependents credit amount                                                                                                                                                                                                                     |
| other\_income\_amount       | number             | No       | W-4 step 4a: other income amount                                                                                                                                                                                                                         |
| other\_deductions\_amount   | number             | No       | W-4 step 4b: deductions amount                                                                                                                                                                                                                           |
| extra\_withholding\_amount  | number             | No       | W-4 step 4c: additional amount withheld each pay period                                                                                                                                                                                                  |
| extra\_withholding\_percent | number             | No       | additional percentage of wages withheld each pay period                                                                                                                                                                                                  |
| override\_type              | enum               | No       | replaces the calculated withholding with a flat amount or percentage Values: NONE, FIXED\_AMOUNT, PERCENT                                                                                                                                                |
| override\_amount            | number             | No       | money (FIXED\_AMOUNT) or percentage (PERCENT) withheld instead of the calculated amount                                                                                                                                                                  |
| is\_exempt                  | boolean            | No       | employee claims exemption from withholding in this jurisdiction                                                                                                                                                                                          |
| effective\_at               | string (date-time) | No       | date these withholding settings take effect (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)                                                                                                                                                                     |
| metadata                    | HrisMetadata\[\]   | No       |                                                                                                                                                                                                                                                          |
| metadata\[\].id             | string             | No       | The ID of the custom field definition (from the metadata/metadata endpoint).                                                                                                                                                                             |
| metadata\[\].value          | object             | No       | 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. |
| metadata\[\].namespace      | string             | No       |                                                                                                                                                                                                                                                          |
| metadata\[\].format         | enum               | No       | The data type of the custom field, which determines how value is formatted. Values: TEXT, NUMBER, DATE, BOOLEAN, FILE, TEXTAREA, SINGLE\_SELECT, MULTIPLE\_SELECT, MEASUREMENT, PRICE, YES\_NO, CURRENCY, URL                                            |
| metadata\[\].extra\_data    | object             | No       |                                                                                                                                                                                                                                                          |
| metadata\[\].slug           | string             | No       | 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.                                                                       |

## Errors

 Errors return the HTTP status code and a JSON body with `statusCode`, `error` (the short label) and `message` (a human-readable detail). 

```json
{
  "statusCode": 429,
  "error": "Too Many Requests",
  "message": "Too many requests to unified.to API; max requests per minute: N"
}
```

| Status | Error                 | Meaning                                           |
| ------ | --------------------- | ------------------------------------------------- |
| 400    | Bad Request           | The request was malformed or failed validation.   |
| 401    | Unauthorized          | The connection is likely broken; re-authorize it. |
| 403    | Forbidden             | The connection is missing permissions or scopes.  |
| 404    | Not Found             | The requested resource does not exist.            |
| 429    | Too Many Requests     | Rate limit exceeded (see the two sources below).  |
| 500    | Internal Server Error | An unexpected error occurred.                     |
| 501    | Not Implemented       | Not supported by this integration.                |

 Errors from the underlying integration pass through: the integration's status comes back as ours (429, 401, 403, 404 or 5xx), usually with its message. When the integration's error body is unclear, Unified extracts what it can and returns a clearer message. 

### 429 Too Many Requests

A 429 has two possible sources:

* The integration's own rate limit, passed through.
* Unified's workspace limit: a rolling 60 seconds, set by plan, with the message `Too many requests to unified.to API; max requests per minute: N`.

## Code Samples

### Node.js SDK

```javascript
import { UnifiedTo } from '@unified-api/typescript-sdk';

const sdk = new UnifiedTo({
    security: {
        jwt: '<YOUR_API_KEY_HERE>',
    },
});

const connectionId = '5de520f96e439b002043d8dc';

const id = '1234';

const results = await sdk.hris.updateHrisTaxwithholding({ connectionId, id, hrisTaxwithholding: { }, 
    fields: '',
    raw: '',
 });
```

### Node.js (axios)

```javascript
const options = {
  method: 'PUT',
  url: 'https://api.unified.to/hris/5de520f96e439b002043d8dc/taxwithholding/5de520f96e439b002043d8d8',
  headers: {
    authorization: 'bearer .....'
  },
  data: undefined,
  params: {
    fields: '',
    raw: '',
  }
};

const results = await axios.request(options);
```

### Java

```java
AsyncHttpClient client = new DefaultAsyncHttpClient();

client.prepare("PUT", "https://api.unified.to/hris/5de520f96e439b002043d8dc/taxwithholding/5de520f96e439b002043d8d8?fields=&raw=")
  .setHeader("accept", "application/json")
  .setHeader("authorization", ".....")
  .execute()
  .toCompletableFuture()
  .thenAccept(System.out::println)
  .join();

client.close();
```

### Go

```go
import (
	"fmt"
	"net/http"
	"io/ioutil"
)

url := `https://api.unified.to/hris/5de520f96e439b002043d8dc/taxwithholding/5de520f96e439b002043d8d8?fields=&raw=

req, _ := http.NewRequest("PUT", url, nil)

req.Header.Add("accept", "application/json")
req.Header.Add("authorization", ".....")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
```

### Python

```python
import requests

url = "https://api.unified.to/hris/5de520f96e439b002043d8dc/taxwithholding/5de520f96e439b002043d8d8?fields=&raw="

headers = {
    "accept": "application/json",
    "authorization": "....."
}

response = requests.put(url, headers=headers)
```

### PHP

```php
$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.unified.to/hris/5de520f96e439b002043d8dc/taxwithholding/5de520f96e439b002043d8d8?fields=&raw=",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_HTTPHEADER => [
    "accept: application/json",
    "authorization: ....."
  ],
]);
```

### Ruby

```ruby
require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.unified.to/hris/5de520f96e439b002043d8dc/taxwithholding/5de520f96e439b002043d8d8?fields=&raw=")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["accept"] = 'application/json'
request["authorization"] = '....'

response = http.request(request)
puts response.read_body
```

### cURL

```bash
curl --request PUT \
  --url 'https://api.unified.to/hris/5de520f96e439b002043d8dc/taxwithholding/5de520f96e439b002043d8d8?fields=&raw=' \
  --header 'accept: application/json' \
  --header 'authorization: .....'
```
