Get Deduction Template

Get a deduction template.

get/deductionTemplate

Request

Query parameters

companyIDstring required

ID of Company

deductionTemplateIDstring

ID of Deduction template. If no value is passed, then all deduction templates will be retrieved.

Response

200

successboolean

Example response

{
  "success": true,
  "data": [
    {
      "companyID": "fc235f012bae46aa8a082f",
      "deductionTemplateID": "61cad98c3e6f8201c34c77c0",
      "custom_name": "Zeal Testing 401k",
      "deduction_type": "401k",
      "employer_contribution": {
        "properties": {
          "contribution_type": {
            "const": "dollars"
          },
          "percentage_source": {
            "enum": [
              "contribution"
            ]
          },
          "value": {
            "type": "number"
          },
          "override_type": {
            "const": "overridable"
          }
        },
        "required": [
          "value"
        ]
      },
      "employee_contribution": {
        "properties": {
          "contribution_type": {
            "const": "dollars"
          },
          "value": {
            "type": "number"
          },
          "override_type": {
            "const": "overridable"
          }
        },
        "required": [
          "value"
        ]
      }
    }
  ]
}

Changes

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