Create Employee Check

post

https://api.zeal.com/employeeCheck

Create a check for an employee.

Body Params

companyID

string

required

Company ID of the employer

employeeID

string

required

Employee ID of the employee

reportingPeriodID

string

required

The reporting period ID that you want this employee check to belong to. See Reporting Periods

check_date

date

required

Check date for this employee check. If the check_date falls on a weekend/bank holiday, or the current time is after 2PM PST, two days before the check_date, adjust the check_date to the next valid business day. Zeal will not roll forward this date automatically.

approval_required

boolean

Defaults to false

Set to true if this check requires manual approval by the employer. Otherwise, by default, Zeal will automatically process the check on the day before the check date. You can approve the check either in the dashboard, or by using update check

disbursement

object

This object includes information regarding how the net pay is disbursed to the employee. Zeal supports Direct Deposit, Download Check, Physical Check, Prepaid, and Paycard (Early Access) disbursement methods.

shifts

array of objects

required

Array of shift objects. The set of shifts attached to this employee check describe the work done and the earnings owed to this employee. You can only create shifts by creating an employee check (through this endpoint). However, you can edit and delete shifts that are still pending. Also supports various earning components as objects. See Shift Object for more information.

shifts*

flsa_ot_recommendation

boolean

Defaults to false

If set to true, we will automatically convert the check to include our OT recommendation at the time of processing NOTE: Only applicable for FLSA Overtime Policy

speed

string

enum

Defaults to two_day

The ACH speed of the check, accepts two_day, one_day,one_day_no_reserve, or zero_day_no_reserve as values

Allowed:

apply_employee_deductions

boolean

Defaults to false

Applies a deduction to this check for each employee deduction template that is effective at the time of the check_date for the employee

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200200

400400