Jump to Content
Guides
API Reference
Changelog
Log In
API Reference
Log In
Guides
API Reference
Changelog
Shift Object
All
Pages
Start typing to search…
JUMP TO
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 Webhook (Early Access)
Employee Requirements Create Webhook
Employee Requirements Update Webhook
Paycard Onboarding Status Webhook (Early Access)
Instant Pay Wallet Webhook
Zeal Components
Generate Company Taxes Page link
post
Generate Company Login Link
post
Generate Employee or Contractor Dashboard Link
post
Generate Reports Link
post
Get Paystub Link
get
Companies
The Company Object
The Requirement Object
Create Company
post
Get Company Onboarding Link
get
Update Company Information
patch
Get Company Information
get
Company Onboarding
Create Company Bank Account
post
Trigger Micro-Deposits
post
Verify Microdeposit Values
post
Get Company Authorization Documents
get
Sign Company Authorization Documents
post
Set Company Onboarded Status to True
post
Reserve Accounts
Get Reserve Balance
get
Customer Accounts [EARLY ACCESS]
Customer Account Object
Create Customer Account
post
Update Customer Account
patch
Generate Customer Account Onboarding Link
post
Set Customer Account Onboarded To true
post
Create Funding Source
post
Trigger Microdeposits
post
Verify Microdeposits
post
Get Customer Account
get
Get All Customer Accounts
get
Taxable Locations
Taxable Location Object
Resolve Taxable Location
post
Get Taxable Location by ID
get
Work Locations
Work Location Object
Create Work Location
post
Get Work Locations
get
Update Work Location
patch
Employees
The Employee Object
Create Employee
post
Update Employee Information
patch
Get Employee Information
get
Get Employees
get
Upload Employee Government ID
post
Employee Requirements Object
Get Employee Requirements
get
Employee Deduction Templates
Create Employee Deduction Template
post
List Employee Deduction Templates
get
Update Employee Deduction Template
patch
Get Employee Deduction Template
get
Delete Employee Deduction Template
del
Employee Onboarding
Generate Employee Onboarding Link
post
Send Employee Onboarding Link
post
Generate Employee Tax Parameter Definitions
post
Set Employee Tax Parameters
post
Get Employee Tax Parameter Summary
post
Set Onboarded Status to True
post
Create Profile Information Collection Link
post
Create Account Setup Link
post
Create I9 Link (Early Access)
post
Create Custom Paperwork Link (Early Access)
post
Create W4 Link
post
Create Paycard Enrollment Link (Early Access)
post
Create Instant Pay Employee Enrollment Link
post
Create Bank Account Collection Link
post
Create Employee ID Upload Link
post
Get I9 Status (Early Access)
get
Bank Accounts
Bank Account Object
Create Bank Account
post
Update Bank Account
patch
Get Bank Account by ID
get
Custom Attributes
Custom Attribute Object
Get Attributes
get
Set Attribute Value
patch
Paperwork API
Paperwork Templates
Paperwork Template Object
Get Paperwork Templates
post
Get Paperwork Template by ID
get
Paperwork Submissions
Paperwork Submission Object
Get paperwork submissions
post
Get a specific paperwork submission
get
Create a paperwork submission
put
Employee Checks
Reporting Periods
Reporting Period Object
Get Reporting Period by Date Range
get
Get All Reporting Periods
get
Employee Checks
Employee Check Object
Create Employee Check
post
Update Employee Check
patch
Delete Employee Check
del
Get Employee Check by ID
get
Get Employee Checks by Employee
get
Create Bulk Employee Checks
post
Download Paystub PDF
get
Deductions
Deduction Template Definition Object
Deduction Template Object
Deduction Object
Types of Deductions
Get Deduction Template Definitions
get
Create Deduction Template
post
Get Deduction Template
get
Create Deduction
post
Get Deduction
get
Update Deduction
patch
Delete Deduction
del
Shifts
Shift Object
Add Shifts to Existing Check
post
Get Shift Information
get
Update Pending Shifts
patch
Delete Pending Shifts
del
Payroll Run
Get Upcoming Regular Payroll
get
Contractors
Contractor Object
Create Contractor
post
Update Contractor Information
patch
Get Contractor Information
get
Get Contractors
get
Upload Contractor Government ID
post
Contractor Onboarding
Generate Contractor Onboarding Link
post
Set Onboarded Status to True
post
Create Contractor ID Upload Link
post
Create Paycard Enrollment Link (Early Access)
post
Create Instant Pay Contractor Enrollment Link
post
Contractor Payments
Contractor Payment Object
Create Contractor Payment
post
Trigger Disbursement
post
Update Contractor Payment
patch
Get Contractor Payment by ID
get
Delete Contractor Payment
del
Paycards [Early Access]
Paycard Object
Get Paycards
get
Instant Pay [EARLY ACCESS]
Card Object
Wallet Transaction Object
Get Card
get
Get Wallet Balance
get
Transfer Funds
post
Get Wallet Transactions
get
Direct Pay [Early Access]
Direct Payment Object
Create Direct Payment
post
Get Direct Payments
get
Employer Checks
Employer Check Object
Employer CheckID Object
Get Employer Check by ID
get
Preview
Preview Payroll by Check IDs
post
Preview Payroll by Check Date
post
Preview Check Data
post
Get Preview
get
Get Next Available Check/Pay Date
get
Embedded HR
Minimum Wage
Get Minimum Wage Rules
get
Accrual Policy
Accrual Policy Object
Create Accrual Policy
post
Update Accrual Policy
patch
Get Accrual Policy
get
Get Sick Time Compliance Rules
get
Add/Remove Employees to Accrual Policy
post
Update Accrual Balance
patch
Get Accrual Balance
get
Create Accrual Policy Usage
post
Accrual Balance History
post
FLSA Overtime
Preview Overtime Checks
post
Reports
Create Payroll Journal Report
post
Create Custom Payroll Journal Report
post
Create Worker Summary Report
post
Create Cash Requirements Report
post
Create Payment Summary Report
post
Create Labor Allocation Report
post
Create Paystub Report
post
Create Year to Date Report
post
Create Quarter to Date Report
post
Create KYC Summary Report
post
Create Deduction Summary Report
post
Get Job Status
get
Get Report Download
get
Documents
The Document Object
Get Documents
get
International Contractors
International Contractor Object
Create International Contractors
post
Update International Contractor
patch
Get International Contractor Information
get
Generate International Contractor Onboarding Link
post
International Contractor Payment Object
Create International Contractor Payment
post
Update International Contractor Payment
patch
Get International Contractor Payments
get
zeal-api.
/forms
Get Forms
get
Submit Forms
post
/forms/list
Get Forms List
get
/forms/template
Get Forms Template
get
/paperwork/contractorPaperwork
View/Sign Contractor Paperwork
post
/paperwork/employeePaperwork
View/Sign Employee Paperwork
post
Shift Object
Ask AI
