---
title: "Retrieve a deduction"
url: "https://docs.unified.to/hris/deduction/Retrieve_a_deduction"
description: "API reference for Retrieve a deduction. Launch multiple pre-built Deduction integrations today with zero maintenance — all through a single API."
generated_at: "2026-05-20T23:11:18.053Z"
---
# Retrieve a deduction

 GET/hris/{connection\_id}/deduction/{id}

## Parameters

**fields**string array 

id

created\_at

updated\_at

user\_id

company\_id

benefit\_id

amount

type

coverage\_level

frequency

start\_at

end\_at

is\_active

notes

raw

Fields to return

**raw**string 

Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar

**connection\_id**string  required 

ID of the connection

**id**string  required 

ID of the Deduction

## Returns

[HrisDeduction](/hris/deduction/model)

Employee-specific deduction/benefit enrolment.

**id**string 

**created\_at**date 

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

**updated\_at**date 

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

**user\_id**string 

employee ID (reference to HrisEmployee)

**company\_id**string 

(reference to HrisCompany)

**benefit\_id**string 

**amount**number 

percentage or absolute amount (employee's portion)

**type** enum

Valid values:

 "FIXED" 

 "PERCENTAGE" 

**coverage\_level** enum

Valid values:

 "EMPLOYEE\_ONLY" 

 "EMPLOYEE\_SPOUSE" 

 "EMPLOYEE\_CHILD" 

 "EMPLOYEE\_CHILDREN" 

 "EMPLOYEE\_FAMILY" 

Level selected by employee (e.g. "FAMILY", "EMPLOYEE\_ONLY", or other)

**frequency** enum

Valid values:

 "ONE\_TIME" 

 "DAY" 

 "QUARTER" 

 "YEAR" 

 "HOUR" 

Frequency for this deduction (should always be set, matches IHrisBenefit.frequency)

**start\_at**date 

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

**end\_at**date 

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

**is\_active**boolean 

**notes**string 

**raw**any 

## Code Samples

### Node.js SDK

```
import { UnifiedTo } from '@unified-api/typescript-sdk';

const sdk = new UnifiedTo({
    security: {
        jwt: '<YOUR_API_KEY_HERE>',
    },
});

const connectionId = '5de520f96e439b002043d8dc';

const id = '1234';

const results = await sdk.hris.getHrisDeduction({ connectionId, id, 
    fields: '',
    raw: '',
 });
```

### Node.js (axios)

```
const options = {
  method: 'GET',
  url: 'https://api.unified.to/hris/5de520f96e439b002043d8dc/deduction/5de520f96e439b002043d8d8',
  headers: {
    authorization: 'bearer .....'
  },
  params: {
    fields: '',
    raw: '',
  }
};

const results = await axios.request(options);
```

### Java

```
AsyncHttpClient client = new DefaultAsyncHttpClient();

client.prepare("GET", "https://api.unified.to/hris/5de520f96e439b002043d8dc/deduction/5de520f96e439b002043d8d8?fields=&raw=")
  .setHeader("accept", "application/json")
  .setHeader("authorization", ".....")
  .execute()
  .toCompletableFuture()
  .thenAccept(System.out::println)
  .join();

client.close();
```

### Go

```
import (
	"fmt"
	"net/http"
	"io/ioutil"
)

url := `https://api.unified.to/hris/5de520f96e439b002043d8dc/deduction/5de520f96e439b002043d8d8?fields=&raw=

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("accept", "application/json")
req.Header.Add("authorization", ".....")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
```

### Python

```
import requests

url = "https://api.unified.to/hris/5de520f96e439b002043d8dc/deduction/5de520f96e439b002043d8d8?fields=&raw="

headers = {
    "accept": "application/json",
    "authorization": "....."
}

response = requests.get(url, headers=headers)
```

### PHP

```
$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.unified.to/hris/5de520f96e439b002043d8dc/deduction/5de520f96e439b002043d8d8?fields=&raw=",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "accept: application/json",
    "authorization: ....."
  ],
]);
```

### Ruby

```
require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.unified.to/hris/5de520f96e439b002043d8dc/deduction/5de520f96e439b002043d8d8?fields=&raw=")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["accept"] = 'application/json'
request["authorization"] = '....'

response = http.request(request)
puts response.read_body
```

### cURL

```
curl --request GET \
  --url 'https://api.unified.to/hris/5de520f96e439b002043d8dc/deduction/5de520f96e439b002043d8d8?fields=&raw=' \
  --header 'accept: application/json' \
  --header 'authorization: .....'
```