Reports
Create Custom Payroll Journal Report
Start an asynchronous job to generate a customizable Payroll Journal report with configurable columns and grouping.
POST
/
reports
/
custom-payroll-journal
Create Custom Payroll Journal Report
curl --request POST \
--url https://api.zeal.com/reports/custom-payroll-journal \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"start_date": "03-22-2022",
"end_date": "04-10-2022",
"companyID": "24b5b29f07924840b119c34c1358940c",
"media_type": "pdf",
"fields": {
"employee_taxes": false,
"employer_taxes": false,
"deductions": false,
"net_pay": false,
"earnings": false,
"disbursement": false,
"gross_pay": false
}
}
'import requests
url = "https://api.zeal.com/reports/custom-payroll-journal"
payload = {
"start_date": "03-22-2022",
"end_date": "04-10-2022",
"companyID": "24b5b29f07924840b119c34c1358940c",
"media_type": "pdf",
"fields": {
"employee_taxes": False,
"employer_taxes": False,
"deductions": False,
"net_pay": False,
"earnings": False,
"disbursement": False,
"gross_pay": False
}
}
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({
start_date: '03-22-2022',
end_date: '04-10-2022',
companyID: '24b5b29f07924840b119c34c1358940c',
media_type: 'pdf',
fields: {
employee_taxes: false,
employer_taxes: false,
deductions: false,
net_pay: false,
earnings: false,
disbursement: false,
gross_pay: false
}
})
};
fetch('https://api.zeal.com/reports/custom-payroll-journal', 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/reports/custom-payroll-journal",
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([
'start_date' => '03-22-2022',
'end_date' => '04-10-2022',
'companyID' => '24b5b29f07924840b119c34c1358940c',
'media_type' => 'pdf',
'fields' => [
'employee_taxes' => false,
'employer_taxes' => false,
'deductions' => false,
'net_pay' => false,
'earnings' => false,
'disbursement' => false,
'gross_pay' => false
]
]),
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/reports/custom-payroll-journal"
payload := strings.NewReader("{\n \"start_date\": \"03-22-2022\",\n \"end_date\": \"04-10-2022\",\n \"companyID\": \"24b5b29f07924840b119c34c1358940c\",\n \"media_type\": \"pdf\",\n \"fields\": {\n \"employee_taxes\": false,\n \"employer_taxes\": false,\n \"deductions\": false,\n \"net_pay\": false,\n \"earnings\": false,\n \"disbursement\": false,\n \"gross_pay\": false\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/reports/custom-payroll-journal")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"start_date\": \"03-22-2022\",\n \"end_date\": \"04-10-2022\",\n \"companyID\": \"24b5b29f07924840b119c34c1358940c\",\n \"media_type\": \"pdf\",\n \"fields\": {\n \"employee_taxes\": false,\n \"employer_taxes\": false,\n \"deductions\": false,\n \"net_pay\": false,\n \"earnings\": false,\n \"disbursement\": false,\n \"gross_pay\": false\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zeal.com/reports/custom-payroll-journal")
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 \"start_date\": \"03-22-2022\",\n \"end_date\": \"04-10-2022\",\n \"companyID\": \"24b5b29f07924840b119c34c1358940c\",\n \"media_type\": \"pdf\",\n \"fields\": {\n \"employee_taxes\": false,\n \"employer_taxes\": false,\n \"deductions\": false,\n \"net_pay\": false,\n \"earnings\": false,\n \"disbursement\": false,\n \"gross_pay\": false\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"job_id": "7282b13f-254f-4eb9-bt88-24f429be6aa0",
"status": "pending",
"request_body": {
"start_date": "03-22-2022",
"end_date": "04-10-2022",
"companyID": "24b5b29f07924840b119c34c1358940c",
"media_type": "pdf",
"fields": {
"employee_taxes": false,
"employer_taxes": false,
"deductions": false,
"net_pay": false,
"earnings": false,
"disbursement": false,
"gross_pay": false
},
"has_live_key": true,
"report_format": "custom_payroll_journal"
},
"created_at": "2023-12-18T22:15:08.977Z"
}
}{
"success": false,
"errors": [
{
"message": "Must provide a valid companyID",
"code": 50
}
]
}Authorizations
Body
application/json
Zeal Company ID
The type of format this report can be downloaded as. Payroll Journals currently support "csv" and "pdf".
Available options:
csv, pdf The first check date this report should retrieve checks for. Date should be in ISO-8601 format (YYYY-MM-DD).
The last check date this report should retrieve checks for. Date should be in ISO-8601 format (YYYY-MM-DD).
Optional fields and parameters for Custom Payroll Journal
Show child attributes
Show child attributes
Filter by customer account(s) (Early Access)
⌘I
Create Custom Payroll Journal Report
curl --request POST \
--url https://api.zeal.com/reports/custom-payroll-journal \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"start_date": "03-22-2022",
"end_date": "04-10-2022",
"companyID": "24b5b29f07924840b119c34c1358940c",
"media_type": "pdf",
"fields": {
"employee_taxes": false,
"employer_taxes": false,
"deductions": false,
"net_pay": false,
"earnings": false,
"disbursement": false,
"gross_pay": false
}
}
'import requests
url = "https://api.zeal.com/reports/custom-payroll-journal"
payload = {
"start_date": "03-22-2022",
"end_date": "04-10-2022",
"companyID": "24b5b29f07924840b119c34c1358940c",
"media_type": "pdf",
"fields": {
"employee_taxes": False,
"employer_taxes": False,
"deductions": False,
"net_pay": False,
"earnings": False,
"disbursement": False,
"gross_pay": False
}
}
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({
start_date: '03-22-2022',
end_date: '04-10-2022',
companyID: '24b5b29f07924840b119c34c1358940c',
media_type: 'pdf',
fields: {
employee_taxes: false,
employer_taxes: false,
deductions: false,
net_pay: false,
earnings: false,
disbursement: false,
gross_pay: false
}
})
};
fetch('https://api.zeal.com/reports/custom-payroll-journal', 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/reports/custom-payroll-journal",
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([
'start_date' => '03-22-2022',
'end_date' => '04-10-2022',
'companyID' => '24b5b29f07924840b119c34c1358940c',
'media_type' => 'pdf',
'fields' => [
'employee_taxes' => false,
'employer_taxes' => false,
'deductions' => false,
'net_pay' => false,
'earnings' => false,
'disbursement' => false,
'gross_pay' => false
]
]),
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/reports/custom-payroll-journal"
payload := strings.NewReader("{\n \"start_date\": \"03-22-2022\",\n \"end_date\": \"04-10-2022\",\n \"companyID\": \"24b5b29f07924840b119c34c1358940c\",\n \"media_type\": \"pdf\",\n \"fields\": {\n \"employee_taxes\": false,\n \"employer_taxes\": false,\n \"deductions\": false,\n \"net_pay\": false,\n \"earnings\": false,\n \"disbursement\": false,\n \"gross_pay\": false\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/reports/custom-payroll-journal")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"start_date\": \"03-22-2022\",\n \"end_date\": \"04-10-2022\",\n \"companyID\": \"24b5b29f07924840b119c34c1358940c\",\n \"media_type\": \"pdf\",\n \"fields\": {\n \"employee_taxes\": false,\n \"employer_taxes\": false,\n \"deductions\": false,\n \"net_pay\": false,\n \"earnings\": false,\n \"disbursement\": false,\n \"gross_pay\": false\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zeal.com/reports/custom-payroll-journal")
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 \"start_date\": \"03-22-2022\",\n \"end_date\": \"04-10-2022\",\n \"companyID\": \"24b5b29f07924840b119c34c1358940c\",\n \"media_type\": \"pdf\",\n \"fields\": {\n \"employee_taxes\": false,\n \"employer_taxes\": false,\n \"deductions\": false,\n \"net_pay\": false,\n \"earnings\": false,\n \"disbursement\": false,\n \"gross_pay\": false\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"job_id": "7282b13f-254f-4eb9-bt88-24f429be6aa0",
"status": "pending",
"request_body": {
"start_date": "03-22-2022",
"end_date": "04-10-2022",
"companyID": "24b5b29f07924840b119c34c1358940c",
"media_type": "pdf",
"fields": {
"employee_taxes": false,
"employer_taxes": false,
"deductions": false,
"net_pay": false,
"earnings": false,
"disbursement": false,
"gross_pay": false
},
"has_live_key": true,
"report_format": "custom_payroll_journal"
},
"created_at": "2023-12-18T22:15:08.977Z"
}
}{
"success": false,
"errors": [
{
"message": "Must provide a valid companyID",
"code": 50
}
]
}