Get Payroll Code By Id

curl --request GET \
  --url https://api.bindbee.dev/api/hris/v1/payroll-codes/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Connector-Token: <api-key>'

import requests

url = "https://api.bindbee.dev/api/hris/v1/payroll-codes/{id}"

headers = {
    "Authorization": "Bearer <token>",
    "X-Connector-Token": "<api-key>"
}

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

print(response.text)

const options = {
  method: 'GET',
  headers: {Authorization: 'Bearer <token>', 'X-Connector-Token': '<api-key>'}
};

fetch('https://api.bindbee.dev/api/hris/v1/payroll-codes/{id}', 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.bindbee.dev/api/hris/v1/payroll-codes/{id}",
  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: Bearer <token>",
    "X-Connector-Token: <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.bindbee.dev/api/hris/v1/payroll-codes/{id}"

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("X-Connector-Token", "<api-key>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.bindbee.dev/api/hris/v1/payroll-codes/{id}")
  .header("Authorization", "Bearer <token>")
  .header("X-Connector-Token", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.bindbee.dev/api/hris/v1/payroll-codes/{id}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
request["X-Connector-Token"] = '<api-key>'

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

{
  "id": "018b18ef-c487-703c-afd9-0ca478ccd9d6",
  "remote_id": "123321",
  "modified_at": "2021-10-16T00:00:00Z",
  "custom_fields": {
    "category_group": "REG",
    "disability_type": "ASBERG",
    "hire_date": "1991-03-16T00:00:00",
    "hire_source": "REFER",
    "nationality": "USA",
    "original_hire_date": "1991-03-16T00:00:00"
  },
  "name": "Dental Insurance",
  "code": "DENTAL",
  "type": "DEDUCTION",
  "sub_type": "DENTAL",
  "raw_data": {
    "key_1": "Platform dependent data 1",
    "key_2": "Platform dependent data 2"
  }
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

{
  "detail": "<string>"
}

GET

api

hris

payroll-codes

{id}

Get Payroll Code By Id

curl --request GET \
  --url https://api.bindbee.dev/api/hris/v1/payroll-codes/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Connector-Token: <api-key>'

import requests

url = "https://api.bindbee.dev/api/hris/v1/payroll-codes/{id}"

headers = {
    "Authorization": "Bearer <token>",
    "X-Connector-Token": "<api-key>"
}

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

print(response.text)

const options = {
  method: 'GET',
  headers: {Authorization: 'Bearer <token>', 'X-Connector-Token': '<api-key>'}
};

fetch('https://api.bindbee.dev/api/hris/v1/payroll-codes/{id}', 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.bindbee.dev/api/hris/v1/payroll-codes/{id}",
  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: Bearer <token>",
    "X-Connector-Token: <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.bindbee.dev/api/hris/v1/payroll-codes/{id}"

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("X-Connector-Token", "<api-key>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.bindbee.dev/api/hris/v1/payroll-codes/{id}")
  .header("Authorization", "Bearer <token>")
  .header("X-Connector-Token", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.bindbee.dev/api/hris/v1/payroll-codes/{id}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
request["X-Connector-Token"] = '<api-key>'

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

{
  "id": "018b18ef-c487-703c-afd9-0ca478ccd9d6",
  "remote_id": "123321",
  "modified_at": "2021-10-16T00:00:00Z",
  "custom_fields": {
    "category_group": "REG",
    "disability_type": "ASBERG",
    "hire_date": "1991-03-16T00:00:00",
    "hire_source": "REFER",
    "nationality": "USA",
    "original_hire_date": "1991-03-16T00:00:00"
  },
  "name": "Dental Insurance",
  "code": "DENTAL",
  "type": "DEDUCTION",
  "sub_type": "DENTAL",
  "raw_data": {
    "key_1": "Platform dependent data 1",
    "key_2": "Platform dependent data 2"
  }
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

{
  "detail": "<string>"
}

Authorizations

Authorization

string

header

default:<BINDBEE_API_KEY>

required

Your Bindbee API key, sent as Authorization: Bearer <BINDBEE_API_KEY>. Required on every request.

X-Connector-Token

string

header

default:<CONNECTOR_TOKEN>

required

The connector token for one customer's connection. This is not your Bindbee API key. Required on requests that read or write a single customer's data.

Path Parameters

string<uuid>

required

Query Parameters

include_raw_data

boolean

default:false

Whether to include the original data Bindbee fetched from the third-party to produce these models.

Example:

false

include_custom_fields

boolean

default:false

Whether to include custom fields in the response.

Example:

false

Response

Successful Response

The Payroll Code object represents a payroll code such as an earning, deduction, or tax used within the payroll system.

string<uuid>

required

Example:

"018b18ef-c487-703c-afd9-0ca478ccd9d6"

remote_id

string | null

required

The third-party API ID of the matching object.

Example:

"123321"

modified_at

string<date-time>

required

This is the datetime that this object was last updated by Bindbee

Example:

"2021-10-16T00:00:00Z"

custom_fields

Custom Fields · object | null

required

The custom fields related to the model

Example:

{
  "category_group": "REG",
  "disability_type": "ASBERG",
  "hire_date": "1991-03-16T00:00:00",
  "hire_source": "REFER",
  "nationality": "USA",
  "original_hire_date": "1991-03-16T00:00:00"
}

name

string | null

required

Human-readable name of the payroll code.

Example:

"Dental Insurance"

code

string | null

required

Short code identifying the payroll code within the source system.

Example:

"DENTAL"

type

string | null

required

Category of the payroll code, such as Earning, Deduction, or Tax.

Example:

"DEDUCTION"

sub_type

enum<string>

required

Optional finer-grained classification of the payroll code, drawn from the set allowed for its type. Null when no unified sub-type applies.

Available options:

REGULAR,

OVERTIME,

BONUS,

ALLOWANCE,

TIME_OFF,

SEVERANCE,

EQUITY,

REIMBURSEMENT,

RETRO,

HEALTH,

DENTAL,

VISION,

HEALTH_SAVINGS,

FLEXIBLE_SPENDING,

RETIREMENT,

LIFE_INSURANCE,

SUPPLEMENTAL_INSURANCE,

DISABILITY,

GARNISHMENT,

FUTA,

SUTA,

FICA,

MEDICARE,

FIT,

SIT,

INCOME_TAX,

UNEMPLOYMENT,

LEVY,

SOCIAL_SECURITY

Example:

"DENTAL"

raw_data

Raw Data · object | null

This is the Raw data

Example:

{
  "key_1": "Platform dependent data 1",
  "key_2": "Platform dependent data 2"
}

API Basics

Platform

HR & Payroll (HRIS)

Recruiting (ATS)

Learning (LMS)

Get Payroll Code By Id

Authorizations

Path Parameters

Query Parameters

Response