List Employee Deduction Templates - Zeal Docs

GET

/

employee-deduction-templates

cURL

curl --request GET \
  --url https://api.zeal.com/employee-deduction-templates \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.zeal.com/employee-deduction-templates', 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",
  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"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.zeal.com/employee-deduction-templates")

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": "<array>"
}

{
  "success": false,
  "errors": [
    {
      "message": "<string>",
      "code": 123
    }
  ]
}

Returns a paginated array of Employee Deduction Template objects matching the supplied filters.

Authorizations

Authorization

string

header

required

Query Parameters

limit

number

The number of deduction templates returned per page

start_at

string

The deductionTemplateID of the template to start the paginated results on

companyID

string

Matches all templates under the company with this ID

employeeID

string

Matches all templates under the employee with this ID

agency_address

string

Matches templates with this agency address

agency_name

string

Matches templates with this agency name

case_id

string

Matches templates with this case ID

custom_name

string

Matches templates with this custom name

deduction_type

string

Matches templates with this deduction type

effective_start_date

string

Matches templates with this effective start date

effective_end_date

string

Matches templates with this effective end date

employee_contribution_amount

number

Matches templates with this employee contribution amount

employee_contribution_percentage

number

Matches templates with this employee contribution percentage

employer_contribution_amount

number

Matches templates with this employer contribution amount

employer_contribution_percentage

number

Matches templates with this employer contribution percentage

external_id

string

Matches templates with this external ID

hsa_type

string

Matches templates with this HSA contribution type

order_number

string

Matches templates with this order number

Response

200

success

boolean

data

array

Array of Employee Deduction Template objects

cURL

curl --request GET \
  --url https://api.zeal.com/employee-deduction-templates \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.zeal.com/employee-deduction-templates', 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",
  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"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.zeal.com/employee-deduction-templates")

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": "<array>"
}

{
  "success": false,
  "errors": [
    {
      "message": "<string>",
      "code": 123
    }
  ]
}