Jump to Content

Guides API Reference Changelog

Log In

API Reference

Log In

Guides API Reference Changelog

All

Pages

Start typing to search…

Introduction

Introduction
Authentication and Keys
Error Codes
Rate Limiting
Idempotency
Times and Dates
Pay Frequency, Reporting Periods and Check Dates
Early Access Endpoints
Metadata
Pagination

Webhooks

What are Zeal Webhooks?
Webhook Event Overview
Create Employee Event
Company Onboarding Event
Company Event
Customer Account Onboarding Event
Customer Account Event
Employee Onboarding Event
Employee Event
Contractor Event
Employee Check Event
Contractor Payment Event
Shift Event
Employer Check Created Event
Employer Check Processed Event
Employer Check Processed Webhook Lite
Job Queue Event
Employee I9 Update Event (Early Access)
Employee E-Verify Update Event (Early Access)
Employee Requirements Create Event
Employee Requirements Update Event
Paycard Onboarding Status Event (Early Access)
Instant Pay Wallet Transaction Event

Zeal Components

Generate Company Taxes Page linkpost
Generate Company Login Linkpost
Generate Employee or Contractor Dashboard Linkpost
Generate Reports Linkpost
Get Paystub Linkget

Companies

The Company Object
The Requirement Object
Create Companypost
Get Company Onboarding Linkget
Update Company Informationpatch
Get Company Informationget

Company Onboarding

Create Company Bank Accountpost
Trigger Micro-Depositspost
Verify Microdeposit Valuespost
Get Company Authorization Documentsget
Sign Company Authorization Documentspost
Set Company Onboarded Status to Truepost

Reserve Accounts

Get Reserve Balanceget

Customer Accounts [EARLY ACCESS]

Customer Account Object
Create Customer Accountpost
Update Customer Accountpatch
Generate Customer Account Onboarding Linkpost
Set Customer Account Onboarded To truepost
Create Funding Sourcepost
Trigger Microdepositspost
Verify Microdepositspost
Get Customer Accountget
Get All Customer Accountsget

Taxable Locations

Taxable Location Object
Resolve Taxable Locationpost
Get Taxable Location by IDget

Work Locations

Work Location Object
Create Work Locationpost
Get Work Locationsget
Update Work Locationpatch

Employees

The Employee Object
Create Employeepost
Update Employee Informationpatch
Get Employee Informationget
Get Employeesget
Upload Employee Government IDpost
Employee Requirements Object
Get Employee Requirementsget

Employee Deduction Templates

Create Employee Deduction Templatepost
List Employee Deduction Templatesget
Update Employee Deduction Templatepatch
Get Employee Deduction Templateget
Delete Employee Deduction Templatedel

Employee Onboarding

Generate Employee Onboarding Linkpost
Send Employee Onboarding Linkpost
Generate Employee Tax Parameter Definitionspost
Set Employee Tax Parameterspost
Get Employee Tax Parameter Summarypost
Set Onboarded Status to Truepost
Create Profile Information Collection Linkpost
Create Account Setup Linkpost
Create I9 Link (Early Access)post
Create Custom Paperwork Link (Early Access)post
Create W4 Linkpost
Create Paycard Enrollment Link (Early Access)post
Create Instant Pay Employee Enrollment Linkpost
Create Bank Account Collection Linkpost
Create Employee ID Upload Linkpost
Get I9 Status (Early Access)get

Bank Accounts

Bank Account Object
Create Bank Accountpost
Update Bank Accountpatch
Get Bank Account by IDget

Custom Attributes

Custom Attribute Object
Get Attributesget
Set Attribute Valuepatch

Paperwork API

Paperwork Templates
Paperwork Submissions

Employee Checks

Reporting Periods
Employee Checks
Deductions
Shifts
Payroll Run
- Get Upcoming Regular Payrollget

Contractors

Contractor Object
Create Contractorpost
Update Contractor Informationpatch
Get Contractor Informationget
Get Contractorsget
Upload Contractor Government IDpost

Contractor Onboarding

Generate Contractor Onboarding Linkpost
Set Onboarded Status to Truepost
Create Contractor ID Upload Linkpost
Create Paycard Enrollment Link (Early Access)post
Create Instant Pay Contractor Enrollment Linkpost

Contractor Payments

Contractor Payment Object
Create Contractor Paymentpost
Trigger Disbursementpost
Update Contractor Paymentpatch
Get Contractor Payment by IDget
Delete Contractor Paymentdel

Paycards [Early Access]

Paycard Object
Get Paycardsget

Instant Pay [EARLY ACCESS]

Card Object
Wallet Transaction Object
Get Cardget
Get Wallet Balanceget
Transfer Fundspost
Get Wallet Transactionsget

Employer Checks

Employer Check Object
Employer CheckID Object
Get Employer Check by IDget

Preview

Preview Payroll by Check IDspost
Preview Payroll by Check Datepost
Preview Check Datapost
Get Previewget
Get Next Available Check/Pay Dateget

Embedded HR

Minimum Wage
- Get Minimum Wage Rulesget
Accrual Policy
FLSA Overtime
- Preview Overtime Checkspost

Reports

Create Payroll Journal Reportpost
Create Custom Payroll Journal Reportpost
Create Worker Summary Reportpost
Create Cash Requirements Reportpost
Create Payment Summary Reportpost
Create Labor Allocation Reportpost
Create Paystub Reportpost
Create Year to Date Reportpost
Create Quarter to Date Reportpost
Create KYC Summary Reportpost
Create Deduction Summary Reportpost
Get Job Statusget
Get Report Downloadget

Documents

The Document Object
Get Documentsget

International Contractors

International Contractor Object
Create International Contractorspost
Update International Contractorpatch
Get International Contractor Informationget
Generate International Contractor Onboarding Linkpost
International Contractor Payment Object
Create International Contractor Paymentpost
Update International Contractor Paymentpatch
Get International Contractor Paymentsget

zeal-api.

/forms
- Get Formsget
- Submit Formspost
/forms/list
- Get Forms Listget
/forms/template
- Get Forms Templateget
/paperwork/contractorPaperwork
- View/Sign Contractor Paperworkpost
/paperwork/employeePaperwork
- View/Sign Employee Paperworkpost

Employee Requirements Update Event

POSTs request when there is an update to an Employee Requirement.