Employee Checks
Update Employee Check
Update a pending employee check - approve it, change the check date, or update the disbursement method.
PATCH
/
employeeCheck
Update Employee Check
curl --request PATCH \
--url https://api.zeal.com/employeeCheck \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"companyID": "<string>",
"employeeCheckID": "<string>",
"reportingPeriodID": "<string>",
"check_date": "2023-12-25",
"approval_required": true,
"approved": true,
"metadata": {},
"disbursement": {
"method": "direct_deposit"
}
}
'import requests
url = "https://api.zeal.com/employeeCheck"
payload = {
"companyID": "<string>",
"employeeCheckID": "<string>",
"reportingPeriodID": "<string>",
"check_date": "2023-12-25",
"approval_required": True,
"approved": True,
"metadata": {},
"disbursement": { "method": "direct_deposit" }
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
companyID: '<string>',
employeeCheckID: '<string>',
reportingPeriodID: '<string>',
check_date: '2023-12-25',
approval_required: true,
approved: true,
metadata: {},
disbursement: {method: 'direct_deposit'}
})
};
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 => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'companyID' => '<string>',
'employeeCheckID' => '<string>',
'reportingPeriodID' => '<string>',
'check_date' => '2023-12-25',
'approval_required' => true,
'approved' => true,
'metadata' => [
],
'disbursement' => [
'method' => 'direct_deposit'
]
]),
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 \"companyID\": \"<string>\",\n \"employeeCheckID\": \"<string>\",\n \"reportingPeriodID\": \"<string>\",\n \"check_date\": \"2023-12-25\",\n \"approval_required\": true,\n \"approved\": true,\n \"metadata\": {},\n \"disbursement\": {\n \"method\": \"direct_deposit\"\n }\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.zeal.com/employeeCheck")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"companyID\": \"<string>\",\n \"employeeCheckID\": \"<string>\",\n \"reportingPeriodID\": \"<string>\",\n \"check_date\": \"2023-12-25\",\n \"approval_required\": true,\n \"approved\": true,\n \"metadata\": {},\n \"disbursement\": {\n \"method\": \"direct_deposit\"\n }\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::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"companyID\": \"<string>\",\n \"employeeCheckID\": \"<string>\",\n \"reportingPeriodID\": \"<string>\",\n \"check_date\": \"2023-12-25\",\n \"approval_required\": true,\n \"approved\": true,\n \"metadata\": {},\n \"disbursement\": {\n \"method\": \"direct_deposit\"\n }\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"
}
}{
"success": false,
"errors": [
{
"message": "No employeeCheckID found in the query of request",
"code": 16
}
]
}Only checks with a
status of pending can be updated. Once a check enters processing, it can no longer be modified via this endpoint.Authorizations
Body
application/json
Company ID of the employer
ID of Employee Check
Reporting Period ID of Employee Check
Date of Employee Check
Whether manual approval is required for this Employee Check.
Set this field to true in order to approve this Employee Check
Set the metadata object of this Employee Check
Set the disbursement method of check - Zeal supports Direct Deposit, Download Check, Physical Check, Prepaid, and Paycard (Early Access) disbursement methods
Show child attributes
Show child attributes
⌘I
Update Employee Check
curl --request PATCH \
--url https://api.zeal.com/employeeCheck \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"companyID": "<string>",
"employeeCheckID": "<string>",
"reportingPeriodID": "<string>",
"check_date": "2023-12-25",
"approval_required": true,
"approved": true,
"metadata": {},
"disbursement": {
"method": "direct_deposit"
}
}
'import requests
url = "https://api.zeal.com/employeeCheck"
payload = {
"companyID": "<string>",
"employeeCheckID": "<string>",
"reportingPeriodID": "<string>",
"check_date": "2023-12-25",
"approval_required": True,
"approved": True,
"metadata": {},
"disbursement": { "method": "direct_deposit" }
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
companyID: '<string>',
employeeCheckID: '<string>',
reportingPeriodID: '<string>',
check_date: '2023-12-25',
approval_required: true,
approved: true,
metadata: {},
disbursement: {method: 'direct_deposit'}
})
};
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 => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'companyID' => '<string>',
'employeeCheckID' => '<string>',
'reportingPeriodID' => '<string>',
'check_date' => '2023-12-25',
'approval_required' => true,
'approved' => true,
'metadata' => [
],
'disbursement' => [
'method' => 'direct_deposit'
]
]),
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 \"companyID\": \"<string>\",\n \"employeeCheckID\": \"<string>\",\n \"reportingPeriodID\": \"<string>\",\n \"check_date\": \"2023-12-25\",\n \"approval_required\": true,\n \"approved\": true,\n \"metadata\": {},\n \"disbursement\": {\n \"method\": \"direct_deposit\"\n }\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.zeal.com/employeeCheck")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"companyID\": \"<string>\",\n \"employeeCheckID\": \"<string>\",\n \"reportingPeriodID\": \"<string>\",\n \"check_date\": \"2023-12-25\",\n \"approval_required\": true,\n \"approved\": true,\n \"metadata\": {},\n \"disbursement\": {\n \"method\": \"direct_deposit\"\n }\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::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"companyID\": \"<string>\",\n \"employeeCheckID\": \"<string>\",\n \"reportingPeriodID\": \"<string>\",\n \"check_date\": \"2023-12-25\",\n \"approval_required\": true,\n \"approved\": true,\n \"metadata\": {},\n \"disbursement\": {\n \"method\": \"direct_deposit\"\n }\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"
}
}{
"success": false,
"errors": [
{
"message": "No employeeCheckID found in the query of request",
"code": 16
}
]
}