Rippling: List variable compensation payouts — response body — results item

API reference · Contract 2026-10-28

SDK schema: List variable compensation payouts — response body — results item

Field	Type	Presence	Description and constraints
$	object	Root
amount_base	object	Required within parent	Payout amount in the worker’s base currency.
amount_base.currency_type	string	Required within parent	Three-letter currency code.
amount_base.value	string	Required within parent	Decimal amount encoded as a string.
amount_usd	object	Required within parent	Payout amount converted to USD.
amount_usd.currency_type	string	Required within parent	Three-letter currency code.
amount_usd.value	string	Required within parent	Decimal amount encoded as a string.
cancel_reason	string	Optional	Reason provided when the payout was cancelled.
client	string	Required within parent	Client system that created the payout. Known values: VC_PLAN_CYCLE, VC_EVENT_DRIVEN_PLAN, CUSTOM, MANUAL_PAYOUT, HRIS_SIGN_ON, OFFLINE_RECOMMENDATION
created_at	string	Required within parent	When the payout was created.
description	string	Optional	Optional payout description.
effective_end_date	string	Required within parent	End date of the covered pay period.
effective_start_date	string	Required within parent	Start date of the covered pay period.
external_id	string	Required within parent	External identifier unique per company and client.
group_label_id	string	Optional	Group label identifier attached to the payout. Expand is deferred from v1; use GET /variable-compensation-payout-labels/{id}/ when needed.
id	string	Required within parent	Unique identifier of the payout.
name	string	Optional	Optional payout name.
pay_classification	string	Optional	Payroll earning code resolved from the payout type.
payee_id	string	Required within parent	ID of the worker who receives this payout. Expandable payee (Worker DTO + workers.read) is deferred from v1; use GET /workers/{id}/ when needed.
payout_type	string	Required within parent	Key of the company payout type used for this payout. Expand is deferred from v1; enumerate valid keys via GET /variable-compensation-payout-types/.
paystub_id	string	Optional	Paystub identifier when the payout has been synced to payroll.
scheduled_date	string	Required within parent	Date on which the payout is scheduled.
source_label_id	string	Optional	Source label identifier attached to the payout. Expand is deferred from v1; use GET /variable-compensation-payout-labels/{id}/ when needed.
status	string	Required within parent	Current payout status. Known values: DRAFT, PENDING_APPROVAL, APPROVAL_REJECTED, SCHEDULED, RELEASED, PAID, FORFEITED, EVALUATION_FAILED, CANCELLED
updated_at	string	Required within parent	When the payout was last updated.