Jump to Content
Zeal Docs
GuidesAPI ReferenceChangelog
Log InZeal Docs
API Reference
Log In
GuidesAPI ReferenceChangelog

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)

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
  • Get All 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 (Early Access)
  • Get Employee Requirements (Early Access)get

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
  • Get I9 Status (Early Access)get

Bank Accounts

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

Paperwork Submissions API

  • Paperwork Templates
    • Paperwork Template Object
    • Get Paperwork Templatespost
    • Get Paperwork Template by IDget
  • Paperwork Submissions
    • Paperwork Submission Object
    • Get paperwork submissionspost
    • Get a specific paperwork submissionget
    • Create a paperwork submissionput

Employee Checks

  • Reporting Periods
    • Reporting Period Object
    • Get Reporting Period by Date Rangeget
    • Get Reporting Period by IDget
    • Get All Reporting Periodsget
  • Employee Checks
    • Employee Check Object
    • Create Employee Checkpost
    • Update Employee Checkpatch
    • Delete Employee Checkdelete
    • Get Employee Check by IDget
    • Get Employee Checks by Employeeget
    • Create Bulk Employee Checkspost
    • Download Paystub PDFget
    • Get Upcoming Regular Payrollget
  • Deductions
    • Deduction Template Definition Object
    • Deduction Template Object
    • Deduction Object
    • Types of Deductions
    • Get Deduction Template Definitionsget
    • Create Deduction Templatepost
    • Get Deduction Templateget
    • Create Deductionpost
    • Get Deductionget
    • Update Deductionpatch
    • Delete Deductiondelete
  • Shifts
    • Shift Object
    • Add Shifts to Existing Checkpost
    • Get Shift Informationget
    • Update Pending Shiftspatch
    • Delete Pending Shiftsdelete

Paycards [Early Access]

  • Paycard Object
  • Get Paycardsget

Direct Pay [Early Access]

  • Direct Payment Object
  • Create Direct Paymentpost
  • Get Direct Paymentsget

Employee Deduction Templates [Early Access]

  • Employee Deduction Templates
    • Create Employee Deduction Templatepost
    • List Employee Deduction Templatesget
    • Update Employee Deduction Templatepatch
    • Get Employee Deduction Templateget
    • Delete Employee Deduction Templatedelete

Employer Checks

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

Preview

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

Embedded HR [EARLY ACCESS]

  • Minimum Wage
    • Get Minimum Wage Rulesget
  • Accrual Policy
    • Accrual Policy Object
    • Create Accrual Policypost
    • Update Accrual Policypatch
    • Get Accrual Policyget
    • Add/Remove Employees to Accrual Policypost
    • Update Accrual Balancepatch
    • Get Accrual Balanceget
    • Create Accrual Policy Usagepost
    • Accrual Balance Historypost
  • FLSA Overtime
    • Preview Overtime Checkspost

Contractors

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

Contractor Onboarding

  • Create Paycard Enrollment Link (Early Access)post
  • Generate Contractor Onboarding Linkpost
  • Set Onboarded Status to Truepost

Contractor Payments

  • Contractor Payment Object
  • Create Contractor Paymentpost
  • Trigger Disbursementpost
  • Update Contractor Paymentpatch
  • Get Contractor Payment by IDget
  • Get Contractor Paymentsget
  • 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

Webhook Event Overview

Chart overview of all of Zeal's webhook events.

Zeal currently offers webhook events corresponding to the following Zeal API objects:

ObjectEvent Webhook
CompanyOnboard
Update
Customer AccountOnboard
Update
EmployeeCreate
Onboard
Update
Delete
ContractorCreate
Onboard
Update
Delete
Employee CheckCreate
Update
Delete
Pre-processed
Processed
Contractor PaymentCreate
Update
Delete
Pre-processed
Processed
ShiftCreate
Update
Delete
Employer CheckCreate
Processed
Job QueueCreate
Update