docs/
242 pages · Updated July 18, 2026
Pages
- Employee Check Object
- Generate Contractor Onboarding Link
- Create Employee Check
- Reporting Period Object
- Payment Item Object
- Update Contractor Deduction Template
- Create Contractor Deduction Template
- Create Contractor ID Upload Link
- Delete Contractor Deduction Template
- Upload Contractor Government ID
- Create Paycard Enrollment Link (Early Access)
- Get Upcoming Regular Payroll
- Delete Deduction
- Deduction Template Object
- Get Contractors
- Set Onboarded Status to True
- Update Contractor Information
- Add Shifts to Existing Check
- Update Pending Shifts
- Get Contractor Deduction Templates
- Update Employee Check
- Create I9 Link (Early Access)
- Create a paperwork submission
- Create Bulk Employee Checks
- Get Shift Information
- Create Deduction Template
- Delete Pending Shifts
- Get Deduction Template
- Get Employee Check by ID
- Update Deduction
- Get Paperwork Templates
- List Employee Deduction Templates
- Get Deduction Template Definitions
- Generate Employee Onboarding Link
- Create Deduction
- Download Paystub PDF
- Get Deduction
- Get Employee Checks by Employee
- Get I9 Status (Early Access)
- Delete Employee Check
- Get Reporting Period by Date Range
- Update Employee Deduction Template
- Create Bank Account
- Paperwork Submission Object
- Get All Reporting Periods
- Create Employee Deduction Template
- Get paperwork submissions
- Create Employee
- Get Paperwork Template by ID
- Get a specific paperwork submission
- Update Work Location
- Get Employee Tax Parameter Summary
- Deduction Object
- Get Bank Account by ID
- Get Attributes
- Set Attribute Value
- Create Custom Paperwork Link (Early Access)
- Create Employee ID Upload Link
- Bank Account Object
- Set Onboarded Status to True
- Create Instant Pay Employee Enrollment Link
- Create Bank Account Collection Link
- Send Employee Onboarding Link
- Create W4 Link
- Get Employees
- Create Paycard Enrollment Link (Early Access)
- Create Account Setup Link
- Get Employee Requirements
- Create Company
- Delete Employee Deduction Template
- Create Work Location
- Get Employee Deduction Template
- Update Employee Information
- Resolve Taxable Location
- Get Work Locations
- Get Employee Information
- Get Customer Account
- Taxable Location Object
- Update Customer Account
- Employee Requirements Object
- Get Taxable Location by ID
- Create Funding Source
- Create Customer Account
- Get All Customer Accounts
- Generate Customer Account Onboarding Link
- Trigger Microdeposits
- Set Customer Account Onboarded To true
- Work Location Object
- Get Company Authorization Documents
- Trigger Micro-Deposits
- Sign Company Authorization Documents
- Set Company Onboarded Status to True
- Get Company Onboarding Link
- Verify Microdeposit Values
- Get Company Information
- Time & Attendance Integration
- Customer Accounts (Early Access)
- Deductions
- Accrual Policies
- Company Onboarding
- Employee Dashboard
- Preview Payroll
- Tax Compliance Across Multiple Jurisdictions
- Contractor Onboarding
- Overtime Compliance
- Paycards (Early Access)
- Custom Paperwork (Early Access)
- Employee Checks
- Reports
- Contractor Dashboard
- Setting up Regular Payroll Run
- Account Setup and API Keys
- Work Locations
- Tax Requirements
- Building a Payroll Product
- Deduction Types
- Payroll Runs
- Paycard Onboarding (Early Access)
- FAQs
- Payroll
- Quickstart Guide
- Create Worker Summary Report
- Create Labor Allocation Report
- Contractor Payments
- Introduction to Payroll Runs
- Create Deduction Summary Report
- Worker Dashboards
- Create Payroll Journal Report
- Worker Onboarding
- Get Documents
- Get Job Status
- Get Report Download
- Create Payment Summary Report
- Create Paystub Report
- The Document Object
- Create KYC Summary Report
- Update Accrual Policy
- Create Custom Payroll Journal Report
- Preview Overtime Checks
- Create Cash Requirements Report
- Create Accrual Policy
- Accrual Balance History
- Get Sick Time Compliance Rules
- Error Codes
- Add/Remove Employees to Accrual Policy
- Employer Check Object
- Create Accrual Policy Usage
- Get Accrual Balance
- Get Employer Check by ID
- Get Next Available Check/Pay Date
- Update Accrual Balance
- Get Paystub/Employee Check Link
- Get Preview
- Update Contractor Payment
- Get Accrual Policy
- Get Wallet Transactions
- Wallet Transaction Object
- The Company Object
- Preview Payroll by Check Date
- Get Minimum Wage Rules
- Transfer Funds
- Get Paycards
- Update Payment Item
- Employee Check Event
- Get Contractor Payments
- Create Payment Item
- Employer Check Created Event
- Pay Frequency, Reporting Periods and Check Dates
- The Requirement Object
- Transaction Update Event
- Preview Payroll by Check IDs
- Get Card
- Delete Contractor Payment
- Create Contractor Payment
- Generate Company Login Link
- Create Company Bank Account
- Generate Reports Link
- Employee I9 Update Event (Early Access)
- Contractor Payment Event
- Employer Check Processed Event
- Get Contractor Payment Link
- Authentication and Keys
- Paycard Object
- Webhook Event Overview
- Create Employee Event
- Employee Event
- Employer Check Processed Webhook Lite
- Paycard Onboarding Status Event (Early Access)
- Customer Account Onboarding Event
- Employee Requirements Create Event
- Company Event
- Bank Account Event
- Customer Account Event
- Employee Onboarding Event
- Employee E-Verify Update Event (Early Access)
- Shift Event
- Instant Pay Wallet Transaction Event
- Paperwork Submission Event
- Company Onboarding Event
- Metadata
- Pagination
- Idempotency
- What are Zeal Webhooks?
- Rate Limiting
- Early Access Endpoints
- Times and Dates
- The Employee Object
- Shift Object
- Contractor Payment Object
- Earning Components
- Deduction Template Definition Object
- Employee Onboarding
- Contractor Object
- Generate Employee or Contractor Dashboard Link
- Customer Account Object
- Upload Employee Government ID
- Accrual Policy Object
- Types of Deductions
- Set Employee Tax Parameters
- Preview Check Data
- Get Reserve Balance
- Trigger Disbursement
- Company Dashboard
- Card Object
- Generate Employee Tax Parameter Definitions
- Create Year to Date Report
- Create Quarter to Date Report
- Generate Company Taxes Page link
- Update Company Information
- Paperwork Template Object
- Custom Attribute Object
- Update Bank Account
- Get Wallet Balance
- Create Profile Information Collection Link
- Create Instant Pay Contractor Enrollment Link
- Verify Microdeposits
- Employer CheckID Object
- Contractor Event
- Introduction
- index.html
- What is Zeal?
- Job Queue Event