Employee Checks
Get Employee Check by ID
Retrieve a single employee check by its employeeCheckID.
GET
/
employeeCheck
Get Employee Checks by Employee
curl --request GET \
--url https://api.zeal.com/employeeCheck \
--header 'Authorization: <api-key>'import requests
url = "https://api.zeal.com/employeeCheck"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
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 => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.zeal.com/employeeCheck"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.zeal.com/employeeCheck")
.header("Authorization", "<api-key>")
.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::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": [
{
"employeeCheckID": "987234657",
"employerCheckID": "123456789",
"status": "processed",
"is_salary": false,
"employeeID": "0987654321",
"companyID": "123456789",
"check_date": "2020-01-07",
"approval_required": false,
"approved": false,
"metadata": {},
"disbursement": {
"method": "direct_deposit"
},
"disbursement_status": "settled",
"first_name": "peter",
"last_name": "gregory",
"reportingPeriodID": "01739fc4cfd84c2e93dba5e802d1dda1",
"gross_pay": 40,
"net_pay": 26.82,
"total_employee_taxes": 13.18,
"total_employer_taxes": 2.8,
"taxes": [
{
"name": "Employee Medicare Tax",
"paidBy": "EMPLOYEE_WITHHOLDING",
"amount": 1.16
}
],
"deductions": [],
"shifts": [
{
"shiftID": "4712c99283304b7b989179aae36b4590",
"employeeID": "1234567890",
"time": "2019-12-13T04:00:00Z",
"hourly": {
"hours": 2,
"wage": 20
},
"overtime": {
"hours": 2.5,
"wage": 30
}
}
],
"currency": "USD"
}
]
}{
"success": false,
"errors": [
{
"message": "Employee ID is not formatted correctly",
"code": 13
}
]
}This is the same underlying route as Get Employee Checks by Employee, which lists checks for an employee instead of looking up a single check - the API doesn’t distinguish these with separate routes, so each page documents the query parameters for its own intended usage. This page’s usage: pass
companyID and employeeCheckID to look up a single check.Authorizations
Query Parameters
Company ID of the employer
ID of Employee
Status to filter by. Can be pending, pre-processed, or processed
ID of reporting period to filter by
ID of the Employee Check to retrieve
Response
200
⌘I
Get Employee Checks by Employee
curl --request GET \
--url https://api.zeal.com/employeeCheck \
--header 'Authorization: <api-key>'import requests
url = "https://api.zeal.com/employeeCheck"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
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 => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.zeal.com/employeeCheck"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.zeal.com/employeeCheck")
.header("Authorization", "<api-key>")
.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::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": [
{
"employeeCheckID": "987234657",
"employerCheckID": "123456789",
"status": "processed",
"is_salary": false,
"employeeID": "0987654321",
"companyID": "123456789",
"check_date": "2020-01-07",
"approval_required": false,
"approved": false,
"metadata": {},
"disbursement": {
"method": "direct_deposit"
},
"disbursement_status": "settled",
"first_name": "peter",
"last_name": "gregory",
"reportingPeriodID": "01739fc4cfd84c2e93dba5e802d1dda1",
"gross_pay": 40,
"net_pay": 26.82,
"total_employee_taxes": 13.18,
"total_employer_taxes": 2.8,
"taxes": [
{
"name": "Employee Medicare Tax",
"paidBy": "EMPLOYEE_WITHHOLDING",
"amount": 1.16
}
],
"deductions": [],
"shifts": [
{
"shiftID": "4712c99283304b7b989179aae36b4590",
"employeeID": "1234567890",
"time": "2019-12-13T04:00:00Z",
"hourly": {
"hours": 2,
"wage": 20
},
"overtime": {
"hours": 2.5,
"wage": 30
}
}
],
"currency": "USD"
}
]
}{
"success": false,
"errors": [
{
"message": "Employee ID is not formatted correctly",
"code": 13
}
]
}