Jump to Content

Guides API Reference Changelog

Guides API Reference Changelog

Introduction

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

Webhooks

What are Zeal Webhooks?
Webhook Event Overview
Create Employee Event
Company Onboarding 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

Zeal Components

Generate Employer Taxes Page linkpost
Generate Employer Login Linkpost
Generate Employee Login 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
Get All Company Informationget

Company Onboarding [EARLY ACCESS]

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

Customer Accounts [EARLY ACCESS]

Create Customer Accountpost
Update Customer Accountpatch
Generate Customer Account Onboarding Linkpost
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 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

Bank Accounts

Bank Account Object
Create Bank Accountpost
Update Bank Accountpatch
Get Bank Account by IDget
Get Bank Account by Employee/Contractor IDget

Paperwork [EARLY ACCESS]

Paperwork Templates
Paperwork Submissions

Paperwork [DEPRECATED]

View/Sign Employee Paperworkpost
View/Sign Contractor Paperworkpost

Employee Checks

Reporting Periods
Employee Checks
Deductions
Shifts

Preview Payroll

Preview Payroll by Check IDspost
Preview Payroll by Check Datepost
Preview Check Datapost
Get Previewget

Employer Checks

Employer Check Object
Employer CheckID Object
Get Employer Check by IDget
Get Employer Checks by Dateget
Get All Employer Checksget

Embedded HR [EARLY ACCESS]

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

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

Contractor Payments

Contractor Payment Object
Create Contractor Paymentpost
Update Contractor Paymentpatch
Get Contractor Payment by IDget
Get Contractor Payments by Contractorget
Delete Contractor Paymentdelete

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

Introduction

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

Webhooks

What are Zeal Webhooks?
Webhook Event Overview
Create Employee Event
Company Onboarding 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

Zeal Components

Generate Employer Taxes Page linkpost
Generate Employer Login Linkpost
Generate Employee Login 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
Get All Company Informationget

Company Onboarding [EARLY ACCESS]

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

Customer Accounts [EARLY ACCESS]

Create Customer Accountpost
Update Customer Accountpatch
Generate Customer Account Onboarding Linkpost
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 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

Bank Accounts

Bank Account Object
Create Bank Accountpost
Update Bank Accountpatch
Get Bank Account by IDget
Get Bank Account by Employee/Contractor IDget

Paperwork [EARLY ACCESS]

Paperwork Templates
Paperwork Submissions

Paperwork [DEPRECATED]

View/Sign Employee Paperworkpost
View/Sign Contractor Paperworkpost

Employee Checks

Reporting Periods
Employee Checks
Deductions
Shifts

Preview Payroll

Preview Payroll by Check IDspost
Preview Payroll by Check Datepost
Preview Check Datapost
Get Previewget

Employer Checks

Employer Check Object
Employer CheckID Object
Get Employer Check by IDget
Get Employer Checks by Dateget
Get All Employer Checksget

Embedded HR [EARLY ACCESS]

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

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

Contractor Payments

Contractor Payment Object
Create Contractor Paymentpost
Update Contractor Paymentpatch
Get Contractor Payment by IDget
Get Contractor Payments by Contractorget
Delete Contractor Paymentdelete

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

Early Access Endpoints

If endpoints are marked Early Access, they are available on a case-by-case basis per partner contracts. Please contact the Zeal team to enable these features.