Sign in

v1

latestOpenAPI 3.1.02026-07-2414339465.7 KB

Create Deduction Template

Create a deduction template.

post/deductionTemplate

Request body

companyIDstring required

ID of Company

custom_namestring required

Name assigned to deduction template (this is what will show on paystubs)

deduction_type'401k' | 'hsa' | 'garnishment' | 'miscellaneous' | 'section_125' | 'roth_401k' | '403b' | 'simple_ira' | 'roth_ira'

Type of deduction

additional_fieldsobject

If the Deduction Template Definition contains additional_fields, pass those values here

deduction_creditboolean

(Customer Accounts Only - Early Access) Denotes whether the deduction should be returned back to the company or not. By default, garnishments and miscellaneous type deductions are not returned back, and all others are.

Response

200

successboolean

Example response

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