v1

latestOpenAPI 3.1.02026-07-2414339465.7 KB

Get Deduction

Get a specific deduction.

get/deductions

Query parameters

deductionIDstring required

ID of Deduction to be retrieved

companyIDstring required

CompanyID of the employer

employeeCheckIDstring required

ID of the employee check

Request body

{"stackTrail":"paths:/deductions:get:requestBody:content:application/json:schema","oasType":"schema","type":"unknown"}

Response

200

successboolean

Example response

{
  "success": true,
  "data": {
    "deductionID": "61d32bb356fdba0023fafa57",
    "deduction_type": "401k",
    "employer_contribution": {
      "value": 7,
      "contribution_type": "dollars"
    },
    "employee_contribution": {
      "value": 5,
      "contribution_type": "percentage"
    },
    "employee_calculated_contribution": 96.61,
    "deductionTemplateID": "61cadff23e6f8201c34c77c6"
  }
}