Create Bulk Employee Checks

Create a batch of employee checks.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

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.


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 pending and will not be processed.

Note: This endpoint has a cap of 100 employee checks.

Returns

attributestypedescription
successbooleanResponse status
dataobjectReturns a corresponding job_id
and an array of Employee Check Objects
errorsarrayContains a list of error objects which consists of:
message: Error message
code: Error code as described in Error codes
Body Params
string
required

Company ID of the employer

employeeChecks
array of objects

Array of employee check objects

employeeChecks
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json