Get Employee Tax Parameter Summary

POST

employees

getTaxParameterSummary

curl --request POST \
  --url https://api.zeal.com/employees/getTaxParameterSummary \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "employeeID": "<string>",
  "companyID": "<string>",
  "jurisdictions": [
    "<string>"
  ],
  "effectiveDate": "2023-12-25"
}
'

import requests

url = "https://api.zeal.com/employees/getTaxParameterSummary"

payload = {
    "employeeID": "<string>",
    "companyID": "<string>",
    "jurisdictions": ["<string>"],
    "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>',
    jurisdictions: ['<string>'],
    effectiveDate: '2023-12-25'
  })
};

fetch('https://api.zeal.com/employees/getTaxParameterSummary', 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/getTaxParameterSummary",
  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>',
    'jurisdictions' => [
        '<string>'
    ],
    '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/getTaxParameterSummary"

	payload := strings.NewReader("{\n  \"employeeID\": \"<string>\",\n  \"companyID\": \"<string>\",\n  \"jurisdictions\": [\n    \"<string>\"\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/getTaxParameterSummary")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"employeeID\": \"<string>\",\n  \"companyID\": \"<string>\",\n  \"jurisdictions\": [\n    \"<string>\"\n  ],\n  \"effectiveDate\": \"2023-12-25\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.zeal.com/employees/getTaxParameterSummary")

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  \"jurisdictions\": [\n    \"<string>\"\n  ],\n  \"effectiveDate\": \"2023-12-25\"\n}"

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

{
  "success": true,
  "data": [
    {
      "employeeID": "622fbd3d2d883a0025b18e96",
      "effectiveDate": "2021-11-11T00:00:00.000Z",
      "jurisdiction": "US",
      "params": [
        {
          "code": "FILINGSTATUS",
          "type": "options",
          "value": "S",
          "valueDescription": "Single or Married filing separately",
          "label": "Filing Status",
          "isDefaultValue": true,
          "isUserProvidedValue": false
        },
        {
          "code": "IS_NON_RESIDENT_ALIEN",
          "type": "boolean",
          "value": "false",
          "label": "Nonresident Alien",
          "isDefaultValue": true,
          "isUserProvidedValue": false
        },
        {
          "code": "TWO_JOBS",
          "type": "boolean",
          "value": "false",
          "label": "Two Jobs",
          "isDefaultValue": true,
          "isUserProvidedValue": false
        },
        {
          "code": "DEPENDENTS_AMOUNT",
          "type": "dollars",
          "value": "0",
          "label": "Dependents Amount",
          "isDefaultValue": true,
          "isUserProvidedValue": false
        },
        {
          "code": "OTHER_INCOME",
          "type": "dollars",
          "value": "0",
          "label": "Other Income",
          "isDefaultValue": true,
          "isUserProvidedValue": false
        },
        {
          "code": "EXTRA_WH",
          "type": "dollars",
          "value": "0",
          "label": "Extra Withholding",
          "isDefaultValue": true,
          "isUserProvidedValue": false
        },
        {
          "code": "DEDUCTIONS",
          "type": "dollars",
          "value": "0",
          "label": "Deductions",
          "isDefaultValue": true,
          "isUserProvidedValue": false
        },
        {
          "code": "EXEMPT",
          "type": "boolean",
          "value": "false",
          "label": "Exempt from withholding",
          "isDefaultValue": true,
          "isUserProvidedValue": false
        },
        {
          "code": "SUBJECT",
          "type": "boolean",
          "value": "true",
          "label": "Subject to tax",
          "isDefaultValue": true,
          "isUserProvidedValue": false
        },
        {
          "code": "FICA_SocialSecurity_EE_EXEMPT",
          "type": "options",
          "value": "NOT_EXEMPT",
          "valueDescription": "Not exempt",
          "label": "FICA Social Security Employee Exempt",
          "isDefaultValue": true,
          "isUserProvidedValue": false
        },
        {
          "code": "FICA_Medicare_EE_EXEMPT",
          "type": "options",
          "value": "NOT_EXEMPT",
          "valueDescription": "Not exempt",
          "label": "FICA Medicare Employee Exempt",
          "isDefaultValue": true,
          "isUserProvidedValue": false
        },
        {
          "code": "FICA_Medicare_ER_EXEMPT",
          "type": "options",
          "value": "NOT_EXEMPT",
          "valueDescription": "Not exempt",
          "label": "FICA Medicare Employer Exempt",
          "isDefaultValue": true,
          "isUserProvidedValue": false
        },
        {
          "code": "FICA_SocialSecurity_ER_EXEMPT",
          "type": "options",
          "value": "NOT_EXEMPT",
          "valueDescription": "Not exempt",
          "label": "FICA Social Security Employer Exempt",
          "isDefaultValue": true,
          "isUserProvidedValue": false
        },
        {
          "code": "FUTA_EXEMPT",
          "type": "options",
          "value": "NOT_EXEMPT",
          "valueDescription": "Not exempt",
          "label": "FUTA Exempt",
          "isDefaultValue": true,
          "isUserProvidedValue": false
        }
      ]
    },
    {
      "employeeID": "622fbd3d2d883a0025b18e96",
      "effectiveDate": "2021-11-11T00:00:00.000Z",
      "jurisdiction": "GA",
      "params": [
        {
          "code": "FILINGSTATUS",
          "type": "options",
          "value": "S",
          "valueDescription": "Single",
          "label": "Filing Status",
          "isDefaultValue": true,
          "isUserProvidedValue": false
        },
        {
          "code": "PERSONALALLOWANCE",
          "type": "integer",
          "value": "0",
          "label": "Allowances based on Marital Status",
          "isDefaultValue": true,
          "isUserProvidedValue": false
        },
        {
          "code": "DEPENDENTALLOWANCE",
          "type": "integer",
          "value": "0",
          "label": "Dependent Allowances",
          "isDefaultValue": true,
          "isUserProvidedValue": false
        },
        {
          "code": "ADDITIONAL_WH",
          "type": "dollars",
          "value": "0",
          "label": "Additional Withholding per pay period",
          "isDefaultValue": true,
          "isUserProvidedValue": false
        },
        {
          "code": "EXEMPT",
          "type": "boolean",
          "value": "false",
          "label": "Exempt from withholding",
          "isDefaultValue": true,
          "isUserProvidedValue": false
        },
        {
          "code": "SUBJECT",
          "type": "boolean",
          "value": "true",
          "label": "Subject to tax",
          "isDefaultValue": true,
          "isUserProvidedValue": false
        },
        {
          "code": "SUTA_GA_EXEMPT",
          "type": "options",
          "value": "NOT_EXEMPT",
          "valueDescription": "Not exempt",
          "label": "SUTA GA Exempt",
          "isDefaultValue": true,
          "isUserProvidedValue": false
        }
      ]
    }
  ]
}

