# Zeal Docs

## Docs

- [Account Setup and API Keys](https://docs.zeal.com/docs/account-setup-and-api-keys.md): Zeal offers a full integration team to help you get up and running with our product. Although our team leads this process, in this guide we give you an overview of the steps to set up your account.
- [Accrual Policies](https://docs.zeal.com/docs/accrual-policies.md): Learn how to set up and manage a PTO or Sick Time Policy for your workers
- [Company Dashboard](https://docs.zeal.com/docs/admin-employer-dashboard-guides.md): 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.
- [Building a Payroll Product](https://docs.zeal.com/docs/building-a-payroll-product.md): Building a payroll product can seem daunting at first, especially if you don’t come from a payroll background. At Zeal, our team of payroll experts is here to help. In this guide, we'll walk you through everything you should know to offer payroll, confidently.
- [Contractor Dashboard](https://docs.zeal.com/docs/contractor-dashboard-guide.md): Contractors need a space to view their profile information and payment history as well as access their 1099 form and other tax information. You can provide this out-of-the-box with the white-label component or build a custom dashboard using our API.
- [Contractor Onboarding](https://docs.zeal.com/docs/contractor-onboarding-guide.md): 1099 Contractors can be onboarded to the payroll solution via the API or white-label components. Since companies aren’t responsible for paying taxes on or withholding taxes from a contractor’s pay, much less information needs to be collected to onboard a contractor than a W-2 Employee.
- [Contractor Payments](https://docs.zeal.com/docs/contractor-payments-guide.md): Contractor payments are rather simple as there are no taxes for the employer to pay and the contractor is responsible for paying their own taxes.
- [Custom Paperwork (Early Access)](https://docs.zeal.com/docs/custom-paperwork.md): Learn how to create Custom Paperwork that can be used in worker onboarding.
- [Customer Accounts (Early Access)](https://docs.zeal.com/docs/customer-accounts-closed-beta.md): The concept of a Customer Account represents the end-client of a staffing company. Typically staffing companies act like marketplaces, supplying labor to brands who provide work opportunities. Zeal's customer accounts functionality enables staffing companies to map labor and payroll fees to their en…
- [Deductions](https://docs.zeal.com/docs/deductions-guide.md): Along with standard payroll withholdings such as income tax and social security, some employees may need additional deductions withheld from their checks, such as 401K contributions or garnishments.
- [Deduction Types](https://docs.zeal.com/docs/deductions-types.md): Below are brief descriptions of Zeal-supported deductions and how they are taxed.
- [Earning Components](https://docs.zeal.com/docs/earning-components.md): Earning Components define categories of compensation and determine how each is taxed according to tax laws and regulations.
- [Employee Checks](https://docs.zeal.com/docs/employee-checks-guide.md): With Zeal, paying employees is a simple matter of creating Employee Checks with the desired check_date (or payday).
- [Employee Dashboard](https://docs.zeal.com/docs/employee-dashboards-guide.md): An essential piece of your payroll product is the Employee Dashboard. Employees need a space to review paystubs and payment history, manage their profile information, and review tax information.
- [Employee Onboarding](https://docs.zeal.com/docs/employee-onboarding-guide.md): Onboarding W-2 Employees is an important step for any payroll offering.
- [Company Onboarding](https://docs.zeal.com/docs/employer-onboarding-guide.md): A key piece of the payroll solution is company onboarding. Companies must submit basic company information, bank account details, and legal paperwork that Zeal uses to run payroll on their behalf. For Partners building an internal payroll solution, onboarding can be done directly from the Partner Da…
- [FAQs](https://docs.zeal.com/docs/faqs.md): Here you’ll find some of the most frequently asked questions our new partners have about Zeal.
- [Introduction to Payroll Runs](https://docs.zeal.com/docs/introduction-to-payroll-runs.md): Before we discuss how to build a payroll product, we'll cover how Zeal's payroll system works. Unlike other payroll providers, where payroll generally must be run on strict cycles, Zeal's system aims to keep things simple. This means that employers (or your system) are only responsible for creating…
- [Overtime Compliance](https://docs.zeal.com/docs/overtime-compliance.md): Calculating overtime can be one of the more difficult processes when running payroll. Along with federal regulation surrounding overtime, each state may also have their own regulation. Adding overtime rules to your timekeeping system can take many developer hours. For this, Zeal offers our overtime…
- [Paycard Onboarding (Early Access)](https://docs.zeal.com/docs/paycard-onboarding.md): Zeal has made it easy to track the progress of a worker's onboarding and provisioning of their paycard.
- [Paycards (Early Access)](https://docs.zeal.com/docs/paycards.md): Paycards allow workers to get paid faster and have easier access to their funds.
- [Payroll Runs](https://docs.zeal.com/docs/payroll-runs.md): Through the white-label Company Dashboard we can set up payroll runs rather than working with individual Employee Checks, as in the API.
- [Preview Payroll](https://docs.zeal.com/docs/preview-payroll-guide.md): There are several key use cases for which we would want a breakdown of a payroll before it is processed.
- [Quickstart Guide](https://docs.zeal.com/docs/quickstart-guide.md): 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.
- [Setting up Regular Payroll Run](https://docs.zeal.com/docs/regular-payroll.md): This guide will explain how to take advantage of Zeal's Regular Payroll Run functionality through the API.
- [Reports](https://docs.zeal.com/docs/reports-guide.md): One of the best features of Zeal is our reporting.
- [Payroll](https://docs.zeal.com/docs/running-payroll-guides.md): As discussed in our Introduction to Payroll Runs Guide, Zeal's payroll system works differently from some traditional payroll providers.
- [Tax Compliance Across Multiple Jurisdictions](https://docs.zeal.com/docs/tax-compliance-across-multiple-jurisdictions.md): Managing payroll taxes becomes difficult as your workforce grows - especially if you have employees across multiple tax jurisdictions. Say an employee works half a pay cycle in New York and the other half in New Jersey. Should you withhold income tax for both states? Are there reciprocity agreements…
- [Tax Requirements](https://docs.zeal.com/docs/tax-requirements-guide.md): Tax requirements are documents that an employer must submit in order for Zeal to properly pay and report taxes on their behalf. Which documents an employer must submit depends on the state(s) and localities in which they have employees. Thankfully, these requirements can be easily tracked and submit…
- [Time & Attendance Integration](https://docs.zeal.com/docs/time-attendance-integration.md): One of the best features of Zeal is how easily it can be integrated with other systems in order to automate traditionally manual processes.
- [What is Zeal?](https://docs.zeal.com/docs/what-is-zeal.md): Zeal makes it faster, easier, and better for companies to build payroll into their products.
- [Work Locations](https://docs.zeal.com/docs/work-locations-guide.md): Before onboarding a W-2 Employee, we'll need to specify where the employee will be working. This is known as a Work Location and is important for taxation. A Work Location is often reused for multiple employees but may also be used by only one employee (sometimes the case for remote employees).
- [Worker Dashboards](https://docs.zeal.com/docs/worker-dashboards-guides.md): Once our workers are onboarded and able to be paid, they need a place to view paystubs and personal information. Worker dashboards are a key piece of the payroll system which provide a great experience for our workers.
- [Worker Onboarding](https://docs.zeal.com/docs/worker-onboarding-guides.md): Workers are at the core of every payroll solution - they're who we pay after all. Before we can pay a worker, their information needs to be submitted through onboarding.
- [Bank Account Object](https://docs.zeal.com/reference/bank-accounts/bank-account-object.md): The Zeal object representing a worker bank account.
- [Create Bank Account](https://docs.zeal.com/reference/bank-accounts/create-bank-account.md): Create a bank account object for a worker (employee or contractor) in Zeal's system, used to pay the worker through direct deposit.
- [Get Bank Account by ID](https://docs.zeal.com/reference/bank-accounts/get-bank-account-by-id.md): Retrieve a single bank account object by its Zeal bank account ID.
- [Get Bank Accounts by Worker ID](https://docs.zeal.com/reference/bank-accounts/get-bank-accounts-by-worker-id.md): Retrieve all bank account objects belonging to a worker (employee or contractor) by their Zeal ID.
- [Update Bank Account](https://docs.zeal.com/reference/bank-accounts/update-bank-account.md): Updates a bank account belonging to the specified worker in Zeal.
- [Create Company](https://docs.zeal.com/reference/companies/create-company.md): Create a new employer company under your Zeal partner account. Returns a companyID used in all subsequent company and payroll API calls.
- [Get Company Information](https://docs.zeal.com/reference/companies/get-company-information.md): Retrieve company information for one or all employers under your Zeal partner account.
- [Get Company Onboarding Link](https://docs.zeal.com/reference/companies/get-company-onboarding-link.md): Retrieve a link to Zeal's web-based company onboarding flow.
- [The Company Object](https://docs.zeal.com/reference/companies/the-company-object.md): The Company object represents an employer in Zeal, including business details, owner information, and onboarding status.
- [The Requirement Object](https://docs.zeal.com/reference/companies/the-requirement-object.md): The Requirement object lists information Zeal needs from an employer to complete tax setup, filing, or payment for a jurisdiction.
- [Update Company Information](https://docs.zeal.com/reference/companies/update-company-info.md): Update an existing company's business details, owner information, or payroll schedule.
- [Sign Company Authorization Documents](https://docs.zeal.com/reference/company-onboarding/create-company-authorization-documents.md): Sign authorization documents required to onboard a company: Tax Information Terms, Reporting Agent Terms, Direct Deposit, and Terms and Conditions Forms.
- [Create Company Bank Account](https://docs.zeal.com/reference/company-onboarding/create-company-bank-account.md): Add bank account information for a company, used for company debits, worker payouts, and micro-deposit verification during onboarding.
- [Get Company Authorization Documents](https://docs.zeal.com/reference/company-onboarding/get-company-authorization-documents.md): View documents that require authorization in order to onboard a company: Tax Information Terms, Reporting Agent Terms, Direct Deposit, and Terms and Conditions Forms.
- [Set Company Onboarded Status to True](https://docs.zeal.com/reference/company-onboarding/set-company-status-to-onboarded.md): Once microdeposits have been confirmed and authorization documents signed, complete onboarding for the specified company.
- [Trigger Micro-Deposits](https://docs.zeal.com/reference/company-onboarding/trigger-microdeposits.md): Triggers micro-deposit amounts to a company bank account for verification, usually appearing in 2-3 business days.
- [Verify Microdeposit Values](https://docs.zeal.com/reference/company-onboarding/verify-microdeposit-values.md): Submit microdeposit amounts to verify company bank accounts.
- [Create Contractor Deduction Template](https://docs.zeal.com/reference/contractor-deduction-templates/create-contractor-deduction-template.md): Create a deduction template for a contractor, such as a garnishment or miscellaneous deduction.
- [Delete Contractor Deduction Template](https://docs.zeal.com/reference/contractor-deduction-templates/delete-contractor-deduction-template.md): Delete a contractor deduction template by deductionTemplateID.
- [Get Contractor Deduction Templates](https://docs.zeal.com/reference/contractor-deduction-templates/get-contractor-deduction-templates.md): Retrieve contractor deduction templates for a company, optionally filtered by contractorID or deduction_type.
- [Update Contractor Deduction Template](https://docs.zeal.com/reference/contractor-deduction-templates/update-contractor-deduction-template.md): Update fields on an existing contractor deduction template by deductionTemplateID.
- [Create Contractor ID Upload Link](https://docs.zeal.com/reference/contractor-onboarding/create-contractor-id-verification-link.md): Creates a shareable link for contractors to submit their ID verification information when they receive an id_verification_required status.
- [Create Instant Pay Contractor Enrollment Link](https://docs.zeal.com/reference/contractor-onboarding/create-instant-pay-enrollment-link.md): Create an enrollment link for a contractor to enroll in Instant Pay.
- [Create Paycard Enrollment Link (Early Access)](https://docs.zeal.com/reference/contractor-onboarding/create-paycard-enrollment-link.md): Generate a link for a contractor to complete Paycard Enrollment.
- [Generate Contractor Onboarding Link](https://docs.zeal.com/reference/contractor-onboarding/generate-contractor-onboarding-link.md): Generate an expirable link to Zeal's hosted contractor onboarding flow.
- [Set Onboarded Status to True](https://docs.zeal.com/reference/contractor-onboarding/set-onboarded-status-to-true.md): Set a contractor as onboarded once all legally required information has been provided.
- [Contractor Payment Object](https://docs.zeal.com/reference/contractor-payments/contractor-payment-object.md): The Contractor Payment Object represents a payment made out to a Contractor Object.
- [Create Contractor Payment](https://docs.zeal.com/reference/contractor-payments/create-contractor-payment.md): Create a contractor payment in Zeal; the payment is processed the day before the pay_date.
- [Delete Contractor Payment](https://docs.zeal.com/reference/contractor-payments/delete-contractor-payment.md): Delete a pending contractor payment by contractorPaymentID in Zeal.
- [Get Contractor Payments](https://docs.zeal.com/reference/contractor-payments/get-contractor-payments.md): Retrieve a contractor payment by its contractorPaymentID.
- [Trigger Disbursement](https://docs.zeal.com/reference/contractor-payments/trigger-disbursement.md): Trigger early disbursement of a pending contractor payment before the standard cutoff time.
- [Update Contractor Payment](https://docs.zeal.com/reference/contractor-payments/update-contractor-payment.md): Update fields on an existing, pending contractor payment in Zeal.
- [Contractor Object](https://docs.zeal.com/reference/contractors/contractor-object.md): The Contractor Object represents a 1099 contractor for a given company.
- [Create Contractor](https://docs.zeal.com/reference/contractors/create-contractor.md): Create one or more 1099 contractors under a company in Zeal.
- [Get Contractor Information](https://docs.zeal.com/reference/contractors/get-contractor-information.md): Retrieve key information about a single 1099 contractor by contractorID.
- [Get Contractors](https://docs.zeal.com/reference/contractors/get-contractors.md): Retrieve information on contractors for a company, with optional filters.
- [Update Contractor Information](https://docs.zeal.com/reference/contractors/update-contractor-information.md): Update fields on an existing 1099 contractor's record in Zeal.
- [Upload Contractor Government ID](https://docs.zeal.com/reference/contractors/upload-contractor-government-id.md): Upload a base64-encoded government ID (driver's license, social security card, or passport) for a contractor.
- [Custom Attribute Object](https://docs.zeal.com/reference/custom-attributes/custom-attribute-object.md): The Custom Attribute object represents an attribute that can be set on an employee or contractor.
- [Get Attributes](https://docs.zeal.com/reference/custom-attributes/get-attributes.md): Retrieve the custom attributes set on an employee or contractor.
- [Set Attribute Value](https://docs.zeal.com/reference/custom-attributes/set-attribute-value.md): Set the value of custom attributes on an employee or contractor.
- [Create Customer Account](https://docs.zeal.com/reference/customer-accounts/create-customer-account.md): Create a new customer account under a company.
- [Create Funding Source](https://docs.zeal.com/reference/customer-accounts/create-funding-source.md): Create a bank account funding source for a customer account using account and routing numbers.
- [Customer Account Object](https://docs.zeal.com/reference/customer-accounts/customer-account-object.md): The Customer Account Object represents a client under a Company that workers, checks, and shifts can be attributed to.
- [Generate Customer Account Onboarding Link](https://docs.zeal.com/reference/customer-accounts/generate-customer-account-onboarding-link.md): Generate an onboarding link for a customer account.
- [Get All Customer Accounts](https://docs.zeal.com/reference/customer-accounts/get-all-customer-accounts.md): Fetch a list of Customer Accounts associated with the specified Company ID.
- [Get Customer Account](https://docs.zeal.com/reference/customer-accounts/get-customer-account.md): Fetch a specified Customer Account object using the passed Customer Account ID.
- [Set Customer Account Onboarded To true](https://docs.zeal.com/reference/customer-accounts/set-customer-account-onboarded-to-true.md): Manually set a customer account's onboarded status to true.
- [Trigger Microdeposits](https://docs.zeal.com/reference/customer-accounts/trigger-ca-microdeposits.md): Trigger microdeposits for the Customer Account funding account for verification.
- [Update Customer Account](https://docs.zeal.com/reference/customer-accounts/update-customer-account.md): Update a specified Customer Account's business details, such as EIN, address, phone, or status.
- [Verify Microdeposits](https://docs.zeal.com/reference/customer-accounts/verify-microdeposits.md): Submit microdeposit amounts to verify a customer account's bank account.
- [Get Documents](https://docs.zeal.com/reference/documents/get-documents.md): Access tax/payroll documents for a company, employee, and/or contractor, such as Quarterly Federal Tax Returns, W-2s, 1099s, etc.
- [The Document Object](https://docs.zeal.com/reference/documents/the-document-object.md): The Zeal object representing a company tax document.
- [Accrual Balance History](https://docs.zeal.com/reference/embedded-hr/accrual-balance-history.md): View accrual balance history for a company, filtered by policy code and employee IDs.
- [Accrual Policy Object](https://docs.zeal.com/reference/embedded-hr/accrual-policy-object.md): Reference for the Accrual Policy object representing a PTO, sick leave, or custom accrual policy assigned to company employees.
- [Add/Remove Employees to Accrual Policy](https://docs.zeal.com/reference/embedded-hr/add-employees-to-accrual-policy.md): Add or remove employees from an existing accrual policy by company and policy code.
- [Create Accrual Policy](https://docs.zeal.com/reference/embedded-hr/create-accrual-policy.md): Create a new PTO, sick leave, or custom accrual policy for a company.
- [Create Accrual Policy Usage](https://docs.zeal.com/reference/embedded-hr/create-accrual-policy-usage.md): Apply accrual usage (or a correction) for one or more employees under a given accrual policy.
- [Get Accrual Balance](https://docs.zeal.com/reference/embedded-hr/get-accrual-balance.md): Retrieve an employee's or company's accrual policy balance, optionally filtered by policy code, employee, or policy status.
- [Get Accrual Policy](https://docs.zeal.com/reference/embedded-hr/get-accrual-policy.md): Fetch an existing accrual policy for a company, optionally filtered by policy code or policy status.
- [Get Minimum Wage Rules](https://docs.zeal.com/reference/embedded-hr/get-minimum-wage-rules.md): Fetch minimum wage rules for a specified work location, optionally as of a given effective date.
- [Get Sick Time Compliance Rules](https://docs.zeal.com/reference/embedded-hr/get-sick-time-compliance-rules.md): Retrieve state and municipal compliance rules for earned paid sick leave by state and optional city.
- [Update Accrual Balance](https://docs.zeal.com/reference/embedded-hr/update-accrual-balance.md): Update an accrual balance corresponding to an accrual policy for one or more employees.
- [Update Accrual Policy](https://docs.zeal.com/reference/embedded-hr/update-accrual-policy.md): Update the configuration of an existing accrual policy, such as its accrual rate, caps, rollover rules, or status.
- [Create Deduction](https://docs.zeal.com/reference/employee-checks/deductions/create-deduction.md): Create a Deduction and attach it to a specific employee check based on a Deduction Template.
- [Create Deduction Template](https://docs.zeal.com/reference/employee-checks/deductions/create-deduction-template.md): Create a Deduction Template for a company that defines the rules for a class of deduction, such as a 401(k) or garnishment.
- [Deduction Object](https://docs.zeal.com/reference/employee-checks/deductions/deduction-object.md): Deduction Object is created using a Deduction Template and is attached to an Employee Check.
- [Deduction Template Definition Object](https://docs.zeal.com/reference/employee-checks/deductions/deduction-template-definition-object.md): Deduction Template Definition represents a JSON schema that describes how to create a Deduction Template in JSON format.
- [Deduction Template Object](https://docs.zeal.com/reference/employee-checks/deductions/deduction-template-object.md): Deduction Template Object represents a template that can be used to create Deductions.
- [Delete Deduction](https://docs.zeal.com/reference/employee-checks/deductions/delete-deduction.md): Delete a deduction attached to an employee check.
- [Get Deduction](https://docs.zeal.com/reference/employee-checks/deductions/get-deduction.md): Retrieve a specific deduction attached to an employee check.
- [Get Deduction Template](https://docs.zeal.com/reference/employee-checks/deductions/get-deduction-template.md): Get a Deduction Template for a company.
- [Get Deduction Template Definitions](https://docs.zeal.com/reference/employee-checks/deductions/get-deduction-template-definitions.md): Retrieve the JSON schema definition for a deduction type, describing every field allowed when creating a Deduction Template.
- [Types of Deductions](https://docs.zeal.com/reference/employee-checks/deductions/types-of-deductions.md): The following is a list of Deductions (both pre-tax and post-tax) that Zeal supports.
- [Update Deduction](https://docs.zeal.com/reference/employee-checks/deductions/update-deduction.md): Update a deduction attached to an employee check.
- [Create Bulk Employee Checks](https://docs.zeal.com/reference/employee-checks/employee-checks/create-bulk-employee-checks.md): Create a batch of up to 100 employee checks in a single request as part of a payroll run.
- [Create Employee Check](https://docs.zeal.com/reference/employee-checks/employee-checks/create-employee-check.md): Create a new payroll check for a W-2 employee by submitting shifts, a reporting period, and a check date.
- [Delete Employee Check](https://docs.zeal.com/reference/employee-checks/employee-checks/delete-employee-check.md): Delete a pending employee check.
- [Download Paystub PDF](https://docs.zeal.com/reference/employee-checks/employee-checks/download-paystub-pdf.md): Fetch a PDF of a paystub corresponding to a processed employee check.
- [Employee Check Object](https://docs.zeal.com/reference/employee-checks/employee-checks/employee-check-object.md): The Employee Check object represents a paycheck for an employee, including pay, taxes, deductions, and disbursement details.
- [Get Employee Check by ID](https://docs.zeal.com/reference/employee-checks/employee-checks/get-employee-check-by-id.md): Retrieve a single employee check by its employeeCheckID.
- [Get Employee Checks by Employee](https://docs.zeal.com/reference/employee-checks/employee-checks/get-employee-checks-by-employee.md): Retrieve employee checks for a given employee, optionally filtered by status or reporting period.
- [Update Employee Check](https://docs.zeal.com/reference/employee-checks/employee-checks/update-employee-check.md): Update a pending employee check - approve it, change the check date, or update the disbursement method.
- [Get Upcoming Regular Payroll](https://docs.zeal.com/reference/employee-checks/payroll-run/get-upcoming-regular-payroll.md): Get the upcoming regularly scheduled check date for a company and its associated reporting period.
- [Get All Reporting Periods](https://docs.zeal.com/reference/employee-checks/reporting-periods/get-all-reporting-periods.md): List all reporting periods for a company, optionally filtered by pay schedule.
- [Get Reporting Period by Date Range](https://docs.zeal.com/reference/employee-checks/reporting-periods/get-reporting-period-by-date-range.md): Retrieve the reporting period containing a given date range and pay schedule.
- [Get Reporting Period by ID](https://docs.zeal.com/reference/employee-checks/reporting-periods/get-reporting-period-by-id.md): Retrieve a single reporting period for a company by its reportingPeriodID.
- [Pay Frequency, Reporting Periods and Check Dates](https://docs.zeal.com/reference/employee-checks/reporting-periods/pay-frequency-reporting-periods-and-check-dates.md): How pay frequency, reporting periods, and check dates work in Zeal, and how they affect payroll timing.
- [Reporting Period Object](https://docs.zeal.com/reference/employee-checks/reporting-periods/reporting-period-object.md): The Reporting Period object represents a date range for a single pay cycle. Learn its schema and how it's used when creating employee payroll checks.
- [Add Shifts to Existing Check](https://docs.zeal.com/reference/employee-checks/shifts/add-shifts-to-check.md): Add one or more shifts to an existing, pending employee check.
- [Delete Pending Shifts](https://docs.zeal.com/reference/employee-checks/shifts/delete-pending-shifts.md): Delete a shift from a pending employee check.
- [Get Shift Information](https://docs.zeal.com/reference/employee-checks/shifts/get-shift-information.md): Retrieve a specific shift by its shiftID.
- [Shift Object](https://docs.zeal.com/reference/employee-checks/shifts/shift-object.md): Learn the Shift Object schema for describing work and earnings on an employee check.
- [Update Pending Shifts](https://docs.zeal.com/reference/employee-checks/shifts/update-pending-shifts.md): Update the time and earning components of shifts on a pending employee check.
- [Create Employee Deduction Template](https://docs.zeal.com/reference/employee-deduction-templates/create-employee-deduction-template.md): Create an employee deduction template, such as a 401(k), HSA, garnishment, or miscellaneous deduction.
- [Delete Employee Deduction Template](https://docs.zeal.com/reference/employee-deduction-templates/delete-employee-deduction-template.md): Delete an employee deduction template by its deductionTemplateID.
- [Get Employee Deduction Template](https://docs.zeal.com/reference/employee-deduction-templates/get-employee-deduction-template.md): Retrieve a single employee deduction template by its deductionTemplateID.
- [List Employee Deduction Templates](https://docs.zeal.com/reference/employee-deduction-templates/list-employee-deduction-templates.md): Retrieve a paginated list of employee deduction templates, optionally filtered by company, employee, or template fields.
- [Update Employee Deduction Template](https://docs.zeal.com/reference/employee-deduction-templates/update-employee-deduction-template.md): Update fields on an existing employee deduction template by deductionTemplateID.
- [Create Account Setup Link](https://docs.zeal.com/reference/employee-onboarding/create-account-setup-link.md): This endpoint provides a link for an employee to complete Account Setup.
- [Create Bank Account Collection Link](https://docs.zeal.com/reference/employee-onboarding/create-bank-account-collection-link.md): Create a link for an employee to submit their bank account information.
- [Create Custom Paperwork Link (Early Access)](https://docs.zeal.com/reference/employee-onboarding/create-custom-paperwork-link.md): Create a link for an employee to complete custom paperwork in Zeal.
- [Create Employee ID Upload Link](https://docs.zeal.com/reference/employee-onboarding/create-employee-id-upload-link.md): Create a shareable link for an employee to submit their ID verification information.
- [Create I9 Link (Early Access)](https://docs.zeal.com/reference/employee-onboarding/create-i9-link.md): Create a link for an employee to complete the I-9 Form in Zeal.
- [Create Instant Pay Employee Enrollment Link](https://docs.zeal.com/reference/employee-onboarding/create-instant-pay-enrollment-link.md): Create an enrollment link for an employee to enroll in Instant Pay.
- [Create Paycard Enrollment Link (Early Access)](https://docs.zeal.com/reference/employee-onboarding/create-paycard-enrollment-link.md): This endpoint provides a link for an employee to complete Paycard Enrollment Link.
- [Create Profile Information Collection Link](https://docs.zeal.com/reference/employee-onboarding/create-profile-information-collection-link.md): Create a link for an employee to submit profile information in Zeal.
- [Create W4 Link](https://docs.zeal.com/reference/employee-onboarding/create-w4-link.md): Create a link for an employee to complete their W-4 tax form in Zeal.
- [Generate Employee Onboarding Link](https://docs.zeal.com/reference/employee-onboarding/generate-employee-onboarding-link.md): Generates an expirable link to Zeal's employee payroll onboarding for a specified employee.
- [Generate Employee Tax Parameter Definitions](https://docs.zeal.com/reference/employee-onboarding/generate-employee-tax-parameter-definitions.md): Retrieve all tax parameters used for withholding calculations.
- [Get Employee Requirements](https://docs.zeal.com/reference/employee-onboarding/get-employee-requirements.md): Get additional tax requirements for an employee in Zeal.
- [Get Employee Requirements Link](https://docs.zeal.com/reference/employee-onboarding/get-employee-requirements-link.md): Get links to submit additional tax requirements for an employee in Zeal (Early Access).
- [Get Employee Tax Parameter Summary](https://docs.zeal.com/reference/employee-onboarding/get-employee-tax-parameter-summary.md): Retrieve a list of an employee's tax withholding parameters.
- [Get I9 Status (Early Access)](https://docs.zeal.com/reference/employee-onboarding/get-i9-status.md): Get the status of an I9's completion in Zeal.
- [Send Employee Onboarding Link](https://docs.zeal.com/reference/employee-onboarding/send-employee-onboarding-link.md): Sends an employee onboarding link to the specified employee's email in Zeal.
- [Set Employee Tax Parameters](https://docs.zeal.com/reference/employee-onboarding/set-employee-tax-parameters.md): Set an employee's tax withholding parameters.
- [Set Onboarded Status to True](https://docs.zeal.com/reference/employee-onboarding/set-onboarded-status-to-true.md): Set an employee as onboarded.
- [Upload Employee Government ID](https://docs.zeal.com/reference/employee-onboarding/upload-employee-government-id.md): Uploads a government issued ID for a specified employee in Zeal.
- [Create Employee](https://docs.zeal.com/reference/employees/create-employee.md): Create one or more W-2 employees under a company in Zeal.
- [Employee Requirements Object](https://docs.zeal.com/reference/employees/employee-requirements-object.md): The Zeal object representing a requirement for an employee, such as a form to be completed.
- [Get Employee Information](https://docs.zeal.com/reference/employees/get-employee-information.md): Retrieve key information about a single W-2 employee by employeeID.
- [Get Employees](https://docs.zeal.com/reference/employees/get-employees.md): Retrieve summarized information for all employees under a company, with optional filters.
- [The Employee Object](https://docs.zeal.com/reference/employees/the-employee-object.md): The Employee Object represents a W-2 employee for a given company.
- [Update Employee Information](https://docs.zeal.com/reference/employees/update-employee-information.md): Update a specific employee record in Zeal.
- [Employer Check Object](https://docs.zeal.com/reference/employer-checks/employer-check-object.md): The Zeal Employer Check represents a payroll run and is only created when checks are sent out (typically the day before a check date).
- [Employer CheckID Object](https://docs.zeal.com/reference/employer-checks/employer-checkid-object.md): The Zeal object identifying an employer check and the reporting periods it contains.
- [Get Employer Check by ID](https://docs.zeal.com/reference/employer-checks/get-employer-check-by-id.md): Retrieve employer check records for a company by companyID.
- [Authentication and Keys](https://docs.zeal.com/reference/introduction/authentication-and-keys.md): Learn how to obtain your Zeal API keys, pass them as Bearer tokens, manage test vs. production keys, and keep your credentials secure.
- [Early Access Endpoints](https://docs.zeal.com/reference/introduction/early-access-endpoints.md): If endpoints are marked Early Access, they are available on a case-by-case basis per partner contracts.
- [Error Codes](https://docs.zeal.com/reference/introduction/error-codes.md): HTTP status codes and error codes returned by the Zeal API, with their meanings.
- [Idempotency](https://docs.zeal.com/reference/introduction/idempotency.md): You can add an Idempotency Key in the request headers to ensure that a particular operation is only performed once.
- [Introduction](https://docs.zeal.com/reference/introduction/introduction.md): Explore the Zeal REST API: base URL, authentication, request and response formats, environments, and available resource groups for embedded payroll.
- [Metadata](https://docs.zeal.com/reference/introduction/metadata.md): Updateable objects in Zeal, such as Employee Check and Shifts, have a metadata parameter you can use to attach key-value data to Zeal objects.
- [Pagination](https://docs.zeal.com/reference/introduction/pagination.md): Zeal's API endpoints use cursor-based pagination through the start_at parameter.
- [Rate Limiting](https://docs.zeal.com/reference/introduction/rate-limiting.md): The Zeal API employs rate limiting to help maximize its stability.
- [Times and Dates](https://docs.zeal.com/reference/introduction/times-and-dates.md): All times and dates required for Zeal's Payroll API should ideally be represented as date-times or dates in ISO-8601 format in UTC.
- [Create a paperwork submission](https://docs.zeal.com/reference/paperwork-api/create-paperwork-submission.md): Create a Paperwork Submission for an employee or contractor from a Paperwork Template.
- [Get paperwork submissions](https://docs.zeal.com/reference/paperwork-api/get-paperwork-submissions.md): Get one or more Paperwork Submissions by company ID or filters.
- [Get Paperwork Template by ID](https://docs.zeal.com/reference/paperwork-api/get-paperwork-template-by-id.md): Fetch a specified Paperwork Template by its template ID.
- [Get Paperwork Templates](https://docs.zeal.com/reference/paperwork-api/get-paperwork-templates.md): Get one or more Paperwork Templates by company ID or filters.
- [Get a specific paperwork submission](https://docs.zeal.com/reference/paperwork-api/get-specific-paperwork-submission.md): Gets a specific Paperwork Submission(s) by its submissionID.
- [Paperwork Submission Object](https://docs.zeal.com/reference/paperwork-api/paperwork-submission-object.md): The Paperwork Submission object represents a submitted paperwork form for a worker's onboarding process.
- [Paperwork Template Object](https://docs.zeal.com/reference/paperwork-api/paperwork-template-object.md): The Paperwork Template object represents a template for custom paperwork used during a worker's onboarding process.
- [Get Paycards](https://docs.zeal.com/reference/paycards/get-paycards.md): Retrieve paycards for a company, optionally filtered by employee, contractor, paycard ID, or date range.
- [Paycard Object](https://docs.zeal.com/reference/paycards/paycard-object.md): Attributes of the Paycard object, including status and type values.
- [Create Payment Item](https://docs.zeal.com/reference/payment-items/create-payment-item.md): Add a payment item line to a pending contractor payment.
- [Payment Item Object](https://docs.zeal.com/reference/payment-items/payment-item-object.md): Individual line items within a contractor payment, referencing a service type or standalone.
- [Update Payment Item](https://docs.zeal.com/reference/payment-items/update-payment-item.md): Update fields on an existing payment item by paymentItemID.
- [Get Preview](https://docs.zeal.com/reference/preview/get-preview.md): Retrieve a previously generated payroll preview by job ID.
- [Get Next Available Check/Pay Date](https://docs.zeal.com/reference/preview/get-preview-available-date.md): Retrieve the next feasible check or pay date for employee checks or contractor payments based on speed and disbursement method.
- [Preview Check Data](https://docs.zeal.com/reference/preview/preview-check-data.md): Preview calculated pay, tax, and deduction data for a single employee check before it is created.
- [Preview Overtime Checks](https://docs.zeal.com/reference/preview/preview-overtime-checks.md): Generate a job ID to preview payroll calculations that include overtime-eligible shift hours for pending checks.
- [Preview Payroll by Check Date](https://docs.zeal.com/reference/preview/preview-payroll-by-check-date.md): Generate a payroll preview job for all pending checks on a given check date.
- [Preview Payroll by Check IDs](https://docs.zeal.com/reference/preview/preview-payroll-by-check-ids.md): Generate a payroll preview job for one or more pending checks by employee check ID.
- [Get Reserve Balance](https://docs.zeal.com/reference/provider-accounts/get-reserve-balance.md): Retrieve reserve account balances for a company, optionally filtered by account type and date range.
- [Create Cash Requirements Report](https://docs.zeal.com/reference/reports/create-cash-requirements-report.md): Start an asynchronous job to generate a Cash Requirements report showing the funds a company needs to cover an upcoming payroll run.
- [Create Custom Payroll Journal Report](https://docs.zeal.com/reference/reports/create-custom-payroll-journal-report.md): Start an asynchronous job to generate a customizable Payroll Journal report with configurable columns and grouping.
- [Create Deduction Summary Report](https://docs.zeal.com/reference/reports/create-deduction-summary-report.md): Start an asynchronous job to generate a Deduction Summary report listing employee deductions within a date range, broken down by deduction type.
- [Create KYC Summary Report](https://docs.zeal.com/reference/reports/create-kyc-summary-report.md): Create a report containing KYC flagged workers by company.
- [Create Labor Allocation Report](https://docs.zeal.com/reference/reports/create-labor-allocation-report.md): Start an asynchronous job to generate a Labor Allocation report showing how labor hours and costs are distributed across cost centers or departments.
- [Create Payment Summary Report](https://docs.zeal.com/reference/reports/create-payment-summary-report.md): Start an asynchronous job to generate a Payment Summary report summarizing employee and contractor payments within a date range.
- [Create Payroll Journal Report](https://docs.zeal.com/reference/reports/create-payroll-journal-report.md): Start an asynchronous job to generate a Payroll Journal report with a detailed breakdown of payroll checks processed within a date range.
- [Create Paystub Report](https://docs.zeal.com/reference/reports/create-paystub-report.md): Start an asynchronous job to generate paystub documents for employee checks within a date range.
- [Create Quarter to Date Report](https://docs.zeal.com/reference/reports/create-quarter-to-date-report.md): Start an asynchronous job to generate a Quarter to Date (QTD) report summarizing cumulative payroll totals for a company.
- [Create Worker Summary Report](https://docs.zeal.com/reference/reports/create-worker-summary-report.md): Start an asynchronous job to generate a Worker Summary report covering employee and contractor details for a company.
- [Create Year to Date Report](https://docs.zeal.com/reference/reports/create-year-to-date-report.md): Start an asynchronous job to generate a Year to Date (YTD) report summarizing cumulative payroll totals for a company.
- [Get Job Status](https://docs.zeal.com/reference/reports/get-job-status.md): Poll the status of a previously submitted report job and retrieve the download URL once the job completes.
- [Get Report Download](https://docs.zeal.com/reference/reports/get-report-download.md): Download the completed file for a previously generated report job.
- [Get Taxable Location by ID](https://docs.zeal.com/reference/taxable-locations/get-taxable-location-by-id.md): Retrieve an existing Taxable Location object in Zeal's system by its taxableLocationID.
- [Resolve Taxable Location](https://docs.zeal.com/reference/taxable-locations/resolve-taxable-location.md): Find or create a Taxable Location object in Zeal's system. This request will try to match an existing record with a case-sensitive search.
- [Taxable Location Object](https://docs.zeal.com/reference/taxable-locations/taxable-location-object.md): The Taxable Location Object represents a U.S.-based address that describes its suitability for use as a work location or residency.
- [Card Object](https://docs.zeal.com/reference/wallet/card-object.md): The Zeal object representing a worker's card used for Instant Pay transfers.
- [Get Card](https://docs.zeal.com/reference/wallet/get-card.md): Retrieve card information for an employee or contractor by companyID and employeeID or contractorID.
- [Get Wallet Balance](https://docs.zeal.com/reference/wallet/get-wallet-balance.md): Retrieve the wallet balance for an employee or contractor by companyID and employeeID or contractorID.
- [Get Wallet Transactions](https://docs.zeal.com/reference/wallet/get-wallet-transactions.md): Retrieve wallet transactions for an employee or contractor by companyID and employeeID or contractorID.
- [Transfer Funds](https://docs.zeal.com/reference/wallet/transfer-funds.md): Transfer funds to an employee or contractor's card, optionally connected to an employee check or contractor payment.
- [Wallet Transaction Object](https://docs.zeal.com/reference/wallet/wallet-transaction-object.md): A Wallet Transaction represents the movement of funds into (credit) or out of (debit) the worker's Instant Pay Wallet.
- [Bank Account Event](https://docs.zeal.com/reference/webhooks/bank-account-event.md): POSTs a request containing Bank Account details when it is created or updated.
- [Company Event](https://docs.zeal.com/reference/webhooks/company-event.md): POSTs a request upon update of a Company object.
- [Company Onboarding Event](https://docs.zeal.com/reference/webhooks/company-onboarding-event.md): POSTs a request upon completion of Company Onboarding.
- [Contractor Event](https://docs.zeal.com/reference/webhooks/contractor-event-webhook.md): Details on the Contractor Event webhook - when it fires, the full payload schema, and how to configure your receiving endpoint in the Partner Dashboard.
- [Contractor Payment Event](https://docs.zeal.com/reference/webhooks/contractor-payment-event.md): POSTs a request when a contractor payment is created, updated, or deleted in the Zeal dashboard.
- [Create Employee Event](https://docs.zeal.com/reference/webhooks/create-employee-event.md): POSTs a request upon creation of an employee in the Zeal dashboard.
- [Customer Account Event](https://docs.zeal.com/reference/webhooks/customer-account-event.md): POSTs a request upon update of a Customer Account object.
- [Customer Account Onboarding Event](https://docs.zeal.com/reference/webhooks/customer-account-onboarding-event.md): POSTs a request upon completion of Company Onboarding.
- [Employee Check Event](https://docs.zeal.com/reference/webhooks/employee-check-event.md): POSTs a request when an employee check is created, updated, or deleted in the Zeal dashboard.
- [Employee E-Verify Update Event (Early Access)](https://docs.zeal.com/reference/webhooks/employee-e-verify-update-event.md): POSTs request when there is an update to E-verify for an Employee.
- [Employee Event](https://docs.zeal.com/reference/webhooks/employee-event.md): POSTs a request when the employee object has been updated in the Zeal dashboard.
- [Employee I9 Update Event (Early Access)](https://docs.zeal.com/reference/webhooks/employee-i9-update-event.md): This endpoint specifies what will be sent to your Employee I9 Event Webhook.
- [Employee Onboarding Event](https://docs.zeal.com/reference/webhooks/employee-onboarding-event.md): Details on the Employee Onboarding webhook event - when it fires, the full payload schema, and how to configure your receiving endpoint in Zeal.
- [Employee Requirements Create Event](https://docs.zeal.com/reference/webhooks/employee-requirements-create-event.md): This endpoint specifies what will be sent to your Employee Requirement Webhook.
- [Employee Requirements Update Event](https://docs.zeal.com/reference/webhooks/employee-requirements-update-event.md): This endpoint specifies what will be sent to your Employee Requirement Webhook.
- [Employer Check Created Event](https://docs.zeal.com/reference/webhooks/employer-check-created-event.md): POSTs request when an employer check is created from existing pending checks.
- [Employer Check Processed Event](https://docs.zeal.com/reference/webhooks/employer-check-processed.md): POSTs a request when an employer check enters processing.
- [Employer Check Processed Webhook Lite](https://docs.zeal.com/reference/webhooks/employer-check-processed-lite.md): A lite version of the Employer Check Processed Event Webhook that returns employee_checks as an array of employeeCheckIDs.
- [Garnishment Event](https://docs.zeal.com/reference/webhooks/garnishment-event.md): POSTs garnishment lifecycle and payroll-scoped events to your garnishment webhook URL.
- [Instant Pay Wallet Transaction Event](https://docs.zeal.com/reference/webhooks/instant-pay-wallet-transaction-event.md): This endpoint specifies what will be sent to your Instant Pay Wallet Webhook.
- [Paperwork Submission Event](https://docs.zeal.com/reference/webhooks/paperwork-submission-event.md): POSTs a request containing a Paperwork Submission Object when paperwork is submitted.
- [Paycard Onboarding Status Event (Early Access)](https://docs.zeal.com/reference/webhooks/paycard-onboarding-status-event.md): POSTs request when Paycard Onboarding is shown to a worker.
- [Job Queue Event](https://docs.zeal.com/reference/webhooks/report-status-change-webhook.md): POSTs a request whenever a report and its corresponding job is created or updated.
- [Shift Event](https://docs.zeal.com/reference/webhooks/shift-event.md): POSTs request when a shift has been created, updated, or deleted in the Zeal dashboard.
- [Transaction Update Event](https://docs.zeal.com/reference/webhooks/transaction-update-event.md): This endpoint specifies what will be sent to your Transaction Webhook.
- [Webhook Event Overview](https://docs.zeal.com/reference/webhooks/webhook-events.md): Overview of all webhook events Zeal sends - company and employee onboarding, contractor, and report status change - with payloads and security details.
- [What are Zeal Webhooks?](https://docs.zeal.com/reference/webhooks/what-are-zeal-webhooks.md): Webhooks are the way decisions and events are communicated by Zeal to you.
- [Create Work Location](https://docs.zeal.com/reference/work-locations/create-work-location.md): Creates a Work Location for a specific company. You will receive an error if you try to create two work locations with the same combination of taxableLocationID and work_site_id.
- [Get Work Locations](https://docs.zeal.com/reference/work-locations/get-work-locations.md): Get a specific Work Location or all Work Locations in Zeal's system for a company.
- [Update Work Location](https://docs.zeal.com/reference/work-locations/update-work-location.md): Update the name or work_site_id of an existing Work Location in Zeal's system.
- [Work Location Object](https://docs.zeal.com/reference/work-locations/work-location-object.md): The Work Location Object represents a Taxable Location Object with some extra metadata for reporting.
- [Generate Company Login Link](https://docs.zeal.com/reference/zeal-components/generate-company-login-link.md): Generate a link that automatically signs in a company and redirects them to their Zeal Company Dashboard, where they can manage and run payroll. This link can only be generated in production and expires exactly 7 days after generation.
- [Generate Company Taxes Page link](https://docs.zeal.com/reference/zeal-components/generate-company-taxes-page-link.md): Generate a link that automatically signs in a company and redirects them to their Taxes Dashboard, where they can view and edit taxes. This link can only be generated in production and expires exactly 7 days after generation.
- [Generate Employee or Contractor Dashboard Link](https://docs.zeal.com/reference/zeal-components/generate-employee-contractor-dashboard-link.md): Generate a link that automatically signs in an employee or contractor and redirects them to their Zeal worker dashboard. This link expires exactly 7 days after generation.
- [Generate Reports Link](https://docs.zeal.com/reference/zeal-components/generate-reports-link.md): Generate a link that automatically signs in an employer and redirects them to their Zeal Reports Dashboard, where they can view all reports. This link can only be generated in production and expires exactly 7 days after generation.
- [Get Contractor Payment Link](https://docs.zeal.com/reference/zeal-components/get-contractor-payment-link.md): Given the Company ID and Contractor Payment ID, Zeal returns an expirable, mobile-friendly link with the contractor payment details, including the ability to download the pay statement.
- [Get Paystub/Employee Check Link](https://docs.zeal.com/reference/zeal-components/get-paystub-link.md): Given the Company ID and Employee Check ID, Zeal returns an expirable, mobile-friendly link with the employee check details, including the ability to download the paystub. This link expires 24 hours after generation.

## OpenAPI Specs

- [zeal-api](https://docs.zeal.com/openapi/zeal-api.json)
- [employee-checks](https://docs.zeal.com/openapi/employee-checks.json)
- [companies](https://docs.zeal.com/openapi/companies.json)