Rippling: List compensations — response body — results item
List compensations: response body, field results / item. Complete fields and constraints for contract 2026-10-28.
API reference · Contract 2026-10-28
SDK schema: List compensations — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
annual_compensation | object | Optional | The worker’s annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage. |
annual_compensation.currency_type | string | Optional | The currency type, ex: USD, EUR, etc. |
annual_compensation.value | JSON | Optional | |
annual_compensation.value (anyOf 1) | number | Alternative | The decimal amount for the currency. |
annual_compensation.value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
annual_salary_equivalent | object | Optional | The worker’s annual salary equivalent, for insurance purposes. It will be equal to the worker’s annual compensation, except for owners that are receiving no cashcompensation. |
annual_salary_equivalent.currency_type | string | Optional | The currency type, ex: USD, EUR, etc. |
annual_salary_equivalent.value | JSON | Optional | |
annual_salary_equivalent.value (anyOf 1) | number | Alternative | The decimal amount for the currency. |
annual_salary_equivalent.value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
bonus_schedule | string | Optional | The worker’s bonus schedule. |
created_at | string | Required within parent | Record creation date |
hourly_wage | object | Optional | The worker’s hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation. |
hourly_wage.currency_type | string | Optional | The currency type, ex: USD, EUR, etc. |
hourly_wage.value | JSON | Optional | |
hourly_wage.value (anyOf 1) | number | Alternative | The decimal amount for the currency. |
hourly_wage.value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
id | string | Required within parent | Identifier field |
monthly_compensation | object | Optional | The worker’s monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage. |
monthly_compensation.currency_type | string | Optional | The currency type, ex: USD, EUR, etc. |
monthly_compensation.value | JSON | Optional | |
monthly_compensation.value (anyOf 1) | number | Alternative | The decimal amount for the currency. |
monthly_compensation.value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
on_target_commission | object | Optional | The worker’s on-target commission. |
on_target_commission.currency_type | string | Optional | The currency type, ex: USD, EUR, etc. |
on_target_commission.value | JSON | Optional | |
on_target_commission.value (anyOf 1) | number | Alternative | The decimal amount for the currency. |
on_target_commission.value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
payment_terms | string | Optional | The payment terms for an worker’s compensation. |
payment_type | string | Optional | The payment type for an worker’s compensation. |
relocation_reimbursement | object | Optional | The worker’s hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation. |
relocation_reimbursement.currency_type | string | Optional | The currency type, ex: USD, EUR, etc. |
relocation_reimbursement.value | JSON | Optional | |
relocation_reimbursement.value (anyOf 1) | number | Alternative | The decimal amount for the currency. |
relocation_reimbursement.value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
salary_effective_date | string | Optional | Salary effective date |
signing_bonus | object | Optional | The worker’s signing bonus. |
signing_bonus.currency_type | string | Optional | The currency type, ex: USD, EUR, etc. |
signing_bonus.value | JSON | Optional | |
signing_bonus.value (anyOf 1) | number | Alternative | The decimal amount for the currency. |
signing_bonus.value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
target_annual_bonus | object | Optional | The worker’s target annual bonus amount. |
target_annual_bonus.currency_type | string | Optional | The currency type, ex: USD, EUR, etc. |
target_annual_bonus.value | JSON | Optional | |
target_annual_bonus.value (anyOf 1) | number | Alternative | The decimal amount for the currency. |
target_annual_bonus.value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
target_annual_bonus_percent | JSON | Optional | |
target_annual_bonus_percent (anyOf 1) | number | Alternative | The worker’s target annual bonus as a percent of annual compensation. |
target_annual_bonus_percent (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
updated_at | string | Required within parent | Record update date |
weekly_compensation | object | Optional | The worker’s weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage. |
weekly_compensation.currency_type | string | Optional | The currency type, ex: USD, EUR, etc. |
weekly_compensation.value | JSON | Optional | |
weekly_compensation.value (anyOf 1) | number | Alternative | The decimal amount for the currency. |
weekly_compensation.value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
worker | Model | Optional | Expand Retrieve a specific compensation — response body — worker |
worker_id | string | Optional | The worker’s ID. |
Referenced models: Retrieve a specific compensation — response body — worker