Employee Onboarding
Generate Employee Tax Parameter Definitions
Retrieve all tax parameters used for withholding calculations.
POST
/
employees
/
getTaxParameterDefinitions
Generate Employee Tax Parameter Definitions
curl --request POST \
--url https://api.zeal.com/employees/getTaxParameterDefinitions \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"jurisdictions": [
"CA"
]
}
'import requests
url = "https://api.zeal.com/employees/getTaxParameterDefinitions"
payload = { "jurisdictions": ["CA"] }
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({jurisdictions: ['CA']})
};
fetch('https://api.zeal.com/employees/getTaxParameterDefinitions', 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/getTaxParameterDefinitions",
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([
'jurisdictions' => [
'CA'
]
]),
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/getTaxParameterDefinitions"
payload := strings.NewReader("{\n \"jurisdictions\": [\n \"CA\"\n ]\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/getTaxParameterDefinitions")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"jurisdictions\": [\n \"CA\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zeal.com/employees/getTaxParameterDefinitions")
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 \"jurisdictions\": [\n \"CA\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"US": [
{
"code": "FILINGSTATUS",
"label": "Filing Status",
"effectiveDate": "2020-01-01T00:00:00.000Z",
"type": "options",
"options": [
{
"code": "S",
"name": "Single or Married filing separately",
"effectiveDate": 2020
},
{
"code": "M",
"name": "Married filing jointly",
"effectiveDate": 2020
},
{
"code": "H",
"name": "Head of Household",
"effectiveDate": 2020
}
],
"defaults": [
{
"effectiveDate": 2020,
"code": "S"
}
]
},
{
"code": "IS_NON_RESIDENT_ALIEN",
"label": "Nonresident Alien",
"effectiveDate": "2020-01-01T00:00:00.000Z",
"type": "boolean",
"defaults": [
{
"effectiveDate": 2020,
"value": false
}
]
},
{
"code": "TWO_JOBS",
"effectiveDate": "2020-01-01T00:00:00.000Z",
"label": "Two Jobs",
"type": "boolean",
"defaults": [
{
"effectiveDate": 2020,
"value": false
}
]
},
{
"code": "DEPENDENTS_AMOUNT",
"label": "Dependents Amount",
"effectiveDate": "2020-01-01T00:00:00.000Z",
"type": "dollars",
"constraints": [
{
"min": 0,
"max": null,
"effectiveDate": 2020
}
],
"defaults": [
{
"effectiveDate": 2020,
"value": 0
}
]
},
{
"code": "OTHER_INCOME",
"label": "Other Income",
"effectiveDate": "2020-01-01T00:00:00.000Z",
"type": "dollars",
"constraints": [
{
"min": 0,
"max": null,
"effectiveDate": 2020
}
],
"defaults": [
{
"effectiveDate": 2020,
"value": 0
}
]
},
{
"code": "EXTRA_WH",
"label": "Extra Withholding",
"effectiveDate": "2020-01-01T00:00:00.000Z",
"type": "dollars",
"constraints": [
{
"min": 0,
"max": null,
"effectiveDate": 2020
}
],
"defaults": [
{
"effectiveDate": 2020,
"value": 0
}
]
},
{
"code": "DEDUCTIONS",
"label": "Deductions",
"effectiveDate": "2020-01-01T00:00:00.000Z",
"type": "dollars",
"constraints": [
{
"min": 0,
"max": null,
"effectiveDate": 2020
}
],
"defaults": [
{
"effectiveDate": 2020,
"value": 0
}
]
},
{
"code": "EXEMPT",
"effectiveDate": "2020-01-01T00:00:00.000Z",
"type": "boolean",
"defaults": [
{
"effectiveDate": 2020,
"value": false
}
],
"label": "Exempt from withholding"
},
{
"code": "SUBJECT",
"effectiveDate": "2020-01-01T00:00:00.000Z",
"type": "boolean",
"defaults": [
{
"effectiveDate": 2020,
"value": true
}
],
"label": "Subject to tax"
},
{
"type": "options",
"code": "FICA_SocialSecurity_EE_EXEMPT",
"label": "FICA Social Security Employee Exempt",
"scope": "FICA_SocialSecurity_EE",
"options": [
{
"code": "NOT_EXEMPT",
"name": "Not exempt",
"effectiveDate": 2020
},
{
"code": "NO_REPORTING",
"name": "No reporting",
"effectiveDate": 2020
},
{
"code": "NO_WITHHOLDING",
"name": "No withholding",
"effectiveDate": 2020
}
],
"defaults": [
{
"code": "NOT_EXEMPT",
"effectiveDate": 2020
}
],
"effectiveDate": "2020-01-01T00:00:00.000Z"
},
{
"type": "options",
"code": "FICA_Medicare_EE_EXEMPT",
"label": "FICA Medicare Employee Exempt",
"scope": "FICA_Medicare_EE",
"options": [
{
"code": "NOT_EXEMPT",
"name": "Not exempt",
"effectiveDate": 2020
},
{
"code": "NO_REPORTING",
"name": "No reporting",
"effectiveDate": 2020
},
{
"code": "NO_WITHHOLDING",
"name": "No withholding",
"effectiveDate": 2020
}
],
"defaults": [
{
"code": "NOT_EXEMPT",
"effectiveDate": 2020
}
],
"effectiveDate": "2020-01-01T00:00:00.000Z"
},
{
"type": "options",
"code": "FICA_Medicare_ER_EXEMPT",
"label": "FICA Medicare Employer Exempt",
"scope": "FICA_Medicare_ER",
"options": [
{
"code": "NOT_EXEMPT",
"name": "Not exempt",
"effectiveDate": 2020
},
{
"code": "NO_REPORTING",
"name": "No reporting",
"effectiveDate": 2020
},
{
"code": "NO_WITHHOLDING",
"name": "No withholding",
"effectiveDate": 2020
}
],
"defaults": [
{
"code": "NOT_EXEMPT",
"effectiveDate": 2020
}
],
"effectiveDate": "2020-01-01T00:00:00.000Z"
},
{
"type": "options",
"code": "FICA_SocialSecurity_ER_EXEMPT",
"label": "FICA Social Security Employer Exempt",
"scope": "FICA_SocialSecurity_ER",
"options": [
{
"code": "NOT_EXEMPT",
"name": "Not exempt",
"effectiveDate": 2020
},
{
"code": "NO_REPORTING",
"name": "No reporting",
"effectiveDate": 2020
},
{
"code": "NO_WITHHOLDING",
"name": "No withholding",
"effectiveDate": 2020
}
],
"defaults": [
{
"code": "NOT_EXEMPT",
"effectiveDate": 2020
}
],
"effectiveDate": "2020-01-01T00:00:00.000Z"
},
{
"type": "options",
"code": "FUTA_EXEMPT",
"label": "FUTA Exempt",
"scope": "FUTA",
"options": [
{
"code": "NOT_EXEMPT",
"name": "Not exempt",
"effectiveDate": 2020
},
{
"code": "NO_REPORTING",
"name": "No reporting",
"effectiveDate": 2020
},
{
"code": "NO_WITHHOLDING",
"name": "No withholding",
"effectiveDate": 2020
}
],
"defaults": [
{
"code": "NOT_EXEMPT",
"effectiveDate": 2020
}
],
"effectiveDate": "2020-01-01T00:00:00.000Z"
}
]
}
}{
"success": false,
"errors": [
{
"message": "Invalid tax parameter jurisdiction",
"code": 91
}
]
}⌘I
Generate Employee Tax Parameter Definitions
curl --request POST \
--url https://api.zeal.com/employees/getTaxParameterDefinitions \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"jurisdictions": [
"CA"
]
}
'import requests
url = "https://api.zeal.com/employees/getTaxParameterDefinitions"
payload = { "jurisdictions": ["CA"] }
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({jurisdictions: ['CA']})
};
fetch('https://api.zeal.com/employees/getTaxParameterDefinitions', 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/getTaxParameterDefinitions",
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([
'jurisdictions' => [
'CA'
]
]),
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/getTaxParameterDefinitions"
payload := strings.NewReader("{\n \"jurisdictions\": [\n \"CA\"\n ]\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/getTaxParameterDefinitions")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"jurisdictions\": [\n \"CA\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zeal.com/employees/getTaxParameterDefinitions")
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 \"jurisdictions\": [\n \"CA\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"US": [
{
"code": "FILINGSTATUS",
"label": "Filing Status",
"effectiveDate": "2020-01-01T00:00:00.000Z",
"type": "options",
"options": [
{
"code": "S",
"name": "Single or Married filing separately",
"effectiveDate": 2020
},
{
"code": "M",
"name": "Married filing jointly",
"effectiveDate": 2020
},
{
"code": "H",
"name": "Head of Household",
"effectiveDate": 2020
}
],
"defaults": [
{
"effectiveDate": 2020,
"code": "S"
}
]
},
{
"code": "IS_NON_RESIDENT_ALIEN",
"label": "Nonresident Alien",
"effectiveDate": "2020-01-01T00:00:00.000Z",
"type": "boolean",
"defaults": [
{
"effectiveDate": 2020,
"value": false
}
]
},
{
"code": "TWO_JOBS",
"effectiveDate": "2020-01-01T00:00:00.000Z",
"label": "Two Jobs",
"type": "boolean",
"defaults": [
{
"effectiveDate": 2020,
"value": false
}
]
},
{
"code": "DEPENDENTS_AMOUNT",
"label": "Dependents Amount",
"effectiveDate": "2020-01-01T00:00:00.000Z",
"type": "dollars",
"constraints": [
{
"min": 0,
"max": null,
"effectiveDate": 2020
}
],
"defaults": [
{
"effectiveDate": 2020,
"value": 0
}
]
},
{
"code": "OTHER_INCOME",
"label": "Other Income",
"effectiveDate": "2020-01-01T00:00:00.000Z",
"type": "dollars",
"constraints": [
{
"min": 0,
"max": null,
"effectiveDate": 2020
}
],
"defaults": [
{
"effectiveDate": 2020,
"value": 0
}
]
},
{
"code": "EXTRA_WH",
"label": "Extra Withholding",
"effectiveDate": "2020-01-01T00:00:00.000Z",
"type": "dollars",
"constraints": [
{
"min": 0,
"max": null,
"effectiveDate": 2020
}
],
"defaults": [
{
"effectiveDate": 2020,
"value": 0
}
]
},
{
"code": "DEDUCTIONS",
"label": "Deductions",
"effectiveDate": "2020-01-01T00:00:00.000Z",
"type": "dollars",
"constraints": [
{
"min": 0,
"max": null,
"effectiveDate": 2020
}
],
"defaults": [
{
"effectiveDate": 2020,
"value": 0
}
]
},
{
"code": "EXEMPT",
"effectiveDate": "2020-01-01T00:00:00.000Z",
"type": "boolean",
"defaults": [
{
"effectiveDate": 2020,
"value": false
}
],
"label": "Exempt from withholding"
},
{
"code": "SUBJECT",
"effectiveDate": "2020-01-01T00:00:00.000Z",
"type": "boolean",
"defaults": [
{
"effectiveDate": 2020,
"value": true
}
],
"label": "Subject to tax"
},
{
"type": "options",
"code": "FICA_SocialSecurity_EE_EXEMPT",
"label": "FICA Social Security Employee Exempt",
"scope": "FICA_SocialSecurity_EE",
"options": [
{
"code": "NOT_EXEMPT",
"name": "Not exempt",
"effectiveDate": 2020
},
{
"code": "NO_REPORTING",
"name": "No reporting",
"effectiveDate": 2020
},
{
"code": "NO_WITHHOLDING",
"name": "No withholding",
"effectiveDate": 2020
}
],
"defaults": [
{
"code": "NOT_EXEMPT",
"effectiveDate": 2020
}
],
"effectiveDate": "2020-01-01T00:00:00.000Z"
},
{
"type": "options",
"code": "FICA_Medicare_EE_EXEMPT",
"label": "FICA Medicare Employee Exempt",
"scope": "FICA_Medicare_EE",
"options": [
{
"code": "NOT_EXEMPT",
"name": "Not exempt",
"effectiveDate": 2020
},
{
"code": "NO_REPORTING",
"name": "No reporting",
"effectiveDate": 2020
},
{
"code": "NO_WITHHOLDING",
"name": "No withholding",
"effectiveDate": 2020
}
],
"defaults": [
{
"code": "NOT_EXEMPT",
"effectiveDate": 2020
}
],
"effectiveDate": "2020-01-01T00:00:00.000Z"
},
{
"type": "options",
"code": "FICA_Medicare_ER_EXEMPT",
"label": "FICA Medicare Employer Exempt",
"scope": "FICA_Medicare_ER",
"options": [
{
"code": "NOT_EXEMPT",
"name": "Not exempt",
"effectiveDate": 2020
},
{
"code": "NO_REPORTING",
"name": "No reporting",
"effectiveDate": 2020
},
{
"code": "NO_WITHHOLDING",
"name": "No withholding",
"effectiveDate": 2020
}
],
"defaults": [
{
"code": "NOT_EXEMPT",
"effectiveDate": 2020
}
],
"effectiveDate": "2020-01-01T00:00:00.000Z"
},
{
"type": "options",
"code": "FICA_SocialSecurity_ER_EXEMPT",
"label": "FICA Social Security Employer Exempt",
"scope": "FICA_SocialSecurity_ER",
"options": [
{
"code": "NOT_EXEMPT",
"name": "Not exempt",
"effectiveDate": 2020
},
{
"code": "NO_REPORTING",
"name": "No reporting",
"effectiveDate": 2020
},
{
"code": "NO_WITHHOLDING",
"name": "No withholding",
"effectiveDate": 2020
}
],
"defaults": [
{
"code": "NOT_EXEMPT",
"effectiveDate": 2020
}
],
"effectiveDate": "2020-01-01T00:00:00.000Z"
},
{
"type": "options",
"code": "FUTA_EXEMPT",
"label": "FUTA Exempt",
"scope": "FUTA",
"options": [
{
"code": "NOT_EXEMPT",
"name": "Not exempt",
"effectiveDate": 2020
},
{
"code": "NO_REPORTING",
"name": "No reporting",
"effectiveDate": 2020
},
{
"code": "NO_WITHHOLDING",
"name": "No withholding",
"effectiveDate": 2020
}
],
"defaults": [
{
"code": "NOT_EXEMPT",
"effectiveDate": 2020
}
],
"effectiveDate": "2020-01-01T00:00:00.000Z"
}
]
}
}{
"success": false,
"errors": [
{
"message": "Invalid tax parameter jurisdiction",
"code": 91
}
]
}