Deductions
Create Deduction
Create a Deduction and attach it to a specific employee check based on a Deduction Template.
POST
/
deductions
Create Deduction
curl --request POST \
--url https://api.zeal.com/deductions \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"companyID": "fc235f012bae46aa8a082f3",
"employeeCheckID": "7f0da5e428324c049ae6a6bac2e62f88",
"deductionTemplateID": "61d12e74db7df700237de5d4",
"deduction": {
"employee_contribution": {
"value": 1.33
},
"employer_contribution": {
"value": 2.66
}
}
}
'import requests
url = "https://api.zeal.com/deductions"
payload = {
"companyID": "fc235f012bae46aa8a082f3",
"employeeCheckID": "7f0da5e428324c049ae6a6bac2e62f88",
"deductionTemplateID": "61d12e74db7df700237de5d4",
"deduction": {
"employee_contribution": { "value": 1.33 },
"employer_contribution": { "value": 2.66 }
}
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
companyID: 'fc235f012bae46aa8a082f3',
employeeCheckID: '7f0da5e428324c049ae6a6bac2e62f88',
deductionTemplateID: '61d12e74db7df700237de5d4',
deduction: {employee_contribution: {value: 1.33}, employer_contribution: {value: 2.66}}
})
};
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 => "POST",
CURLOPT_POSTFIELDS => json_encode([
'companyID' => 'fc235f012bae46aa8a082f3',
'employeeCheckID' => '7f0da5e428324c049ae6a6bac2e62f88',
'deductionTemplateID' => '61d12e74db7df700237de5d4',
'deduction' => [
'employee_contribution' => [
'value' => 1.33
],
'employer_contribution' => [
'value' => 2.66
]
]
]),
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 \"deductionTemplateID\": \"61d12e74db7df700237de5d4\",\n \"deduction\": {\n \"employee_contribution\": {\n \"value\": 1.33\n },\n \"employer_contribution\": {\n \"value\": 2.66\n }\n }\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.zeal.com/deductions")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"companyID\": \"fc235f012bae46aa8a082f3\",\n \"employeeCheckID\": \"7f0da5e428324c049ae6a6bac2e62f88\",\n \"deductionTemplateID\": \"61d12e74db7df700237de5d4\",\n \"deduction\": {\n \"employee_contribution\": {\n \"value\": 1.33\n },\n \"employer_contribution\": {\n \"value\": 2.66\n }\n }\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::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"companyID\": \"fc235f012bae46aa8a082f3\",\n \"employeeCheckID\": \"7f0da5e428324c049ae6a6bac2e62f88\",\n \"deductionTemplateID\": \"61d12e74db7df700237de5d4\",\n \"deduction\": {\n \"employee_contribution\": {\n \"value\": 1.33\n },\n \"employer_contribution\": {\n \"value\": 2.66\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"companyID": "fc235f012bae46aa8a082f3",
"deductionID": "61cadff23e6f8201c34c77c6",
"employeeCheckID": "73a99095827d4f32bbb18adce048c081",
"deduction_type": "401k",
"employer_contribution": {
"value": 1.33,
"contribution_type": "dollars",
"matching": false
},
"employee_contribution": {
"value": 2.66,
"contribution_type": "dollars"
},
"deductionTemplateID": "61cad98c3e6f8201c34c77c0"
}
}{
"success": false,
"errors": [
{
"message": "No deduction template found with provided ID",
"code": 13
}
]
}The deduction is scoped to a single employee check. Its required fields are determined by the
required_template_fields in the Deduction Template Definition.Authorizations
Body
application/json
ID of Company
ID of EmployeeCheck to attach Deduction to
ID of Deduction Template used to create this deduction
The deduction object
Show child attributes
Show child attributes
Additional fields contingent upon the deduction type/template
⌘I
Create Deduction
curl --request POST \
--url https://api.zeal.com/deductions \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"companyID": "fc235f012bae46aa8a082f3",
"employeeCheckID": "7f0da5e428324c049ae6a6bac2e62f88",
"deductionTemplateID": "61d12e74db7df700237de5d4",
"deduction": {
"employee_contribution": {
"value": 1.33
},
"employer_contribution": {
"value": 2.66
}
}
}
'import requests
url = "https://api.zeal.com/deductions"
payload = {
"companyID": "fc235f012bae46aa8a082f3",
"employeeCheckID": "7f0da5e428324c049ae6a6bac2e62f88",
"deductionTemplateID": "61d12e74db7df700237de5d4",
"deduction": {
"employee_contribution": { "value": 1.33 },
"employer_contribution": { "value": 2.66 }
}
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
companyID: 'fc235f012bae46aa8a082f3',
employeeCheckID: '7f0da5e428324c049ae6a6bac2e62f88',
deductionTemplateID: '61d12e74db7df700237de5d4',
deduction: {employee_contribution: {value: 1.33}, employer_contribution: {value: 2.66}}
})
};
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 => "POST",
CURLOPT_POSTFIELDS => json_encode([
'companyID' => 'fc235f012bae46aa8a082f3',
'employeeCheckID' => '7f0da5e428324c049ae6a6bac2e62f88',
'deductionTemplateID' => '61d12e74db7df700237de5d4',
'deduction' => [
'employee_contribution' => [
'value' => 1.33
],
'employer_contribution' => [
'value' => 2.66
]
]
]),
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 \"deductionTemplateID\": \"61d12e74db7df700237de5d4\",\n \"deduction\": {\n \"employee_contribution\": {\n \"value\": 1.33\n },\n \"employer_contribution\": {\n \"value\": 2.66\n }\n }\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.zeal.com/deductions")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"companyID\": \"fc235f012bae46aa8a082f3\",\n \"employeeCheckID\": \"7f0da5e428324c049ae6a6bac2e62f88\",\n \"deductionTemplateID\": \"61d12e74db7df700237de5d4\",\n \"deduction\": {\n \"employee_contribution\": {\n \"value\": 1.33\n },\n \"employer_contribution\": {\n \"value\": 2.66\n }\n }\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::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"companyID\": \"fc235f012bae46aa8a082f3\",\n \"employeeCheckID\": \"7f0da5e428324c049ae6a6bac2e62f88\",\n \"deductionTemplateID\": \"61d12e74db7df700237de5d4\",\n \"deduction\": {\n \"employee_contribution\": {\n \"value\": 1.33\n },\n \"employer_contribution\": {\n \"value\": 2.66\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"companyID": "fc235f012bae46aa8a082f3",
"deductionID": "61cadff23e6f8201c34c77c6",
"employeeCheckID": "73a99095827d4f32bbb18adce048c081",
"deduction_type": "401k",
"employer_contribution": {
"value": 1.33,
"contribution_type": "dollars",
"matching": false
},
"employee_contribution": {
"value": 2.66,
"contribution_type": "dollars"
},
"deductionTemplateID": "61cad98c3e6f8201c34c77c0"
}
}{
"success": false,
"errors": [
{
"message": "No deduction template found with provided ID",
"code": 13
}
]
}