Get Timesheets
Allows reading computed timesheet data for one or more providers.
Timesheets are returned for any matching provider who was active during the specified date range even if they worked zero hours. These values are impacted by historical corrections, you are advised to review the Historical Corrections documentation.
<ResponseField name="Available Expansions"> <Expandable title="expand options"> * **provider**: Includes the entire provider object for each timesheet. * **paySegments**: Pay segments describe each individually worked span during the timesheet. They are the primitive unit of timekeeping data. * **scheduledPaySegments**: Scheduled pay segments represent the expected set of worked segments based on the schedule only, not punch data. * **problems**: Includes any warnings and errors for the timesheet. * **approval**: Includes whether the entire range is approved, and the exact sub ranges that have been approved. * **signOff**: Includes whether the entire range is signed off, and the exact sub ranges that have been signed off. * **historicalCorrections**: Includes any historical corrections which are applied to the time range of the timesheet. These are historical corrections which were made _to_ this time range as opposed to applied to/paid out in this range. * **totals**: The computed totals broken down by pay code and role for the requested range. * **historicalCorrectionTotals**: The totals from any historical corrections which are applied _to_ this timesheet (as opposed to corrections made to this timesheet). Historical correction totals are only available when requesting a particular pay period (by offset or exact reference). </Expandable> </ResponseField> <Warning> This endpoint may have to do significant computation to generate timesheet data on-the-fly, you are advised to set appropriate timeout and consider caching the results if applicable. </Warning>get/v1/timekeeping/timesheet
Request
- Base URLhttps://app.untetherlabs.com/api
- URLhttps://app.untetherlabs.com/api/v1/timekeeping/timesheet
- AuthHTTP bearer
Query parameters
teamIdstring uuid
providerIdstring uuid
payPeriodIdstring uuid
payPeriodOffsetinteger
Optional offset from current pay period. 0 = current, 1 = next, -1 = previous.
startDatestring
Example:2024-11-20T07:43:34+0000
endDatestring
Example:2024-11-20T07:43:34+0000
expandstring
Available expansions: provider, paySegments, scheduledPaySegments, problems, approval, signOff, historicalCorrections, totals, historicalCorrectionTotals
See Query Parameters for more information on expansions.
pageSizenumber
cursorstring
Response
Changes
No recorded changes to this operation across all 1 revision of this API.