Skip to main content
POST
cURL
Creates a new deduction template for an employee. Returns the created Employee Deduction Template object.

Authorizations

Authorization
string
header
required

Body

application/json
companyID
string
required

ID of the company related to this template

employeeID
string
required

ID of the employee related to this template

custom_name
string
required

Human-readable name for the deduction template

deduction_type
enum<string>
required

Type of deduction

Available options:
401k,
403b,
dependent_care_benefit,
employer_sponsored_health_coverage,
garnishment,
hsa,
miscellaneous,
roth_401k,
roth_ira,
section_125,
simple_ira
effective_start_date
string<date>
required

Date the template should start becoming effective

effective_end_date
string<date>

Date the template should become ineffective

employee_contribution_amount
number

Default dollar amount contributed by the employee for deductions

employee_contribution_percentage
number

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

employer_contribution_amount
number

Default dollar amount contributed by the employer for deductions

employer_contribution_percentage
number

Default percentage of employee's pay 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 created Employee Deduction Template object