Time Entry

Time Entry is used for entering time. It allows you to see a range of time entries logged against a project. Time Entry object allows you to perform the following operations:

  • Retrieve a specific time entry or a list of time entries
  • Create a time entry
  • Update a time entry
  • Delete a time entry

  • cURL
  • NODE.JS
  • PHP
  • C#
  • PYTHON
  • JAVA
NameDescriptionFormatAttributes
activityId Identifier of an activity for which time is entereduuid
date Date of a time entry in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ssdate-timeFilterable, Sortable
description Description of an activity performedstringMaxLength = 100
projectId Identifier of a project on which activity is performeduuidFilterable
resourceId Identifier of an employee or vendor working on a projectuuidFilterable
activity Name of an activity for which time is enteredstringSortable
actualHours Actual hours worked on a projectdouble
billable Indicates whether a time entry is billable or notbooleanFilterable, Sortable
billRate Rate at which a client is billed for per hour of work done by an employee or a vendor on a projectdouble
billStatus Provides the status of a time entry, e.g., un-billed etc.
BilledStatus Enumerated type: Click to see possible values and their descriptions.
Filterable, Sortable
class Name of the classstringFilterable, Sortable
classId Identifier of the classuuidFilterable
classification Job classification or title of a timekeeper (employee or vendor)stringMaxLength = 100
client Name of a client associated with the time entrystringFilterable
clientHours Hours billed or charged to a client for work done on a projectdouble
compensationTime Indicates whether the time entry is marked as compensation timebooleanFilterable, Sortable
costRate Value representing the cost to your company for per hour of work done by an employee or a vendor working on a projectdouble
createdById Identifier of the user who created this objectuuidFilterable
createdOn Date and time when this object was created (UTC Now), in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ssdate-timeFilterable, Sortable
customFields []Array: Parent object can have multiple instances of this nested object under it.Represents the custom fields
CustomFieldData Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter.
expenseAccount Name of an expense account associated with a time entrystring
expenseAccountId Identifier of an expense account associated with a time entryuuid
extra Indicates whether a time entry is marked as extra or notboolean
flag1 Tracks any characteristic of the time entry. For example, to mark time entries that are tax deductible, you can select this flag for thembooleanFilterable
flag2 Tracks any characteristic of the time entry. For example, to mark time entries that are tax deductible, you can select this flag for thembooleanFilterable
flag3 Tracks any characteristic of the time entry. For example, to mark time entries that are tax deductible, you can select this flag for thembooleanFilterable
id Object identifieruuidFilterable
incomeAccount Name of an income account associated with a time entrystring
incomeAccountId Identifier of an income account associated with a time entryuuid
invoiceId Identifier of an invoice associated with a time entryuuidFilterable
invoiceNumber Invoice number of an invoice associated with a time entrystringFilterable, Sortable
lastUpdated Last updated date and time value of this object in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ssdate-timeFilterable, Sortable
lastUpdatedById Identifier of the user who last updated this objectuuidFilterable
memo Records any extra information or details about a time entrystring
objectState Represents the state of the object. e.g., new, unchanged, modified or deleted
ObjectState Enumerated type: Click to see possible values and their descriptions.
overtime Indicates whether the time entry is marked as overtimebooleanFilterable, Sortable
project Name of a project on which activity is performedstringFilterable, Sortable
resource Name of an employee or vendor working on a projectstringFilterable, Sortable
startInterval This is the start time duration of a time entry in minutes, e.g a time entry that starts at 9:00 A.M will have the start interval as 9*60 = 540. Where 9 represents the hours from the start of the day and 60 are the minutes in an hour.int32
startTime Represents the time when a time entry was startedstring
stopInterval This is the stop time duration of a time entry in minutes, e.g a time entry that stops at 6:00 P.M will have the stop interval as 18*60 = 1080. Where 18 represents the hours from the start of the day and 60 are the minutes in an hour.int32
stopTime Represents the time when a time entry was stoppedstring
tax1 Tax 1 rate used to compute item tax as part of the bill amountdouble
tax2 Tax 2 rate used to compute item tax as part of the bill amountdouble
tax3 Tax 3 rate used to compute item tax as part of the bill amountdouble
token Represents the token for update operationsint32
vendorBillId Identifier of a vendor bill associated with a time entryuuidFilterable
vendorBillNumber Vendor bill number associated with a time entrystringFilterable, Sortable
version Implements concurrency on this objectbyte
workflow []Array: Parent object can have multiple instances of this nested object under it.Represents the list of workflow
WorkflowState Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter.
wudMultiplier Multiplier at which billable hours are written up or down.doubleFilterable, Sortable
wudPercent Percentage at which billable hours are written up or down.doubleSortable

Use this method to retrieve a list of time entries. Optionally pass where, orderBy and page as the query parameters to filter the result. Use the fields parameter to request a subset of the model. By default, a complete model is returned. The expand parameter is used to request nested properties in the model.

Request URL
base_url/timeentry

Method Overview

HTTP Method:

GET

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Headers:

Access Token

Module:

TimeEntry

Required Scopes:

read:core

Required Subscription:

