Skip to content

Rippling: POST Time Entry

Rippling tandAapi.postPlatformApiTimeEntries: arguments, response, policy and SDK examples.

← Tand aapi operations · Get started

Operation rippling.t_and_a_api.post_platform_api_time_entries

Provider route: POST /platform/api/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["tandAapi"]["postPlatformApiTimeEntries"]>[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.tandAapi.postPlatformApiTimeEntries(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.tand_aapi.post_platform_api_time_entries(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
bodyJSONOptional
body (anyOf 1)objectAlternative
body (anyOf 1).breaksarrayRequired within parent
body (anyOf 1).breaks[]objectEach item
body (anyOf 1).breaks[].companyBreakTypestringRequired within parent
body (anyOf 1).breaks[].endTimestringRequired within parent
body (anyOf 1).breaks[].startTimestringRequired within parent
body (anyOf 1).commentsarrayOptional
body (anyOf 1).comments[]stringEach item
body (anyOf 1).companystringRequired within parent
body (anyOf 1).endTimestring or nullOptional
body (anyOf 1).idempotencyKeystringOptionalExternal identifier for the TimeEntry. Rippling will ensure that this is unique on the backend.
body (anyOf 1).jobShiftsarrayRequired within parent
body (anyOf 1).jobShifts[]objectEach item
body (anyOf 1).jobShifts[].endTimestring or nullRequired within parent
body (anyOf 1).jobShifts[].jobCodesarrayOptional
body (anyOf 1).jobShifts[].jobCodes[]stringEach item
body (anyOf 1).jobShifts[].startTimestringRequired within parent
body (anyOf 1).rolestringRequired within parent
body (anyOf 1).startTimestringOptional
body (anyOf 1).statusstring or nullOptionalAllowed value: [DRAFT/APPROVED/PAID]
Default: DRAFT
body (anyOf 2)objectAlternative
body (anyOf 2).breaksarrayOptional
body (anyOf 2).breaks[]objectEach item
body (anyOf 2).breaks[].companyBreakTypestringRequired within parent
body (anyOf 2).breaks[].endTimestringRequired within parent
body (anyOf 2).breaks[].startTimestringRequired within parent
body (anyOf 2).commentsarrayOptional
body (anyOf 2).comments[]stringEach item
body (anyOf 2).companystringRequired within parent
body (anyOf 2).endTimestring or nullRequired within parent
body (anyOf 2).idempotencyKeystringOptionalExternal identifier for the TimeEntry. Rippling will ensure that this is unique on the backend.
body (anyOf 2).jobShiftsarrayOptional
body (anyOf 2).jobShifts[]objectEach item
body (anyOf 2).jobShifts[].endTimestring or nullRequired within parent
body (anyOf 2).jobShifts[].jobCodesarrayOptional
body (anyOf 2).jobShifts[].jobCodes[]stringEach item
body (anyOf 2).jobShifts[].startTimestringRequired within parent
body (anyOf 2).rolestringRequired within parent
body (anyOf 2).startTimestringRequired within parent
body (anyOf 2).statusstring or nullOptionalAllowed value: [DRAFT/APPROVED/PAID]
Default: DRAFT

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

FieldTypePresenceDescription and constraints
$ModelRootExpand GET Time Entry — response body

Referenced models: GET Time Entry — response body

GET Time Entry — response body
FieldTypePresenceDescription and constraints
$objectRootA time entry object corresponds to a singular continuous instance of work from clock in to clock out.
breaksarrayOptional
breaks[]ModelEach itemExpand GET Time Entry — response body — breaks item
commentsarrayOptional
comments[]stringEach item
durationstringOptionalTotal length of the time entry, in hours.
endTimestring or nullOptionalThe end time of the time entry, in UTC. Will be null if the time entry
has not yet completed.
idstringOptional
idempotencyKeystring or nullOptional
jobShiftsarrayOptional
jobShifts[]ModelEach itemExpand GET Time Entry — response body — job Shifts item
overtimeHoursstringOptionalTotal overtime hours in the time entry.
pieceRatePremiumsarrayOptional
pieceRatePremiums[]ModelEach itemExpand GET Time Entry — response body — piece Rate Premiums item
premiumsarrayOptional
premiums[]ModelEach itemExpand GET Time Entry — response body — premiums item
regularHoursstringOptionalTotal regular hours (base pay) in the time entry.
rolestringOptional
segmentsarrayOptional
segments[]ModelEach itemExpand GET Time Entry — response body — segments item
shouldCreateExtraHoursRunboolean or nullOptionalShould this time entry be considered for extra hours run
startTimestringOptionalThe start time of the time entry, in UTC.
statusstring or nullOptionalThe status of the time entry
tagsarray or nullOptional
tags[]stringEach item
timezonestringOptionalThe timezone the time entry was logged in. Can be used in conjunction with startTime and endTime to derive the localized start/end times of the time entry.

Referenced models: GET Time Entry — response body — piece Rate Premiums item, GET Time Entry — response body — premiums item, GET Time Entry — response body — segments item, GET Time Entry — response body — breaks item, GET Time Entry — response body — job Shifts item

GET Time Entry — response body — piece Rate Premiums item
FieldTypePresenceDescription and constraints
$objectRootAn additional amount that employees can get per unit worked. For example, an additonal amount per item, per customer, per class, etc.
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]+)?$
GET Time Entry — response body — premiums item
FieldTypePresenceDescription and constraints
$objectRootAn additional amount of money that employees can get per hour worked.
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]+)?$
GET Time Entry — response body — segments item
FieldTypePresenceDescription and constraints
$objectRootA piece of continuous time within the time entry that is associated with some type of work or break. This is the pay rate that is used to sync to Payroll and pay employees.
break_typearrayOptional
break_type[]ModelEach itemExpand GET Time Entry — response body — segments item break type item
display_namestringOptionalName of the final earning for the segment.
end_timestringOptionalThe end time of the segment.
job_codesarrayOptionalThe job codes associated with the segment.
job_codes[]ModelEach itemExpand GET Job Code — response body
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.

