Create Deduction Template

Time	Status	User Agent
Make a request to see history.

URL Expired

The URL for this request expired after 30 days.

Create a Deduction Template in Zeal. A deduction template is used as a scaffold to create Deductions.

The fields required to create a Deduction Template come from Deduction Template Definition Object

Returns

Returns response status and the new Deduction Template Object

Returns

attributes	types	description
success	boolean	Response status
data	array	Returns response status and new Deduction Template Object
errors	array	Contains list of error objects which consists of: `message`: Error message `code`: Error code as described in Error codes

companyID

string

required

ID of Company

custom_name

string

required

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

deduction_type

string

enum

Type of deduction

401k401khsagarnishmentmiscellaneoussection_125roth_401k403bsimple_iraroth_ira

Show 9 enum values

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.

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.

truefalse

``200 200

``400 400

Updated 7 months ago

curl --request POST \
     --url https://api.zeal.com/deductionTemplate \
     --header 'accept: application/json' \
     --header 'content-type: application/json'

application/json

200 - Result400 - Result

Updated 7 months ago