Employee Check Object

attribute

type

description

employeeCheckID

string

Employee Check ID

employerCheckID

string

ID of employer check that contains this employee check

processed check

status

string

Holds one of the following values:
pending
pre-processed
processed
voided
failed

is_salary

boolean

Whether this check was created by Zeal's Autopilot Salary feature. See The Employee Object for more information about Autopilot

employeeID

string

Zeal Employee ID

companyID

string

Zeal Company ID

check_date

datetime

Datetime of Check Date for this employee check, in the ISO-8601 format in UTC

approval_required

boolean

optional

Whether manual approval is required for this check or not.
By default, Zeal automatically processes the check the day before the check date. However, if approval is required and the check is not approved by time of processing, Zeal will NOT process the check

approved

boolean

optional

Whether this check has been manually approved or not (only relevant if approval_required is true)

first_name

string

First name of the employee this check is for

middle_initial

string

Middle initial of the employee this check is for

last_name

string

Last name of the employee this check is for

reportingPeriodID

string

Reporting Period ID

disbursement

object

This object includes information regarding how the net pay is disbursed to the employee. Zeal supports three disbursement methods, Direct Deposit, Prepaid and Download Check. More information on these can be found at the bottom of the page

Show disbursement fields **method** type: string default: `direct_deposit` description: There are 3 options: - `direct_deposit`: Zeal will make a direct deposit to the employee's bank account - `download_check`: Zeal will give you the link to a PDF version of the check (see below for more fields) - `prepaid`: Zeal will not debit net pay from the employer account to pay the employee, the employer is responsible for paying the employee directly e.g. in cash, check etc.
Download Check specific fields

link
type: string
description: Link to a PDF version of the employee's check. It is at the employee's discretion as to how to cash the check.

processed check

gross_pay

number

Gross pay for employee based on shifts

net_pay

number

Net pay for employee (total pay after taxes)
processed check

deductions

array

List of deductions object applied to this employee check. See The Deduction Object

taxes

array

List of tax breakdown

processed check

total_employee_taxes

number

Total amount of employee taxes

processed check

total_employer_taxes

number

Total amount of employer taxes

processed check

metadata

object

Custom object you can attach to the employee check object. This is useful for storing additional information about the object in a custom, structured format. See Metadata

shifts

array

List of shifts objects associated with this employee check.

Types of Disbursements

Prepaid: Prepaid is used when the employer does want to use direct deposit, but instead has an alternate method of paying their employees. In that case, Zeal does not include net pay from this employee check in the Company Debit number of the employer check (i.e. net pay is not debited from the employer’s bank account if employee check is prepaid). Instead the employer is shown the net pay they owe their employees after taking out the appropriate taxes.

The employer is responsible for disbursing net pay outside of Zeal.

Download check: Checks are useful for certain employees who prefer to be paid in checks instead of direct deposits. We do not include net pay from this employee check in the Company Debit number of the employer check (i.e. net pay is not debited from the employer’s bank account if employee check is “download check”).

Net pay is only taken out of the employers bank account when the employee cashes the check. The account / routing number is that of the employers.

The link for downloading the check becomes available by check date on the employee dashboard.

Direct Deposit: The most convenient disbursement type is to do a direct deposit into the employee's bank account, from the employers. In this case, Zeal will include the employee net pay in the Company Debit number of the employer check (i.e. net pay is debited from the employer's bank account.

The net pay is deposited into the employee bank account at check date