Timesheets

Timesheet records

GET /timesheets

Default limit is 200 items. Maximum limit is 39,999. Exceeding the maximum reverts to the default.

Example: GET /timesheets?fromDate=2023-01-01&toDate=2023-12-31&limit=1000

Query parameters:

Parameter	Default	Description
limit	200	Default 200, max 39,999
page	0	Pagination offset
fromDate	-	Timesheets with DateOfService >= value. Format: YYYY-MM-DD
toDate	-	Timesheets with DateOfService <= value. Format: YYYY-MM-DD
createdTimeFrom	-	Timesheets with CreatedTime >= value. Format: YYYY-MM-DD
createdTimeTo	-	Timesheets with CreatedTime <= value. Format: YYYY-MM-DD
timesheetId	-	Filter by timesheet ID
clientId	-	Filter by client ID
carerId	-	Filter by carer ID
serviceId	-	Filter by service ID
includeNotes	-	Returns app notes for the timesheet

Response fields:

Field	Type	Notes
TimeSheetId	integer
ClientId	integer
CarerId	integer
AgreementId	integer
AgreementItemId	integer
ServiceId	integer
DateOfService	string	Date
StartTime	string	Time
Minutes	integer
ChargeRate	integer
PayRate	integer
KM	integer
KMCharge	integer
KMNoCharge	integer
KMTravelTime	integer
Variation	integer	0/1
VariationQty	integer
VariationComment	string
VariationApproved	integer	0/1
ExtraChargeClient	integer
BreakStartTime1	string	Time
BreakMinutes1	integer
RecurrenceId	integer
OnHoldType	string
OnHoldNote	string
OnHoldCode	string
OnHoldChargePer	string
OnHoldPayMinutes	string
OnHoldDateTime	string
RosterItemId	integer
APP_IP	string
APP_StartTime	string	Datetime
APP_FinishTime	string	Datetime
APP_LastLongtitude	string
APP_LastLatitude	string
HasExported	integer	0/1
ExportInvoiceNumber	string
DEXCaseId	integer
DEXServiceTypeId	integer
DEXSessionId	integer
LastModified	string	Datetime
LastModifiedBy	string	Email
CreatedTime	string	Datetime
CreatedBy	integer
Status	string
Area3Desc	string
cArea3Desc	string