List Employee Deduction Templates

get

https://api.zeal.com/employee-deduction-templates

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

limit

number

1 to 100

The number of deduction templates returned per page

start_at

string

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

The deductionTemplateID of the template to start the paginated results on

companyID

string

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

Matches all templates under the company with this ID

employeeID

string

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

Matches all templates under the employee with this ID

agency_address

string

length ≥ 1

Matches templates with this agency address

agency_name

string

length ≥ 1

Matches templates with this agency name

case_id

string

Matches templates with this case ID

custom_name

string

Matches templates with this custom name

deduction_type

string

enum

Matches templates with this deduction type

effective_end_date

string

^(19|20)\d{2}(-)(0[1-9]|1[1,2])(-)(0[1-9]|[1,2][0-9]|3[0,1])$

Matches templates with this effective end date

effective_start_date

string

^(19|20)\d{2}(-)(0[1-9]|1[1,2])(-)(0[1-9]|[1,2][0-9]|3[0,1])$

Matches templates with this effective start date

employee_contribution_amount

number

≥ 0

Matches templates with this employee contribution amount

employee_contribution_percentage

number

0 to 100

Matches templates with this employee contribution percentage

employer_contribution_amount

number

≥ 0

Matches templates with this employer contribution amount

employer_contribution_percentage

number

0 to 100

Matches templates with this employer contribution percentage

external_id

string

length ≥ 1

Matches templates with this external ID

hsa_type

string

enum

Matches templates with this HSA contribution type

Allowed:

order_number

string

length ≥ 1

Matches templates with this order number

Responses

Language

Loading…

Response

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

application/json

200Successful response

400Invalid request error