Create an earning

POST/hris/{connection_id}/earning

Parameters

Payload

idstring

created_atdate-time

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

updated_atdate-time

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

user_idstring

employee ID (reference to HrisEmployee)

company_idstring

(reference to HrisCompany)

paycode_idstring

the hris_paycode (earning code) this earning is paid under

amountnumber

money amount added to each pay run it applies to

currencystring

hoursnumber

rate_amountnumber

rate per hour/unit

frequency enum

Valid values:

"ONE_TIME"

"DAY"

"QUARTER"

"YEAR"

"HOUR"

"MONTH"

"WEEK"

"BIWEEKLY"

"SEMIMONTHLY"

ONE_TIME for a single addition to the next unprocessed pay run, otherwise recurring

start_atdate-time

recurring: first effective date; ONE_TIME: requested pay date (empty = next unprocessed pay run) (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

end_atdate-time

recurring: last effective date (empty = until stopped) (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

status enum

Valid values:

"PENDING"

"ACTIVE"

"PROCESSED"

"ENDED"

"CANCELLED"

"FAILED"

payroll_idstring

the hris_payroll (pay run) a ONE_TIME earning targets or was paid in

payslip_idstring

the hris_payslip a ONE_TIME earning was paid on

notesstring

raw

Returns

HrisEarning

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)
`user_id`	string	No	employee ID (reference to HrisEmployee)
`company_id`	string	No	(reference to HrisCompany)
`paycode_id`	string	No	the hris_paycode (earning code) this earning is paid under
`amount`	number	No	money amount added to each pay run it applies to
`currency`	string	No
`hours`	number	No
`rate_amount`	number	No	rate per hour/unit
`frequency`	enum	No	ONE_TIME for a single addition to the next unprocessed pay run, otherwise recurring Values: `ONE_TIME`, `DAY`, `QUARTER`, `YEAR`, `HOUR`, `MONTH`, `WEEK`, `BIWEEKLY`, `SEMIMONTHLY`
`start_at`	string (date-time)	No	recurring: first effective date; ONE_TIME: requested pay date (empty = next unprocessed pay run) (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
`end_at`	string (date-time)	No	recurring: last effective date (empty = until stopped) (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
`status`	enum	No	Values: `PENDING`, `ACTIVE`, `PROCESSED`, `ENDED`, `CANCELLED`, `FAILED`
`payroll_id`	string	No	the hris_payroll (pay run) a ONE_TIME earning targets or was paid in
`payslip_id`	string	No	the hris_payslip a ONE_TIME earning was paid on
`notes`	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: 'POST',
  url: 'https://api.unified.to/hris/5de520f96e439b002043d8dc/earning',
  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 results = await sdk.hris.createHrisEarning({ connectionId, hrisEarning: { }, 
    fields: '',
    raw: '',
 });

Node.js (axios)

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

const results = await axios.request(options);

Java

AsyncHttpClient client = new DefaultAsyncHttpClient();

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

req, _ := http.NewRequest("POST", 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/earning?fields=&raw="

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

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

PHP

$curl = curl_init();

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

Ruby

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

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

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

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

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

cURL

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

Are we missing anything? Let us know

Was this page helpful?