Sign in

v1

latestOpenAPI 3.1.02026-07-2414339465.7 KB
Employee Deduction Templates

Update Employee Deduction Template

patch/employee-deduction-templates/{deductionTemplateID}

Path parameters

deductionTemplateIDstring required

ID of this template

Example:4adec94c713c425b9d7c147ba4981bec

Request body

deductionTemplateIDstring

ID of this template

agency_addressstring

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

agency_namestring

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

case_idstring

Case ID of a court order (Garnishment only)

custom_namestring

Human-readable name for the deduction template

effective_end_datestring

Date the template should become ineffective

effective_start_datestring

Date the template should start become effective

employee_contribution_amountnumber

Default dollar amount to be contributed by the employee for deductions

employee_contribution_percentagenumber

Default percentage of employee's pay to be contributed by the employee for deductions

employer_contribution_amountnumber

Default dollar amount to be contributed by the employer for deductions

employer_contribution_percentagenumber

Default percentage of employee's pay to be contributed by the employer for deductions

external_idstring

ID in a external system related to the template

hsa_type'family' | 'individual'

Contribution limit type for the template (HSA only)

order_numberstring

Order number of a court order (Garnishment only)

Example request

{
  "deductionTemplateID": "4adec94c713c425b9d7c147ba4981bec",
  "agency_address": "123 Goverment ST, Washington D.C., 20001",
  "agency_name": "Child Support Agency of State",
  "case_id": "ID12345",
  "custom_name": "Jon Doe's 401K",
  "effective_end_date": "2025-01-01",
  "effective_start_date": "2024-01-01",
  "employee_contribution_amount": 32.54,
  "employee_contribution_percentage": 15,
  "employer_contribution_amount": 50,
  "employer_contribution_percentage": 10,
  "external_id": "temp_123",
  "hsa_type": "family",
  "order_number": "OR05"
}

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"
  }
}