Skip to main content
PATCH
cURL
Updates an existing Employee Deduction Template. Returns the updated Employee Deduction Template object.

Authorizations

Authorization
string
header
required

Path Parameters

deductionTemplateID
string
required

ID of this template

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

Body

application/json
deductionTemplateID
string

ID of the template to update

custom_name
string

Human-readable name for the deduction template

effective_start_date
string<date>

Date the template should start become effective

effective_end_date
string<date>

Date the template should become ineffective

employee_contribution_amount
number

Default dollar amount to be contributed by the employee for deductions

employee_contribution_percentage
number

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

employer_contribution_amount
number

Default dollar amount to be contributed by the employer for deductions

employer_contribution_percentage
number

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

hsa_type
enum<string>

Contribution limit type for the template (HSA only)

Available options:
family,
individual
agency_address
string

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

agency_name
string

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

case_id
string

Case ID of a court order (Garnishment only)

order_number
string

Order number of a court order (Garnishment only)

external_id
string

ID in an external system related to the template

Response

200

success
boolean
data
object

The updated Employee Deduction Template object