Sign in
latestOpenAPI 3.0.12026-08-192092911.2 MB

916e669fc527

Timesheets

Gets a list of timesheets that belong to the specified resource

Retrieve a paged list of timesheets for a resource (required scope resources:read)

get/v1/resources/{resourceId}/timesheets

Path parameters

resourceIdinteger required

The unique identifier of the resource whose timesheets are being retrieved

Query parameters

startAtDatestring date-time

Only return timesheets where startedAt is on or after this date

endAtDatestring date-time

Only return timesheets where endedAt is on or before this date

status'unsigned' | 'signed' | 'queried' | 'rejected' | 'approved' | 'paid'

The status of a resource timesheet.<p>Possible values:</p><ul><li><b>unsigned</b>: The timesheet has not yet been signed by the resource.</li><li><b>signed</b>: The timesheet has been signed by the resource.</li><li><b>queried</b>: The timesheet has been queried and requires review.</li><li><b>rejected</b>: The timesheet has been rejected.</li><li><b>approved</b>: The timesheet has been approved.</li><li><b>paid</b>: The timesheet has been paid.</li></ul>

Example:unsigned

Only return timesheets where status matches the value provided

pageNumberinteger

The page number being requested (minimum: 1, maximum: 2147483)

pageSizeinteger

The page size being requested (minimum: 1, maximum: 1000)

Headers

Customer-Idinteger required

The customer identifier

Response

OK

pageNumberinteger

The page number of the response where 1 is the first page

pageSizeinteger

The number of items requested for the current page

pageItemCountinteger

The number of items returned in the current page

Example response

{
  "items": [
    {
      "id": 12345,
      "status": "unsigned",
      "totalHours": 7.5
    }
  ],
  "pageNumber": 2,
  "pageSize": 100,
  "pageItemCount": 55
}