Set Employee Tax Parameters

Time	Status	User Agent
Make a request to see history.

URL Expired

The URL for this request expired after 30 days.

After getting the tax parameter definitions from Zeal, you can store effectively dated tax parameters for an employee. Zeal will only use valid tax parameters set here or the defaults (outlined in the definitions endpoint).

Returns Skip link to Returns

attribute	type	description
employeeID	string	ID of the Employee being updated
federalParameters	array	List of Tax Parameter Show child attributes code type: string description: codename of tax parameter value type: string description: Value for the given tax parameter jurisdiction type: string description: "US" for federal effectiveDate type: string description: effective date of the tax parameter
stateParameters	array	List of Tax Parameter Show child attributes code type: string description: codename of tax parameter value type: string description: Value for the given tax parameter jurisdiction type: string description: example "CA" for state effectiveDate type: string description: effective date of the tax parameter
errors	array	Contains list of error objects which consists of: `message`: Error message `code`: Error code as described in Error codes

employeeID

string

required

ID of the Employee being updated

companyID

string

required

ID of the company that the employee belongs to

federalParameters

array of objects

required

An array of Tax Parameter entries

federalParameters* ADD object

stateParameters

array of objects

An array of state Tax Parameter entries

stateParameters ADD object

effectiveDate

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

``200 200

``400 400

Updated 7 months ago

Shell


xxxxxxxxxx

{

"employeeID": "6547etrc312314213",

"companyID": "123rwqeq123123",

"federalParameters": [\
\
    {\
\
      "code": "FILINGSTATUS",\
\
      "jurisdiction": "US",\
\
      "value": "H"\
\
    }\
\
  ],

"stateParameters": [\
\
    {\
\
      "code": "FILINGSTATUS",\
\
      "jurisdiction": "CA",\
\
      "value": "H"\
\
    },\
\
    {\
\
      "code": "REGULAR_ALLOWANCES",\
\
      "jurisdiction": "CA",\
\
      "value": "1"\
\
    },\
\
    {\
\
      "code": "SUTA_CA_EXEMPT",\
\
      "jurisdiction": "CA",\
\
      "value": "NO_REPORTING"\
\
    }\
\
  ]

}

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200 - Result400 - Result

Updated7 months ago