Skip to main content
PATCH
Update Employee Check
Only checks with a status of pending can be updated. Once a check enters processing, it can no longer be modified via this endpoint.

Authorizations

Authorization
string
header
required

Body

application/json
companyID
string
required

Company ID of the employer

employeeCheckID
string
required

ID of Employee Check

reportingPeriodID
string

Reporting Period ID of Employee Check

check_date
string<date>

Date of Employee Check

approval_required
boolean

Whether manual approval is required for this Employee Check.

approved
boolean

Set this field to true in order to approve this Employee Check

metadata
object

Set the metadata object of this Employee Check

disbursement
object

Set the disbursement method of check - Zeal supports Direct Deposit, Download Check, Physical Check, Prepaid, and Paycard (Early Access) disbursement methods

Response

200

success
boolean
default:true
Example:

true

data
object