Deduction Object is created using a Deduction Template and is attached to an Employee Check.
The corresponding deduction template provides the JSON schema which lays out the fields needed to create a Deduction.
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 attributesvalue contribution_type |
employee_contribution | object | Show child attributesvalue contribution_type |
additional_fields | object | Some deduction types like HSA or Garnishment have additional properties apart from employee and employer contributions. This field is used to provide information on those fields if set as overridable
|
agency | object | Falls within the additional_fields object if relevant to the deduction type
|
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 |