> ## 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.

# Quickstart Guide

> In this guide we lead you through a quick, step-by-step example of how to run your first payroll using Zeal's pre-build white-label components. Even if you plan to build fully using the API, this guide gives you a high-level view of how the payroll system works.

<Info>
  If you haven't already, check out our [Introduction to Payroll Runs](/docs/introduction-to-payroll-runs) before continuing with this guide. It gives a conceptual overview of how payroll runs work with Zeal's system.
</Info>

## In this guide

* How to onboard a Company (employer).
* How to add a Work Location.
* How to onboard an Employee.
* How to set up and submit a Payroll Run.

***

## Onboarding a Company

Zeal represents employers in our system as *Companies*. A Company must first be onboarded before payroll can be run.

Navigate to your Partner Dashboard, ensure that *Test Mode* is enabled, then click **Add company**. In the modal that appears, click **Copy onboarding link**.

<img src="https://mintcdn.com/zeal-9a4b7c2b/8iA6Z7TGBwM-qVOT/images/docs/841d1fc-super-admin-test-mode.png?fit=max&auto=format&n=8iA6Z7TGBwM-qVOT&q=85&s=b3529aeaf3504f9323df69aa38472680" alt="" width="4720" height="2589" data-path="images/docs/841d1fc-super-admin-test-mode.png" />

Paste the link in a new tab of your web browser, and complete the onboarding flow.

<img src="https://mintcdn.com/zeal-9a4b7c2b/8iA6Z7TGBwM-qVOT/images/docs/05a65eb-payrollonboarding.png?fit=max&auto=format&n=8iA6Z7TGBwM-qVOT&q=85&s=2aff4ed908ad232a0bd0c9c3e1c51633" alt="" width="4720" height="2589" data-path="images/docs/05a65eb-payrollonboarding.png" />

Back on the Partner Dashboard, the newly onboarded company is shown in the main section.

***

## Creating a Work Location

Once the employer is onboarded, you can click on the Company to view the Employer Dashboard as an admin. From here, you can add a Work Location for the Company.

Click the company name.

<img src="https://mintcdn.com/zeal-9a4b7c2b/8iA6Z7TGBwM-qVOT/images/docs/837a4df-super-admin-employer-dashboard-test-mode.png?fit=max&auto=format&n=8iA6Z7TGBwM-qVOT&q=85&s=273be1319f346b90594125b8423c660c" alt="" width="4720" height="2589" data-path="images/docs/837a4df-super-admin-employer-dashboard-test-mode.png" />

Navigate to the **Work Locations** page then click **Add a New Location**.

<img src="https://mintcdn.com/zeal-9a4b7c2b/8iA6Z7TGBwM-qVOT/images/docs/cca1e87-worklocations.png?fit=max&auto=format&n=8iA6Z7TGBwM-qVOT&q=85&s=83915edcbe13a88afb12d4a843fcf2df" alt="" width="4720" height="2589" data-path="images/docs/cca1e87-worklocations.png" />

Enter the taxable address where the employee(s) will be working and click **Create**.

<img src="https://mintcdn.com/zeal-9a4b7c2b/8iA6Z7TGBwM-qVOT/images/docs/787523a-newworklocation.png?fit=max&auto=format&n=8iA6Z7TGBwM-qVOT&q=85&s=dc4dd0c37667e7b270f5bfd43d55a8a8" alt="" width="4720" height="2589" data-path="images/docs/787523a-newworklocation.png" />

***

## Onboarding an Employee

Now that we've added a location our employee(s) will be working at, we can onboard them.

Navigate to the **People** page and click **Add employee**.

<img src="https://mintcdn.com/zeal-9a4b7c2b/8iA6Z7TGBwM-qVOT/images/docs/d0b1b91-peoplepage.png?fit=max&auto=format&n=8iA6Z7TGBwM-qVOT&q=85&s=6de3aae429fb5274cbf11f0c90020658" alt="" width="4720" height="2589" data-path="images/docs/d0b1b91-peoplepage.png" />

Fill the employee information and select the proper Work Location from the dropdown, then click **Add Employee**.

<img src="https://mintcdn.com/zeal-9a4b7c2b/8iA6Z7TGBwM-qVOT/images/docs/bb9f0de-createnewemployee.png?fit=max&auto=format&n=8iA6Z7TGBwM-qVOT&q=85&s=c48fa26033fab20ea8f01b17586a9a1c" alt="" width="4720" height="2589" data-path="images/docs/bb9f0de-createnewemployee.png" />

Back on the **People** page, find the Employee and click **Onboarding link** to copy the onboarding link or send it to the worker's email.

<img src="https://mintcdn.com/zeal-9a4b7c2b/8iA6Z7TGBwM-qVOT/images/docs/177693f-workeronboarding.png?fit=max&auto=format&n=8iA6Z7TGBwM-qVOT&q=85&s=06f1648cf982fce8f5a63e141ae2b40f" alt="" width="4720" height="2589" data-path="images/docs/177693f-workeronboarding.png" />

