Skip to content

Rippling: Create a new time entry

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

← Rest API operations · Get started

Operation rippling.rest_api.create_time_entries

Provider route: POST /time-entries/. 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"]["createTimeEntries"]>[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.createTimeEntries(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_time_entries(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
bodyModelOptionalExpand Update a time entry — request body — body

Referenced models: Update a time entry — 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
$objectRoot
breaksarrayOptionalThe breaks taken during the time entry.
breaks[]ModelEach itemExpand Update a time entry — response body — breaks item
commentsarrayOptionalThe comments associated with the time entry.
comments[]ModelEach itemExpand Update a time entry — response body — comments item
create_extra_hours_runbooleanOptionalWhether the time entry should create an extra hours run.
created_atstringRequired within parentRecord creation date
end_timestringOptionalThe end time of the time entry.
idstringRequired within parentIdentifier field
idempotency_keystringOptionalThe unique key of the time entry in an outside system. If set, no other time entry with the same key can be created.
job_shiftsarrayOptionalThe job shifts worked during the time entry.
job_shifts[]ModelEach itemExpand Update a time entry — response body — job shifts item
pay_periodobjectOptionalThe pay period associated with the time card.
pay_period.end_datestringOptionalThe end date of the pay period.
pay_period.pay_schedule_idstringOptionalThe ID of the pay schedule associated with the pay period.
pay_period.start_datestringOptionalThe start date of the pay period.
piece_rate_premiumsarrayOptionalThe piece-rate premiums earned during the time entry.
piece_rate_premiums[]ModelEach itemExpand Update a time entry — response body — piece rate premiums item
premiumsarrayOptionalThe premiums earned during the time entry.
premiums[]ModelEach itemExpand Update a time entry — response body — premiums item
segmentsarrayOptionalThe pay rates for each segment of the time entry.
segments[]ModelEach itemExpand Update a time entry — response body — segments item
shift_input_valuesarrayOptionalArbitrary shift inputs collected on the time entry
shift_input_values[]ModelEach itemExpand Update a time entry — response body — shift input values item
start_timestringOptionalThe start time of the time entry.
statusstringOptionalThe status of the time entry.
Known values: DRAFT, APPROVED, PAID, FINALIZED
tagsarrayOptionalThe tags associated with the time entry.
tags[]stringEach item
time_cardModelOptionalExpand Update a time entry — response body — time card
time_card_idstringOptionalThe ID of the time card associated with the time entry.
time_entry_summaryModelOptionalExpand Update a time entry — response body — time entry summary
updated_atstringRequired within parentRecord update date
workerModelOptionalExpand Update a time entry — response body — worker
worker_idstringRequired within parentThe ID of the worker associated with the time entry.

Referenced models: Update a time entry — response body — breaks item, Update a time entry — response body — job shifts item, Update a time entry — response body — piece rate premiums item, Update a time entry — response body — premiums item, Update a time entry — response body — segments item, Update a time entry — response body — shift input values item, Update a time entry — response body — comments item, Update a time entry — response body — time card, Update a time entry — response body — time entry summary, Update a time entry — response body — worker

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

