Preview
Preview Payroll by Check IDs
Generate a payroll preview job for one or more pending checks by employee check ID.
POST
/
preview
/
checks
Preview Payroll by Check IDs
curl --request POST \
--url https://api.zeal.com/preview/checks \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"companyID": "h0c56cc41q1040ac8a3322342a3bbb462",
"checks": [
"c614c5ff59d7cc22eae4c9442f315",
"22cdbd897e3345a55c3fa22b1712be52",
"3942348bd453410485cd783ef1ce8391"
]
}
'import requests
url = "https://api.zeal.com/preview/checks"
payload = {
"companyID": "h0c56cc41q1040ac8a3322342a3bbb462",
"checks": ["c614c5ff59d7cc22eae4c9442f315", "22cdbd897e3345a55c3fa22b1712be52", "3942348bd453410485cd783ef1ce8391"]
}
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: 'h0c56cc41q1040ac8a3322342a3bbb462',
checks: [
'c614c5ff59d7cc22eae4c9442f315',
'22cdbd897e3345a55c3fa22b1712be52',
'3942348bd453410485cd783ef1ce8391'
]
})
};
fetch('https://api.zeal.com/preview/checks', 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/preview/checks",
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' => 'h0c56cc41q1040ac8a3322342a3bbb462',
'checks' => [
'c614c5ff59d7cc22eae4c9442f315',
'22cdbd897e3345a55c3fa22b1712be52',
'3942348bd453410485cd783ef1ce8391'
]
]),
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/preview/checks"
payload := strings.NewReader("{\n \"companyID\": \"h0c56cc41q1040ac8a3322342a3bbb462\",\n \"checks\": [\n \"c614c5ff59d7cc22eae4c9442f315\",\n \"22cdbd897e3345a55c3fa22b1712be52\",\n \"3942348bd453410485cd783ef1ce8391\"\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/preview/checks")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"companyID\": \"h0c56cc41q1040ac8a3322342a3bbb462\",\n \"checks\": [\n \"c614c5ff59d7cc22eae4c9442f315\",\n \"22cdbd897e3345a55c3fa22b1712be52\",\n \"3942348bd453410485cd783ef1ce8391\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zeal.com/preview/checks")
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\": \"h0c56cc41q1040ac8a3322342a3bbb462\",\n \"checks\": [\n \"c614c5ff59d7cc22eae4c9442f315\",\n \"22cdbd897e3345a55c3fa22b1712be52\",\n \"3942348bd453410485cd783ef1ce8391\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"status": 200,
"success": true,
"data": {
"job_id": "232c21f1-cc24-4664-8420-393d0acd21351",
"status": "pending",
"request_body": {
"companyID": "h0c56cc41q1040ac8a3322342a3bbb462",
"checks": [
"c614c5ff59d7cc22eae4c9442f315",
"22cdbd897e3345a55c3fa22b1712be52",
"3942348bd453410485cd783ef1ce8391"
],
"test_mode": false,
"job_type": "preview-checks",
"has_live_key": true
},
"created_at": "2023-05-04T19:29:39.134Z"
}
}{
"success": false,
"errors": [
{
"message": "Employee Check with this check ID does not exist",
"code": 43
}
]
}Authorizations
Body
application/json
⌘I
Preview Payroll by Check IDs
curl --request POST \
--url https://api.zeal.com/preview/checks \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"companyID": "h0c56cc41q1040ac8a3322342a3bbb462",
"checks": [
"c614c5ff59d7cc22eae4c9442f315",
"22cdbd897e3345a55c3fa22b1712be52",
"3942348bd453410485cd783ef1ce8391"
]
}
'import requests
url = "https://api.zeal.com/preview/checks"
payload = {
"companyID": "h0c56cc41q1040ac8a3322342a3bbb462",
"checks": ["c614c5ff59d7cc22eae4c9442f315", "22cdbd897e3345a55c3fa22b1712be52", "3942348bd453410485cd783ef1ce8391"]
}
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: 'h0c56cc41q1040ac8a3322342a3bbb462',
checks: [
'c614c5ff59d7cc22eae4c9442f315',
'22cdbd897e3345a55c3fa22b1712be52',
'3942348bd453410485cd783ef1ce8391'
]
})
};
fetch('https://api.zeal.com/preview/checks', 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/preview/checks",
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' => 'h0c56cc41q1040ac8a3322342a3bbb462',
'checks' => [
'c614c5ff59d7cc22eae4c9442f315',
'22cdbd897e3345a55c3fa22b1712be52',
'3942348bd453410485cd783ef1ce8391'
]
]),
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/preview/checks"
payload := strings.NewReader("{\n \"companyID\": \"h0c56cc41q1040ac8a3322342a3bbb462\",\n \"checks\": [\n \"c614c5ff59d7cc22eae4c9442f315\",\n \"22cdbd897e3345a55c3fa22b1712be52\",\n \"3942348bd453410485cd783ef1ce8391\"\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/preview/checks")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"companyID\": \"h0c56cc41q1040ac8a3322342a3bbb462\",\n \"checks\": [\n \"c614c5ff59d7cc22eae4c9442f315\",\n \"22cdbd897e3345a55c3fa22b1712be52\",\n \"3942348bd453410485cd783ef1ce8391\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zeal.com/preview/checks")
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\": \"h0c56cc41q1040ac8a3322342a3bbb462\",\n \"checks\": [\n \"c614c5ff59d7cc22eae4c9442f315\",\n \"22cdbd897e3345a55c3fa22b1712be52\",\n \"3942348bd453410485cd783ef1ce8391\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"status": 200,
"success": true,
"data": {
"job_id": "232c21f1-cc24-4664-8420-393d0acd21351",
"status": "pending",
"request_body": {
"companyID": "h0c56cc41q1040ac8a3322342a3bbb462",
"checks": [
"c614c5ff59d7cc22eae4c9442f315",
"22cdbd897e3345a55c3fa22b1712be52",
"3942348bd453410485cd783ef1ce8391"
],
"test_mode": false,
"job_type": "preview-checks",
"has_live_key": true
},
"created_at": "2023-05-04T19:29:39.134Z"
}
}{
"success": false,
"errors": [
{
"message": "Employee Check with this check ID does not exist",
"code": 43
}
]
}