Rippling: Retrieve a specific time card — response body — summary
Retrieve a specific time card: response body, field summary. Complete fields and constraints for contract 2026-10-28.
API reference · Contract 2026-10-28
SDK schema: Retrieve a specific time card — response body — summary
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The summary of the time card. |
approved_hours | JSON | Optional | |
approved_hours (anyOf 1) | number | Alternative | The approved hours for the pay period. |
approved_hours (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
double_overtime_hours | JSON | Optional | |
double_overtime_hours (anyOf 1) | number | Alternative | The total number of doubletime hours worked during the pay period. |
double_overtime_hours (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
earnings | JSON | Optional | |
earnings (anyOf 1) | number | Alternative | The earnings for the pay period. |
earnings (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
hours_worked_by_job_code | array | Optional | The amount of hours worked for each job code for the pay period. |
hours_worked_by_job_code[] | Model | Each item | Expand Retrieve a specific time card — response body — summary hours worked by job code item |
overtime_hours | JSON | Optional | |
overtime_hours (anyOf 1) | number | Alternative | The total number of overtime hours worked during the pay period. |
overtime_hours (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
paid_hours | JSON | Optional | |
paid_hours (anyOf 1) | number | Alternative | The paid hours for the pay period. |
paid_hours (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
premiums | JSON | Optional | |
premiums (anyOf 1) | number | Alternative | The premiums for the pay period. |
premiums (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
regular_hours | JSON | Optional | |
regular_hours (anyOf 1) | number | Alternative | The total number of regular hours worked during the pay period. |
regular_hours (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total_holiday_hours | JSON | Optional | |
total_holiday_hours (anyOf 1) | number | Alternative | The total holiday hours for the pay period. |
total_holiday_hours (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total_hours | JSON | Optional | |
total_hours (anyOf 1) | number | Alternative | The total hours for the pay period. |
total_hours (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total_paid_time_off_hours | JSON | Optional | |
total_paid_time_off_hours (anyOf 1) | number | Alternative | The total paid time off hours for the pay period. |
total_paid_time_off_hours (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total_unpaid_time_off_hours | JSON | Optional | |
total_unpaid_time_off_hours (anyOf 1) | number | Alternative | The total unpaid time off hours for the pay period. |
total_unpaid_time_off_hours (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
unpaid_break_hours_by_entry | JSON | Optional | |
unpaid_break_hours_by_entry (anyOf 1) | number | Alternative | The map of time entry to unpaidBreakHours in seconds |
unpaid_break_hours_by_entry (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: Retrieve a specific time card — response body — summary hours worked by job code item