Skip to main content
GET
Get Compensation By 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<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

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.

Example:

"manager[first_name,last_name]"

Response

Successful Response

id
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
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:
employee
any | null
required

The employee holding this position.

Example:

"018abccc-3208-7b2d-8b86-927945f89a42"

pay_group
any | null
required

The employee's pay group.

Example:

"018b802f-4856-7ea8-a83f-ac374853ab90"

pay_rate
required

The position's pay rate in dollars.

Example:

77000

pay_period
enum<string>
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.

Available options:
HOUR,
DAY,
WEEK,
EVERY_TWO_WEEKS,
EVERY_FOUR_WEEKS,
TWICE_PER_MONTH,
SEMIMONTHLY,
MONTH,
QUARTER,
EVERY_SIX_MONTHS,
YEAR,
-
Example:

"YEAR"

pay_frequency
enum<string>
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.

Available options:
HOURLY,
WEEKLY,
BIWEEKLY,
QUARTERLY,
SEMIANNUALLY,
ANNUALLY,
THIRTEEN-MONTHLY,
PRO_RATA,
SEMIMONTHLY,
MONTHLY,
FOURWEEKLY,
-
Example:

"MONTHLY"

pay_currency
string | null
required

The position's currency code.

Example:

"USD"

flsa_status
enum<string>
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.

Available options:
EXEMPT,
SALARIED_NONEXEMPT,
NONEXEMPT,
OWNER,
-
Example:

"EXEMPT"

start_date
string | null
required

The position's start date.

Example:

"2022-12-15T00:00:00Z"

raw_data
Raw Data · object | null

This is the Raw data

Example: