Skip to main content
POST
Create Deduction Template
The fields you can include are determined by the schema returned from Deduction Template Definition.

Authorizations

Authorization
string
header
required

Body

application/json
companyID
string
required

ID of Company

custom_name
string
required

Name assigned to deduction template (this is what will show on paystubs)

deduction_type
enum<string>

Type of deduction

Available options:
401k,
hsa,
garnishment,
miscellaneous,
section_125,
roth_401k,
403b,
simple_ira,
roth_ira
employee_contribution
object

Object containing all the fields which are needed to define the employee contribution.

employer_contribution
object

Object containing all the fields which are needed to define the employer_contribution.

additional_fields
object

If the Deduction Template Definition contains additional_fields, pass those values here

deduction_credit
boolean

(Customer Accounts Only - Early Access) Denotes whether the deduction should be returned back to the company or not. By default, garnishments and miscellaneous type deductions are not returned back, and all others are.

Response

200

success
boolean
default:true
Example:

true

data
object