Create Timesheet

POST

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

POST

/v1/timesheets

const url = 'https://api.coperniq.io/v1/timesheets';
const options = {
  method: 'POST',
  headers: {'x-api-key': '<apiKey>', 'Content-Type': 'application/json'},
  body: '{"targetUserId":1,"type":"WORKING","startDate":"2024-01-15T09:30:00Z","endDate":"2024-01-15T09:30:00Z"}'
};
try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

{
  "id": 1,
  "type": "WORKING",
  "status": "PROCESSING",
  "startDate": "2024-01-15T09:30:00Z",
  "endDate": "2024-01-15T09:30:00Z",
  "distance": 1.1,
  "note": "string",
  "isArchived": true,
  "createdAt": "2024-01-15T09:30:00Z",
  "updatedAt": "2024-01-15T09:30:00Z",
  "projectId": 1,
  "accountId": 1,
  "opportunityId": 1,
  "workOrderId": 1,
  "targetUserId": 1,
  "createdBy": 1,
  "updatedBy": 1,
  "laborHourlyRate": 1.1,
  "laborTotalCost": 1.1
}

Create a new timesheet (time entry) for a worker on a project, account, or opportunity (and optionally a work order).

Authentication

x-api-keystring

API Key authentication via header

Request

This endpoint expects an object.

targetUserIdintegerRequired

Worker the time entry is logged for.

typeenumRequired

startDatestringRequiredformat: "date-time"

endDatestringRequiredformat: "date-time"

Must be after startDate.

projectIdintegerOptional

Project this time entry belongs to. Exactly one of projectId, accountId, or opportunityId is required.

accountIdintegerOptional

Account this time entry belongs to. Exactly one of projectId, accountId, or opportunityId is required.

opportunityIdintegerOptional

Opportunity this time entry belongs to. Exactly one of projectId, accountId, or opportunityId is required.

workOrderIdinteger or nullOptional

Work order this time entry is logged against, if any.

distancedouble or nullOptional

laborHourlyRatedouble or nullOptional

notestring or nullOptional

Response

Timesheet created successfully

idintegerOptional

Unique identifier.

typeenum or nullOptional

Time entry type.

statusenum or nullOptional

Processing status of the time entry.

startDatestring or nullOptionalformat: "date-time"

endDatestring or nullOptionalformat: "date-time"

distancedouble or nullOptional

Distance traveled, for TRAVEL entries.

notestring or nullOptional

isArchivedboolean or nullOptional

createdAtstringOptionalformat: "date-time"

updatedAtstringOptionalformat: "date-time"

projectIdinteger or nullOptional

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

accountIdinteger or nullOptional

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

opportunityIdinteger or nullOptional

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

workOrderIdinteger or nullOptional

targetUserIdinteger or nullOptional

The worker the time entry is logged for.

createdByinteger or nullOptional

updatedByinteger or nullOptional

laborHourlyRatedouble or nullOptional

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

laborTotalCostdouble or nullOptional

Only visible with the appropriate financial privilege.

Errors

400

Bad Request Error

401

Unauthorized Error

502

Bad Gateway Error