{
  "success": false,
  "errors": [
    {
      "message": "Employee with this employeeID does not exist",
      "code": 23
    }
  ]
}

Authorizations

Authorization

string

header

required

Body

application/json

employeeID

string

required

ID of the Employee

companyID

string

required

ID of the employer that the Employee belongs to

jurisdictions

string[]

List of jurisdictions for which the tax parameters are to be fetched. "US" for federal, or State (2 letter abbreviation)

effectiveDate

string<date>

Effective date of the tax parameters in this request. Only accepts YYYY-MM-DD date format Note: Will default to the time of the request

Response

200

success

boolean

default:true

Example:

true

data

object[]

Show child attributes

Get Employee Tax Parameter Summary

curl --request POST \
  --url https://api.zeal.com/employees/getTaxParameterSummary \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "employeeID": "<string>",
  "companyID": "<string>",
  "jurisdictions": [
    "<string>"
  ],
  "effectiveDate": "2023-12-25"
}
'

import requests

url = "https://api.zeal.com/employees/getTaxParameterSummary"

payload = {
    "employeeID": "<string>",
    "companyID": "<string>",
    "jurisdictions": ["<string>"],
    "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>',
    jurisdictions: ['<string>'],
    effectiveDate: '2023-12-25'
  })
};

fetch('https://api.zeal.com/employees/getTaxParameterSummary', 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/getTaxParameterSummary",
  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>',
    'jurisdictions' => [
        '<string>'
    ],
    '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/getTaxParameterSummary"

	payload := strings.NewReader("{\n  \"employeeID\": \"<string>\",\n  \"companyID\": \"<string>\",\n  \"jurisdictions\": [\n    \"<string>\"\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/getTaxParameterSummary")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"employeeID\": \"<string>\",\n  \"companyID\": \"<string>\",\n  \"jurisdictions\": [\n    \"<string>\"\n  ],\n  \"effectiveDate\": \"2023-12-25\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.zeal.com/employees/getTaxParameterSummary")

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  \"jurisdictions\": [\n    \"<string>\"\n  ],\n  \"effectiveDate\": \"2023-12-25\"\n}"

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

