Get Employee Tax Parameter Summary

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

post/employees/getTaxParameterSummary

Request

Base URL
https://api.zeal.com
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/zeal/apis/zeal-api/docs/employees/getTaxParameterSummary/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

employeeIDstring required

ID of the Employee

companyIDstring required

ID of the employer that the Employee belongs to

jurisdictionsstring[]

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

effectiveDatestring 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

successboolean

Example response

{
  "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
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.