timesheets

Get Timesheet

Retrieve a specific timesheet by ID. Returns 404 if archived unless include_archived=true is passed.

get/timesheets/{timesheet_id}

Request

  • Base URL: https://api.coperniq.io/v1
  • URL: https://api.coperniq.io/v1/timesheets/{timesheet_id}
  • Auth: API key in header x-api-key

Path parameters

timesheet_idstring required

Query parameters

include_archivedboolean

Return the timesheet even if it has been archived.

Response

Timesheet details

idinteger

Unique identifier.

type'WORKING' | 'TRAVEL'

Time entry type.

status'PROCESSING' | 'PROCESSED' | 'FAILED'

Processing status of the time entry.

startDatestring date-time nullable
endDatestring date-time nullable
distancenumber double nullable

Distance traveled, for TRAVEL entries.

notestring nullable
isArchivedboolean nullable
createdAtstring date-time
updatedAtstring date-time
projectIdinteger nullable

Set when the linked record is a Project. Null when it is an Account (see accountId) or Opportunity (see opportunityId).

accountIdinteger nullable

Set when the linked record is an Account. Null otherwise.

opportunityIdinteger nullable

Set when the linked record is an Opportunity. Null otherwise.

workOrderIdinteger nullable
targetUserIdinteger nullable

The worker the time entry is logged for.

createdByinteger nullable
updatedByinteger nullable
laborHourlyRatenumber double nullable

Labor cost ($/hr). Only visible with the appropriate financial privilege.

laborTotalCostnumber double nullable

Only visible with the appropriate financial privilege.

Changes

No recorded changes to this operation across all 1 revision of this API.