Update a time entry — response body — breaks item
FieldTypePresenceDescription and constraints
$objectRoot
break_type_idstringOptionalThe ID of the break type.
end_timestringOptionalThe end time of the break.
original_end_timestringOptionalThe original end time of the break. If the endTime field has been rounded then this contain the end time before the rounding occured.
original_start_timestringOptionalThe original start time of the break. If the startTime field has been rounded then this contain the start time before the rounding occured.
start_timestringOptionalThe start time of the break.
Update a time entry — response body — job shifts item
FieldTypePresenceDescription and constraints
$objectRoot
end_timestringOptionalThe end time of the job shift.
is_hours_only_inputbooleanOptionalWhether the job shift was entered as a duration in hours table
job_codes_idarrayOptionalThe IDs of the job codes associated with the job shift.
job_codes_id[]stringEach item
original_end_timestringOptionalThe original end time of the job shift. If the endTime field has been rounded then this contain the end time before the rounding occured.
original_start_timestringOptionalThe original start time of the job shift. If the startTime field has been rounded then this contain the start time before the rounding occured.
start_timestringOptionalThe start time of the job shift.
Update a time entry — response body — piece rate premiums item
FieldTypePresenceDescription and constraints
$objectRoot
namestringOptionalThe piece rate name.
premium_rateJSONOptional
premium_rate (anyOf 1)numberAlternativeThe pay rate for this piece rate premium.
premium_rate (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
premium_unitsJSONOptional
premium_units (anyOf 1)numberAlternativeThe total units produced at the premium rate.
premium_units (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Update a time entry — response body — premiums item
FieldTypePresenceDescription and constraints
$objectRoot
namestringOptionalThe pay rate name
premium_hoursJSONOptional
premium_hours (anyOf 1)numberAlternativeThe total hours worked for at the premium rate.
premium_hours (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
premium_rateJSONOptional
premium_rate (anyOf 1)numberAlternativeThe pay rate for this premium.
premium_rate (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Update a time entry — response body — segments item
FieldTypePresenceDescription and constraints
$objectRoot
break_type_idstringOptionalThe ID of the break type.
display_namestringOptionalName of the final earning for the segment.
end_timestringOptionalThe end time of the segment.
job_codes_idarrayOptionalThe IDs of the job codes associated with the segment.
job_codes_id[]stringEach item
ot_multiplierJSONOptional
ot_multiplier (anyOf 1)numberAlternativeThe multiplier for overtime hours in this segment.
ot_multiplier (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
pay_rateJSONOptional
pay_rate (anyOf 1)numberAlternativeThe pay rate for this segment.
pay_rate (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
start_timestringOptionalThe start time of the segment.
Update a time entry — response body — shift input values item
FieldTypePresenceDescription and constraints
$objectRoot
author_idstringOptionalThe id of the role that last added/updated this input.
shift_input_idstringRequired within parentThe id of the relevant shift input
valueobjectRequired within parentThe value of the shift input.
Update a time entry — response body — comments item
FieldTypePresenceDescription and constraints
$objectRoot
author_idstringOptionalThe ID of the worker who made of the comment.
created_atstringOptionalThe time the comment was created.
textstringOptionalThe text of the comment.
Update a time entry — request body — body
FieldTypePresenceDescription and constraints
$objectRoot
breaksarrayOptionalThe breaks taken during the time entry.
breaks[]ModelEach itemExpand Update a time entry — request body — body breaks item
commentsarrayOptionalThe comments associated with the time entry.
comments[]ModelEach itemExpand Update a time entry — request body — body comments item
create_extra_hours_runbooleanOptionalWhether the time entry should create an extra hours run.
durationnumberOptionalThe duration of the time entry.
idempotency_keystringOptionalThe unique key of the time entry in an outside system. If set, no other time entry with the same key can be created.
job_shiftsarrayOptionalThe job shifts worked during the time entry.
job_shifts[]ModelEach itemExpand Update a time entry — request body — body job shifts item
pay_periodobjectOptionalThe pay period associated with the time card.
pay_period.end_datestringOptionalThe end date of the pay period.
pay_period.pay_schedule_idstringOptionalThe ID of the pay schedule associated with the pay period.
pay_period.start_datestringOptionalThe start date of the pay period.
shift_input_valuesarrayOptionalArbitrary shift inputs collected on the time entry
shift_input_values[]ModelEach itemExpand Update a time entry — response body — shift input values item
start_datestringOptionalThe date of the time entry if using duration.
statusstringOptionalThe status of the time entry.
One of: DRAFT, APPROVED, PAID, FINALIZED
tagsarrayOptionalThe tags associated with the time entry.
tags[]stringEach item
worker_idstringRequired within parentThe ID of the worker associated with the time entry.

Referenced models: Update a time entry — response body — shift input values item, Update a time entry — request body — body breaks item, Update a time entry — request body — body job shifts item, Update a time entry — request body — body comments item

Update a time entry — response body — time card
FieldTypePresenceDescription and constraints
$objectRootThe time card associated with the time entry.

Expandable field
created_atstringRequired within parentRecord creation date
idstringRequired within parentIdentifier field
pay_periodobjectOptionalThe pay period associated with the time card.
pay_period.end_datestringOptionalThe end date of the pay period.
pay_period.pay_schedule_idstringOptionalThe ID of the pay schedule associated with the pay period.
pay_period.start_datestringOptionalThe start date of the pay period.
summaryModelOptionalExpand Retrieve a specific time card — response body — summary
updated_atstringRequired within parentRecord update date
workerModelOptionalExpand Retrieve a specific time card — response body — worker
worker_idstringRequired within parentThe ID of the worker associated with the time card.

Referenced models: Retrieve a specific time card — response body — summary, Retrieve a specific time card — response body — worker

Update a time entry — request body — body breaks item
FieldTypePresenceDescription and constraints
$objectRoot
break_type_idstringOptionalThe ID of the break type.
end_timestringOptionalThe end time of the break.
start_timestringOptionalThe start time of the break.

SDK function policy ID: rippling.rest_api.create_time_entries. Catalog operation: create-time-entries. 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: ["time-entries.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.