Rippling: Retrieve a specific headcount position — response body — actual compensation
Retrieve a specific headcount position: response body, field actual_compensation. Complete fields and constraints for contract 2026-10-28.
API reference · Contract 2026-10-28
SDK schema: Retrieve a specific headcount position — response body — actual compensation
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Compensation data synched from worker compensation |
base_pay | object | Optional | Annual base pay for the headcount position |
base_pay.currency_type | string | Optional | The currency type, ex: USD, EUR, etc. |
base_pay.value | JSON | Optional | |
base_pay.value (anyOf 1) | number | Alternative | The decimal amount for the currency. |
base_pay.value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
bonus | object | Optional | Annual bonus for the headcount position |
bonus.currency_type | string | Optional | The currency type, ex: USD, EUR, etc. |
bonus.value | JSON | Optional | |
bonus.value (anyOf 1) | number | Alternative | The decimal amount for the currency. |
bonus.value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
commission | object | Optional | Annual on target commission for the headcount position |
commission.currency_type | string | Optional | The currency type, ex: USD, EUR, etc. |
commission.value | JSON | Optional | |
commission.value (anyOf 1) | number | Alternative | The decimal amount for the currency. |
commission.value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
tax_and_benefits | object | Optional | Annual total taxes and benefits compensation for this headcount position |
tax_and_benefits.currency_type | string | Optional | The currency type, ex: USD, EUR, etc. |
tax_and_benefits.value | JSON | Optional | |
tax_and_benefits.value (anyOf 1) | number | Alternative | The decimal amount for the currency. |
tax_and_benefits.value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total_cash | object | Optional | Annual total cash compensation for the headcount position |
total_cash.currency_type | string | Optional | The currency type, ex: USD, EUR, etc. |
total_cash.value | JSON | Optional | |
total_cash.value (anyOf 1) | number | Alternative | The decimal amount for the currency. |
total_cash.value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total_equity | object | Optional | Annual total equity compensation for the headcount position |
total_equity.currency_type | string | Optional | The currency type, ex: USD, EUR, etc. |
total_equity.value | JSON | Optional | |
total_equity.value (anyOf 1) | number | Alternative | The decimal amount for the currency. |
total_equity.value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |