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.
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"]["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 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_time_entries(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 Update a time entry — request body — body |
Referenced models: Update a time entry — 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 |
|---|---|---|---|
$ | object | Root | |
breaks | array | Optional | The breaks taken during the time entry. |
breaks[] | Model | Each item | Expand Update a time entry — response body — breaks item |
comments | array | Optional | The comments associated with the time entry. |
comments[] | Model | Each item | Expand Update a time entry — response body — comments item |
create_extra_hours_run | boolean | Optional | Whether the time entry should create an extra hours run. |
created_at | string | Required within parent | Record creation date |
end_time | string | Optional | The end time of the time entry. |
id | string | Required within parent | Identifier field |
idempotency_key | string | Optional | The unique key of the time entry in an outside system. If set, no other time entry with the same key can be created. |
job_shifts | array | Optional | The job shifts worked during the time entry. |
job_shifts[] | Model | Each item | Expand Update a time entry — response body — job shifts item |
pay_period | object | Optional | The pay period associated with the time card. |
pay_period.end_date | string | Optional | The end date of the pay period. |
pay_period.pay_schedule_id | string | Optional | The ID of the pay schedule associated with the pay period. |
pay_period.start_date | string | Optional | The start date of the pay period. |
piece_rate_premiums | array | Optional | The piece-rate premiums earned during the time entry. |
piece_rate_premiums[] | Model | Each item | Expand Update a time entry — response body — piece rate premiums item |
premiums | array | Optional | The premiums earned during the time entry. |
premiums[] | Model | Each item | Expand Update a time entry — response body — premiums item |
segments | array | Optional | The pay rates for each segment of the time entry. |
segments[] | Model | Each item | Expand Update a time entry — response body — segments item |
shift_input_values | array | Optional | Arbitrary shift inputs collected on the time entry |
shift_input_values[] | Model | Each item | Expand Update a time entry — response body — shift input values item |
start_time | string | Optional | The start time of the time entry. |
status | string | Optional | The status of the time entry. Known values: DRAFT, APPROVED, PAID, FINALIZED |
tags | array | Optional | The tags associated with the time entry. |
tags[] | string | Each item | |
time_card | Model | Optional | Expand Update a time entry — response body — time card |
time_card_id | string | Optional | The ID of the time card associated with the time entry. |
time_entry_summary | Model | Optional | Expand Update a time entry — response body — time entry summary |
updated_at | string | Required within parent | Record update date |
worker | Model | Optional | Expand Update a time entry — response body — worker |
worker_id | string | Required within parent | The 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
Schemas
Section titled “Schemas”33 more schemas are linked from the tables above, on the schema pages.
Update a time entry — response body — breaks item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
break_type_id | string | Optional | The ID of the break type. |
end_time | string | Optional | The end time of the break. |
original_end_time | string | Optional | The 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_time | string | Optional | The original start time of the break. If the startTime field has been rounded then this contain the start time before the rounding occured. |
start_time | string | Optional | The start time of the break. |
Update a time entry — response body — job shifts item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
end_time | string | Optional | The end time of the job shift. |
is_hours_only_input | boolean | Optional | Whether the job shift was entered as a duration in hours table |
job_codes_id | array | Optional | The IDs of the job codes associated with the job shift. |
job_codes_id[] | string | Each item | |
original_end_time | string | Optional | The 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_time | string | Optional | The 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_time | string | Optional | The start time of the job shift. |
Update a time entry — response body — piece rate premiums item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
name | string | Optional | The piece rate name. |
premium_rate | JSON | Optional | |
premium_rate (anyOf 1) | number | Alternative | The pay rate for this piece rate premium. |
premium_rate (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
premium_units | JSON | Optional | |
premium_units (anyOf 1) | number | Alternative | The total units produced at the premium rate. |
premium_units (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Update a time entry — response body — premiums item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
name | string | Optional | The pay rate name |
premium_hours | JSON | Optional | |
premium_hours (anyOf 1) | number | Alternative | The total hours worked for at the premium rate. |
premium_hours (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
premium_rate | JSON | Optional | |
premium_rate (anyOf 1) | number | Alternative | The pay rate for this premium. |
premium_rate (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Update a time entry — response body — segments item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
break_type_id | string | Optional | The ID of the break type. |
display_name | string | Optional | Name of the final earning for the segment. |
end_time | string | Optional | The end time of the segment. |
job_codes_id | array | Optional | The IDs of the job codes associated with the segment. |
job_codes_id[] | string | Each item | |
ot_multiplier | JSON | Optional | |
ot_multiplier (anyOf 1) | number | Alternative | The multiplier for overtime hours in this segment. |
ot_multiplier (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
pay_rate | JSON | Optional | |
pay_rate (anyOf 1) | number | Alternative | The pay rate for this segment. |
pay_rate (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
start_time | string | Optional | The start time of the segment. |
Update a time entry — response body — shift input values item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
author_id | string | Optional | The id of the role that last added/updated this input. |
shift_input_id | string | Required within parent | The id of the relevant shift input |
value | object | Required within parent | The value of the shift input. |
Update a time entry — response body — comments item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
author_id | string | Optional | The ID of the worker who made of the comment. |
created_at | string | Optional | The time the comment was created. |
text | string | Optional | The text of the comment. |
Update a time entry — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
breaks | array | Optional | The breaks taken during the time entry. |
breaks[] | Model | Each item | Expand Update a time entry — request body — body breaks item |
comments | array | Optional | The comments associated with the time entry. |
comments[] | Model | Each item | Expand Update a time entry — request body — body comments item |
create_extra_hours_run | boolean | Optional | Whether the time entry should create an extra hours run. |
duration | number | Optional | The duration of the time entry. |
idempotency_key | string | Optional | The unique key of the time entry in an outside system. If set, no other time entry with the same key can be created. |
job_shifts | array | Optional | The job shifts worked during the time entry. |
job_shifts[] | Model | Each item | Expand Update a time entry — request body — body job shifts item |
pay_period | object | Optional | The pay period associated with the time card. |
pay_period.end_date | string | Optional | The end date of the pay period. |
pay_period.pay_schedule_id | string | Optional | The ID of the pay schedule associated with the pay period. |
pay_period.start_date | string | Optional | The start date of the pay period. |
shift_input_values | array | Optional | Arbitrary shift inputs collected on the time entry |
shift_input_values[] | Model | Each item | Expand Update a time entry — response body — shift input values item |
start_date | string | Optional | The date of the time entry if using duration. |
status | string | Optional | The status of the time entry. One of: DRAFT, APPROVED, PAID, FINALIZED |
tags | array | Optional | The tags associated with the time entry. |
tags[] | string | Each item | |
worker_id | string | Required within parent | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The time card associated with the time entry. Expandable field |
created_at | string | Required within parent | Record creation date |
id | string | Required within parent | Identifier field |
pay_period | object | Optional | The pay period associated with the time card. |
pay_period.end_date | string | Optional | The end date of the pay period. |
pay_period.pay_schedule_id | string | Optional | The ID of the pay schedule associated with the pay period. |
pay_period.start_date | string | Optional | The start date of the pay period. |
summary | Model | Optional | Expand Retrieve a specific time card — response body — summary |
updated_at | string | Required within parent | Record update date |
worker | Model | Optional | Expand Retrieve a specific time card — response body — worker |
worker_id | string | Required within parent | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
break_type_id | string | Optional | The ID of the break type. |
end_time | string | Optional | The end time of the break. |
start_time | string | Optional | The start time of the break. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”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"}