Rippling: Create hire — request body — body hires item compensation commission
Create hire: request body, field body / hires / item / compensation / commission. Complete fields and constraints for contract 2026-10-28.
API reference · Contract 2026-10-28
SDK schema: Create hire — request body — body hires item compensation commission
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Variable sales compensation expected when the person meets target. on_target_amount is required; provide payment_frequency where required by GET /hire-requirements/. Starting with API version 2025-08-01, this field does not apply to contractor hires and is reported in ignored_fields. Additional keys: not allowed |
on_target_amount | object | Required within parent | Expected total commission for a full year when the person meets target, using currency_type as a three-letter ISO 4217 code and value as the decimal amount. |
on_target_amount.currency_type | string | Optional | The currency type, ex: USD, EUR, etc. |
on_target_amount.value | number | Optional | The decimal amount for the currency. |
payment_frequency | string | Optional | How often commission is paid: MONTH, QUARTER, or YEAR. Required when indicated by GET /hire-requirements/ for the selected country and hire type. One of: MONTH, QUARTER, YEAR |