Rippling: Create a new payroll payment mode change — response body — results item
Create a new payroll payment mode change: response body, field results / item. Complete fields and constraints for contract 2026-10-28.
API reference · Contract 2026-10-28
SDK schema: 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. |