Skip to content

Rippling: Create a new worker time split

Rippling restApi.createWorkerTimeSplits: arguments, response, policy and SDK examples.

← Rest API operations · Get started

Operation rippling.rest_api.create_worker_time_splits

Provider route: POST /worker-time-splits/. Alter supplies the connection’s credentials and routing.

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"]["createWorkerTimeSplits"]>[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.createWorkerTimeSplits(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from 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_worker_time_splits(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
bodyModelOptionalExpand Update a worker time split — request body — body

Referenced models: Update a worker time split — request body — body

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$objectRootWorker time split configuration resource.
created_atstringRequired within parentRecord creation date
idstringRequired within parentIdentifier field
is_enabledbooleanOptionalWhether hard-coded time splits are active for this worker.
job_codesarrayOptionalThe job codes referenced in this time split configuration. Use ?expand=job_codes to populate.

Expandable field
job_codes[]ModelEach itemExpand List job codes — response body — results item
job_codes_idarrayOptionalIDs of all unique job codes referenced across all split rows.
job_codes_id[]stringEach item
splitsarrayOptionalThe split rows defining time allocation percentages across job codes. Empty when is_enabled is false.
splits[]ModelEach itemExpand Update a worker time split — response body — splits item
updated_atstringRequired within parentRecord update date
workerModelOptionalExpand Update a worker time split — response body — worker
worker_idstringRequired within parentIdentifier of the worker whose time split configuration this represents.

Referenced models: List job codes — response body — results item, Update a worker time split — response body — splits item, Update a worker time split — response body — worker

29 more schemas are linked from the tables above, on the schema pages.