Open the link in a new tab to complete the onboarding flow.

<img src="https://mintcdn.com/zeal-9a4b7c2b/8iA6Z7TGBwM-qVOT/images/docs/174196a-workeronboardingpage1.png?fit=max&auto=format&n=8iA6Z7TGBwM-qVOT&q=85&s=5d506299077cb2035c6d08fd7831e5ea" alt="" width="4720" height="2589" data-path="images/docs/174196a-workeronboardingpage1.png" />

***

## Running payroll

Once the employee is onboarded, we can pay them.

Navigate to **Run Payroll** and click **Get Started** under the run off-cycle payroll section.

<img src="https://mintcdn.com/zeal-9a4b7c2b/8iA6Z7TGBwM-qVOT/images/docs/854808e-get-started-off-cycle.png?fit=max&auto=format&n=8iA6Z7TGBwM-qVOT&q=85&s=05120c668a7f3cb651b224fb9b6882e5" alt="Get started with off-cycle payroll" width="4720" height="2589" data-path="images/docs/854808e-get-started-off-cycle.png" />

On the following page, we'll select the **Pay frequency**. Ensure that this matches the *pay schedule* we assigned to our employee.

<img src="https://mintcdn.com/zeal-9a4b7c2b/8iA6Z7TGBwM-qVOT/images/docs/3e344a1-select-pay-frequency.png?fit=max&auto=format&n=8iA6Z7TGBwM-qVOT&q=85&s=d535b9b3bee32311ac3eb8346a3ecd3c" alt="Select pay frequency" width="4720" height="2589" data-path="images/docs/3e344a1-select-pay-frequency.png" />

Next, select the **Pay period** and **Pay date**, then hit **Continue**.

<img src="https://mintcdn.com/zeal-9a4b7c2b/8iA6Z7TGBwM-qVOT/images/docs/8a4b632-select-period-and-date.png?fit=max&auto=format&n=8iA6Z7TGBwM-qVOT&q=85&s=cf1d0509e13a1398712253bfea71d1bc" alt="" width="4720" height="2589" data-path="images/docs/8a4b632-select-period-and-date.png" />

On the following page, click **Add employees to payroll run**.

<img src="https://mintcdn.com/zeal-9a4b7c2b/8iA6Z7TGBwM-qVOT/images/docs/a6ef00d-click-add-employees-to-run.png?fit=max&auto=format&n=8iA6Z7TGBwM-qVOT&q=85&s=53a3b35e65e2f6ec081baebbd1e6a993" alt="" width="4720" height="2589" data-path="images/docs/a6ef00d-click-add-employees-to-run.png" />

In the modal that appears, we'll select our employee and hit **Continue**.

<img src="https://mintcdn.com/zeal-9a4b7c2b/vBKrJf75YCNoIQu3/images/docs/f531518-add-employee-to-run.png?fit=max&auto=format&n=vBKrJf75YCNoIQu3&q=85&s=dab62a70e971e3a93ad8378135810fb9" alt="" width="4720" height="2589" data-path="images/docs/f531518-add-employee-to-run.png" />

On the following page, we'll see a view of our payroll run with defaults based on employee's default wage and pay schedule.

<img src="https://mintcdn.com/zeal-9a4b7c2b/8iA6Z7TGBwM-qVOT/images/docs/a16c8c9-off-cycle-payroll-run.png?fit=max&auto=format&n=8iA6Z7TGBwM-qVOT&q=85&s=c9412c3ecb5d04c0d484bc6e2f599cd4" alt="" width="4720" height="2589" data-path="images/docs/a16c8c9-off-cycle-payroll-run.png" />

From this page, click **Continue**.

<img src="https://mintcdn.com/zeal-9a4b7c2b/8iA6Z7TGBwM-qVOT/images/docs/bfec784-go-to-preview.png?fit=max&auto=format&n=8iA6Z7TGBwM-qVOT&q=85&s=010a7133d468247a9285cb59e9a5036c" alt="" width="4720" height="2589" data-path="images/docs/bfec784-go-to-preview.png" />

On the final page, click **Submit payroll**.

<img src="https://mintcdn.com/zeal-9a4b7c2b/8iA6Z7TGBwM-qVOT/images/docs/334e479-submit-payroll.png?fit=max&auto=format&n=8iA6Z7TGBwM-qVOT&q=85&s=eec57fa32a38528b77df1235dac7708e" alt="" width="4720" height="2589" data-path="images/docs/334e479-submit-payroll.png" />

Once submitted, Zeal will finalize and process the payroll two business days before the pay date.

***

## Recap

* The first step for our payroll solution is to onboard one or more Companies (employers).
* Before onboarding any Employees, a Company must have at least one Work Location.
* To run payroll, first onboard an Employee(s).
* With a Company and Employee(s) onboarded, payroll can be run from the Employer Dashboard.
