Rippling: Create a new off-cycle payroll run — response body — runs item

API reference · Contract 2026-10-28

SDK schema: Create a new off-cycle payroll run — response body — runs item

Field	Type	Presence	Description and constraints
$	object	Root
check_date	string	Required within parent	Payment date selected for this run.
company_entity_id	JSON	Required within parent
company_entity_id (anyOf 1)	string	Alternative	HRIS company entity relationship ID for this run, matching company_entity_id on payroll run retrieval. Null if the relationship cannot be resolved.
company_entity_id (anyOf 2)	null	Alternative
country_code	string	Required within parent	Country code of the payroll entity.
employment_split	string	Required within parent	Worker eligibility category used to split this run, such as employees or contractors.
pay_period	object	Required within parent	Pay period for this run.
pay_period.end_date	string	Required within parent	End date of this run’s pay period.
pay_period.start_date	string	Required within parent	Start date of this run’s pay period.
run_configuration	object	Required within parent	Calculation configuration used for this run.
run_configuration.pay_basis	string	Required within parent	Amount basis used by the created run. This API currently creates gross-pay runs.
run_id	string	Required within parent	Identifier of the created draft payroll run.
run_status	string	Required within parent	Status of the created payroll run.
run_type	string	Required within parent	Type of the created payroll run.
worker_ids	array	Required within parent	Role IDs included in this run.
worker_ids[]	string	Each item