Referenced models: GET Time Entry — response body — segments item break type item, GET Job Code — response body

GET Time Entry — response body — breaks item
FieldTypePresenceDescription and constraints
$objectRootA specific instance of a break taken within a time entry.
descriptionstringOptional
endTimestring or nullOptionalThe end time of the break, in UTC. Will be null if the break has not yet completed.
isOTEligiblestringOptionalWhether or not the break counts towards hours worked.
isPaidstringOptional
startTimestringOptionalThe start time of the break, in UTC.
GET Time Entry — response body — job Shifts item
FieldTypePresenceDescription and constraints
$objectRootA specific instance of a job shift within a time entry. The instance includes the start time of the shift, end time of the shift, any a map from dimension_id to job_code_id for all job codes selected for this particular shift. Any time the job codes switch, a new instance of TimeEntryJobShift is created.
endTimestring or nullOptionalThe end time of the shift, in UTC. Will be null if the shift has not yet completed.
jobCodesarrayOptionalA list of job code ids worked during the shift. If empty, no job codes were worked during the shift.
jobCodes[]stringEach item
startTimestringOptionalThe start time of the shift, in UTC.
GET Time Entry — response body — segments item break type item
FieldTypePresenceDescription and constraints
$objectRoot
created_atstringOptional
descriptionstringOptionalDescription of the break type.
idstringOptionalThe ID of the break type.
is_over_time_eligiblebooleanOptionalWhether the break counts towards hours worked.
is_paidbooleanOptionalWhether the break is paid.
updated_atstringOptional
GET Job Code — response body
FieldTypePresenceDescription and constraints
$objectRootA job code object is a specific instance of an option underneath a dimension that time can be tracked against. If the configured dimension were to be 'Location', for example, job code options underneath that dimension might include 'San Francisco', 'New York', 'Bangalore', etc.
dimensionstringRequired within parentThe id of the associated dimension.
groupstring or nullOptionalThe id of the group that applies to the job code, if one exists.
idstringRequired within parentThe id of the job code.
spoke_identifierstring or nullOptionalThe unique identifier of the job code in an outside system.
valuestringRequired within parentThe name of the job code.

SDK function policy ID: rippling.t_and_a_api.post_platform_api_time_entries. Catalog operation: t-and-a-api.post-platform-api-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.

Source limitations: ["upstream_time_entry_alternative_request_shapes"]

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.