Preview Check Data

Preview an employee check and its corresponding data including a breakdown of taxes and deductions withheld. In addition to the companyID and employeeID, Zeal requires a reportingPeriodID that describes the reporting period that this check belongs to.
See here for more information about Reporting Periods.

Creating a check also requires a Shift Object that takes in an array of various earning components such as hourly shift data, overtime, reimbursement, or various other supported earning components.

Returns

Returns response status and a JSON breakdown of total as well as individual calculated employer & employee taxes, net/gross pay, and deductions for a specific check.

attributestypedescription
successbooleanResponse status
dataobjectCalculated data corresponding to check
errorsarrayContains list of error objects which consists of:
message: Error message
code: Error code as described in Error codes
Language
Authorization
Header
Click Try It! to start a request and see the response here!