> ## Documentation Index
> Fetch the complete documentation index at: https://docs.zeal.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Company Dashboard
> 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. Use [Get All Company Checks](/reference-link/retrieve-all-employer-checks) or [Get Employer Checks by Dates](/reference-link/retrieve-employer-checks-by-dates) and get the data from the most recent Employer Check to display the *Last payroll run* and *Upcoming payroll run* sections.
2. Use [Get Employees](/reference/employees/get-employees) and [Get Contractors](/reference/contractors/get-contractors) and filter by `onboarded` status and `start_date` to display *Recently onboarded workers*.
### People Page
1. Use [Get Employees](/reference/employees/get-employees) and [Get Contractors](/reference/contractors/get-contractors) to display all workers.
2. Use [Create Employee](/reference/employees/create-employee) and [Create Contractor](/reference/contractors/create-contractor) to provide a form to create workers.
3. Use [Get Employee Onboarding Link](/reference/employee-onboarding/generate-employee-onboarding-link) and [Get Contractor Onboarding Link](/reference/contractor-onboarding/generate-contractor-onboarding-link) to allow for onboarding employees and contractors.
### Tip
You might also choose to build your own custom onboarding flow. Please reference our [Employee Onboarding](/docs/employee-onboarding-guide) and [Contractor Onboarding](/docs/contractor-onboarding-guide) guides for more information.
### Individual Worker Page
1. Use [Get/Update Employee Information](/reference/employees/get-employee-information) and [Get/Update Contractor Information](/reference/contractors/get-contractor-information) to allow companies to view/edit the personal and employment information of their workers.
2. Use [Get Bank Account by Employee/Contractor ID](/reference/bank-accounts/get-bank-accounts-by-worker-id) to display bank information. Use [Update Bank Account](/reference/bank-accounts/update-bank-account) to allow companies to correct bank account information.
3. For employees, use [Get Employee Tax Parameter Summary](/reference/employee-onboarding/get-employee-tax-parameter-summary) and [Set Employee Tax Parameters](/reference/employee-onboarding/set-employee-tax-parameters) to allow companies to view/edit the employee's tax information.
### Work Locations
1. Use [Get Work Locations](/reference/work-locations/get-work-locations) to display Work Locations.
2. Use [Resolve Taxable Location](/reference/taxable-locations/resolve-taxable-location) to verify a taxable address and then [Create Work Location](/reference/work-locations/create-work-location) to add new locations.
### Tip
Check out our [Work Locations Guide](/docs/work-locations-guide) for more details.
### Pay Page
1. Use [Create Employee Check](/reference/employee-checks/employee-checks/create-employee-check) and [Create Contractor Payment](/reference/contractor-payments/create-contractor-payment) to allow for creation of payroll.
2. Use [Get Employee Check by ID](/reference/employee-checks/employee-checks/get-employee-check-by-id) and [Get Contractor Payment by ID](/reference/contractor-payments/get-contractor-payments) to display details about a particular check or payment.
3. Use [Get Employer Checks by Dates](/reference-link/retrieve-employer-checks-by-dates) to show the recent payroll history and [Get Employer Check by ID](/reference/employer-checks/get-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. Use [Generate Company Taxes Page link](/reference/zeal-components/generate-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. Use [Get Reports Link](/reference/zeal-components/generate-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, call [Generate Company Login Link](/reference/zeal-components/generate-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.
```bash bash theme={null}
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 an iframe.
```bash bash theme={null}
Click to access your payroll dashboard!
```
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.