Create Bulk Employee Checks

Time Status User Agent
Make a request to see history.

URL Expired

The URL for this request expired after 30 days.

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

attributes type description
success boolean Response status
data object Returns a corresponding job_id
and an array of Employee Check Objects
errors array Contains a list of error objects which consists of:
message: Error message
code: Error code as described in Error codes

companyID

string

required

Company ID of the employer

employeeChecks

array of objects

Array of employee check objects

employeeChecks

ADD object

``200 200

``400 400


curl --request POST \
 
     --url https://api.zeal.com/employeeChecks \
 
     --header 'accept: application/json' \
 
     --header 'content-type: application/json'

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

application/json

200 - Result400 - Result