View Subscription


Request Parameters asterisk denotes required
NameParameter TypeDescriptionFormat
fields Query Specifies the nested model properties you want in the response bodystring
where Query Specifies only those records that match an expression in the querystring
orderBy Query Specifies the order of the recordsstring
page Query Specifies the page number and number of records on each pagestring
expand Query Specifies the nested model properties you want in the response bodystring
Response Body
NameDescriptionFormat
activityId Identifier of an activity for which time is entereduuid
date Date of a time entry in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ssdate-time
description Description of an activity performedstring
projectId Identifier of a project on which activity is performeduuid
resourceId Identifier of an employee or vendor working on a projectuuid
activity Name of an activity for which time is enteredstring
actualHours Actual hours worked on a projectdouble
billable Indicates whether a time entry is billable or notboolean
billRate Rate at which a client is billed for per hour of work done by an employee or a vendor on a projectdouble
billStatus Provides the status of a time entry, e.g., un-billed etc.
BilledStatusEnumerated type: Click to see possible values and their descriptions.
class Name of the classstring
classId Identifier of the classuuid
classification Job classification or title of a timekeeper (employee or vendor)string
client Name of a client associated with the time entrystring
clientHours Hours billed or charged to a client for work done on a projectdouble
compensationTime Indicates whether the time entry is marked as compensation timeboolean
costRate Value representing the cost to your company for per hour of work done by an employee or a vendor working on a projectdouble
createdById Identifier of the user who created this objectuuid
createdOn Date and time when this object was created (UTC Now), in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ssdate-time
customFields []Array: Parent object can have multiple instances of this nested object under it.Represents the custom fields
CustomFieldData Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter.
expenseAccount Name of an expense account associated with a time entrystring
expenseAccountId Identifier of an expense account associated with a time entryuuid
extra Indicates whether a time entry is marked as extra or notboolean
flag1 Tracks any characteristic of the time entry. For example, to mark time entries that are tax deductible, you can select this flag for themboolean
flag2 Tracks any characteristic of the time entry. For example, to mark time entries that are tax deductible, you can select this flag for themboolean
flag3 Tracks any characteristic of the time entry. For example, to mark time entries that are tax deductible, you can select this flag for themboolean
id Object identifieruuid
incomeAccount Name of an income account associated with a time entrystring
incomeAccountId Identifier of an income account associated with a time entryuuid
invoiceId Identifier of an invoice associated with a time entryuuid
invoiceNumber Invoice number of an invoice associated with a time entrystring
lastUpdated Last updated date and time value of this object in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ssdate-time
lastUpdatedById Identifier of the user who last updated this objectuuid
memo Records any extra information or details about a time entrystring
objectState Represents the state of the object. e.g., new, unchanged, modified or deleted
ObjectStateEnumerated type: Click to see possible values and their descriptions.
overtime Indicates whether the time entry is marked as overtimeboolean
project Name of a project on which activity is performedstring
resource Name of an employee or vendor working on a projectstring
startInterval This is the start time duration of a time entry in minutes, e.g a time entry that starts at 9:00 A.M will have the start interval as 9*60 = 540. Where 9 represents the hours from the start of the day and 60 are the minutes in an hour.int32
startTime Represents the time when a time entry was startedstring
stopInterval This is the stop time duration of a time entry in minutes, e.g a time entry that stops at 6:00 P.M will have the stop interval as 18*60 = 1080. Where 18 represents the hours from the start of the day and 60 are the minutes in an hour.int32
stopTime Represents the time when a time entry was stoppedstring
tax1 Tax 1 rate used to compute item tax as part of the bill amountdouble
tax2 Tax 2 rate used to compute item tax as part of the bill amountdouble
tax3 Tax 3 rate used to compute item tax as part of the bill amountdouble
token Represents the token for update operationsint32
vendorBillId Identifier of a vendor bill associated with a time entryuuid
vendorBillNumber Vendor bill number associated with a time entrystring
version Implements concurrency on this objectbyte
workflow []Array: Parent object can have multiple instances of this nested object under it.Represents the list of workflow
WorkflowState Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter.
wudMultiplier Multiplier at which billable hours are written up or down.double
wudPercent Percentage at which billable hours are written up or down.double
Example Request
Example Response
[
  {
    "activityId": "e0bfb49e-2910-4fcd-87ff-15f3608c4e32",
    "date": "2024-01-24T04:16:09Z",
    "description": "TimeEntry Description",
    "projectId": "012bba1a-7802-4ee8-af0e-969849c56db1",
    "resourceId": "a939d953-4c38-4a3d-8de9-df625736c314",
    "activity": "activity",
    "actualHours": 1,
    "billable": true,
    "billRate": 1,
    "billStatus": null,
    "class": "class",
    "classId": "88b9abd7-a59b-404d-81c0-3971aa687ce9",
    "classification": "classification",
    "client": "client",
    "clientHours": 1,
    "compensationTime": true,
    "costRate": 1,
    "createdById": "be38a480-97f5-497f-92f3-85948033c5a0",
    "createdOn": "2024-01-24T04:16:09Z",
    "customFields": [
      {
        "definitionId": "22b7e136-0be5-4ea8-83af-4512f53b89d2",
        "createdById": "0ee11fe6-b0b4-4521-87f2-1e8f3e97ed3e",
        "createdOn": "2024-01-24T04:16:09Z",
        "description": "CustomFieldData Description",
        "id": "f9e53040-b88d-4f95-8318-0bb5d54c8f07",
        "label": "label",
        "lastUpdated": "2024-01-24T04:16:09Z",
        "lastUpdatedById": "581eaaf8-b6a9-4e3c-9a0f-d5a25d8a1d52",
        "objectState": null,
        "token": 0,
        "type": null,
        "value": "value",
        "version": "U3dhZ2dlciByb2Nrcw=="
      }
    ],
    "expenseAccount": "expenseAccount",
    "expenseAccountId": "eece4fed-d6ff-4584-a6a9-e17ddbc811c2",
    "extra": true,
    "flag1": true,
    "flag2": true,
    "flag3": true,
    "id": "503a0219-bfaf-47db-980a-2cefb89da651",
    "incomeAccount": "incomeAccount",
    "incomeAccountId": "c18718ac-06ed-418e-8db3-3ad7c16dcaba",
    "invoiceId": "f00ac204-8fe3-409b-bd7a-501eb1517477",
    "invoiceNumber": "invoiceNumber",
    "lastUpdated": "2024-01-24T04:16:09Z",
    "lastUpdatedById": "f5b6a852-6e9c-44e0-a13e-df21f982f272",
    "memo": "memo",
    "objectState": null,
    "overtime": true,
    "project": "project",
    "resource": "resource",
    "startInterval": 0,
    "startTime": "startTime",
    "stopInterval": 0,
    "stopTime": "stopTime",
    "tax1": 1,
    "tax2": 1,
    "tax3": 1,
    "token": 0,
    "vendorBillId": "91fc3139-dcfe-4966-900b-ff9d6f123881",
    "vendorBillNumber": "vendorBillNumber",
    "version": "U3dhZ2dlciByb2Nrcw==",
    "workflow": [
      {
        "actionById": "9821f64a-0b09-403c-bfc3-07c70ccc9530",
        "action": null,
        "actionBy": "actionBy",
        "createdById": "9d016d85-7165-4c43-b256-861ffc10cbe1",
        "createdOn": "2024-01-24T04:16:09Z",
        "date": "2024-01-24T04:16:09Z",
        "id": "8798209f-7feb-46f0-9cb3-912c35f19b13",
        "lastUpdated": "2024-01-24T04:16:09Z",
        "lastUpdatedById": "4d7e763b-fd51-4158-b774-ab3d95ddd8f5",
        "memo": "memo",
        "objectState": null,
        "sendTo": "sendTo",
        "sendToId": "fa66be95-df8e-4d08-b4fd-63f270a0b4eb",
        "submitTo": null,
        "token": 0,
        "type": null,
        "version": "U3dhZ2dlciByb2Nrcw=="
      }
    ],
    "wudMultiplier": 1,
    "wudPercent": 1
  }
]

