Skip to content

Rippling: Tand aapi schemas

12 Rippling schemas with complete fields and constraints.

← Tand aapi operations · All schemas

GET Dimension — response body

FieldTypePresenceDescription and constraints
$objectRootA dimension object can be created to track time worked under various different buckets. Examples of dimensions include 'Location' or 'Project', and each dimension typically has one or more specific job codes underneath it.
groupstring or nullOptionalThe id of the group that applies to the dimension, if one exists.
idstringRequired within parentThe id of the dimension.
namestringRequired within parentThe name of the dimension.
spoke_identifierstring or nullOptionalThe unique identifier of the dimension in an outside system.

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.

GET Pay Periods for an Employee — response body — item

FieldTypePresenceDescription and constraints
$objectRootA pay period object.
endDatestringOptional
paySchedulestring or nullOptional
startDatestringOptional

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 — 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 — 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 — 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 Timecard — response body

FieldTypePresenceDescription and constraints
$objectRootA timecard object is an instance that tracks a role's time logged in T&A across an entire pay period. The object specifically references a TimecardSummary instance, which takes down all of the hours logged for the role in the pay period in T&A and breaks them down.
idstringOptionalUnique identifier for timecard
payPeriodModelOptionalExpand GET Pay Periods for an Employee — response body — item
rolestringOptionalRippling identifier for target user
timecardSummaryModelOptionalExpand GET Timecard — response body — timecard Summary

Referenced models: GET Pay Periods for an Employee — response body — item, GET Timecard — response body — timecard Summary

GET Timecard — response body — timecard Summary

FieldTypePresenceDescription and constraints
$objectRootA timecard summary object is a breakdown of all hours that match a specific timecard. The object breaks down all earned hours by earning id, all premium hours by earning id, all hours by job codes, amongst others.
stringOptional
approved_hoursstringOptionalTotal approved hours in the timecard.
earningsobjectOptionalA breakdown of total worked hours by earning type id in the timecard.
earnings.[earning_id]stringOptional
job_codesarrayOptionalA breakdown of total worked hours by job codes in the timecard.
job_codes[]objectEach item
job_codes[].codesarrayOptional
job_codes[].codes[]stringEach item
job_codes[].hoursstringOptional
overtime_hoursstringOptionalTotal overtime hours in the timecard.
paid_hoursstringOptionalTotal paid hours in the timecard.
premiumsobjectOptionalA breakdown of total premium hours by earning type id in the timecard.
premiums.[earning_id]stringOptional
regular_hoursstringOptionalTotal regular hours (base pay) in the timecard.
total_holiday_hoursstringOptionalTotal paid holiday hours in the timecard.
total_hoursstringOptionalTotal worked hours in the timecard.
total_paid_time_off_hoursstringOptionalTotal paid time off hours in the timecard.
total_unpaid_time_off_hoursstringOptionalTotal unpaid time off hours in the timecard.

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.