Get Employee Tax Parameter Summary

Retrieve a list of an employee's tax withholding parameters.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Get all tax parameters for an Employee that Zeal will use on a given date.

Returns

attributetypedescription
employeeIDstringID of the employee
effectiveDatedatetimeEffective date of the tax parameters in this request.
jurisdictionsarrayList of jurisdictions, "US" for federal, or State(2 letter abbreviation)
paramsarrayList of effective Tax Parameters on a given date for the employee with flags, indicating if it is user provided or default value
Show child attributes code
type: string
description: codename of tax parametertype
type: string
description: a string representing the type of the parameter. We currently use options, strings, numbers, dollars, and booleanvalue
type: string
description: Value that the parameter is set tovalueDescription
type: string
description: Human readable description of the value setisDefaultValue
type: boolean
description: Set to true if value is set by default
  • isUserProvidedValue* (BETA)
    type: string
    description: Set to true if value is provided by the Employee
Body Params
string
required

ID of the Employee

string
required

ID of the employer that the Employee belongs to

jurisdictions
array of strings

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

jurisdictions
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

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json