Create Bulk Employee Checks

curl --request POST \
  --url https://api.zeal.com/employeeChecks \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "companyID": "fc235fcc12ae4c6cce4082f357715bcfa",
  "employeeChecks": [
    {
      "employeeID": "6cc3cc3f37c91f5f123c25cde490e",
      "reportingPeriodID": "235ccd0c9291f5f2b00c25de490e",
      "check_date": "2024-03-27",
      "approval_required": true,
      "shifts": [
        {
          "time": "2024-03-27T19:38:55.527Z",
          "hourly": {
            "hours": 5,
            "wage": 40,
            "custom_name": "example"
          }
        }
      ]
    },
    {
      "employeeID": "5cc33f3791f52325d2e490e",
      "reportingPeriodID": "235cd09291f5f2b0025de490e",
      "check_date": "2022-09-27",
      "approval_required": true,
      "shifts": [
        {
          "time": "2024-03-27T19:38:55.527Z",
          "hourly": {
            "hours": 4,
            "wage": 20,
            "custom_name": "example"
          }
        }
      ]
    }
  ]
}
'

import requests

url = "https://api.zeal.com/employeeChecks"

payload = {
    "companyID": "fc235fcc12ae4c6cce4082f357715bcfa",
    "employeeChecks": [
        {
            "employeeID": "6cc3cc3f37c91f5f123c25cde490e",
            "reportingPeriodID": "235ccd0c9291f5f2b00c25de490e",
            "check_date": "2024-03-27",
            "approval_required": True,
            "shifts": [
                {
                    "time": "2024-03-27T19:38:55.527Z",
                    "hourly": {
                        "hours": 5,
                        "wage": 40,
                        "custom_name": "example"
                    }
                }
            ]
        },
        {
            "employeeID": "5cc33f3791f52325d2e490e",
            "reportingPeriodID": "235cd09291f5f2b0025de490e",
            "check_date": "2022-09-27",
            "approval_required": True,
            "shifts": [
                {
                    "time": "2024-03-27T19:38:55.527Z",
                    "hourly": {
                        "hours": 4,
                        "wage": 20,
                        "custom_name": "example"
                    }
                }
            ]
        }
    ]
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    companyID: 'fc235fcc12ae4c6cce4082f357715bcfa',
    employeeChecks: [
      {
        employeeID: '6cc3cc3f37c91f5f123c25cde490e',
        reportingPeriodID: '235ccd0c9291f5f2b00c25de490e',
        check_date: '2024-03-27',
        approval_required: true,
        shifts: [
          {
            time: '2024-03-27T19:38:55.527Z',
            hourly: {hours: 5, wage: 40, custom_name: 'example'}
          }
        ]
      },
      {
        employeeID: '5cc33f3791f52325d2e490e',
        reportingPeriodID: '235cd09291f5f2b0025de490e',
        check_date: '2022-09-27',
        approval_required: true,
        shifts: [
          {
            time: '2024-03-27T19:38:55.527Z',
            hourly: {hours: 4, wage: 20, custom_name: 'example'}
          }
        ]
      }
    ]
  })
};

