Create Deduction

Create a deduction.

post/deductions

Request

Base URL
https://api.zeal.com
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/zeal/apis/zeal-api/docs/deductions/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

companyIDstring required

ID of Company

employeeCheckIDstring required

ID of EmployeeCheck to attach Deduction to

deductionTemplateIDstring required

ID of Deduction Template used to create this deduction

additional_fieldsobject

Additional fields contingent upon the deduction type/template

Response

200

successboolean

Example response

{
  "success": true,
  "data": {
    "companyID": "fc235f012bae46aa8a082f3",
    "deductionID": "61cadff23e6f8201c34c77c6",
    "employeeCheckID": "73a99095827d4f32bbb18adce048c081",
    "deduction_type": "401k",
    "employer_contribution": {
      "value": 1.33,
      "contribution_type": "dollars"
    },
    "employee_contribution": {
      "value": 2.66,
      "contribution_type": "dollars"
    },
    "deductionTemplateID": "61cad98c3e6f8201c34c77c0"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.