v1

latestOpenAPI 3.1.02026-07-2414339465.7 KB

Set Employee Tax Parameters

Set an employee's tax withholding parameters.

post/employees/setTaxParameters

Request body

employeeIDstring required

ID of the Employee being updated

companyIDstring required

ID of the company that the employee belongs to

effectiveDatestring date

Effective Date of the tax parameters in this request. Only accepts YYYY-MM-DD date format. This effective date will apply to any net new changed parameters unless the date is explicitly declared in the individual parameter object. Note: Will default to the time of the request

Response

200

successboolean

Example response

{
  "success": true,
  "data": {
    "employeeID": "6547etrc312314213",
    "federalParameters": [
      {
        "_id": "660dbaf23c1e233277df7f",
        "code": "FILINGSTATUS",
        "value": "H",
        "jurisdiction": "US",
        "effectiveDate": "2024-04-03T00:00:00.000Z"
      }
    ],
    "stateParameters": [
      {
        "_id": "660dbaf23c1e233277df7f",
        "code": "FILINGSTATUS",
        "value": "H",
        "jurisdiction": "CA",
        "effectiveDate": "2024-04-03T00:00:00.000Z"
      }
    ]
  }
}