Sign in
latestOpenAPI 3.0.12026-07-2464217456.8 KB

1e8ba619e741

Time Tracking

Update a time entry

This endpoint can be used to update a time entry using its ID. To ensure that the total time for all the time entries added for that date does not exceed 24 hours, the fields date and minutes are mandatory. The properties activityName, notes, billable and minutes can be updated using this endPoint. This API returns the updated time entry object.

put/1.0/time-entries/{timeEntryId}

Path parameters

timeEntryIdinteger required

The unique, system-generated identifier, which can be used to identify the time entry globally.

Query parameters

includeFieldsstring[]

This query parameter allows you to specify which fields should be returned in the response body by selecting from the drop down. To get the relevant fields, use comma separated values. If the field is left blank, the default properties are returned.

includeAllFieldsboolean
Example:true

This query parameter allows you to specify if all the fields should be returned in the response body. If the field is left blank, the default properties are returned.

Request body

TimeEntryPublicAPIUpdateRequest required— unresolved $ref

Response

The requested action was successfully executed.

timeEntryIdinteger

The unique, system-generated identifier, which can be used to identify the time entry globally.

datestring

Date of the time entry in format YYYY-MM-DD

minutesinteger

Duration of the time entry in minutes

activityNamestring

Name of the adhoc activity being performed

createdAtinteger

Timestamp of creation time of the entry in epoch milliseconds

updatedAtinteger

Timestamp of last updated time of the entry in epoch milliseconds

billableboolean

Whether the time entry is billable. Defaults to true

notesstring

Notes for the time entry

sourceType'GOOGLE_CALENDAR' | 'OUTLOOK_CALENDAR' | 'TASK' | 'PROJECT' | 'PHASE' | 'ADHOC' | 'MILESTONE'

Type of source of the time entry Eg: Task, Adhoc (Activity), Milestone

status'NOT_SUBMITTED' | 'SUBMITTED' | 'APPROVED' | 'REJECTED'

Status of the time entry

submittedAtinteger

Time of submission for time entry

Note: This field may be null, even when the time entry is in an APPROVED or REJECTED state, as time entries can be approved or rejected without an explicit submission step.

approvedAtinteger

Time of approval for time entry

rejectedAtinteger

Time of rejection for time entry

deletedboolean

Whether the time entry is deleted.

Example response

{
  "timeEntryId": 201,
  "date": "2023-03-28",
  "minutes": 250,
  "activityName": "Pre-Sales campaign",
  "project": {
    "projectName": "Acme Onboarding",
    "projectId": 204
  },
  "task": {
    "taskName": "Kickoff meeting",
    "taskId": 201
  },
  "projectPhase": {
    "phaseId": 201,
    "phaseName": "Go live"
  },
  "createdAt": 1681319726000,
  "updatedAt": 1681319726000,
  "createdBy": {
    "emailId": "john.doe@rocketlane.com",
    "userId": 201,
    "firstName": "John",
    "lastName": "Doe"
  },
  "updatedBy": {
    "emailId": "john.doe@rocketlane.com",
    "userId": 201,
    "firstName": "John",
    "lastName": "Doe"
  },
  "billable": true,
  "user": {
    "emailId": "john.doe@rocketlane.com",
    "userId": 201,
    "firstName": "John",
    "lastName": "Doe"
  },
  "notes": "Working on API integration",
  "category": {
    "categoryName": "Pre-sales",
    "categoryId": 8
  },
  "sourceType": "Task",
  "submittedBy": {
    "emailId": "john.doe@rocketlane.com",
    "userId": 201,
    "firstName": "John",
    "lastName": "Doe"
  },
  "submittedAt": 1681319726000,
  "approvedBy": {
    "emailId": "john.doe@rocketlane.com",
    "userId": 201,
    "firstName": "John",
    "lastName": "Doe"
  },
  "approvedAt": 1681319726000,
  "rejectedBy": {
    "emailId": "john.doe@rocketlane.com",
    "userId": 201,
    "firstName": "John",
    "lastName": "Doe"
  },
  "rejectedAt": 1681319726000,
  "deleted": true,
  "costRate": {
    "rate": 40,
    "currency": "USD"
  },
  "billRate": {
    "rate": 40,
    "currency": "EUR"
  },
  "fields": [
    {
      "fieldId": 201,
      "fieldLabel": "MRR",
      "fieldValueLabel": "1000"
    }
  ]
}