v1

latestOpenAPI 3.1.02026-07-2414339465.7 KB

Create Employee Check

Create a check for an employee.

post/employeeCheck

Request body

companyIDstring required

Company ID of the employer

employeeIDstring required

Employee ID of the employee

reportingPeriodIDstring required

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

check_datestring 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_requiredboolean

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

flsa_ot_recommendationboolean

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'two_day' | 'one_day' | 'one_day_no_reserve' | 'zero_day_no_reserve'

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

apply_employee_deductionsboolean

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

metadataobject

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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata. Metadata

Response

200

successboolean

Example response

{
  "success": true,
  "data": {
    "employeeCheckID": "9827465739",
    "companyID": "1b5n28nrideucd24",
    "employeeID": "1234567890",
    "status": "pending",
    "first_name": "erlich",
    "last_name": "bachman",
    "reportingPeriodID": "0982349584387523234",
    "check_date": "2020-01-07",
    "approval_required": true,
    "metadata": {
      "checkCorrelationID": "1"
    },
    "disbursement": {
      "method": "direct_deposit"
    },
    "disbursement_status": "pending",
    "gross_pay": 40,
    "totals": {
      "gross_pay": 40
    },
    "shifts": [
      {
        "employeeID": "1234567890",
        "shiftID": "123456789",
        "first_name": "erlich",
        "last_name": "bachman",
        "time": "2019-12-12T10:00:00",
        "hourly": {
          "hours": 2,
          "wage": 20
        }
      }
    ]
  }
}