Skip to content

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

Create a new off-cycle payroll run: response body, field errors / item. Complete fields and constraints for contract 2026-10-28.

API reference · Contract 2026-10-28

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

FieldTypePresenceDescription and constraints
$objectRoot
codestringRequired within parentStable error code; an exception does not prove that no run was created.
Known values: RUN_CREATION_OUTCOME_UNKNOWN
company_entity_idJSONRequired within parent
company_entity_id (anyOf 1)stringAlternativeHRIS company entity relationship ID for the attempted run. Null if the relationship cannot be resolved.
company_entity_id (anyOf 2)nullAlternative
employment_splitstringRequired within parentEmployment category for the attempted run.
messagestringRequired within parentSafe description of the unconfirmed creation outcome and retry guidance.
worker_idsarrayRequired within parentRole IDs in the run whose creation could not be confirmed.
worker_ids[]stringEach item

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.