{
  "success": true,
  "data": [
    {
      "employeeID": "622fbd3d2d883a0025b18e96",
      "effectiveDate": "2021-11-11T00:00:00.000Z",
      "jurisdiction": "US",
      "params": [
        {
          "code": "FILINGSTATUS",
          "type": "options",
          "value": "S",
          "valueDescription": "Single or Married filing separately",
          "label": "Filing Status",
          "isDefaultValue": true,
          "isUserProvidedValue": false
        },
        {
          "code": "IS_NON_RESIDENT_ALIEN",
          "type": "boolean",
          "value": "false",
          "label": "Nonresident Alien",
          "isDefaultValue": true,
          "isUserProvidedValue": false
        },
        {
          "code": "TWO_JOBS",
          "type": "boolean",
          "value": "false",
          "label": "Two Jobs",
          "isDefaultValue": true,
          "isUserProvidedValue": false
        },
        {
          "code": "DEPENDENTS_AMOUNT",
          "type": "dollars",
          "value": "0",
          "label": "Dependents Amount",
          "isDefaultValue": true,
          "isUserProvidedValue": false
        },
        {
          "code": "OTHER_INCOME",
          "type": "dollars",
          "value": "0",
          "label": "Other Income",
          "isDefaultValue": true,
          "isUserProvidedValue": false
        },
        {
          "code": "EXTRA_WH",
          "type": "dollars",
          "value": "0",
          "label": "Extra Withholding",
          "isDefaultValue": true,
          "isUserProvidedValue": false
        },
        {
          "code": "DEDUCTIONS",
          "type": "dollars",
          "value": "0",
          "label": "Deductions",
          "isDefaultValue": true,
          "isUserProvidedValue": false
        },
        {
          "code": "EXEMPT",
          "type": "boolean",
          "value": "false",
          "label": "Exempt from withholding",
          "isDefaultValue": true,
          "isUserProvidedValue": false
        },
        {
          "code": "SUBJECT",
          "type": "boolean",
          "value": "true",
          "label": "Subject to tax",
          "isDefaultValue": true,
          "isUserProvidedValue": false
        },
        {
          "code": "FICA_SocialSecurity_EE_EXEMPT",
          "type": "options",
          "value": "NOT_EXEMPT",
          "valueDescription": "Not exempt",
          "label": "FICA Social Security Employee Exempt",
          "isDefaultValue": true,
          "isUserProvidedValue": false
        },
        {
          "code": "FICA_Medicare_EE_EXEMPT",
          "type": "options",
          "value": "NOT_EXEMPT",
          "valueDescription": "Not exempt",
          "label": "FICA Medicare Employee Exempt",
          "isDefaultValue": true,
          "isUserProvidedValue": false
        },
        {
          "code": "FICA_Medicare_ER_EXEMPT",
          "type": "options",
          "value": "NOT_EXEMPT",
          "valueDescription": "Not exempt",
          "label": "FICA Medicare Employer Exempt",
          "isDefaultValue": true,
          "isUserProvidedValue": false
        },
        {
          "code": "FICA_SocialSecurity_ER_EXEMPT",
          "type": "options",
          "value": "NOT_EXEMPT",
          "valueDescription": "Not exempt",
          "label": "FICA Social Security Employer Exempt",
          "isDefaultValue": true,
          "isUserProvidedValue": false
        },
        {
          "code": "FUTA_EXEMPT",
          "type": "options",
          "value": "NOT_EXEMPT",
          "valueDescription": "Not exempt",
          "label": "FUTA Exempt",
          "isDefaultValue": true,
          "isUserProvidedValue": false
        }
      ]
    },
    {
      "employeeID": "622fbd3d2d883a0025b18e96",
      "effectiveDate": "2021-11-11T00:00:00.000Z",
      "jurisdiction": "GA",
      "params": [
        {
          "code": "FILINGSTATUS",
          "type": "options",
          "value": "S",
          "valueDescription": "Single",
          "label": "Filing Status",
          "isDefaultValue": true,
          "isUserProvidedValue": false
        },
        {
          "code": "PERSONALALLOWANCE",
          "type": "integer",
          "value": "0",
          "label": "Allowances based on Marital Status",
          "isDefaultValue": true,
          "isUserProvidedValue": false
        },
        {
          "code": "DEPENDENTALLOWANCE",
          "type": "integer",
          "value": "0",
          "label": "Dependent Allowances",
          "isDefaultValue": true,
          "isUserProvidedValue": false
        },
        {
          "code": "ADDITIONAL_WH",
          "type": "dollars",
          "value": "0",
          "label": "Additional Withholding per pay period",
          "isDefaultValue": true,
          "isUserProvidedValue": false
        },
        {
          "code": "EXEMPT",
          "type": "boolean",
          "value": "false",
          "label": "Exempt from withholding",
          "isDefaultValue": true,
          "isUserProvidedValue": false
        },
        {
          "code": "SUBJECT",
          "type": "boolean",
          "value": "true",
          "label": "Subject to tax",
          "isDefaultValue": true,
          "isUserProvidedValue": false
        },
        {
          "code": "SUTA_GA_EXEMPT",
          "type": "options",
          "value": "NOT_EXEMPT",
          "valueDescription": "Not exempt",
          "label": "SUTA GA Exempt",
          "isDefaultValue": true,
          "isUserProvidedValue": false
        }
      ]
    }
  ]
}

{
  "success": false,
  "errors": [
    {
      "message": "Employee with this employeeID does not exist",
      "code": 23
    }
  ]
}

Introduction

Webhooks

Zeal Components

Companies

Company Onboarding

Reserve Accounts

Customer Accounts (Early Access)

Taxable Locations

Work Locations

Employees

Employee Deduction Templates

Employee Onboarding

Bank Accounts

Custom Attributes

Paperwork API

Employee Checks

Contractors

Contractor Onboarding

Contractor Payment Deductions

Payment Items

Contractor Payments

Paycards

Instant Pay

Employer Checks

Preview

Embedded HR

Reports

Documents

Get Employee Tax Parameter Summary

Authorizations

Body

Response