Update Timesheet

PATCH

https://api.coperniq.io/v1/timesheets/:timesheet_id

PATCH

/v1/timesheets/:timesheet_id

1 const url = 'https://api.coperniq.io/v1/timesheets/timesheet_id';
2 const options = {
3   method: 'PATCH',
4   headers: {'x-api-key': '<apiKey>', 'Content-Type': 'application/json'},
5   body: '{}'
6 };
7 
8 try {
9   const response = await fetch(url, options);
10   const data = await response.json();
11   console.log(data);
12 } catch (error) {
13   console.error(error);
14 }

1 {
2   "id": 1,
3   "type": "WORKING",
4   "status": "PROCESSING",
5   "startDate": "2024-01-15T09:30:00Z",
6   "endDate": "2024-01-15T09:30:00Z",
7   "distance": 1.1,
8   "note": "string",
9   "isArchived": true,
10   "createdAt": "2024-01-15T09:30:00Z",
11   "updatedAt": "2024-01-15T09:30:00Z",
12   "projectId": 1,
13   "accountId": 1,
14   "opportunityId": 1,
15   "workOrderId": 1,
16   "targetUserId": 1,
17   "createdBy": 1,
18   "updatedBy": 1,
19   "laborHourlyRate": 1.1,
20   "laborTotalCost": 1.1
21 }

Update a timesheet’s fields, and/or archive or unarchive it.

Set isArchived to true/false to archive/unarchive the timesheet; this is applied independently of any other fields present in the same request.

Authentication

x-api-keystring

API Key authentication via header

Path parameters

timesheet_idstringRequired

Request

This endpoint expects an object.

projectIdintegerOptional

Reassign to a different project. At most one of projectId, accountId, or opportunityId may be provided.

accountIdintegerOptional

Reassign to a different account. At most one of projectId, accountId, or opportunityId may be provided.

opportunityIdintegerOptional

Reassign to a different opportunity. At most one of projectId, accountId, or opportunityId may be provided.

workOrderIdinteger or nullOptional

targetUserIdintegerOptional

startDatestringOptionalformat: "date-time"

endDatestringOptionalformat: "date-time"

distancedouble or nullOptional

laborHourlyRatedouble or nullOptional

notestring or nullOptional

isArchivedbooleanOptional

Set true to archive, false to unarchive. Handled independently of the other fields.

Response

Timesheet updated successfully

idinteger

Unique identifier.

typeenum or null

Time entry type.

statusenum or null

Processing status of the time entry.

startDatestring or nullformat: "date-time"

endDatestring or nullformat: "date-time"

distancedouble or null

Distance traveled, for TRAVEL entries.

notestring or null

isArchivedboolean or null

createdAtstringformat: "date-time"

updatedAtstringformat: "date-time"

projectIdinteger or null

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

accountIdinteger or null

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

opportunityIdinteger or null

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

workOrderIdinteger or null

targetUserIdinteger or null

The worker the time entry is logged for.

createdByinteger or null

updatedByinteger or null

laborHourlyRatedouble or null

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

laborTotalCostdouble or null

Only visible with the appropriate financial privilege.

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

502

Bad Gateway Error