Sign in

v4

latestOpenAPI 3.1.02026-08-01139149645.9 KB
Compensation

Get Compensation By Id

Returns a Compensation object with the given id.

get/api/hris/v1/compensations/{id}

Path parameters

idstring uuid required

Query parameters

include_raw_databoolean

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

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

include_custom_fieldsboolean

Whether to include custom fields in the response.

Whether to include custom fields in the response.

expandstring

Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.

Example:manager[first_name,last_name]

Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.

Headers

x-connector-tokenstring required

Response

Successful Response

idstring uuid required
remote_idstring nullable required

The third-party API ID of the matching object.

modified_atstring required

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

raw_dataobject nullable

This is the Raw data

custom_fieldsobject nullable required

The custom fields related to the model

employeestring nullable required

The employee holding this position.

pay_groupstring nullable required

The employee's pay group.

pay_period'HOUR' | 'DAY' | 'WEEK' | 'EVERY_TWO_WEEKS' | 'EVERY_FOUR_WEEKS' | 'TWICE_PER_MONTH' | 'SEMIMONTHLY' | 'MONTH' | 'QUARTER' | 'EVERY_SIX_MONTHS' | 'YEAR' | '-' nullable required

The time period this pay rate encompasses. If the value is not one of the defined enum values, the original value passed through will be returned.

pay_frequency'HOURLY' | 'WEEKLY' | 'BIWEEKLY' | 'QUARTERLY' | 'SEMIANNUALLY' | 'ANNUALLY' | 'THIRTEEN-MONTHLY' | 'PRO_RATA' | 'SEMIMONTHLY' | 'MONTHLY' | 'FOURWEEKLY' | '-' nullable required

The position's pay frequency. If the value is not one of the defined enum values, the original value passed through will be returned.

pay_currencystring nullable required

The position's currency code.

flsa_status'EXEMPT' | 'SALARIED_NONEXEMPT' | 'NONEXEMPT' | 'OWNER' | '-' nullable required

The position's FLSA status. If the value is not one of the defined enum values, the original value passed through will be returned.

start_datestring nullable required

The position's start date.

Example response

{
  "id": "018b18ef-c487-703c-afd9-0ca478ccd9d6",
  "remote_id": "123321",
  "modified_at": "2021-10-16T00:00:00Z",
  "raw_data": {
    "key_1": "Platform dependent data 1",
    "key_2": "Platform dependent data 2"
  },
  "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"
  },
  "employee": "018abccc-3208-7b2d-8b86-927945f89a42",
  "pay_group": "018b802f-4856-7ea8-a83f-ac374853ab90",
  "pay_period": "YEAR",
  "pay_frequency": "MONTHLY",
  "pay_currency": "USD",
  "flsa_status": "EXEMPT",
  "start_date": "2022-12-15T00:00:00Z"
}