Use this method to retrieve a specific time entry. Pass id as the parameter.

Request URL
base_url/timeentry/{id}

Method Overview

HTTP Method:

GET

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Headers:

Access Token

Module:

TimeEntry

Required Scopes:

read:core

Required Subscription:

View Subscription


Request Parameters asterisk denotes required
NameParameter TypeDescriptionFormat
id Path Time entry identifierstring
Response Body
NameDescriptionFormat
activityId Identifier of an activity for which time is entereduuid
date Date of a time entry in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ssdate-time
description Description of an activity performedstring
projectId Identifier of a project on which activity is performeduuid
resourceId Identifier of an employee or vendor working on a projectuuid
activity Name of an activity for which time is enteredstring
actualHours Actual hours worked on a projectdouble
billable Indicates whether a time entry is billable or notboolean
billRate Rate at which a client is billed for per hour of work done by an employee or a vendor on a projectdouble
billStatus Provides the status of a time entry, e.g., un-billed etc.
BilledStatusEnumerated type: Click to see possible values and their descriptions.
class Name of the classstring
classId Identifier of the classuuid
classification Job classification or title of a timekeeper (employee or vendor)string
client Name of a client associated with the time entrystring
clientHours Hours billed or charged to a client for work done on a projectdouble
compensationTime Indicates whether the time entry is marked as compensation timeboolean
costRate Value representing the cost to your company for per hour of work done by an employee or a vendor working on a projectdouble
createdById Identifier of the user who created this objectuuid
createdOn Date and time when this object was created (UTC Now), in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ssdate-time
customFields []Array: Parent object can have multiple instances of this nested object under it.Represents the custom fields
CustomFieldData Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter.
expenseAccount Name of an expense account associated with a time entrystring
expenseAccountId Identifier of an expense account associated with a time entryuuid
extra Indicates whether a time entry is marked as extra or notboolean
flag1 Tracks any characteristic of the time entry. For example, to mark time entries that are tax deductible, you can select this flag for themboolean
flag2 Tracks any characteristic of the time entry. For example, to mark time entries that are tax deductible, you can select this flag for themboolean
flag3 Tracks any characteristic of the time entry. For example, to mark time entries that are tax deductible, you can select this flag for themboolean
id Object identifieruuid
incomeAccount Name of an income account associated with a time entrystring
incomeAccountId Identifier of an income account associated with a time entryuuid
invoiceId Identifier of an invoice associated with a time entryuuid
invoiceNumber Invoice number of an invoice associated with a time entrystring
lastUpdated Last updated date and time value of this object in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ssdate-time
lastUpdatedById Identifier of the user who last updated this objectuuid
memo Records any extra information or details about a time entrystring
objectState Represents the state of the object. e.g., new, unchanged, modified or deleted
ObjectStateEnumerated type: Click to see possible values and their descriptions.
overtime Indicates whether the time entry is marked as overtimeboolean
project Name of a project on which activity is performedstring
resource Name of an employee or vendor working on a projectstring
startInterval This is the start time duration of a time entry in minutes, e.g a time entry that starts at 9:00 A.M will have the start interval as 9*60 = 540. Where 9 represents the hours from the start of the day and 60 are the minutes in an hour.int32
startTime Represents the time when a time entry was startedstring
stopInterval This is the stop time duration of a time entry in minutes, e.g a time entry that stops at 6:00 P.M will have the stop interval as 18*60 = 1080. Where 18 represents the hours from the start of the day and 60 are the minutes in an hour.int32
stopTime Represents the time when a time entry was stoppedstring
tax1 Tax 1 rate used to compute item tax as part of the bill amountdouble
tax2 Tax 2 rate used to compute item tax as part of the bill amountdouble
tax3 Tax 3 rate used to compute item tax as part of the bill amountdouble
token Represents the token for update operationsint32
vendorBillId Identifier of a vendor bill associated with a time entryuuid
vendorBillNumber Vendor bill number associated with a time entrystring
version Implements concurrency on this objectbyte
workflow []Array: Parent object can have multiple instances of this nested object under it.Represents the list of workflow
WorkflowState Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter.
wudMultiplier Multiplier at which billable hours are written up or down.double
wudPercent Percentage at which billable hours are written up or down.double
Example Request
Example Response
{
  "activityId": "7c1bf509-696a-494b-bb9f-6828b9474206",
  "date": "2024-01-24T04:16:09Z",
  "description": "TimeEntry Description",
  "projectId": "57ede34c-69df-43fc-bf8e-c89bcfadfef9",
  "resourceId": "197b47f6-ea18-4602-9c83-36f1f3a09a53",
  "activity": "activity",
  "actualHours": 1,
  "billable": true,
  "billRate": 1,
  "billStatus": null,
  "class": "class",
  "classId": "e8c3b665-0565-48a4-bd86-27af4ba422ba",
  "classification": "classification",
  "client": "client",
  "clientHours": 1,
  "compensationTime": true,
  "costRate": 1,
  "createdById": "1c4aa728-205a-441a-bb04-2e4f4e38b447",
  "createdOn": "2024-01-24T04:16:09Z",
  "customFields": [
    {
      "definitionId": "5c2ee785-09c2-4aed-a1c6-db9bbfe0f2b8",
      "createdById": "71348d5f-055d-4832-9c48-04958c9e7186",
      "createdOn": "2024-01-24T04:16:09Z",
      "description": "CustomFieldData Description",
      "id": "31be8308-e72b-427b-8ab1-a22ed66a239c",
      "label": "label",
      "lastUpdated": "2024-01-24T04:16:09Z",
      "lastUpdatedById": "aadcf882-6d76-4898-8000-a211f214e44b",
      "objectState": null,
      "token": 0,
      "type": null,
      "value": "value",
      "version": "U3dhZ2dlciByb2Nrcw=="
    }
  ],
  "expenseAccount": "expenseAccount",
  "expenseAccountId": "f146cd28-c906-4db1-83d9-d52a2bfb9784",
  "extra": true,
  "flag1": true,
  "flag2": true,
  "flag3": true,
  "id": "75a54397-0a27-44f1-8778-7923fd16ffc7",
  "incomeAccount": "incomeAccount",
  "incomeAccountId": "86c5559e-5cf0-41b7-8df5-c85a3ab20ee3",
  "invoiceId": "02067659-2a8a-4c8b-b00f-f10bd903b5d0",
  "invoiceNumber": "invoiceNumber",
  "lastUpdated": "2024-01-24T04:16:09Z",
  "lastUpdatedById": "d1895d73-92fd-45a8-9f26-397c56108e17",
  "memo": "memo",
  "objectState": null,
  "overtime": true,
  "project": "project",
  "resource": "resource",
  "startInterval": 0,
  "startTime": "startTime",
  "stopInterval": 0,
  "stopTime": "stopTime",
  "tax1": 1,
  "tax2": 1,
  "tax3": 1,
  "token": 0,
  "vendorBillId": "bbdb43f8-0881-4368-a85f-ad62f170f27a",
  "vendorBillNumber": "vendorBillNumber",
  "version": "U3dhZ2dlciByb2Nrcw==",
  "workflow": [
    {
      "actionById": "77b3e7e1-9779-4146-ac9b-e71ec0c0b932",
      "action": null,
      "actionBy": "actionBy",
      "createdById": "a184977f-a32e-4682-8ef7-f0bd2ce6ed4e",
      "createdOn": "2024-01-24T04:16:09Z",
      "date": "2024-01-24T04:16:09Z",
      "id": "6e658a3d-5b3a-4a9d-a09e-5ebeedaaaca2",
      "lastUpdated": "2024-01-24T04:16:09Z",
      "lastUpdatedById": "f6727118-dd16-43f2-9115-54c5e74b9f29",
      "memo": "memo",
      "objectState": null,
      "sendTo": "sendTo",
      "sendToId": "b1fb7537-2c1d-4071-8cdb-b2c42dbbaf2d",
      "submitTo": null,
      "token": 0,
      "type": null,
      "version": "U3dhZ2dlciByb2Nrcw=="
    }
  ],
  "wudMultiplier": 1,
  "wudPercent": 1
}

