Rippling: Create hire — request body — body hires item compensation signing bonus
Create hire: request body, field body / hires / item / compensation / signing_bonus. 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 signing bonus
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | One-time payment offered for accepting or starting the job. When provided, amount and schedule are required; payment_days is optional. 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 |
amount | object | Required within parent | Total one-time signing bonus, using currency_type as a three-letter ISO 4217 code and value as the decimal amount. |
amount.currency_type | string | Optional | The currency type, ex: USD, EUR, etc. |
amount.value | number | Optional | The decimal amount for the currency. |
payment_days | integer | Optional | Number of days after the applicable start or schedule event when the bonus is paid, if used. |
schedule | string | Required within parent | Payment event or schedule for the signing bonus, for example FIRST_PAYROLL. Use an allowed value returned by GET /hire-requirements/. |