Employee Check Object

attribute	type	description
employeeCheckID	string	Employee Check ID
employerCheckID	string	ID of employer check that contains this employee check
status	string	Holds one of the following values: `pendingpre-processedprocessedvoidedfailed`
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	string	Date of Check Date for this employee check, in the ISO-8601 date format YYYY-MM-DD
approval_required	booleanoptional	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	booleanoptional	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 6 disbursement methods: Direct Deposit, Download Check, Physical Check, Prepaid, Paycards (Early Access), and Instant Pay (Early Access). More information on these can be found at the bottom of the page. Show disbursement fields:method (type: string, default: `direct_deposit`) history (type: array)Provides an array of transaction updatesstatus (type: string) Provides an up-to-date status of the payment. The `status` will hold one of the following values:`pending`: Status of all checks until net pay has been started`settled` - Funds have successfully settled in employee’s account`void` - When an Employer pays out the wrong person or the wrong amount and wants to void the check`returned` - Net pay did not successfully get disbursed`refunded` - Status of checks that failed but then the employer wants to pay out in-house (only applicable to direct deposit payments)`canceled` - The check got canceled due to going to an inactive user or having a transaction going to a watchlist match (only applicable to direct deposit payments)
gross_pay	number	Gross pay for employee based on shifts
net_pay	number	Net pay for employee (total pay after taxes)
deductions	array	List of deductions object applied to this employee check. See The Deduction Object
taxes	array	List of tax breakdown processed check Show taxes fields `name` - Name of the specific tax parameter `paidBy` - Specifies whether this was withheld by employee or employer `codename` - The specified code of the tax parameter `amount` - Amount of tax withheld
total_employee_taxes	number	Total amount of employee taxesprocessed check
total_employer_taxes	number	Total amount of employer taxesprocessed check
totals	object	Object displaying the following totals: Show totals fields `gross_earnings` - Total gross earnings of the check `gross_pay` - Total gross pay of the check `net_pay` - Total net pay of the check `employer_taxes` - Total employer taxes of the check `employee_deductions` - Total amount of employee deductions applied to the check, if any `employee_garnishments` - Total amount of employee garnishments applied to the check, if any `employer_deductions` - Total amount of employer deductions applied to the check, if any `company debit`- The total amount to be debited from the company bank account for this check `company_cash_requirement` - The total requirement amount for the company to fulfill the 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.
flsa_ot_recommendation	boolean	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	The ACH speed of the check, accepts `two_day`, `one_day`, `one_day_no_reserve`, or `zero_day_no_reserve` as values (Early Access)
triggered	boolean	Whether a disbursement has been triggered. Only applicable if disbursement method is `paycard` or `instant_pay`
triggered_at	datetime	Timestamp of when the disbursement was triggered, in the ISO-8601 format in UTC.

Types of Disbursement Methods

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.

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.

Physical check: For employees where net pay speed delivery is not an issue, and who prefer to be paid with a physical, mailed check instead of the download check or direct deposit methods. We do not include the net pay amount 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 “phsyical 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 physical check is created on the check date, and sent to the home address listed for the employee in Zeal. Its arrival time will depend on the location of the employee.

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.

Paycard: If an employee has a paycard, the paycard disbursement method can be used to direct funds to the existing paycard. This allows for instantaneous payout and does not depend on ACH timings and delays. Note: This is only available for Paycards product (Early Access)

Instant Pay: If an employee has an Instant Pay wallet, the instant_pay disbursement method can be used to direct funds to their wallet. This allows for instantaneous payout and does not depend on ACH timings and delays. Note: This is only available for Instant Pay product (Early Access)