Create Employee Check

POST

employeeCheck

curl --request POST \
  --url https://api.zeal.com/employeeCheck \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "approval_required": true,
  "disbursement": {
    "method": "direct_deposit"
  },
  "shifts": [
    {
      "hourly": {
        "hours": 20,
        "wage": 30
      },
      "time": "2022-02-10"
    }
  ],
  "reportingPeriodID": "61d5533c8fc6b7af3bfc2ff3",
  "check_date": "2022-02-15",
  "companyID": "fc235f012bae46aa8a082f347715bcfa",
  "employeeID": "62547a2228a58200241e2b42"
}
'

import requests

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

payload = {
    "approval_required": True,
    "disbursement": { "method": "direct_deposit" },
    "shifts": [
        {
            "hourly": {
                "hours": 20,
                "wage": 30
            },
            "time": "2022-02-10"
        }
    ],
    "reportingPeriodID": "61d5533c8fc6b7af3bfc2ff3",
    "check_date": "2022-02-15",
    "companyID": "fc235f012bae46aa8a082f347715bcfa",
    "employeeID": "62547a2228a58200241e2b42"
}
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({
    approval_required: true,
    disbursement: {method: 'direct_deposit'},
    shifts: [{hourly: {hours: 20, wage: 30}, time: '2022-02-10'}],
    reportingPeriodID: '61d5533c8fc6b7af3bfc2ff3',
    check_date: '2022-02-15',
    companyID: 'fc235f012bae46aa8a082f347715bcfa',
    employeeID: '62547a2228a58200241e2b42'
  })
};