Use this method to save a time entry. Pass TimeEntry as the parameter.

Request URL
base_url/timeentry

Method Overview

HTTP Method:

POST

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Headers:

Access Token

Module:

TimeEntry

Required Scopes:

readwrite:core

Required Subscription:

View Subscription


Request Parameters asterisk denotes required
NameParameter TypeDescriptionFormat
body Body Time entry objectTimeEntry
Response Body
NameDescriptionFormat
activityId Identifier of an activity for which time is entereduuid
date Date of a time entry in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ssdate-time
description Description of an activity performedstring
projectId Identifier of a project on which activity is performeduuid
resourceId Identifier of an employee or vendor working on a projectuuid
activity Name of an activity for which time is enteredstring
actualHours Actual hours worked on a projectdouble
billable Indicates whether a time entry is billable or notboolean
billRate Rate at which a client is billed for per hour of work done by an employee or a vendor on a projectdouble
billStatus Provides the status of a time entry, e.g., un-billed etc.
BilledStatusEnumerated type: Click to see possible values and their descriptions.
class Name of the classstring
classId Identifier of the classuuid
classification Job classification or title of a timekeeper (employee or vendor)string
client Name of a client associated with the time entrystring
clientHours Hours billed or charged to a client for work done on a projectdouble
compensationTime Indicates whether the time entry is marked as compensation timeboolean
costRate Value representing the cost to your company for per hour of work done by an employee or a vendor working on a projectdouble
createdById Identifier of the user who created this objectuuid
createdOn Date and time when this object was created (UTC Now), in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ssdate-time
customFields []Array: Parent object can have multiple instances of this nested object under it.Represents the custom fields
CustomFieldData Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter.
expenseAccount Name of an expense account associated with a time entrystring
expenseAccountId Identifier of an expense account associated with a time entryuuid
extra Indicates whether a time entry is marked as extra or notboolean
flag1 Tracks any characteristic of the time entry. For example, to mark time entries that are tax deductible, you can select this flag for themboolean
flag2 Tracks any characteristic of the time entry. For example, to mark time entries that are tax deductible, you can select this flag for themboolean
flag3 Tracks any characteristic of the time entry. For example, to mark time entries that are tax deductible, you can select this flag for themboolean
id Object identifieruuid
incomeAccount Name of an income account associated with a time entrystring
incomeAccountId Identifier of an income account associated with a time entryuuid
invoiceId Identifier of an invoice associated with a time entryuuid
invoiceNumber Invoice number of an invoice associated with a time entrystring
lastUpdated Last updated date and time value of this object in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ssdate-time
lastUpdatedById Identifier of the user who last updated this objectuuid
memo Records any extra information or details about a time entrystring
objectState Represents the state of the object. e.g., new, unchanged, modified or deleted
ObjectStateEnumerated type: Click to see possible values and their descriptions.
overtime Indicates whether the time entry is marked as overtimeboolean
project Name of a project on which activity is performedstring
resource Name of an employee or vendor working on a projectstring
startInterval This is the start time duration of a time entry in minutes, e.g a time entry that starts at 9:00 A.M will have the start interval as 9*60 = 540. Where 9 represents the hours from the start of the day and 60 are the minutes in an hour.int32
startTime Represents the time when a time entry was startedstring
stopInterval This is the stop time duration of a time entry in minutes, e.g a time entry that stops at 6:00 P.M will have the stop interval as 18*60 = 1080. Where 18 represents the hours from the start of the day and 60 are the minutes in an hour.int32
stopTime Represents the time when a time entry was stoppedstring
tax1 Tax 1 rate used to compute item tax as part of the bill amountdouble
tax2 Tax 2 rate used to compute item tax as part of the bill amountdouble
tax3 Tax 3 rate used to compute item tax as part of the bill amountdouble
token Represents the token for update operationsint32
vendorBillId Identifier of a vendor bill associated with a time entryuuid
vendorBillNumber Vendor bill number associated with a time entrystring
version Implements concurrency on this objectbyte
workflow []Array: Parent object can have multiple instances of this nested object under it.Represents the list of workflow
WorkflowState Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter.
wudMultiplier Multiplier at which billable hours are written up or down.double
wudPercent Percentage at which billable hours are written up or down.double
Example Request
Example Response
{
  "activityId": "cde04037-9aea-4592-9d2f-ff49e85fb0c4",
  "date": "2024-01-24T04:16:09Z",
  "description": "TimeEntry Description",
  "projectId": "a390f988-8c05-48fb-83d2-68b62e58a865",
  "resourceId": "f4343eaf-7413-4b4a-a0d4-c96ba03c67bd",
  "activity": "activity",
  "actualHours": 1,
  "billable": true,
  "billRate": 1,
  "billStatus": null,
  "class": "class",
  "classId": "0f60fec1-908a-4583-8504-9cbc9807f163",
  "classification": "classification",
  "client": "client",
  "clientHours": 1,
  "compensationTime": true,
  "costRate": 1,
  "createdById": "027b4db2-a2e0-44bf-bc3c-0053becfb546",
  "createdOn": "2024-01-24T04:16:09Z",
  "customFields": [
    {
      "definitionId": "14b577f7-66ef-4797-898a-c9c5a65a27b5",
      "createdById": "229ff44a-0a35-4cf8-b4cf-f74ad5486abe",
      "createdOn": "2024-01-24T04:16:09Z",
      "description": "CustomFieldData Description",
      "id": "14e95278-131e-458b-98b7-ab945c473136",
      "label": "label",
      "lastUpdated": "2024-01-24T04:16:09Z",
      "lastUpdatedById": "1f2f779e-b50b-406d-a089-8d7c086f1585",
      "objectState": null,
      "token": 0,
      "type": null,
      "value": "value",
      "version": "U3dhZ2dlciByb2Nrcw=="
    }
  ],
  "expenseAccount": "expenseAccount",
  "expenseAccountId": "bace6fcd-7b72-4417-ac5a-6c3d46d8f406",
  "extra": true,
  "flag1": true,
  "flag2": true,
  "flag3": true,
  "id": "a4cbcdd4-18c0-4fcf-aadd-c55056ff9977",
  "incomeAccount": "incomeAccount",
  "incomeAccountId": "b4d751b4-5626-495a-ae75-a3dfcb376987",
  "invoiceId": "ec524c47-f4d9-401d-9022-e611f7c02ef4",
  "invoiceNumber": "invoiceNumber",
  "lastUpdated": "2024-01-24T04:16:09Z",
  "lastUpdatedById": "d8c3776c-f5fb-4c5d-89e4-f8f8eba43d8e",
  "memo": "memo",
  "objectState": null,
  "overtime": true,
  "project": "project",
  "resource": "resource",
  "startInterval": 0,
  "startTime": "startTime",
  "stopInterval": 0,
  "stopTime": "stopTime",
  "tax1": 1,
  "tax2": 1,
  "tax3": 1,
  "token": 0,
  "vendorBillId": "1e1df2d1-a254-4686-a6f4-99460a362fbf",
  "vendorBillNumber": "vendorBillNumber",
  "version": "U3dhZ2dlciByb2Nrcw==",
  "workflow": [
    {
      "actionById": "844c729a-cc19-4bb5-aa4a-8556624a6a10",
      "action": null,
      "actionBy": "actionBy",
      "createdById": "64bcded8-e869-4444-966a-07eab3007b55",
      "createdOn": "2024-01-24T04:16:09Z",
      "date": "2024-01-24T04:16:09Z",
      "id": "8e511642-b481-4bcc-9605-deecc917056b",
      "lastUpdated": "2024-01-24T04:16:09Z",
      "lastUpdatedById": "cc689ab5-7d3a-47b3-b5de-c97f86b75016",
      "memo": "memo",
      "objectState": null,
      "sendTo": "sendTo",
      "sendToId": "5f76c385-1f68-41dc-88cb-e178d10ef726",
      "submitTo": null,
      "token": 0,
      "type": null,
      "version": "U3dhZ2dlciByb2Nrcw=="
    }
  ],
  "wudMultiplier": 1,
  "wudPercent": 1
}

