Reports
Create Payment Summary Report
Start an asynchronous job to generate a Payment Summary report summarizing employee and contractor payments within a date range.
POST
/
reports
/
payment-summary
Create Payment Summary Report
curl --request POST \
--url https://api.zeal.com/reports/payment-summary \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"pay_start_date": "2023-12-01",
"pay_end_date": "2023-12-28",
"companyID": "fc235f012bae46aa8a082f357715bcfa",
"media_type": "pdf"
}
'import requests
url = "https://api.zeal.com/reports/payment-summary"
payload = {
"pay_start_date": "2023-12-01",
"pay_end_date": "2023-12-28",
"companyID": "fc235f012bae46aa8a082f357715bcfa",
"media_type": "pdf"
}
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({
pay_start_date: '2023-12-01',
pay_end_date: '2023-12-28',
companyID: 'fc235f012bae46aa8a082f357715bcfa',
media_type: 'pdf'
})
};
fetch('https://api.zeal.com/reports/payment-summary', 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/payment-summary",
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([
'pay_start_date' => '2023-12-01',
'pay_end_date' => '2023-12-28',
'companyID' => 'fc235f012bae46aa8a082f357715bcfa',
'media_type' => 'pdf'
]),
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/payment-summary"
payload := strings.NewReader("{\n \"pay_start_date\": \"2023-12-01\",\n \"pay_end_date\": \"2023-12-28\",\n \"companyID\": \"fc235f012bae46aa8a082f357715bcfa\",\n \"media_type\": \"pdf\"\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/payment-summary")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"pay_start_date\": \"2023-12-01\",\n \"pay_end_date\": \"2023-12-28\",\n \"companyID\": \"fc235f012bae46aa8a082f357715bcfa\",\n \"media_type\": \"pdf\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zeal.com/reports/payment-summary")
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 \"pay_start_date\": \"2023-12-01\",\n \"pay_end_date\": \"2023-12-28\",\n \"companyID\": \"fc235f012bae46aa8a082f357715bcfa\",\n \"media_type\": \"pdf\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"job_id": "76f8a4e0-f2a0-4dc0-9a1c-215e083de5eb",
"status": "pending",
"request_body": {
"start_date": "2022-01-01",
"end_date": "2022-03-28",
"company_id": "fc235f012bae46aa8a082f357715bcfa",
"media_type": "pdf",
"has_live_key": true,
"report_format": "payment_summary"
},
"created_at": "2023-12-25T18:52:43.138Z"
}
}{
"success": false,
"errors": [
{
"message": "No start date found in query of request",
"code": 19
}
]
}Authorizations
Body
application/json
The first payment date this report should retrieve payments for. Date should be in ISO-8601 format (YYYY-MM-DD).
The last payment date this report should retrieve payments for. Date should be in ISO-8601 format (YYYY-MM-DD).
Zeal Company ID
The type of format this report can be downloaded as. Payment Summaries currently support "csv" and "pdf".
Available options:
csv, pdf Include international contractors in this report
⌘I
Create Payment Summary Report
curl --request POST \
--url https://api.zeal.com/reports/payment-summary \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"pay_start_date": "2023-12-01",
"pay_end_date": "2023-12-28",
"companyID": "fc235f012bae46aa8a082f357715bcfa",
"media_type": "pdf"
}
'import requests
url = "https://api.zeal.com/reports/payment-summary"
payload = {
"pay_start_date": "2023-12-01",
"pay_end_date": "2023-12-28",
"companyID": "fc235f012bae46aa8a082f357715bcfa",
"media_type": "pdf"
}
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({
pay_start_date: '2023-12-01',
pay_end_date: '2023-12-28',
companyID: 'fc235f012bae46aa8a082f357715bcfa',
media_type: 'pdf'
})
};
fetch('https://api.zeal.com/reports/payment-summary', 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/payment-summary",
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([
'pay_start_date' => '2023-12-01',
'pay_end_date' => '2023-12-28',
'companyID' => 'fc235f012bae46aa8a082f357715bcfa',
'media_type' => 'pdf'
]),
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/payment-summary"
payload := strings.NewReader("{\n \"pay_start_date\": \"2023-12-01\",\n \"pay_end_date\": \"2023-12-28\",\n \"companyID\": \"fc235f012bae46aa8a082f357715bcfa\",\n \"media_type\": \"pdf\"\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/payment-summary")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"pay_start_date\": \"2023-12-01\",\n \"pay_end_date\": \"2023-12-28\",\n \"companyID\": \"fc235f012bae46aa8a082f357715bcfa\",\n \"media_type\": \"pdf\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zeal.com/reports/payment-summary")
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 \"pay_start_date\": \"2023-12-01\",\n \"pay_end_date\": \"2023-12-28\",\n \"companyID\": \"fc235f012bae46aa8a082f357715bcfa\",\n \"media_type\": \"pdf\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"job_id": "76f8a4e0-f2a0-4dc0-9a1c-215e083de5eb",
"status": "pending",
"request_body": {
"start_date": "2022-01-01",
"end_date": "2022-03-28",
"company_id": "fc235f012bae46aa8a082f357715bcfa",
"media_type": "pdf",
"has_live_key": true,
"report_format": "payment_summary"
},
"created_at": "2023-12-25T18:52:43.138Z"
}
}{
"success": false,
"errors": [
{
"message": "No start date found in query of request",
"code": 19
}
]
}