fetch('https://api.zeal.com/employeeCheck', 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/employeeCheck",
  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([
    'approval_required' => true,
    'disbursement' => [
        'method' => 'direct_deposit'
    ],
    'shifts' => [
        [
                'hourly' => [
                                'hours' => 20,
                                'wage' => 30
                ],
                'time' => '2022-02-10'
        ]
    ],
    'reportingPeriodID' => '61d5533c8fc6b7af3bfc2ff3',
    'check_date' => '2022-02-15',
    'companyID' => 'fc235f012bae46aa8a082f347715bcfa',
    'employeeID' => '62547a2228a58200241e2b42'
  ]),
  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/employeeCheck"

	payload := strings.NewReader("{\n  \"approval_required\": true,\n  \"disbursement\": {\n    \"method\": \"direct_deposit\"\n  },\n  \"shifts\": [\n    {\n      \"hourly\": {\n        \"hours\": 20,\n        \"wage\": 30\n      },\n      \"time\": \"2022-02-10\"\n    }\n  ],\n  \"reportingPeriodID\": \"61d5533c8fc6b7af3bfc2ff3\",\n  \"check_date\": \"2022-02-15\",\n  \"companyID\": \"fc235f012bae46aa8a082f347715bcfa\",\n  \"employeeID\": \"62547a2228a58200241e2b42\"\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/employeeCheck")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"approval_required\": true,\n  \"disbursement\": {\n    \"method\": \"direct_deposit\"\n  },\n  \"shifts\": [\n    {\n      \"hourly\": {\n        \"hours\": 20,\n        \"wage\": 30\n      },\n      \"time\": \"2022-02-10\"\n    }\n  ],\n  \"reportingPeriodID\": \"61d5533c8fc6b7af3bfc2ff3\",\n  \"check_date\": \"2022-02-15\",\n  \"companyID\": \"fc235f012bae46aa8a082f347715bcfa\",\n  \"employeeID\": \"62547a2228a58200241e2b42\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"approval_required\": true,\n  \"disbursement\": {\n    \"method\": \"direct_deposit\"\n  },\n  \"shifts\": [\n    {\n      \"hourly\": {\n        \"hours\": 20,\n        \"wage\": 30\n      },\n      \"time\": \"2022-02-10\"\n    }\n  ],\n  \"reportingPeriodID\": \"61d5533c8fc6b7af3bfc2ff3\",\n  \"check_date\": \"2022-02-15\",\n  \"companyID\": \"fc235f012bae46aa8a082f347715bcfa\",\n  \"employeeID\": \"62547a2228a58200241e2b42\"\n}"

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

{
  "success": true,
  "data": {
    "employeeCheckID": "9827465739",
    "employerCheckID": null,
    "companyID": "1b5n28nrideucd24",
    "employeeID": "1234567890",
    "status": "pending",
    "is_salary": false,
    "first_name": "erlich",
    "middle_initial": null,
    "last_name": "bachman",
    "reportingPeriodID": "0982349584387523234",
    "check_date": "2020-01-07",
    "approval_required": true,
    "approved": false,
    "metadata": {
      "checkCorrelationID": "1"
    },
    "disbursement": {
      "method": "direct_deposit"
    },
    "disbursement_status": "pending",
    "gross_pay": 40,
    "net_pay": null,
    "taxes": null,
    "total_employer_taxes": null,
    "total_employee_taxes": null,
    "totals": {
      "gross_earnings": 0,
      "gross_pay": 40,
      "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": [
      {
        "employeeID": "1234567890",
        "shiftID": "123456789",
        "first_name": "erlich",
        "last_name": "bachman",
        "metadata": {},
        "time": "2019-12-12T10:00:00",
        "hourly": {
          "hours": 2,
          "wage": 20
        }
      }
    ],
    "currency": "USD"
  }
}

"{\n    \"success\": false,\n    \"errors\": [\n        {\n            \"message\": \"Employee Check for this employee and check date already exists. Please choose another check date or add shifts to the existing check.\",\n            \"code\": 32\n        }\n    ]\n}"

Employee checks are the core payroll object in Zeal. Each check represents a single payment to a W-2 employee and contains the shifts (units of work and earnings) that determine gross pay, tax withholding, and net disbursement. See the Reporting Period Object and Shift Object for the objects this endpoint references.

Authorizations

Authorization

string

header

required

Body

application/json

companyID

string

required

Company ID of the employer

employeeID

string

required

Employee ID of the employee

reportingPeriodID

string

required

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

check_date

string<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.

shifts

object[]

required

Array of shift objects. The set of shifts attached to this employee check describe the work done and the earnings owed to this employee. You can only create shifts by creating an employee check (through this endpoint). However, you can edit and delete shifts that are still pending. Also supports various earning components as objects. See Shift Object [blocked] for more information.

Show child attributes

approval_required

boolean

default:false

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 [blocked]

disbursement

object

This object includes information regarding how the net pay is disbursed to the employee. Zeal supports Direct Deposit, Download Check, Physical Check, Prepaid, Instant Pay and Paycard (Early Access) disbursement methods.

Show child attributes

flsa_ot_recommendation

boolean

default:false

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

enum<string>

default:two_day

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

Available options:

two_day,

one_day,

one_day_no_reserve,

zero_day_no_reserve

apply_employee_deductions

boolean

default:false

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

metadata

object

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 [blocked]

Response

200

success

boolean

default:true

Example:

true

data

object

Show child attributes

Create Employee Check

curl --request POST \
  --url https://api.zeal.com/employeeCheck \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "approval_required": true,
  "disbursement": {
    "method": "direct_deposit"
  },
  "shifts": [
    {
      "hourly": {
        "hours": 20,
        "wage": 30
      },
      "time": "2022-02-10"
    }
  ],
  "reportingPeriodID": "61d5533c8fc6b7af3bfc2ff3",
  "check_date": "2022-02-15",
  "companyID": "fc235f012bae46aa8a082f347715bcfa",
  "employeeID": "62547a2228a58200241e2b42"
}
'

import requests

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

payload = {
    "approval_required": True,
    "disbursement": { "method": "direct_deposit" },
    "shifts": [
        {
            "hourly": {
                "hours": 20,
                "wage": 30
            },
            "time": "2022-02-10"
        }
    ],
    "reportingPeriodID": "61d5533c8fc6b7af3bfc2ff3",
    "check_date": "2022-02-15",
    "companyID": "fc235f012bae46aa8a082f347715bcfa",
    "employeeID": "62547a2228a58200241e2b42"
}
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({
    approval_required: true,
    disbursement: {method: 'direct_deposit'},
    shifts: [{hourly: {hours: 20, wage: 30}, time: '2022-02-10'}],
    reportingPeriodID: '61d5533c8fc6b7af3bfc2ff3',
    check_date: '2022-02-15',
    companyID: 'fc235f012bae46aa8a082f347715bcfa',
    employeeID: '62547a2228a58200241e2b42'
  })
};

