Employee Deduction Templates
Get Employee Deduction Template
Retrieve a single employee deduction template by its deductionTemplateID.
GET
/
employee-deduction-templates
/
{deductionTemplateID}
cURL
curl --request GET \
--url https://api.zeal.com/employee-deduction-templates/{deductionTemplateID} \
--header 'Authorization: <api-key>'import requests
url = "https://api.zeal.com/employee-deduction-templates/{deductionTemplateID}"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.zeal.com/employee-deduction-templates/{deductionTemplateID}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.zeal.com/employee-deduction-templates/{deductionTemplateID}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.zeal.com/employee-deduction-templates/{deductionTemplateID}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.zeal.com/employee-deduction-templates/{deductionTemplateID}")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zeal.com/employee-deduction-templates/{deductionTemplateID}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": {}
}{
"success": false,
"errors": [
{
"message": "<string>",
"code": 123
}
]
}Returns a single Employee Deduction Template object identified by its
deductionTemplateID.
The Employee Deduction Template object contains the following fields:
| attribute | type | description |
|---|---|---|
| deductionTemplateID | string | ID of this template. |
| companyID | string | ID of the company related to this template. |
| employeeID | string | ID of the employee related to this template. |
| custom_name | string | Human-readable name for the deduction template. |
| deduction_type | string (enum) | One of 401k, 403b, dependent_care_benefit, employer_sponsored_health_coverage, garnishment, hsa, miscellaneous, roth_401k, roth_ira, section_125, simple_ira. |
| effective_start_date | string (date) | Date the template starts becoming effective. |
| employee_contribution_amount | number | Default dollar amount contributed by the employee for deductions. |
| employer_contribution_percentage | number | Default percentage of the employee’s pay contributed for deductions. |
| external_id | string | ID in an external system related to the template. |
⌘I
cURL
curl --request GET \
--url https://api.zeal.com/employee-deduction-templates/{deductionTemplateID} \
--header 'Authorization: <api-key>'import requests
url = "https://api.zeal.com/employee-deduction-templates/{deductionTemplateID}"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.zeal.com/employee-deduction-templates/{deductionTemplateID}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.zeal.com/employee-deduction-templates/{deductionTemplateID}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.zeal.com/employee-deduction-templates/{deductionTemplateID}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.zeal.com/employee-deduction-templates/{deductionTemplateID}")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zeal.com/employee-deduction-templates/{deductionTemplateID}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": {}
}{
"success": false,
"errors": [
{
"message": "<string>",
"code": 123
}
]
}