In this step, the company's admin reviews or changes the employee's Tax Setup information in the employee's profile before running the first payroll. The company's admin verifies this information by calling two endpoints. However, for a successful call of both endpoints, the step status must be in Waiting.
The endpoints that the company's admin calls to verify the employee's tax information are:
The GET request to this endpoint returns the employee's pre-filled Tax Setup details. After the employee onboards this information into the system, calling this endpoint returns the onboarded information.
Returned information, which is an array of objects, for the company's admin to review includes the following:
These objects are unique data fields that have peculiar attributes and behaviors. The fields usually store information about the specific object. eg., Residential Address Object contains fields such as Address Line 1, City, State, Zip code, etc.
This object contains verifiable information about the employee's home location. The authenticity of this address was important during the employee's tax setup.
This object also contains information about the company's primary work location.
This object contains data fields that store the employee's tax definition. The data fields include Filing status, Tax exemptions, Deductions, and Extra Withholdings.
This is an array of objects in itself. Each object contains the name of the tax and the tax items, which is also an array of objects. The tax items return information, such as the name of the tax item, the description of the tax item, and the employee's assigned values for the items.
For example, a state tax object may contain two state taxes (New York and Mississipi), which are objects containing the name of taxes peculiar to the state (eg. SUTA Taxes) and items of those taxes. The items of these taxes now contains an array of objects which include the name of these tax items, their description, and their values.
After the company's admin has reviewed the employee's Tax Setup information, the admin completes the step by making a PUT request to the Finish Tax Setup Step endpoint. A successful call of this endpoint onboards the employee's Tax Setup details for a successful payroll run.
Updated 6 months ago