fetch('https://api.zeal.com/employeeCheck', 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/employeeCheck",
  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([
    'approval_required' => true,
    'disbursement' => [
        'method' => 'direct_deposit'
    ],
    'shifts' => [
        [
                'hourly' => [
                                'hours' => 20,
                                'wage' => 30
                ],
                'time' => '2022-02-10'
        ]
    ],
    'reportingPeriodID' => '61d5533c8fc6b7af3bfc2ff3',
    'check_date' => '2022-02-15',
    'companyID' => 'fc235f012bae46aa8a082f347715bcfa',
    'employeeID' => '62547a2228a58200241e2b42'
  ]),
  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/employeeCheck"

	payload := strings.NewReader("{\n  \"approval_required\": true,\n  \"disbursement\": {\n    \"method\": \"direct_deposit\"\n  },\n  \"shifts\": [\n    {\n      \"hourly\": {\n        \"hours\": 20,\n        \"wage\": 30\n      },\n      \"time\": \"2022-02-10\"\n    }\n  ],\n  \"reportingPeriodID\": \"61d5533c8fc6b7af3bfc2ff3\",\n  \"check_date\": \"2022-02-15\",\n  \"companyID\": \"fc235f012bae46aa8a082f347715bcfa\",\n  \"employeeID\": \"62547a2228a58200241e2b42\"\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/employeeCheck")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"approval_required\": true,\n  \"disbursement\": {\n    \"method\": \"direct_deposit\"\n  },\n  \"shifts\": [\n    {\n      \"hourly\": {\n        \"hours\": 20,\n        \"wage\": 30\n      },\n      \"time\": \"2022-02-10\"\n    }\n  ],\n  \"reportingPeriodID\": \"61d5533c8fc6b7af3bfc2ff3\",\n  \"check_date\": \"2022-02-15\",\n  \"companyID\": \"fc235f012bae46aa8a082f347715bcfa\",\n  \"employeeID\": \"62547a2228a58200241e2b42\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"approval_required\": true,\n  \"disbursement\": {\n    \"method\": \"direct_deposit\"\n  },\n  \"shifts\": [\n    {\n      \"hourly\": {\n        \"hours\": 20,\n        \"wage\": 30\n      },\n      \"time\": \"2022-02-10\"\n    }\n  ],\n  \"reportingPeriodID\": \"61d5533c8fc6b7af3bfc2ff3\",\n  \"check_date\": \"2022-02-15\",\n  \"companyID\": \"fc235f012bae46aa8a082f347715bcfa\",\n  \"employeeID\": \"62547a2228a58200241e2b42\"\n}"

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

{
  "success": true,
  "data": {
    "employeeCheckID": "9827465739",
    "employerCheckID": null,
    "companyID": "1b5n28nrideucd24",
    "employeeID": "1234567890",
    "status": "pending",
    "is_salary": false,
    "first_name": "erlich",
    "middle_initial": null,
    "last_name": "bachman",
    "reportingPeriodID": "0982349584387523234",
    "check_date": "2020-01-07",
    "approval_required": true,
    "approved": false,
    "metadata": {
      "checkCorrelationID": "1"
    },
    "disbursement": {
      "method": "direct_deposit"
    },
    "disbursement_status": "pending",
    "gross_pay": 40,
    "net_pay": null,
    "taxes": null,
    "total_employer_taxes": null,
    "total_employee_taxes": null,
    "totals": {
      "gross_earnings": 0,
      "gross_pay": 40,
      "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": [
      {
        "employeeID": "1234567890",
        "shiftID": "123456789",
        "first_name": "erlich",
        "last_name": "bachman",
        "metadata": {},
        "time": "2019-12-12T10:00:00",
        "hourly": {
          "hours": 2,
          "wage": 20
        }
      }
    ],
    "currency": "USD"
  }
}

"{\n    \"success\": false,\n    \"errors\": [\n        {\n            \"message\": \"Employee Check for this employee and check date already exists. Please choose another check date or add shifts to the existing check.\",\n            \"code\": 32\n        }\n    ]\n}"

Introduction

Webhooks

Zeal Components

Companies

Company Onboarding

Reserve Accounts

Customer Accounts (Early Access)

Taxable Locations

Work Locations

Employees

Employee Deduction Templates

Employee Onboarding

Bank Accounts

Custom Attributes

Paperwork API

Employee Checks

Contractors

Contractor Onboarding

Contractor Payment Deductions

Payment Items

Contractor Payments

Paycards

Instant Pay

Employer Checks

Preview

Embedded HR

Reports

Documents

Create Employee Check

Authorizations

Body

Response