Sign in

v1

latestOpenAPI 3.1.02026-07-2414339465.7 KB

Update Employee Check

Update a pending employee check.

patch/employeeCheck

Request body

companyIDstring required

Company ID of the employer

employeeCheckIDstring required

ID of Employee Check

reportingPeriodIDstring

Reporting Period ID of Employee Check

check_datestring date

Date of Employee Check

approval_requiredboolean

Whether manual approval is required for this Employee Check.

approvedboolean

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

metadataobject

Set the metadata object of this Employee Check

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
        }
      }
    ]
  }
}