Use this method to save multiple time entries. Pass model as the parameter.

Request URL
base_url/timeentry/batch

Method Overview

HTTP Method:

POST

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Headers:

Access Token

Module:

TimeEntry

Required Scopes:

readwrite:core

Required Subscription:

View Subscription


Request Parameters asterisk denotes required
NameParameter TypeDescriptionFormat
body Body Time entry objectTimeEntryBatchRequest
Response Body
NameDescriptionFormat
batchSize Represents the number of entities in a batchint64
createdById Identifier of the user who created this objectuuid
createdOn Date and time when this object was created (UTC Now), in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ssdate-time
id Object identifieruuid
lastUpdated Last updated date and time value of this object in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ssdate-time
lastUpdatedById Identifier of the user who last updated this objectuuid
objectState Represents the state of the object. e.g., new, unchanged, modified or deleted
ObjectStateEnumerated type: Click to see possible values and their descriptions.
progress Represents the total number of entities processedint64
status Represents the status of a job e.g., ready, running, completed, or terminatedstring
token Represents the token for update operationsint32
type Represents the type of a job e.g., create, update, or deletestring
version Implements concurrency on this objectbyte
Example Request
Example Response
{
  "batchSize": 0,
  "createdById": "1ca30931-ec31-4baa-9f9a-04e93f8adb12",
  "createdOn": "2024-01-24T04:16:09Z",
  "id": "9fb2fedf-16eb-462f-9246-71c43d6e81b5",
  "lastUpdated": "2024-01-24T04:16:09Z",
  "lastUpdatedById": "72ddeeec-94c1-4e33-87e9-d495fbc3b97c",
  "objectState": null,
  "progress": 0,
  "status": "status",
  "token": 0,
  "type": "type",
  "version": "U3dhZ2dlciByb2Nrcw=="
}