List job codes — response body — results item
FieldTypePresenceDescription and constraints
$objectRoot
created_atstringRequired within parentRecord creation date
custom_locationModelOptionalExpand Update a job code — response body — custom location
departmentModelOptionalExpand Update a job code — response body — department
department_idstringOptionalThe department associated with the job code.
external_idstringOptionalThe unique identifier of the job code in an outside system.
group_idstringOptionalThe ID of the job roster group.
idstringRequired within parentIdentifier field
is_archivedbooleanOptionalWhether this job code is archived. Set to true via PATCH to archive. Archiving is irreversible via this API.
job_dimensionModelOptionalExpand Update a job code — response body — job dimension
job_dimension_idstringRequired within parentThe ID of the job dimension this job code belongs to.
namestringRequired within parentThe name of the job dimension.
pay_rateJSONOptional
pay_rate (anyOf 1)numberAlternativeThe pay rate for this job code. Only applicable if the associated job dimension includes the 'PAY_RATE' organizational attribute.
pay_rate (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
pay_rate_exceptionsarrayOptionalPay rate overrides for the job based on exception dimension values.

Expandable field
pay_rate_exceptions[]ModelEach itemExpand Update a job code — response body — pay rate exceptions item
pay_rate_exceptions_idarrayOptionalPay rate overrides id for the job based on exception dimension values.
pay_rate_exceptions_id[]stringEach item
updated_atstringRequired within parentRecord update date
work_locationModelOptionalExpand Update a job code — response body — work location
work_location_idstringOptionalThe work location associated with the job code.

Referenced models: Update a job code — response body — pay rate exceptions item, Update a job code — response body — custom location, Update a job code — response body — department, Update a job code — response body — job dimension, Update a job code — response body — work location

Update a worker time split — response body — splits item
FieldTypePresenceDescription and constraints
$objectRootA single split row representing a percentage allocation across one or more job codes.
job_code_idsarrayOptionalIDs of canonical /job-codes/ resources in this split row.
job_code_ids[]stringEach item
split_percentagestringOptionalPercentage allocated to this split row. Decimal string with precision 2; must be greater than zero per row. All rows must sum to 100.00 when is_enabled is true.
Update a worker time split — request body — body
FieldTypePresenceDescription and constraints
$objectRootWorker time split configuration resource.
is_enabledbooleanOptionalWhether hard-coded time splits are active for this worker.
splitsarrayOptionalThe split rows defining time allocation percentages across job codes. Empty when is_enabled is false.
splits[]ModelEach itemExpand Update a worker time split — response body — splits item
worker_idstringRequired within parentIdentifier of the worker whose time split configuration this represents.

Referenced models: Update a worker time split — response body — splits item

Update a job code — response body — pay rate exceptions item
FieldTypePresenceDescription and constraints
$objectRoot
created_atstringRequired within parentRecord creation date
exception_dimension_idstringRequired within parentIdentifier of dimension object on which exception is configured. This objects details can be queried from exception_dimension_type's resource
exception_dimension_typestringOptionalType of dimension on which exception is configured
Known values: JOB_CODE, LEVEL, TEAM, DEPARTMENT, WORK_LOCATION
idstringRequired within parentIdentifier field
job_codeModelOptionalExpand List job codes — response body — results item
Job for which exception is configured.

Expandable field
job_code_idstringRequired within parentIdentifier of Job for which exception is configured.
pay_rateJSONRequired within parent
pay_rate (anyOf 1)numberAlternativeThe pay rate for exception on job_code_id and exception_dimension_id combination
pay_rate (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
updated_atstringRequired within parentRecord update date

Referenced models: List job codes — response body — results item

Update a job code — response body — custom location
FieldTypePresenceDescription and constraints
$objectRootThe custom location of the job code. This location will be used for tax calculation purposes if using US Payroll when an employee is working at this job code.
addressModelRequired within parentExpand Update a job code — response body — custom location address

Referenced models: Update a job code — response body — custom location address

Update a job code — response body — department
FieldTypePresenceDescription and constraints
$objectRootThe department associated with the job code.

Expandable field
created_atstringRequired within parentRecord creation date
department_hierarchyarrayOptionalList of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.

Expandable field
department_hierarchy[]ModelEach itemExpand Update a department — response body — parent
department_hierarchy_idarrayOptionalThe identifier of departments in the department hierarchy ordered from parent department to child department.
department_hierarchy_id[]stringEach item
idstringRequired within parentIdentifier field
namestringRequired within parentThe name of the department.
parentModelOptionalExpand Update a department — response body — parent
The parent department.

Expandable field
parent_idstringOptionalThe parent department.
reference_codestringOptionalReference code of the department.
updated_atstringRequired within parentRecord update date

Referenced models: Update a department — response body — parent

Update a job code — response body — job dimension
FieldTypePresenceDescription and constraints
$objectRootThe job dimension this job code belongs to.

Expandable field
created_atstringRequired within parentRecord creation date
external_idstringOptionalThe unique identifier of the job dimension in a third party system
group_idstringOptionalThe ID of the dimension roster group.
idstringRequired within parentIdentifier field
includes_custom_locationbooleanOptionalWhether the job dimension includes codes related to a custom location. Only one dimension can have this set to true.
namestringRequired within parentThe name of the job dimension
org_attribute_associationsarrayOptionalOrganizational attributes associated with the job dimension. Only 'PAY_RATE' can be set or modified using POST or PATCH requests.
org_attribute_associations[]JSONEach itemKnown values: DEPARTMENT, WORK_LOCATION, PAY_RATE, ENTITY
roster_typestringOptionalThe roster type of the dimension. PER_DIMENSION means that there is a group on the dimension level and employees within that group have access to all job codes in the dimension. PER_JOB_CODE means that each job code has its own group.
Known values: PER_DIMENSION, PER_JOB_CODE
updated_atstringRequired within parentRecord update date
Update a job code — response body — work location
FieldTypePresenceDescription and constraints
$objectRootThe work location associated with the job code.

Expandable field
addressModelRequired within parentExpand Update a work location — response body — address
created_atstringRequired within parentRecord creation date
idstringRequired within parentIdentifier field
namestringRequired within parentThe name of the work location.
updated_atstringRequired within parentRecord update date

Referenced models: Update a work location — response body — address

SDK function policy ID: rippling.rest_api.create_worker_time_splits. Catalog operation: create-worker-time-splits. 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: ["worker-time-splits.read-write"]

Provider entitlements: ["API_Tier_1"]

Pinned headers: {"Rippling-Api-Version": "2024-08-01"}

Official provider source

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.