Get Employee Tax Parameter Summary
| Time | Status | User Agent | |
|---|---|---|---|
| Make a request to see history. |
URL Expired
The URL for this request expired after 30 days.
Get all tax parameters for an Employee that Zeal will use on a given date.
Returns
| attribute | type | description |
|---|---|---|
| employeeID | string | ID of the employee |
| effectiveDate | datetime | Effective date of the tax parameters in this request. |
| jurisdictions | array | List of jurisdictions, "US" for federal, or State(2 letter abbreviation) |
| params | array | List of effective Tax Parameters on a given date for the employee with flags, indicating if it is user provided or default value |
| code | string | codename of tax parameter |
| type | string | a string representing the type of the parameter. We currently use options, strings, numbers, dollars, and boolean |
| value | string | Value that the parameter is set to |
| valueDescription | string | Human readable description of the value set |
| isDefaultValue | boolean | Set to true if value is set by default |
| - isUserProvidedValue* (BETA) | ||
| type: string | ||
description: Set to true if value is provided by the Employee |
| employeeID | string | required | ID of the Employee | | companyID | 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 | ADD string | | | | effectiveDate | 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 |
``200 200
``400 400
curl --request POST \
--url https://api.zeal.com/employees/getTaxParameterSummary \
--header 'accept: application/json' \
--header 'content-type: application/json'
``200 - Result``400 - Result