Rippling: Update a variable compensation payout type — response body — mappings item

API reference · Contract 2026-10-28

SDK schema: Update a variable compensation payout type — response body — mappings item

Field	Type	Presence	Description and constraints
$	object	Root
earning_code	string	Optional	Mapped earning code for the payroll entity.
earning_display_name	string	Optional	Display name of the mapped earning code at response time. Convenience snapshot for the mapping matrix; authoritative earning metadata lives in payroll, not this field.
entity_id	string	Required within parent	ID of the payroll entity this mapping applies to.
entity_name	string	Optional	Display name of the payroll entity at response time. Convenience snapshot for the mapping matrix; authoritative entity data lives on payroll entities, not this field.
health	string	Required within parent	Mapping health status.