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

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-connector-token
string
required

Path Parameters

id
string
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.

include_custom_fields
boolean
default:
false

Whether to include custom fields in the response.

expand
string

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.

Response

200 - application/json
custom_fields
object | null
required

The custom fields related to the model

employee
any | null
required

The employee holding this position.

flsa_status
string | null
required

The position's FLSA status. Possible values include: EXEMPT, SALARIED_NONEXEMPT, NONEXEMPT, OWNER, or - in cases where there is no clear mapping - the original value passed through.

id
string
required
modified_at
string
required

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

pay_currency
string | null
required

The position's currency code.

pay_frequency
string | null
required

The position's pay frequency. Possible values include: WEEKLY, BIWEEKLY, MONTHLY, QUARTERLY, SEMIANNUALLY, ANNUALLY, THIRTEEN-MONTHLY, PRO_RATA, SEMIMONTHLY, or - in cases where there is no clear mapping - the original value passed through.

pay_group
any | null
required

The employee's pay group.

pay_period
string | null
required

The time period this pay rate encompasses. Possible values include: HOUR, DAY, WEEK, EVERY_TWO_WEEKS, SEMIMONTHLY, MONTH, QUARTER, EVERY_SIX_MONTHS, YEAR, or - in cases where there is no clear mapping - the original value passed through.

pay_rate
required

The position's pay rate in dollars.

remote_id
string | null
required

The third-party API ID of the matching object.

start_date
string | null
required

The position's start date.

raw_data
object | null

This is the Raw data