Time entry object

A unit of work for a project or time off where members can log their time.

Example

{
  "id": "4497fa99-27a4-4509-9748-83e4399296e3",
  "typeId": "project_time",
  "statusId": "approved",
  "date": "2022-03-08",
  "minutes": 120,
  "timerStartedAt": "2022-03-10T17:50:48.808Z",
  "notes": "Write up the weekly status report.",
  "isBillable": true,
  "invoiced": false,
  "createdAt": "2022-03-11T16:13:40.715Z",
  "member": {
    "id": "ec5543de-3b0f-47a0-b8ef-a6e18dc4b885",
    "name": "John Smith"
  },
  "project": {
    "id": "095e0780-48bf-472c-8deb-2fc3ebc7d90c",
    "name": "Vendor Portal",
    "client": {
      "id": "4cacdf11-71d1-4fbb-90ee-b091803581b0",
      "name": "Joe's Shop"
    }
  },
  "role": {
    "id": "7ad5a34a-07b7-48e9-a760-bd220d52e354",
    "name": "Project Manager"
  },
  "task": {
    "id": "9a7097a0-d71e-4ed2-9bc3-2dd7d797edc4",
    "name": "Project Status Reporting"
  },
  "timeOffType": {
    "id": "8fc28b3d-e179-4193-bbdd-09387be8a1e9",
    "name": "Holiday"
  }
}

Attributes

NameTypeDescription
iduuidThe unique identifier for the object.
typeIdstringThe type of the time entry. Can be either "project_time" (Project Time) or "time_off" (Time Off).
statusIdstringThe status of the time entry. Can be either "not_submitted" (Not Submitted), "pending_approval" (Pending Approval), "approved" (Approved), or "rejected" (Rejected).
datedateThe date of the time entry. Will be in the form YYYY-MM-DD.
minutesnumberThe total minutes of the time entry, these are whole numbers.
timerStartedAttimestampThe timestamp of the start of a running timer. If set, this means a timer is actively running.
notesstringAny notes with the associated entry.
isBillablebooleanA flag to indicate if the time entry is billable. This is calculated based on related objects and statuses.
invoicedbooleanA flag to indicate if the time entry has been invoiced.
createdAttimestampThe timestamp when the object was created.
memberobjectA simple object to the related workspace member. See attributes.
projectobjectA simple object to the related project. Only available if the typeId is "project_time". See attributes.
roleobjectA simple object to the related project role. Only available if the typeId is "project_time" and the project set is using roles. See attributes.
taskobjectA simple object to the related project task. Only available if the typeId is "project_time" and the project has tasks. See attributes.
timeOffTypeobjectA simple object to the related time-off type. Only available if the typeId is "time_off". See attributes.

Member attributes

NameTypeDescription
iduuidThe unique identifier for the object.
namestringThe name of the workspace member.

Project attributes

NameTypeDescription
iduuidThe unique identifier for the object.
namestringThe name of the project.
clientobjectA simple object to the related client. See attributes.

Client attributes

NameTypeDescription
iduuidThe unique identifier for the object.
namestringThe name of the client.

Role attributes

NameTypeDescription
iduuidThe unique identifier for the object.
namestringThe name of the project role.

Task attributes

NameTypeDescription
iduuidThe unique identifier for the object.
namestringThe name of the project task.

Time off type attributes

NameTypeDescription
iduuidThe unique identifier for the object.
namestringThe name of the time-off type.