One of the best features of Zeal is our reporting. Our whitelabel 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

  1. Call Create Payroll Journal Report. This will return a job_id.

๐Ÿ””

Note

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"
}
'
  1. When the job is finished processing, Zeal will send you an update via the Job Queue Event.
  2. Include the job_id in a call to Get Job Status.
curl --request GET \
     --url 'https://api.zeal.com/reports?job_id=ID&companyID={{companyID}}' \
     --header 'Accept: application/json' \
     --header 'Authorization: Bearer {{testApiKey}}'
  1. The returned JSON will include a payload field which may be used to download the report.
{
  "status": 200,
  "success": true,
  "data": {
    "job_id": "7g88a4e0-f2a0-4dc0-9a1c-215e083de5eb",
    "status": "complete",
    "created_at": "2022-03-25T18:52:43.138Z",
    "request_body": {
      "start_date": "2022-01-01",
      "end_date": "2022-03-28",
      "company_id": "fc235f012bae46aa8a082f357715bcfa",
      "media_type": "csv",
      "has_live_key": true,
      "report_format": "payroll_journal"
    },
    "payload": "https://api.zeal.com/reports/downloads/7g88a4e0-f2a0-4dc0-9a1c-215e083de5eb"
  }
}

Whitelabel

Admin/Employer Dashboard

If you are using our whitelabel Employer Dashboard, reports can be accessed through the Reports page.

  1. Navigate to the Reports page.

  1. Click the Payroll Journal card.
  2. Fill the information on the following page and then click Generate.
  3. 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.

  1. 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 whitelabel component directly in your dashboard.

  1. 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}}"
}
'
  1. Embed the link in your application through and iframe or open it up in a new tab.


Whatโ€™s Next

Learn how reports and more fit together in your Admin/Employer Dashboard.