Deductions
Get Deduction
Retrieve a specific deduction attached to an employee check.
GET
/
deductions
Get Deduction
curl --request GET \
--url https://api.zeal.com/deductions \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"companyID": "fc235f012bae46aa8a082f3",
"employeeCheckID": "7f0da5e428324c049ae6a6bac2e62f88",
"deductionID": "61d32bb356fdba0023fafa57"
}
'import requests
url = "https://api.zeal.com/deductions"
payload = {
"companyID": "fc235f012bae46aa8a082f3",
"employeeCheckID": "7f0da5e428324c049ae6a6bac2e62f88",
"deductionID": "61d32bb356fdba0023fafa57"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.get(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
companyID: 'fc235f012bae46aa8a082f3',
employeeCheckID: '7f0da5e428324c049ae6a6bac2e62f88',
deductionID: '61d32bb356fdba0023fafa57'
})
};
fetch('https://api.zeal.com/deductions', 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/deductions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_POSTFIELDS => json_encode([
'companyID' => 'fc235f012bae46aa8a082f3',
'employeeCheckID' => '7f0da5e428324c049ae6a6bac2e62f88',
'deductionID' => '61d32bb356fdba0023fafa57'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.zeal.com/deductions"
payload := strings.NewReader("{\n \"companyID\": \"fc235f012bae46aa8a082f3\",\n \"employeeCheckID\": \"7f0da5e428324c049ae6a6bac2e62f88\",\n \"deductionID\": \"61d32bb356fdba0023fafa57\"\n}")
req, _ := http.NewRequest("GET", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
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/deductions")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"companyID\": \"fc235f012bae46aa8a082f3\",\n \"employeeCheckID\": \"7f0da5e428324c049ae6a6bac2e62f88\",\n \"deductionID\": \"61d32bb356fdba0023fafa57\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zeal.com/deductions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"companyID\": \"fc235f012bae46aa8a082f3\",\n \"employeeCheckID\": \"7f0da5e428324c049ae6a6bac2e62f88\",\n \"deductionID\": \"61d32bb356fdba0023fafa57\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"deductionID": "61d32bb356fdba0023fafa57",
"deduction_type": "401k",
"employer_contribution": {
"value": 7,
"contribution_type": "dollars",
"matching": false
},
"employee_contribution": {
"value": 5,
"contribution_type": "percentage"
},
"employee_calculated_contribution": 96.61,
"deductionTemplateID": "61cadff23e6f8201c34c77c6"
}
}{
"success": false,
"errors": [
{
"message": "Employee Check with this check ID does not exist",
"code": 43
}
]
}Authorizations
Query Parameters
ID of Deduction to be retrieved
CompanyID of the employer
ID of the employee check
Body
application/json
The body is of type any.
⌘I
Get Deduction
curl --request GET \
--url https://api.zeal.com/deductions \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"companyID": "fc235f012bae46aa8a082f3",
"employeeCheckID": "7f0da5e428324c049ae6a6bac2e62f88",
"deductionID": "61d32bb356fdba0023fafa57"
}
'import requests
url = "https://api.zeal.com/deductions"
payload = {
"companyID": "fc235f012bae46aa8a082f3",
"employeeCheckID": "7f0da5e428324c049ae6a6bac2e62f88",
"deductionID": "61d32bb356fdba0023fafa57"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.get(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
companyID: 'fc235f012bae46aa8a082f3',
employeeCheckID: '7f0da5e428324c049ae6a6bac2e62f88',
deductionID: '61d32bb356fdba0023fafa57'
})
};
fetch('https://api.zeal.com/deductions', 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/deductions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_POSTFIELDS => json_encode([
'companyID' => 'fc235f012bae46aa8a082f3',
'employeeCheckID' => '7f0da5e428324c049ae6a6bac2e62f88',
'deductionID' => '61d32bb356fdba0023fafa57'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.zeal.com/deductions"
payload := strings.NewReader("{\n \"companyID\": \"fc235f012bae46aa8a082f3\",\n \"employeeCheckID\": \"7f0da5e428324c049ae6a6bac2e62f88\",\n \"deductionID\": \"61d32bb356fdba0023fafa57\"\n}")
req, _ := http.NewRequest("GET", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
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/deductions")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"companyID\": \"fc235f012bae46aa8a082f3\",\n \"employeeCheckID\": \"7f0da5e428324c049ae6a6bac2e62f88\",\n \"deductionID\": \"61d32bb356fdba0023fafa57\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zeal.com/deductions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"companyID\": \"fc235f012bae46aa8a082f3\",\n \"employeeCheckID\": \"7f0da5e428324c049ae6a6bac2e62f88\",\n \"deductionID\": \"61d32bb356fdba0023fafa57\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"deductionID": "61d32bb356fdba0023fafa57",
"deduction_type": "401k",
"employer_contribution": {
"value": 7,
"contribution_type": "dollars",
"matching": false
},
"employee_contribution": {
"value": 5,
"contribution_type": "percentage"
},
"employee_calculated_contribution": 96.61,
"deductionTemplateID": "61cadff23e6f8201c34c77c6"
}
}{
"success": false,
"errors": [
{
"message": "Employee Check with this check ID does not exist",
"code": 43
}
]
}