v1

latestOpenAPI 3.0.12026-08-041753011.2 MB

Time entry

Stop a currently running timer on a workspace for a user

patch/v1/workspaces/{workspaceId}/user/{userId}/time-entries

Path parameters

workspaceIdstring required

Represents a workspace identifier across the system.

Example:64a687e29ae1f428e7ebe303

Represents a workspace identifier across the system.

userIdstring required

Represents a user identifier across the system.

Example:5a0ab5acb07987125438b60f

Represents a user identifier across the system.

Request body

endstring date-time required

Represents an end date in the yyyy-MM-ddThh:mm:ssZ format.

Example request

{
  "end": "2021-01-01T00:00:00Z"
}

Response

billableboolean

Indicates whether a time entry is billable.

descriptionstring

Represents time entry description.

idstring

Represents time entry identifier across the system.

isLockedboolean

Represents whether time entry is locked for modification.

kioskIdstring

Represents kiosk identifier across the system.

projectIdstring

Represents project identifier across the system.

tagIdsstring[]

Represents a list of tag identifiers across the system.

taskIdstring

Represents task identifier across the system.

type'REGULAR' | 'BREAK' | 'HOLIDAY' | 'TIME_OFF'

Represents a time entry type enum.

userIdstring

Represents user identifier across the system.

workspaceIdstring

Represents workspace identifier across the system.

Example response

{
  "customFieldValues": [
    {
      "customFieldId": "5e4117fe8c625f38930d57b7",
      "name": "TIN",
      "timeEntryId": "64c777ddd3fcab07cfbb210c",
      "type": "WORKSPACE"
    }
  ],
  "description": "This is a sample time entry description.",
  "id": "64c777ddd3fcab07cfbb210c",
  "kioskId": "94c777ddd3fcab07cfbb210d",
  "projectId": "25b687e29ae1f428e7ebe123",
  "tagIds": [
    "321r77ddd3fcab07cfbb567y",
    "44x777ddd3fcab07cfbb88f"
  ],
  "taskId": "54m377ddd3fcab07cfbb432w",
  "timeInterval": {
    "duration": "8000",
    "end": "2021-01-01T00:00:00Z",
    "start": "2020-01-01T00:00:00Z"
  },
  "type": "BREAK",
  "userId": "5a0ab5acb07987125438b60f",
  "workspaceId": "64a687e29ae1f428e7ebe303"
}