Create Bulk Employee Checks (Beta)

Create an array of employee checks as a payroll run in Zeal. 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. This endpoint returns a job_id that can be passed in the Get Employee Checks endpoint.

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 earnings.

If an employee check is not approved by the processing date, it will stay as pending and will not be processed.
Note: this endpoint has a cap of 100 employee checks.

Returns

Returns response status and the new Employee Check Object

attributestypedescription
successbooleanResponse status
dataobjectReturns a corresponding job_id
and an array of Employee Check Objects
errorsarrayContains list of error objects which consists of:
message: Error message
code: Error code as described in Error codes
Language
Authentication
Header
Click Try It! to start a request and see the response here!