v1
latestOpenAPI 3.1.02026-07-2414339465.7 KBGet Deduction Template Definitions
Get a definition for a deduction template.
get/deductionTemplateDefinitions
Query parameters
deduction_type'401k' | 'section_125' | 'hsa' | 'miscellaneous' | 'garnishment' | '403b' | 'roth_ira' | 'simple_ira' | 'roth_401k' required
Deduction type for which Deduction Template Definition is required
Request body
{"stackTrail":"paths:/deductionTemplateDefinitions:get:requestBody:content:application/json:schema","oasType":"schema","type":"unknown"}
Response
200
Example response
{
"success": true,
"data": {
"type": "object",
"required": [
"employee_contribution"
],
"properties": {
"required_template_fields": {
"const": [
"employee_contribution"
]
},
"custom_name": {
"type": "string"
},
"deduction_type": {
"const": "hsa"
},
"employee_contribution": {
"type": "object",
"properties": {
"contribution_type": {
"enum": [
"dollars"
]
},
"value": {
"type": "number"
},
"override_type": {
"enum": [
"overridable"
]
},
"required_template_fields": {
"const": [
"value"
]
}
},
"allOf": [
{
"if": {
"properties": {
"override_type": {
"const": "final"
}
},
"required": [
"override_type"
]
},
"then": {
"required": [
"value"
]
}
}
],
"required": [
"override_type"
]
},
"employer_contribution": {
"type": "object",
"properties": {
"contribution_type": {
"enum": [
"dollars"
]
},
"value": {
"type": "number"
},
"override_type": {
"enum": [
"overridable"
]
},
"required_template_fields": {
"const": [
"value"
]
}
},
"allOf": [
{
"if": {
"properties": {
"override_type": {
"const": "final"
}
},
"required": [
"override_type"
]
},
"then": {
"required": [
"value"
]
}
}
],
"required": [
"override_type"
]
},
"additional_fields": {
"type": "object",
"properties": {
"hsa_type": {
"enum": [
"family"
]
}
},
"required": [
"hsa_type"
]
}
}
}
}