An essential piece of your payroll product is the Company Dashboard. In this guide we’ll show how to build a custom dashboard through APIs and how to offer it out-of-the-box with our white-label components.

In this guide

• Which endpoints are needed to recreate the Company Dashboard.
• How to embed the white-label Company Dashboard in your application.

API

Since a custom Company Dashboard can take so many forms, we'll focus on providing an overview of the endpoints we recommend using rather than giving detailed code examples. We’ll use Zeal’s white-label component to provide an example structure for your dashboard.

Home Page

1. UseGet All Company Checks orGet Employer Checks by Dates and get the data from the most recentEmployer Check to display theLast payroll run andUpcoming payroll run sections.
2. UseGet Employees andGet Contractors and filter byonboarded status andstart_date to displayRecently onboarded workers.

People Page

1. UseGet Employees andGet Contractors to display all workers.
2. UseCreate Employee andCreate Contractor to provide a form to create workers.
3. UseGet Employee Onboarding Link andGet Contractor Onboarding Link to allow for onboarding employees and contractors.

🪄

Tip

You might also choose to build your own custom onboarding flow. Please reference ourEmployee Onboarding andContractor Onboarding guides for more information.

Individual Worker Page

1. UseGet/Update Employee Information andGet/Update Contractor Information to allow companies to view/edit the personal and employment information of their workers.
2. UseGet Bank Account by Employee/Contractor ID to display bank information. UseUpdate Bank Account to allow companies to correct bank account information.
3. For employees, useGet Employee Tax Parameter Summary andSet Employee Tax Parameters to allow companies to view/edit the employee's tax information.

Work Locations

1. UseGet Work Locations to displayWork Locations.
2. UseResolve Taxable Location to verify a taxable address and thenCreate Work Location to add new locations.

🪄

Tip

Check out ourWork Locations Guide for more details.

Pay Page

1. UseCreate Employee Check andCreate Contractor Payment to allow for creation of payroll.
2. UseGet Employee Check by ID andGet Contractor Payment by ID to display details about a particular check or payment.
3. UseGet Employer Checks by Dates to show the recent payroll history andGet Employer Check by ID to display details of a particular payroll run.

Tax Setup Page

Our partners generally choose to embed our out-of-the-box tax component so that companies can submit important tax documents directly. UseGenerate Company Taxes Page link and embed the component directly in your custom dashboard.

Reports Page

Similar to the Tax Setup page, most partners generally use Zeal's out-of-the-box Report Page component in their custom dashboards. UseGet Reports Link and embed the component directly in your custom dashboard.

White-Label

1. The company logs in to your application.
2. Once they are authenticated, callGenerate Company Login Link to get an SSO link specific to this company that they can use to access the dashboard without having to log in again.

🔔

Note

Remember to replace the placeholders such as{{testApiKey}} in the code samples below.

curl --location --request POST 'https://api.zeal.com/getAuthLink'--header 'Content-Type: application/json'--header 'Authorization: Bearer {{testApiKey}}'--data-raw '{   "partnerID": "{{partnerID}}",   "companyID": "{{companyID}}"}'

3. Give the company access to the link. Generally our partners include the link in their application or display the component directly through aniframe.

<a href="{{companyLoginLink}}">Click to access your payroll dashboard!</a>

4. When the company accesses the link, they’ll see the white-label component (on your domain with your logo) where they can manage people, payroll, and their information.

Recap

• The Company Dashboard provides core functionality to your users such as running payroll and managing workers.
• All the data and processes needed to build your customer company dashboard are exposed through Zeal's API endpoints.
• You may embed the white-label Company Dashboard directly in your application.

Updated 4 months ago

• Worker Dashboards