v1

latestOpenAPI 3.1.02026-07-2414339465.7 KB

Create Bulk Employee Checks

Create a batch of employee checks.

post/employeeChecks

Request body

companyIDstring required

Company ID of the employer

Response

200

successboolean

testModeboolean

Example response

{
  "data": {
    "success": true,
    "created_checks": [
      {
        "employeeCheckID": "fbd359a66e8f4ae0a3erer3bcab9ada6063",
        "companyID": "fc235fcc12ae4c6cce4082f357715bcfa",
        "employeeID": "6cc3cc3f37c91f5f123c25cde490e",
        "status": "pending",
        "first_name": "Erlich",
        "last_name": "Bachman",
        "reportingPeriodID": "5ecee24ac2b00264c105ab97",
        "check_date": "2024-05-15",
        "speed": "two_day",
        "metadata": {
          "newKey": "New Value"
        },
        "disbursement": {
          "method": "download_check"
        },
        "gross_pay": 300,
        "totals": {
          "gross_pay": 300
        },
        "shifts": [
          {
            "shiftID": "7ea23a1c34b245dde1150bffed65d686",
            "employeeID": "6cc3cc3f37c91f5f123c25cde490e",
            "employeeCheckID": "fbd359a66e8f4ae0a3erer3bcab9ada6063",
            "first_name": "Erlich",
            "last_name": "Bachman",
            "time": "2024-09-27T19:38:55Z",
            "hourly": {
              "hours": 10,
              "wage": 30
            }
          }
        ]
      }
    ]
  },
  "success": true
}