Rippling: Create a new off-cycle payroll run
Rippling restApi.createPayrollRunsOffCycle: arguments, response, policy and SDK examples.
← Rest API operations · Get started
Operation rippling.rest_api.create_payroll_runs_off_cycle
Provider route: POST /payroll-runs/off-cycle/. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/rippling with npm, or alter-sdk-rippling with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { RipplingIntegration } from "@alter-ai/rippling";
async function execute(input: Parameters<RipplingIntegration["restApi"]["createPayrollRunsOffCycle"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new RipplingIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.restApi.createPayrollRunsOffCycle(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_rippling import RipplingIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = RipplingIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.rest_api.create_payroll_runs_off_cycle(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
body | object | Optional | Opaque native JSON: the provider publishes a response-shaped request model. Input fields are not verified. Internal_Testing entitlement required. Never retry automatically. Additional keys: allowed |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
errors | array | Required within parent | One error per unconfirmed run creation. Empty on full success; reconcile before retrying. |
errors[] | Model | Each item | Expand Create a new off-cycle payroll run — response body — errors item |
runs | array | Required within parent | Confirmed created draft runs. Empty when no creation could be confirmed. |
runs[] | Model | Each item | Expand Create a new off-cycle payroll run — response body — runs item |
status | string | Required within parent | SUCCESS, PARTIAL_SUCCESS, or FAILED. FAILED means no run creation was confirmed. Known values: SUCCESS, PARTIAL_SUCCESS, FAILED |
Referenced models: Create a new off-cycle payroll run — response body — errors item, Create a new off-cycle payroll run — response body — runs item
Schemas
Section titled “Schemas”Create a new off-cycle payroll run — response body — errors item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
code | string | Required within parent | Stable error code; an exception does not prove that no run was created. Known values: RUN_CREATION_OUTCOME_UNKNOWN |
company_entity_id | JSON | Required within parent | |
company_entity_id (anyOf 1) | string | Alternative | HRIS company entity relationship ID for the attempted run. Null if the relationship cannot be resolved. |
company_entity_id (anyOf 2) | null | Alternative | |
employment_split | string | Required within parent | Employment category for the attempted run. |
message | string | Required within parent | Safe description of the unconfirmed creation outcome and retry guidance. |
worker_ids | array | Required within parent | Role IDs in the run whose creation could not be confirmed. |
worker_ids[] | string | Each item |
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 |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: rippling.rest_api.create_payroll_runs_off_cycle. Catalog operation: create-payroll-runs/off-cycle. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.
Required provider scopes: ["payroll-runs/off-cycle.read-write"]
Provider entitlements: ["Internal_Testing"]
Pinned headers: {"Rippling-Api-Version": "2024-08-01"}
Source limitations: ["upstream_response_shaped_request_schema"]