fetch('https://api.zeal.com/employeeChecks', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.zeal.com/employeeChecks",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'companyID' => 'fc235fcc12ae4c6cce4082f357715bcfa',
    'employeeChecks' => [
        [
                'employeeID' => '6cc3cc3f37c91f5f123c25cde490e',
                'reportingPeriodID' => '235ccd0c9291f5f2b00c25de490e',
                'check_date' => '2024-03-27',
                'approval_required' => true,
                'shifts' => [
                                [
                                                                'time' => '2024-03-27T19:38:55.527Z',
                                                                'hourly' => [
                                                                                                                                'hours' => 5,
                                                                                                                                'wage' => 40,
                                                                                                                                'custom_name' => 'example'
                                                                ]
                                ]
                ]
        ],
        [
                'employeeID' => '5cc33f3791f52325d2e490e',
                'reportingPeriodID' => '235cd09291f5f2b0025de490e',
                'check_date' => '2022-09-27',
                'approval_required' => true,
                'shifts' => [
                                [
                                                                'time' => '2024-03-27T19:38:55.527Z',
                                                                'hourly' => [
                                                                                                                                'hours' => 4,
                                                                                                                                'wage' => 20,
                                                                                                                                'custom_name' => 'example'
                                                                ]
                                ]
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.zeal.com/employeeChecks"

	payload := strings.NewReader("{\n  \"companyID\": \"fc235fcc12ae4c6cce4082f357715bcfa\",\n  \"employeeChecks\": [\n    {\n      \"employeeID\": \"6cc3cc3f37c91f5f123c25cde490e\",\n      \"reportingPeriodID\": \"235ccd0c9291f5f2b00c25de490e\",\n      \"check_date\": \"2024-03-27\",\n      \"approval_required\": true,\n      \"shifts\": [\n        {\n          \"time\": \"2024-03-27T19:38:55.527Z\",\n          \"hourly\": {\n            \"hours\": 5,\n            \"wage\": 40,\n            \"custom_name\": \"example\"\n          }\n        }\n      ]\n    },\n    {\n      \"employeeID\": \"5cc33f3791f52325d2e490e\",\n      \"reportingPeriodID\": \"235cd09291f5f2b0025de490e\",\n      \"check_date\": \"2022-09-27\",\n      \"approval_required\": true,\n      \"shifts\": [\n        {\n          \"time\": \"2024-03-27T19:38:55.527Z\",\n          \"hourly\": {\n            \"hours\": 4,\n            \"wage\": 20,\n            \"custom_name\": \"example\"\n          }\n        }\n      ]\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.zeal.com/employeeChecks")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"companyID\": \"fc235fcc12ae4c6cce4082f357715bcfa\",\n  \"employeeChecks\": [\n    {\n      \"employeeID\": \"6cc3cc3f37c91f5f123c25cde490e\",\n      \"reportingPeriodID\": \"235ccd0c9291f5f2b00c25de490e\",\n      \"check_date\": \"2024-03-27\",\n      \"approval_required\": true,\n      \"shifts\": [\n        {\n          \"time\": \"2024-03-27T19:38:55.527Z\",\n          \"hourly\": {\n            \"hours\": 5,\n            \"wage\": 40,\n            \"custom_name\": \"example\"\n          }\n        }\n      ]\n    },\n    {\n      \"employeeID\": \"5cc33f3791f52325d2e490e\",\n      \"reportingPeriodID\": \"235cd09291f5f2b0025de490e\",\n      \"check_date\": \"2022-09-27\",\n      \"approval_required\": true,\n      \"shifts\": [\n        {\n          \"time\": \"2024-03-27T19:38:55.527Z\",\n          \"hourly\": {\n            \"hours\": 4,\n            \"wage\": 20,\n            \"custom_name\": \"example\"\n          }\n        }\n      ]\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.zeal.com/employeeChecks")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"companyID\": \"fc235fcc12ae4c6cce4082f357715bcfa\",\n  \"employeeChecks\": [\n    {\n      \"employeeID\": \"6cc3cc3f37c91f5f123c25cde490e\",\n      \"reportingPeriodID\": \"235ccd0c9291f5f2b00c25de490e\",\n      \"check_date\": \"2024-03-27\",\n      \"approval_required\": true,\n      \"shifts\": [\n        {\n          \"time\": \"2024-03-27T19:38:55.527Z\",\n          \"hourly\": {\n            \"hours\": 5,\n            \"wage\": 40,\n            \"custom_name\": \"example\"\n          }\n        }\n      ]\n    },\n    {\n      \"employeeID\": \"5cc33f3791f52325d2e490e\",\n      \"reportingPeriodID\": \"235cd09291f5f2b0025de490e\",\n      \"check_date\": \"2022-09-27\",\n      \"approval_required\": true,\n      \"shifts\": [\n        {\n          \"time\": \"2024-03-27T19:38:55.527Z\",\n          \"hourly\": {\n            \"hours\": 4,\n            \"wage\": 20,\n            \"custom_name\": \"example\"\n          }\n        }\n      ]\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "success": true,
    "failed_checks": [],
    "created_checks": [
      {
        "employeeCheckID": "fbd359a66e8f4ae0a3erer3bcab9ada6063",
        "employerCheckID": null,
        "companyID": "fc235fcc12ae4c6cce4082f357715bcfa",
        "employeeID": "6cc3cc3f37c91f5f123c25cde490e",
        "status": "pending",
        "is_salary": false,
        "approval_required": false,
        "approved": false,
        "first_name": "Erlich",
        "middle_initial": null,
        "last_name": "Bachman",
        "reportingPeriodID": "5ecee24ac2b00264c105ab97",
        "check_date": "2024-05-15",
        "speed": "two_day",
        "metadata": {
          "newKey": "New Value"
        },
        "disbursement": {
          "method": "download_check",
          "history": [],
          "link": null
        },
        "taxes": [],
        "gross_pay": 300,
        "net_pay": null,
        "total_employer_taxes": null,
        "total_employee_taxes": null,
        "totals": {
          "gross_earnings": 0,
          "gross_pay": 300,
          "net_pay": 0,
          "employer_taxes": 0,
          "employee_taxes": 0,
          "employee_deductions": 0,
          "employee_garnishments": 0,
          "employer_deductions": 0,
          "company_debit": 0,
          "company_cash_requirement": 0
        },
        "shifts": [
          {
            "shiftID": "7ea23a1c34b245dde1150bffed65d686",
            "status": null,
            "employeeID": "6cc3cc3f37c91f5f123c25cde490e",
            "employeeCheckID": "fbd359a66e8f4ae0a3erer3bcab9ada6063",
            "first_name": "Erlich",
            "last_name": "Bachman",
            "time": "2024-09-27T19:38:55Z",
            "metadata": {},
            "wcc_code": null,
            "workLocationID": null,
            "customerAccountID": null,
            "flsa_ot_exempt": null,
            "hourly": {
              "hours": 10,
              "wage": 30
            }
          }
        ],
        "deductions": []
      }
    ]
  },
  "success": true,
  "testMode": false
}

{
  "data": {
    "success": true,
    "failed_checks": [
      {
        "employeeID": "6cc3cc3f37c91f5f123c25cde490e",
        "error": {
          "message": "This worker does not have a bank account. Please choose download_check or prepaid as the method of disbursement.",
          "status": 400,
          "code": 13
        }
      }
    ],
    "created_checks": []
  },
  "success": true,
  "testMode": true
}