Sign in

v1

latestOpenAPI 3.1.02026-07-2414339465.7 KB
Employee Deduction Templates

List Employee Deduction Templates

get/employee-deduction-templates

Query parameters

limitnumber
Example:25

The number of deduction templates returned per page

start_atstring

ID of this template

Example:4adec94c713c425b9d7c147ba4981bec

The deductionTemplateID of the template to start the paginated results on

companyIDstring

ID of the company related to this template

Example:5edac48c713a435c9d7b147be4976ee0

Matches all templates under the company with this ID

employeeIDstring

ID of the employee related to this template

Example:612e079f950181002246837a

Matches all templates under the employee with this ID

agency_addressstring

Name of the agency for a court order (Garnishment only)

Example:123 Goverment ST, Washington D.C., 20001

Matches templates with this agency address

agency_namestring

Address of the agency for a court order (Garnishment only)

Example:Child Support Agency of State

Matches templates with this agency name

case_idstring

Case ID of a court order (Garnishment only)

Example:ID12345

Matches templates with this case ID

custom_namestring

Human-readable name for the deduction template

Example:Jon Doe's 401K

Matches templates with this custom name

deduction_type'401k' | '403b' | 'dependent_care_benefit' | 'employer_sponsored_health_coverage' | 'garnishment' | 'hsa' | 'miscellaneous' | 'roth_401k' | 'roth_ira' | 'section_125' | 'simple_ira'
Example:401k

Matches templates with this deduction type

effective_end_datestring

Date the template should become ineffective

Example:2025-01-01

Matches templates with this effective end date

effective_start_datestring

Date the template should start become effective

Example:2024-01-01

Matches templates with this effective start date

employee_contribution_amountnumber

Matches templates with this employee contribution amount

employee_contribution_percentagenumber

Matches templates with this employee contribution percentage

employer_contribution_amountnumber

Matches templates with this employer contribution amount

employer_contribution_percentagenumber

Matches templates with this employer contribution percentage

external_idstring

ID in a external system related to the template

Example:temp_123

Matches templates with this external ID

hsa_type'family' | 'individual'

Contribution limit type for the template (HSA only)

Example:family

Matches templates with this HSA contribution type

order_numberstring

Order number of a court order (Garnishment only)

Example:OR05

Matches templates with this order number

Response

Successful response

successtrue

Example response

{
  "success": true,
  "data": [
    {
      "deductionTemplateID": "4adec94c713c425b9d7c147ba4981bec",
      "companyID": "5edac48c713a435c9d7b147be4976ee0",
      "employeeID": "612e079f950181002246837a",
      "custom_name": "Jon Doe's 401K",
      "deduction_type": "401k",
      "effective_start_date": "2024-01-01",
      "employee_contribution_amount": 32.54,
      "employer_contribution_percentage": 15,
      "external_id": "temp_123"
    }
  ],
  "meta": {
    "next": "https://api.zeal.com/employee-deduction-templates?limit=25&start_at=2a7d6cb3c64351028c9ba98eda4b2b4b",
    "previous": "https://api.zeal.com/employee-deduction-templates?limit=25&start_at=2a7d6cb3c64351028c9ba98eda4b2b4b"
  }
}