Rippling: Create a new payroll payment mode change
Rippling restApi.createPayrollPaymentModeChanges: arguments, response, policy and SDK examples.
← Rest API operations · Get started
Operation rippling.rest_api.create_payroll_payment_mode_changes
Provider route: POST /payroll-payment-mode-changes/. 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"]["createPayrollPaymentModeChanges"]>[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.createPayrollPaymentModeChanges(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_payment_mode_changes(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
body | Model | Optional | Expand Create a new payroll payment mode change — request body — body |
Referenced models: Create a new payroll payment mode change — request body — body
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 |
|---|---|---|---|
$ | Model | Root | Expand Create a new payroll payment mode change — response body |
Referenced models: Create a new payroll payment mode change — response body
Schemas
Section titled “Schemas”Create a new payroll payment mode change — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
results | array | Optional | Item-level results for the requested payment mode changes. Each item is either updated or rejected so callers can retry failed items independently. |
results[] | Model | Each item | Expand Create a new payroll payment mode change — response body — results item |
write_status | string | Optional | Completion status for this synchronous request. This is currently always COMPLETED; the field is reserved for future status values if processing becomes asynchronous. It describes the overall request, while each result status describes an individual item. Known values: COMPLETED |
Referenced models: Create a new payroll payment mode change — response body — results item
Create a new payroll payment mode change — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
changes | array | Required within parent | Payment mode changes to process. The maximum batch size is 100. |
changes[] | Model | Each item | Expand Create a new payroll payment mode change — request body — body changes item |
Referenced models: Create a new payroll payment mode change — request body — body changes item
Create a new payroll payment mode change — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
error | object | Optional | Structured error when the item was rejected. This field is omitted for UPDATED items and is present for REJECTED items. |
error.code | string | Optional | Machine-readable error code for a rejected item. DUPLICATE_NO_OP means the requested change was already requested and no retry is needed; DUPLICATE_TARGET_CONFLICT, OUT_OF_SCOPE, RUN_NOT_FOUND, WORKER_NOT_IN_RUN, and PAYMENT_MODE_NOT_SUPPORTED are terminal request errors that require changing the request or authorization; RUN_NOT_WRITABLE may be retried when the run becomes writable; PAYMENT_MODE_UPDATE_FAILED is retryable after the underlying update failure is resolved. Known values: DUPLICATE_NO_OP, DUPLICATE_TARGET_CONFLICT, OUT_OF_SCOPE, RUN_NOT_FOUND, RUN_NOT_WRITABLE, WORKER_NOT_IN_RUN, PAYMENT_MODE_NOT_SUPPORTED, PAYMENT_MODE_UPDATE_FAILED |
error.message | string | Optional | Human-readable error message. |
payment_mode | string | Optional | Requested Global Payroll payment mode code. Known values: DEFAULT, BANK_FILE, MANUAL, SAME_DAY_ACH, CHECK_PRINTING, CHECK_MAILING |
run_id | string | Optional | ID of the requested payroll run. |
status | string | Optional | Item result: UPDATED or REJECTED. Known values: UPDATED, REJECTED |
worker_id | string | Optional | ID of the requested worker. |
Create a new payroll payment mode change — request body — body changes item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
payment_mode | string | Required within parent | Canonical Global Payroll payment mode code to apply to the worker in the run. Known labels are DEFAULT (Default), BANK_FILE (Bank file), MANUAL (Manual), SAME_DAY_ACH (Same-day ACH), CHECK_PRINTING (Check printing), and CHECK_MAILING (Check mailing). One of: DEFAULT, BANK_FILE, MANUAL, SAME_DAY_ACH, CHECK_PRINTING, CHECK_MAILING |
run_id | string | Required within parent | ID of the draft Global Payroll run to update. |
worker_id | string | Required within parent | ID of the worker whose payment mode will be updated. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: rippling.rest_api.create_payroll_payment_mode_changes. Catalog operation: create-payroll-payment-mode-changes. 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-payment-mode-changes.read-write"]
Provider entitlements: ["Internal_Testing"]
Pinned headers: {"Rippling-Api-Version": "2024-08-01"}