BIbindbee
Compensation

Get Compensation By Id

Changed on

Returns a Compensation object with the given id.

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

Request

  • Base URL
    https://api.bindbee.dev (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer and API key in header X-Connector-Token

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.

include_custom_fieldsboolean

Whether to include custom fields in the response.

expandstring nullable

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. Add .custom_fields to return an expanded record's custom fields, or .custom_fields[name,other_name] for only those (quote a name holding anything but letters, digits, _ and -: .custom_fields["wd:Visa_ID"]).

Example:manager[first_name,last_name]

Response

Successful Response

idstring uuid required
remote_idstring nullable required

The third-party API ID of the matching object.

modified_atstring date-time 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_periodstring 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_frequencystring 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_statusstring 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"
}

Changes

  • 1f9bc0ad4bfbRevision changes
    • info

      the endpoint scheme security HTTPBearer AND ConnectorToken was added to the API

    • info

      the endpoint scheme security ConnectorToken was removed from the API

    • info

      the endpoint scheme security HTTPBearer was removed from the API

    • info

      removed the - enum value from the response property for the response status

    • info

      removed the - enum value from the response property for the response status

    • info

      removed the - enum value from the response property for the response status

    • info

      removed the ANNUALLY enum value from the response property for the response status

    • info

      removed the BIWEEKLY enum value from the response property for the response status

    • info

      removed the DAY enum value from the response property for the response status

    • info

      removed the EVERY_FOUR_WEEKS enum value from the response property for the response status

    • info

      removed the EVERY_SIX_MONTHS enum value from the response property for the response status

    • info

      removed the EVERY_TWO_WEEKS enum value from the response property for the response status

    • info

      removed the EXEMPT enum value from the response property for the response status

    • info

      removed the FOURWEEKLY enum value from the response property for the response status

    • info

      removed the HOUR enum value from the response property for the response status

    • info

      removed the HOURLY enum value from the response property for the response status

    • info

      removed the MONTH enum value from the response property for the response status

    • info

      removed the MONTHLY enum value from the response property for the response status

    • info

      removed the NONEXEMPT enum value from the response property for the response status

    • info

      removed the OWNER enum value from the response property for the response status

    • info

      removed the PRO_RATA enum value from the response property for the response status

    • info

      removed the QUARTER enum value from the response property for the response status

    • info

      removed the QUARTERLY enum value from the response property for the response status

    • info

      removed the SALARIED_NONEXEMPT enum value from the response property for the response status

    • info

      removed the SEMIANNUALLY enum value from the response property for the response status

    • info

      removed the SEMIMONTHLY enum value from the response property for the response status

    • info

      removed the SEMIMONTHLY enum value from the response property for the response status

    • info

      removed the THIRTEEN-MONTHLY enum value from the response property for the response status

    • info

      removed the TWICE_PER_MONTH enum value from the response property for the response status

    • info

      removed the WEEK enum value from the response property for the response status

    • info

      removed the WEEKLY enum value from the response property for the response status

    • info

      removed the YEAR enum value from the response property for the response status

  • cf8209fb1cd7Revision changes
    • warning

      deleted the header request parameter x-connector-token

    • info

      the endpoint scheme security ConnectorToken was added to the API