Use this method to update a time entry. Pass TimeEntry as the parameter.

Request URL
base_url/timeentry/{id}

Method Overview

HTTP Method:

PUT

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Headers:

Access Token

Module:

TimeEntry

Required Scopes:

readwrite:core

Required Subscription:

View Subscription


Request Parameters asterisk denotes required
NameParameter TypeDescriptionFormat
id Path Time entry identifierstring
body Body Time entry objectTimeEntry
Response Body
NameDescriptionFormat
activityId Identifier of an activity for which time is entereduuid
date Date of a time entry in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ssdate-time
description Description of an activity performedstring
projectId Identifier of a project on which activity is performeduuid
resourceId Identifier of an employee or vendor working on a projectuuid
activity Name of an activity for which time is enteredstring
actualHours Actual hours worked on a projectdouble
billable Indicates whether a time entry is billable or notboolean
billRate Rate at which a client is billed for per hour of work done by an employee or a vendor on a projectdouble
billStatus Provides the status of a time entry, e.g., un-billed etc.
BilledStatusEnumerated type: Click to see possible values and their descriptions.
class Name of the classstring
classId Identifier of the classuuid
classification Job classification or title of a timekeeper (employee or vendor)string
client Name of a client associated with the time entrystring
clientHours Hours billed or charged to a client for work done on a projectdouble
compensationTime Indicates whether the time entry is marked as compensation timeboolean
costRate Value representing the cost to your company for per hour of work done by an employee or a vendor working on a projectdouble
createdById Identifier of the user who created this objectuuid
createdOn Date and time when this object was created (UTC Now), in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ssdate-time
customFields []Array: Parent object can have multiple instances of this nested object under it.Represents the custom fields
CustomFieldData Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter.
expenseAccount Name of an expense account associated with a time entrystring
expenseAccountId Identifier of an expense account associated with a time entryuuid
extra Indicates whether a time entry is marked as extra or notboolean
flag1 Tracks any characteristic of the time entry. For example, to mark time entries that are tax deductible, you can select this flag for themboolean
flag2 Tracks any characteristic of the time entry. For example, to mark time entries that are tax deductible, you can select this flag for themboolean
flag3 Tracks any characteristic of the time entry. For example, to mark time entries that are tax deductible, you can select this flag for themboolean
id Object identifieruuid
incomeAccount Name of an income account associated with a time entrystring
incomeAccountId Identifier of an income account associated with a time entryuuid
invoiceId Identifier of an invoice associated with a time entryuuid
invoiceNumber Invoice number of an invoice associated with a time entrystring
lastUpdated Last updated date and time value of this object in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ssdate-time
lastUpdatedById Identifier of the user who last updated this objectuuid
memo Records any extra information or details about a time entrystring
objectState Represents the state of the object. e.g., new, unchanged, modified or deleted
ObjectStateEnumerated type: Click to see possible values and their descriptions.
overtime Indicates whether the time entry is marked as overtimeboolean
project Name of a project on which activity is performedstring
resource Name of an employee or vendor working on a projectstring
startInterval This is the start time duration of a time entry in minutes, e.g a time entry that starts at 9:00 A.M will have the start interval as 9*60 = 540. Where 9 represents the hours from the start of the day and 60 are the minutes in an hour.int32
startTime Represents the time when a time entry was startedstring
stopInterval This is the stop time duration of a time entry in minutes, e.g a time entry that stops at 6:00 P.M will have the stop interval as 18*60 = 1080. Where 18 represents the hours from the start of the day and 60 are the minutes in an hour.int32
stopTime Represents the time when a time entry was stoppedstring
tax1 Tax 1 rate used to compute item tax as part of the bill amountdouble
tax2 Tax 2 rate used to compute item tax as part of the bill amountdouble
tax3 Tax 3 rate used to compute item tax as part of the bill amountdouble
token Represents the token for update operationsint32
vendorBillId Identifier of a vendor bill associated with a time entryuuid
vendorBillNumber Vendor bill number associated with a time entrystring
version Implements concurrency on this objectbyte
workflow []Array: Parent object can have multiple instances of this nested object under it.Represents the list of workflow
WorkflowState Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter.
wudMultiplier Multiplier at which billable hours are written up or down.double
wudPercent Percentage at which billable hours are written up or down.double
Example Request
Example Response
{
  "activityId": "6ac4a5fe-31fe-4ba4-96fc-64f174c536b5",
  "date": "2024-01-24T04:16:09Z",
  "description": "TimeEntry Description",
  "projectId": "b76796e0-73a8-48c8-87bb-eb8dfce5df6e",
  "resourceId": "bb868d8b-bf03-49ac-81a4-cbc52f9bb72c",
  "activity": "activity",
  "actualHours": 1,
  "billable": true,
  "billRate": 1,
  "billStatus": null,
  "class": "class",
  "classId": "f65d9a90-dc16-4a31-88a2-d04fb7fc573a",
  "classification": "classification",
  "client": "client",
  "clientHours": 1,
  "compensationTime": true,
  "costRate": 1,
  "createdById": "60e491b1-8062-4eeb-b5f1-9d0bb61eb372",
  "createdOn": "2024-01-24T04:16:09Z",
  "customFields": [
    {
      "definitionId": "672dca81-07e2-4f40-9f42-d56c38603f63",
      "createdById": "e8647e7d-a020-4f9c-a631-0c45a43804e9",
      "createdOn": "2024-01-24T04:16:09Z",
      "description": "CustomFieldData Description",
      "id": "3398437c-4bf0-4dd3-a5cd-e9273dbbb92a",
      "label": "label",
      "lastUpdated": "2024-01-24T04:16:09Z",
      "lastUpdatedById": "49d7915e-1fd6-4a05-b50f-6da582886820",
      "objectState": null,
      "token": 0,
      "type": null,
      "value": "value",
      "version": "U3dhZ2dlciByb2Nrcw=="
    }
  ],
  "expenseAccount": "expenseAccount",
  "expenseAccountId": "0814d42f-ec79-4cc3-a090-e510008c4c70",
  "extra": true,
  "flag1": true,
  "flag2": true,
  "flag3": true,
  "id": "a3c044ef-8f11-49d1-a2b1-afee1144f614",
  "incomeAccount": "incomeAccount",
  "incomeAccountId": "ff7262e3-dba4-4010-9ebe-5318cdd63520",
  "invoiceId": "aa44b442-ad3c-4f70-8560-a226a8ad29e9",
  "invoiceNumber": "invoiceNumber",
  "lastUpdated": "2024-01-24T04:16:09Z",
  "lastUpdatedById": "16e2e95a-4d0d-4cf5-9e04-28bac8a2b429",
  "memo": "memo",
  "objectState": null,
  "overtime": true,
  "project": "project",
  "resource": "resource",
  "startInterval": 0,
  "startTime": "startTime",
  "stopInterval": 0,
  "stopTime": "stopTime",
  "tax1": 1,
  "tax2": 1,
  "tax3": 1,
  "token": 0,
  "vendorBillId": "c6f2bfbf-2d35-47d7-a29d-14a6e9afc467",
  "vendorBillNumber": "vendorBillNumber",
  "version": "U3dhZ2dlciByb2Nrcw==",
  "workflow": [
    {
      "actionById": "db8d4ec1-dd38-48d3-ba7a-8f7abd298287",
      "action": null,
      "actionBy": "actionBy",
      "createdById": "39892ec2-1345-4385-993e-da863678ee68",
      "createdOn": "2024-01-24T04:16:09Z",
      "date": "2024-01-24T04:16:09Z",
      "id": "261e8da1-68df-46a2-bcff-74398eef673c",
      "lastUpdated": "2024-01-24T04:16:09Z",
      "lastUpdatedById": "592642f9-c506-4022-a733-c0aef8309490",
      "memo": "memo",
      "objectState": null,
      "sendTo": "sendTo",
      "sendToId": "6d177e42-b0bb-4b9c-9a5d-d4af2fc2ff5a",
      "submitTo": null,
      "token": 0,
      "type": null,
      "version": "U3dhZ2dlciByb2Nrcw=="
    }
  ],
  "wudMultiplier": 1,
  "wudPercent": 1
}

Use this method to delete a time entry. Pass id as the parameter.

Request URL
base_url/timeentry/{id}

Method Overview

HTTP Method:

DELETE

Content Type:

application/json

Response Format:

N/A

Requires Authentication?

Yes

Headers:

Access Token

Required Scopes:

readwrite:core

Required Subscription:

View Subscription


Request Parameters asterisk denotes required
NameParameter TypeDescriptionFormat
id Path Time entry identifierstring
Example Request

Use this method to perform partial modifications to a time entry. Pass id and patch document as parameters.

Request URL
base_url/timeentry/{id}

Method Overview

HTTP Method:

PATCH

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Headers:

Access Token

Module:

TimeEntry

Required Scopes:

readwrite:core

Required Subscription:

View Subscription


Request Parameters asterisk denotes required
NameParameter TypeDescriptionFormat
id Path Time entry identifierstring
body Body A document containing an array of objects with each object representing a single operationTimeEntryPatchDocument
Response Body
NameDescriptionFormat
Example Request
Example Response