← Tand aapi operations · All schemas
GET Dimension — response body
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | A 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. |
group | string or null | Optional | The id of the group that applies to the dimension, if one exists. |
id | string | Required within parent | The id of the dimension. |
name | string | Required within parent | The name of the dimension. |
spoke_identifier | string or null | Optional | The unique identifier of the dimension in an outside system. |
GET Job Code — response body
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | A 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. |
dimension | string | Required within parent | The id of the associated dimension. |
group | string or null | Optional | The id of the group that applies to the job code, if one exists. |
id | string | Required within parent | The id of the job code. |
spoke_identifier | string or null | Optional | The unique identifier of the job code in an outside system. |
value | string | Required within parent | The name of the job code. |
GET Pay Periods for an Employee — response body — item
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | A pay period object. |
endDate | string | Optional | |
paySchedule | string or null | Optional | |
startDate | string | Optional | |
GET Time Entry — response body
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | A time entry object corresponds to a singular continuous instance of work from clock in to clock out. |
breaks | array | Optional | |
breaks[] | Model | Each item | Expand GET Time Entry — response body — breaks item |
comments | array | Optional | |
comments[] | string | Each item | |
duration | string | Optional | Total length of the time entry, in hours. |
endTime | string or null | Optional | The end time of the time entry, in UTC. Will be null if the time entry has not yet completed. |
id | string | Optional | |
idempotencyKey | string or null | Optional | |
jobShifts | array | Optional | |
jobShifts[] | Model | Each item | Expand GET Time Entry — response body — job Shifts item |
overtimeHours | string | Optional | Total overtime hours in the time entry. |
pieceRatePremiums | array | Optional | |
pieceRatePremiums[] | Model | Each item | Expand GET Time Entry — response body — piece Rate Premiums item |
premiums | array | Optional | |
premiums[] | Model | Each item | Expand GET Time Entry — response body — premiums item |
regularHours | string | Optional | Total regular hours (base pay) in the time entry. |
role | string | Optional | |
segments | array | Optional | |
segments[] | Model | Each item | Expand GET Time Entry — response body — segments item |
shouldCreateExtraHoursRun | boolean or null | Optional | Should this time entry be considered for extra hours run |
startTime | string | Optional | The start time of the time entry, in UTC. |
status | string or null | Optional | The status of the time entry |
tags | array or null | Optional | |
tags[] | string | Each item | |
timezone | string | Optional | The 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
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | A specific instance of a break taken within a time entry. |
description | string | Optional | |
endTime | string or null | Optional | The end time of the break, in UTC. Will be null if the break has not yet completed. |
isOTEligible | string | Optional | Whether or not the break counts towards hours worked. |
isPaid | string | Optional | |
startTime | string | Optional | The start time of the break, in UTC. |
GET Time Entry — response body — job Shifts item
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | A 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. |
endTime | string or null | Optional | The end time of the shift, in UTC. Will be null if the shift has not yet completed. |
jobCodes | array | Optional | A list of job code ids worked during the shift. If empty, no job codes were worked during the shift. |
jobCodes[] | string | Each item | |
startTime | string | Optional | The start time of the shift, in UTC. |
GET Time Entry — response body — piece Rate Premiums item
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | An additional amount that employees can get per unit worked. For example, an additonal amount per item, per customer, per class, etc. |
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]+)?$ |
GET Time Entry — response body — premiums item
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | An additional amount of money that employees can get per hour worked. |
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]+)?$ |
GET Time Entry — response body — segments item
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | A 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_type | array | Optional | |
break_type[] | Model | Each item | Expand GET Time Entry — response body — segments item break type item |
display_name | string | Optional | Name of the final earning for the segment. |
end_time | string | Optional | The end time of the segment. |
job_codes | array | Optional | The job codes associated with the segment. |
job_codes[] | Model | Each item | Expand GET Job Code — response body |
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. |
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
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
created_at | string | Optional | |
description | string | Optional | Description of the break type. |
id | string | Optional | The ID of the break type. |
is_over_time_eligible | boolean | Optional | Whether the break counts towards hours worked. |
is_paid | boolean | Optional | Whether the break is paid. |
updated_at | string | Optional | |
GET Timecard — response body
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | A 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. |
id | string | Optional | Unique identifier for timecard |
payPeriod | Model | Optional | Expand GET Pay Periods for an Employee — response body — item |
role | string | Optional | Rippling identifier for target user |
timecardSummary | Model | Optional | Expand 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
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | A 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. |
| string | Optional | |
approved_hours | string | Optional | Total approved hours in the timecard. |
earnings | object | Optional | A breakdown of total worked hours by earning type id in the timecard. |
earnings.[earning_id] | string | Optional | |
job_codes | array | Optional | A breakdown of total worked hours by job codes in the timecard. |
job_codes[] | object | Each item | |
job_codes[].codes | array | Optional | |
job_codes[].codes[] | string | Each item | |
job_codes[].hours | string | Optional | |
overtime_hours | string | Optional | Total overtime hours in the timecard. |
paid_hours | string | Optional | Total paid hours in the timecard. |
premiums | object | Optional | A breakdown of total premium hours by earning type id in the timecard. |
premiums.[earning_id] | string | Optional | |
regular_hours | string | Optional | Total regular hours (base pay) in the timecard. |
total_holiday_hours | string | Optional | Total paid holiday hours in the timecard. |
total_hours | string | Optional | Total worked hours in the timecard. |
total_paid_time_off_hours | string | Optional | Total paid time off hours in the timecard. |
total_unpaid_time_off_hours | string | Optional | Total unpaid time off hours in the timecard. |