Reports
One of the best features of Zeal is our reporting. Our white-label components and APIs give easy access to complex reports on demand. In this example we’ll show how to get a standard Payroll Journal Report, but there are many more reports available. See our API Reference for a full view of what is available.
API
- Call Create Payroll Journal Report. This will return a
job_id
.
Code Samples
Remember to replace the placeholders such as
{{testApiKey}}
in the code samples below.
curl --request POST \
--url https://api.zeal.com/reports/payroll-journal \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {{testApiKey}}' \
--header 'Content-Type: application/json' \
--data '
{
"start_date": "2022-01-01",
"end_date": "2022-03-28",
"companyID": "{{companyID}}",
"media_type": "csv"
}
'
- Include the
job_id
in a call to Get Job Status. This returns a JSON object about the status of the report.
curl --request GET \
--url 'https://api.zeal.com/reports?job_id=ID&companyID={{companyID}}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {{testApiKey}}'
- If the
status
ispending
, wait a few moments before making another call to Get Job Status. If thestatus
iscomplete
, use the link included in thepayload
to download the report.
White-Label
Admin/Employer Dashboard
If you are using our white-label Employer Dashboard, reports can be accessed through the Reports page.
- Navigate to the Reports page.


- Click the Payroll Journal card.
- Fill the information on the following page and then click Generate.
- A success alert will appear indicating that the browser will automatically download the report when it is ready in a few moments. Please ensure pop-ups are enabled in the browser.


- Once the report has downloaded, we can open it to view the payroll journal.


Embedding the Reports Page
If you’ve built your own custom dashboards using our APIs, you can embed the Reports white-label component directly in your dashboard.
- Call Get Reports Link.
curl --request POST \
--url https://api.zeal.com/authLinks/reports \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {{testApiKey}}' \
--header 'Content-Type: application/json' \
--data '
{
"partnerID": "{{partnerID}}",
"companyID": "{{companyID}}"
}
'
- Embed the link in your application through and iframe or open it up in a new tab.


Updated 12 days ago
Did this page help you?