Rippling: Create a new earnings-input — request body — body

API reference · Contract 2026-10-28

SDK schema: Create a new earnings-input — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	V2 DTO representing an external earnings input record. Used by: - GET /earnings-inputs/ (list)
amount	string	Optional	Earning amount as a string-encoded decimal.
assignment_type	string	Optional	How the earning is assigned (e.g. BY_PAY_PERIOD).
company_entity_id	string	Optional	Identifier for the legal entity (company entity relationship) this earning is associated with. Use this to correlate earnings with a specific legal entity in a multi-entity company.
earning_code	string	Optional	Code identifying the earning type (e.g. regular_salary).
earning_end_date	string	Optional	End of the period this earning was earned. Used for regular-rate-of-pay (RROP) attribution. Distinct from pay_period_basis_date, which selects the pay run.
earning_start_date	string	Optional	Start of the period this earning was earned. Used for regular-rate-of-pay (RROP) attribution. Distinct from pay_period_basis_date, which selects the pay run.
external_id	string	Optional	External reference identifier for this earning.
hours	string	Optional	Hours associated with this earning as a string-encoded decimal.
is_overridden	boolean	Optional	Whether this earning’s amount was manually overridden instead of using the calculated value. Always false for newly created earnings.
pay_period_basis_date	string	Optional	The pay period basis date for this earning.
run_id	string	Optional	Identifier of the payroll run this earning is assigned to, if any.
status	string	Optional	Current status of the earnings input (e.g. UNASSIGNED, ASSIGNED).
time_labels	array	Optional	Time tracking labels associated with this earning.
time_labels[]	string	Each item
worker_id	string	Optional	Identifier of the worker (role ID).