Reporting Periods
Get All Reporting Periods
List all reporting periods for a company, optionally filtered by pay schedule.
GET
/
reportingPeriod
/
Get All Reporting Periods
curl --request GET \
--url https://api.zeal.com/reportingPeriod/ \
--header 'Authorization: <api-key>'import requests
url = "https://api.zeal.com/reportingPeriod/"
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/reportingPeriod/', 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/reportingPeriod/",
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/reportingPeriod/"
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/reportingPeriod/")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zeal.com/reportingPeriod/")
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": [
{
"reportingPeriodID": "5eb317a40d1158d5ddcb6895",
"pay_schedule": "weekly",
"start": "2023-08-02",
"end": "2023-08-08"
},
{
"reportingPeriodID": "522317a404341158d5c3b6895",
"pay_schedule": "monthly",
"start": "2023-07-01",
"end": "2023-08-01"
}
]
}{
"success": false,
"errors": [
{
"message": "No user with this company ID exists",
"code": 4
}
]
}⌘I
Get All Reporting Periods
curl --request GET \
--url https://api.zeal.com/reportingPeriod/ \
--header 'Authorization: <api-key>'import requests
url = "https://api.zeal.com/reportingPeriod/"
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/reportingPeriod/', 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/reportingPeriod/",
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/reportingPeriod/"
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/reportingPeriod/")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zeal.com/reportingPeriod/")
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": [
{
"reportingPeriodID": "5eb317a40d1158d5ddcb6895",
"pay_schedule": "weekly",
"start": "2023-08-02",
"end": "2023-08-08"
},
{
"reportingPeriodID": "522317a404341158d5c3b6895",
"pay_schedule": "monthly",
"start": "2023-07-01",
"end": "2023-08-01"
}
]
}{
"success": false,
"errors": [
{
"message": "No user with this company ID exists",
"code": 4
}
]
}