URL Expired

The URL for this request expired after 30 days.

Create an Employee Deduction Template for a given employee. You can view all supported Deduction Types here.

Payload to create an employee deduction template

• companyID
  string
  required
  ^[0-9a-f]{32}$
  ID of the company related to this template

• employeeID
  string
  required
  ^[0-9a-f]{24}$
  ID of the employee related to this template

• agency_address
  string
  length ≥ 1
  Name of the agency for a court order (Garnishment only)

• agency_name
  string
  length ≥ 1
  Address of the agency for a court order (Garnishment only)

• case_id
  string
  Case ID of a court order (Garnishment only)

• custom_name
  string
  required
  Human-readable name for the deduction template

• deduction_type
  string
  enum
  required
  401k, 403b, dependent_care_benefit, employer_sponsored_health_coverage, garnishment, hsa, miscellaneous, roth_401k, roth_ira, section_125, simple_ira

• effective_end_date
  string
  ^(19|20)\d{2}(-)(0[1-9]|1[1,2])(-)(0[1-9]|[1,2][0-9]|3[0,1])$
  Date the template should become ineffective

• effective_start_date
  string
  required
  ^(19|20)\d{2}(-)(0[1-9]|1[1,2])(-)(0[1-9]|[1,2][0-9]|3[0,1])$
  Date the template should start become effective

• employee_contribution_amount
  number
  ≥ 0
  Default dollar amount to be contributed by the employee for deductions

• employee_contribution_percentage
  number
  0 to 100
  Default percentage of employee's pay to be contributed by the employee for deductions

• employer_contribution_amount
  number
  ≥ 0
  Default dollar amount to be contributed by the employer for deductions

• employer_contribution_percentage
  number
  0 to 100
  Default percentage of employee's pay to be contributed by the employer for deductions

• external_id
  string
  length ≥ 1
  ID in an external system related to the template

• hsa_type
  string
  enum
  Contribution limit type for the template (HSA only)
  Allowed: family, individual

• order_number
  string
  length ≥ 1
  Order number of a court order (Garnishment only)

Response Codes

200 Successful response

400 Invalid request error

404 Resource not found error

Shell Example

curl --request POST \
     --url https://api.zeal.com/employee-deduction-templates \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "deduction_type": "401k"
}
'

Click Try It! to start a request and see the response here! Or choose an example:

"200"
"400"
"404"