Update Employee Deduction Template

patch

https://api.zeal.com/employee-deduction-templates/{deductionTemplateID}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

deductionTemplateID

string

required

ID of this template

Body Params

Payload to update an employee deduction template

deductionTemplateID

string

ID of 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

Human-readable name for the deduction template

effective_end_date

string

Date the template should become ineffective

effective_start_date

string

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 a external system related to the template

hsa_type

string

enum

Contribution limit type for the template (HSA only)

Allowed:

order_number

string

length ≥ 1

Order number of a court order (Garnishment only)

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

404Resource not found error