API Reference

Create Deduction Template

post
https://api.zeal.com/deductionTemplate

Create a deduction template.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

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

attributestypesdescription
successbooleanResponse status
dataarrayReturns response status and new Deduction Template Object
errorsarrayContains list of error objects which consists of:
message: Error message
code: Error code as described in Error codes
Body Params
string
required

ID of Company

string
required

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

string
enum

Type of deduction

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.

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.

Responses

Updated 6 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 6 months ago