Employee Onboarding
Set Employee Tax Parameters
Set an employee’s tax withholding parameters.
POST
/
employees
/
setTaxParameters
Set Employee Tax Parameters
curl --request POST \
--url https://api.zeal.com/employees/setTaxParameters \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"employeeID": "<string>",
"companyID": "<string>",
"federalParameters": [
{
"code": "<string>",
"value": "<string>",
"jurisdiction": "<string>",
"effectiveDate": "2023-12-25"
}
],
"stateParameters": [
{
"code": "<string>",
"value": "<string>",
"jurisdiction": "<string>",
"effectiveDate": "2023-12-25"
}
],
"effectiveDate": "2023-12-25"
}
'import requests
url = "https://api.zeal.com/employees/setTaxParameters"
payload = {
"employeeID": "<string>",
"companyID": "<string>",
"federalParameters": [
{
"code": "<string>",
"value": "<string>",
"jurisdiction": "<string>",
"effectiveDate": "2023-12-25"
}
],
"stateParameters": [
{
"code": "<string>",
"value": "<string>",
"jurisdiction": "<string>",
"effectiveDate": "2023-12-25"
}
],
"effectiveDate": "2023-12-25"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
employeeID: '<string>',
companyID: '<string>',
federalParameters: [
{
code: '<string>',
value: '<string>',
jurisdiction: '<string>',
effectiveDate: '2023-12-25'
}
],
stateParameters: [
{
code: '<string>',
value: '<string>',
jurisdiction: '<string>',
effectiveDate: '2023-12-25'
}
],
effectiveDate: '2023-12-25'
})
};
fetch('https://api.zeal.com/employees/setTaxParameters', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.zeal.com/employees/setTaxParameters",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'employeeID' => '<string>',
'companyID' => '<string>',
'federalParameters' => [
[
'code' => '<string>',
'value' => '<string>',
'jurisdiction' => '<string>',
'effectiveDate' => '2023-12-25'
]
],
'stateParameters' => [
[
'code' => '<string>',
'value' => '<string>',
'jurisdiction' => '<string>',
'effectiveDate' => '2023-12-25'
]
],
'effectiveDate' => '2023-12-25'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.zeal.com/employees/setTaxParameters"
payload := strings.NewReader("{\n \"employeeID\": \"<string>\",\n \"companyID\": \"<string>\",\n \"federalParameters\": [\n {\n \"code\": \"<string>\",\n \"value\": \"<string>\",\n \"jurisdiction\": \"<string>\",\n \"effectiveDate\": \"2023-12-25\"\n }\n ],\n \"stateParameters\": [\n {\n \"code\": \"<string>\",\n \"value\": \"<string>\",\n \"jurisdiction\": \"<string>\",\n \"effectiveDate\": \"2023-12-25\"\n }\n ],\n \"effectiveDate\": \"2023-12-25\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.zeal.com/employees/setTaxParameters")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"employeeID\": \"<string>\",\n \"companyID\": \"<string>\",\n \"federalParameters\": [\n {\n \"code\": \"<string>\",\n \"value\": \"<string>\",\n \"jurisdiction\": \"<string>\",\n \"effectiveDate\": \"2023-12-25\"\n }\n ],\n \"stateParameters\": [\n {\n \"code\": \"<string>\",\n \"value\": \"<string>\",\n \"jurisdiction\": \"<string>\",\n \"effectiveDate\": \"2023-12-25\"\n }\n ],\n \"effectiveDate\": \"2023-12-25\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zeal.com/employees/setTaxParameters")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"employeeID\": \"<string>\",\n \"companyID\": \"<string>\",\n \"federalParameters\": [\n {\n \"code\": \"<string>\",\n \"value\": \"<string>\",\n \"jurisdiction\": \"<string>\",\n \"effectiveDate\": \"2023-12-25\"\n }\n ],\n \"stateParameters\": [\n {\n \"code\": \"<string>\",\n \"value\": \"<string>\",\n \"jurisdiction\": \"<string>\",\n \"effectiveDate\": \"2023-12-25\"\n }\n ],\n \"effectiveDate\": \"2023-12-25\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"employeeID": "6547etrc312314213",
"federalParameters": [
{
"_id": "660dbaf23c1e233277df7f",
"code": "FILINGSTATUS",
"value": "H",
"jurisdiction": "US",
"effectiveDate": "2024-04-03T00:00:00.000Z"
},
{
"_id": "660dbaf23c1e233277df7f",
"code": "TWO_JOBS",
"value": "false",
"jurisdiction": "US",
"effectiveDate": "2024-04-03T00:00:00.000Z"
}
],
"stateParameters": [
{
"_id": "660dbaf23c1e233277df7f",
"code": "FILINGSTATUS",
"value": "H",
"jurisdiction": "CA",
"effectiveDate": "2024-04-03T00:00:00.000Z"
},
{
"code": "REGULAR_ALLOWANCES",
"value": "1",
"jurisdiction": "CA",
"effectiveDate": "2024-04-03T00:00:00.000"
},
{
"code": "SUTA_CA_EXEMPT",
"value": "NO_REPORTING",
"jurisdiction": "CA",
"effectiveDate": "2024-04-03T00:00:00.000"
}
]
}
}{
"success": false,
"errors": [
{
"message": "Employee with this employeeID does not exist",
"status": 400,
"code": 23
}
]
}Authorizations
Body
application/json
ID of the Employee being updated
ID of the company that the employee belongs to
An array of Tax Parameter entries
Show child attributes
Show child attributes
An array of state Tax Parameter entries
Show child attributes
Show child attributes
Effective Date of the tax parameters in this request. Only accepts YYYY-MM-DD date format. This effective date will apply to any net new changed parameters unless the date is explicitly declared in the individual parameter object. Note: Will default to the time of the request
⌘I
Set Employee Tax Parameters
curl --request POST \
--url https://api.zeal.com/employees/setTaxParameters \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"employeeID": "<string>",
"companyID": "<string>",
"federalParameters": [
{
"code": "<string>",
"value": "<string>",
"jurisdiction": "<string>",
"effectiveDate": "2023-12-25"
}
],
"stateParameters": [
{
"code": "<string>",
"value": "<string>",
"jurisdiction": "<string>",
"effectiveDate": "2023-12-25"
}
],
"effectiveDate": "2023-12-25"
}
'import requests
url = "https://api.zeal.com/employees/setTaxParameters"
payload = {
"employeeID": "<string>",
"companyID": "<string>",
"federalParameters": [
{
"code": "<string>",
"value": "<string>",
"jurisdiction": "<string>",
"effectiveDate": "2023-12-25"
}
],
"stateParameters": [
{
"code": "<string>",
"value": "<string>",
"jurisdiction": "<string>",
"effectiveDate": "2023-12-25"
}
],
"effectiveDate": "2023-12-25"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
employeeID: '<string>',
companyID: '<string>',
federalParameters: [
{
code: '<string>',
value: '<string>',
jurisdiction: '<string>',
effectiveDate: '2023-12-25'
}
],
stateParameters: [
{
code: '<string>',
value: '<string>',
jurisdiction: '<string>',
effectiveDate: '2023-12-25'
}
],
effectiveDate: '2023-12-25'
})
};
fetch('https://api.zeal.com/employees/setTaxParameters', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.zeal.com/employees/setTaxParameters",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'employeeID' => '<string>',
'companyID' => '<string>',
'federalParameters' => [
[
'code' => '<string>',
'value' => '<string>',
'jurisdiction' => '<string>',
'effectiveDate' => '2023-12-25'
]
],
'stateParameters' => [
[
'code' => '<string>',
'value' => '<string>',
'jurisdiction' => '<string>',
'effectiveDate' => '2023-12-25'
]
],
'effectiveDate' => '2023-12-25'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.zeal.com/employees/setTaxParameters"
payload := strings.NewReader("{\n \"employeeID\": \"<string>\",\n \"companyID\": \"<string>\",\n \"federalParameters\": [\n {\n \"code\": \"<string>\",\n \"value\": \"<string>\",\n \"jurisdiction\": \"<string>\",\n \"effectiveDate\": \"2023-12-25\"\n }\n ],\n \"stateParameters\": [\n {\n \"code\": \"<string>\",\n \"value\": \"<string>\",\n \"jurisdiction\": \"<string>\",\n \"effectiveDate\": \"2023-12-25\"\n }\n ],\n \"effectiveDate\": \"2023-12-25\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.zeal.com/employees/setTaxParameters")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"employeeID\": \"<string>\",\n \"companyID\": \"<string>\",\n \"federalParameters\": [\n {\n \"code\": \"<string>\",\n \"value\": \"<string>\",\n \"jurisdiction\": \"<string>\",\n \"effectiveDate\": \"2023-12-25\"\n }\n ],\n \"stateParameters\": [\n {\n \"code\": \"<string>\",\n \"value\": \"<string>\",\n \"jurisdiction\": \"<string>\",\n \"effectiveDate\": \"2023-12-25\"\n }\n ],\n \"effectiveDate\": \"2023-12-25\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zeal.com/employees/setTaxParameters")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"employeeID\": \"<string>\",\n \"companyID\": \"<string>\",\n \"federalParameters\": [\n {\n \"code\": \"<string>\",\n \"value\": \"<string>\",\n \"jurisdiction\": \"<string>\",\n \"effectiveDate\": \"2023-12-25\"\n }\n ],\n \"stateParameters\": [\n {\n \"code\": \"<string>\",\n \"value\": \"<string>\",\n \"jurisdiction\": \"<string>\",\n \"effectiveDate\": \"2023-12-25\"\n }\n ],\n \"effectiveDate\": \"2023-12-25\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"employeeID": "6547etrc312314213",
"federalParameters": [
{
"_id": "660dbaf23c1e233277df7f",
"code": "FILINGSTATUS",
"value": "H",
"jurisdiction": "US",
"effectiveDate": "2024-04-03T00:00:00.000Z"
},
{
"_id": "660dbaf23c1e233277df7f",
"code": "TWO_JOBS",
"value": "false",
"jurisdiction": "US",
"effectiveDate": "2024-04-03T00:00:00.000Z"
}
],
"stateParameters": [
{
"_id": "660dbaf23c1e233277df7f",
"code": "FILINGSTATUS",
"value": "H",
"jurisdiction": "CA",
"effectiveDate": "2024-04-03T00:00:00.000Z"
},
{
"code": "REGULAR_ALLOWANCES",
"value": "1",
"jurisdiction": "CA",
"effectiveDate": "2024-04-03T00:00:00.000"
},
{
"code": "SUTA_CA_EXEMPT",
"value": "NO_REPORTING",
"jurisdiction": "CA",
"effectiveDate": "2024-04-03T00:00:00.000"
}
]
}
}{
"success": false,
"errors": [
{
"message": "Employee with this employeeID does not exist",
"status": 400,
"code": 23
}
]
}