Deduction Object

Deduction Object is created using a Deduction Template, and is attached to an Employee Checks to which it is meant to be applied to.

The corresponding Deduction Template, provides the JSON schema which lays out the fields needed to create a Deduction for that template.

attribute

type

description

deductionID

string

Zeal Deduction ID

companyID

string

Zeal Company ID

employeeCheckID

string

Zeal Employee Check ID

deduction_type

string

Type of deduction. You can find all deduction types here

employer_contribution

object

Show child attributes

value
type: float
description: Employer contribution amount

contribution_type
type: string
description: Can be either dollars or percentage

employee_contribution

object

Show child attributes

value
type: float
description: Employee contribution amount

contribution_type
type: string
description: Can be either dollars or percentage

additional_fields

object

Some deduction types like HSA or Garnishment have additional properties apart from employee and employer contribution. This field is used to provide information on those fields if set as overridable

Show child attributes

order_number
type: float
description: The number given for the order

case_id
type: string
description: Custom ID given for the case

agency
type: object

See next row for agency child attributes

agency

object

Falls within the additional_fields object if relevant to the deduction type

Show child attributes **name** type: string description: The name given of the Agency

address
type: string
description: The address of the Agency location

employer_calculated_contribution

number

This is the calculated amount that the employer contributed once the check has been moved from pending to pre-processed. The value while this check is pending will always be 0.

employee_calculated_contribution

number

This is the calculated amount that the employee contributed once the check has been moved from pending to pre-processed. The value while this check is pending will always be 0.

deduction_template_name

string

Name of deduction template, this deduction was created with

deductionTemplateID

string

ID of Deduction Template this deduction was created with