API Reference

Create Employee Deduction Template

post
https://api.zeal.com/employee-deduction-templates
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

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

Body Params

Payload to create an employee deduction template

string
required
^[0-9a-f]{32}$

ID of the company related to this template

string
required
^[0-9a-f]{24}$

ID of the employee related to this template

string
length ≥ 1

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

string
length ≥ 1

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

string

Case ID of a court order (Garnishment only)

string
required

Human-readable name for the deduction template

string
enum
required
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

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

number
≥ 0

Default dollar amount to be contributed by the employee for deductions

number
0 to 100

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

number
≥ 0

Default dollar amount to be contributed by the employer for deductions

number
0 to 100

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

string
length ≥ 1

ID in a external system related to the template

string
enum

Contribution limit type for the template (HSA only)

Allowed:
string
length ≥ 1

Order number of a court order (Garnishment only)

Responses

Updated 6 months ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 6 months ago

Did this page help you?