Rippling: Create a new variable compensation payout write — request body — body

API reference · Contract 2026-10-28

SDK schema: Create a new variable compensation payout write — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
ai_conditions_summary	string	Optional	Optional markdown summary of the eligibility conditions.
amount_base	object	Required within parent	Payout amount.
amount_base.currency_type	string	Required within parent	Three-letter currency code.
amount_base.value	string	Required within parent	Decimal payout amount encoded as a string.
eligibility_sql	string	Optional	SQL eligibility expression. Omit to use the active-role default.
group_name	string	Optional	Optional payout group label.
payee_id	string	Required within parent	ID of the worker who receives this payout.
payment_type	string	Required within parent	Key of the company payment type used for this payout.
scheduled_date	string	Required within parent	Date on which the payout is scheduled.