| 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:
`pending``pre-processed``processed``voided``failed` | | is_salary | boolean | Whether this check was created by Zeal's Autopilot Salary feature. See [The Employee Object](https://docs.zeal.com/reference/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 | 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 the 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 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 updates
**status** (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](https://docs.zeal.com/reference/the-deduction-object) | | taxes | array | List of tax breakdown
processed checkShow 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 taxes
processed check | | total_employer_taxes | number | Total amount of employer taxes
processed 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](https://docs.zeal.com/reference/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.