Update a benefit

PUT/hris/{connection_id}/benefit/{id}

Parameters

Payload

Company-wide benefit plans available to employees.

idstring

created_atdate-time

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

updated_atdate-time

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

namestring

e.g. "401(k) Plan"

descriptionstring

e.g. "Company 401(k) retirement plan"

company_idstring

(reference to HrisCompany)

type enum

Valid values:

"RETIREMENT"

"HEALTH"

"DENTAL"

"VISION"

"LIFE"

"HSA"

"FSA"

"SHORT_TERM_DISABILITY"

"LONG_TERM_DISABILITY"

"WORKERS_COMP"

"HOUSING_STIPEND"

"EMPLOYER_TAX_CONTRIBUTION"

"GARNISHMENT"

"LOAN_REPAYMENT"

"CHARITABLE_CONTRIBUTION"

"OTHER"

"RETIREMENT_ROTH"

"COMMUTER"

"DEPENDENT_CARE"

"PENSION"

tax enum

Valid values:

"PRE_TAX"

"POST_TAX"

"TAXABLE"

"NON_TAXABLE"

"TAX"

Tax describes the tax treatment of the benefit

frequency enum

Valid values:

"ONE_TIME"

"DAY"

"QUARTER"

"YEAR"

"HOUR"

"MONTH"

"WEEK"

"BIWEEKLY"

"SEMIMONTHLY"

Frequency that costs accrue for this benefit. For insurance/benefits, usually "MONTHLY". For compensation, matches pay cycle (WEEKLY, BIWEEKLY, etc).

is_activeboolean

employer_contribution_type enum

Valid values:

"PERCENTAGE"

"FIXED"

employer_contribution_amountnumber

percentage or money

employer_contribution_max_amountnumber

always money

coverage_level enum

Valid values:

"EMPLOYEE_ONLY"

"EMPLOYEE_SPOUSE"

"EMPLOYEE_CHILD"

"EMPLOYEE_CHILDREN"

"EMPLOYEE_FAMILY"

"FAMILY"

"OTHER"

currencystring

raw

Returns

HrisBenefit

Response field	Type	Required	Description
`id`	string	No
`created_at`	string (date-time)	No	(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
`updated_at`	string (date-time)	No	(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
`name`	string	No	e.g. "401(k) Plan"
`description`	string	No	e.g. "Company 401(k) retirement plan"
`company_id`	string	No	(reference to HrisCompany)
`type`	enum	No	Values: `RETIREMENT`, `HEALTH`, `DENTAL`, `VISION`, `LIFE`, `HSA`, `FSA`, `SHORT_TERM_DISABILITY`, `LONG_TERM_DISABILITY`, `WORKERS_COMP`, `HOUSING_STIPEND`, `EMPLOYER_TAX_CONTRIBUTION`, `GARNISHMENT`, `LOAN_REPAYMENT`, `CHARITABLE_CONTRIBUTION`, `OTHER`, `RETIREMENT_ROTH`, `COMMUTER`, `DEPENDENT_CARE`, `PENSION`
`tax`	enum	No	Tax describes the tax treatment of the benefit Values: `PRE_TAX`, `POST_TAX`, `TAXABLE`, `NON_TAXABLE`, `TAX`
`frequency`	enum	No	Frequency that costs accrue for this benefit. For insurance/benefits, usually "MONTHLY". For compensation, matches pay cycle (WEEKLY, BIWEEKLY, etc). Values: `ONE_TIME`, `DAY`, `QUARTER`, `YEAR`, `HOUR`, `MONTH`, `WEEK`, `BIWEEKLY`, `SEMIMONTHLY`
`is_active`	boolean	No
`employer_contribution_type`	enum	No	Values: `PERCENTAGE`, `FIXED`
`employer_contribution_amount`	number	No	percentage or money
`employer_contribution_max_amount`	number	No	always money
`coverage_level`	enum	No	Values: `EMPLOYEE_ONLY`, `EMPLOYEE_SPOUSE`, `EMPLOYEE_CHILD`, `EMPLOYEE_CHILDREN`, `EMPLOYEE_FAMILY`, `FAMILY`, `OTHER`
`currency`	string	No

Errors

Errors return the HTTP status code and a JSON body with statusCode, error (the short label) and message (a human-readable detail).

{
  "statusCode": 429,
  "error": "Too Many Requests",
  "message": "Too many requests to unified.to API; max requests per minute: N"
}

Status	Error	Meaning
`400`	Bad Request	The request was malformed or failed validation.
`401`	Unauthorized	The connection is likely broken; re-authorize it.
`403`	Forbidden	The connection is missing permissions or scopes.
`404`	Not Found	The requested resource does not exist.
`429`	Too Many Requests	Rate limit exceeded (see the two sources below).
`500`	Internal Server Error	An unexpected error occurred.
`501`	Not Implemented	Not supported by this integration.

Errors from the underlying integration pass through: the integration's status comes back as ours (429, 401, 403, 404 or 5xx), usually with its message. When the integration's error body is unclear, Unified extracts what it can and returns a clearer message.

429 Too Many Requests

A 429 has two possible sources:

The integration's own rate limit, passed through.
Unified's workspace limit: a rolling 60 seconds, set by plan, with the message Too many requests to unified.to API; max requests per minute: N.

const options = {
  method: 'PUT',
  url: 'https://api.unified.to/hris/5de520f96e439b002043d8dc/benefit/5de520f96e439b002043d8d8',
  headers: {
    authorization: 'bearer .....'
  },
  data: undefined,
  params: {
    fields: '',
    raw: '',
  }
};

const results = await axios.request(options);

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.updateHrisBenefit({ connectionId, id, hrisBenefit: { }, 
    fields: '',
    raw: '',
 });

Node.js (axios)

const options = {
  method: 'PUT',
  url: 'https://api.unified.to/hris/5de520f96e439b002043d8dc/benefit/5de520f96e439b002043d8d8',
  headers: {
    authorization: 'bearer .....'
  },
  data: undefined,
  params: {
    fields: '',
    raw: '',
  }
};

const results = await axios.request(options);

Java

AsyncHttpClient client = new DefaultAsyncHttpClient();

client.prepare("PUT", "https://api.unified.to/hris/5de520f96e439b002043d8dc/benefit/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/benefit/5de520f96e439b002043d8d8?fields=&raw=

req, _ := http.NewRequest("PUT", 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/benefit/5de520f96e439b002043d8d8?fields=&raw="

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

response = requests.put(url, headers=headers)

PHP

$curl = curl_init();

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

Ruby

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

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

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

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

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

cURL

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

Are we missing anything? Let us know

Was this page helpful?