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
The Time Entry Object
asterisk denotes requiredName | Description | Format | Attributes |
---|---|---|---|
activityId | Identifier of an activity for which time is entered | uuid | |
date | Date of a time entry in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss | date-time | Filterable, Sortable |
description | Description of an activity performed | string | MaxLength = 100 |
projectId | Identifier of a project on which activity is performed | uuid | Filterable |
resourceId | Identifier of an employee or vendor working on a project | uuid | Filterable |
activity | Name of an activity for which time is entered | string | Sortable |
actualHours | Actual hours worked on a project | double | |
billable | Indicates whether a time entry is billable or not | boolean | Filterable, Sortable |
billRate | Rate at which a client is billed for per hour of work done by an employee or a vendor on a project | double | |
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 class | string | Filterable, Sortable |
classId | Identifier of the class | uuid | Filterable |
classification | Job classification or title of a timekeeper (employee or vendor) | string | MaxLength = 100 |
client | Name of a client associated with the time entry | string | Filterable |
clientHours | Hours billed or charged to a client for work done on a project | double | |
compensationTime | Indicates whether the time entry is marked as compensation time | boolean | Filterable, Sortable |
costRate | Value representing the cost to your company for per hour of work done by an employee or a vendor working on a project | double | |
createdById | Identifier of the user who created this object | uuid | Filterable |
createdOn | Date and time when this object was created (UTC Now), in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss | date-time | Filterable, 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 entry | string | |
expenseAccountId | Identifier of an expense account associated with a time entry | uuid | |
extra | Indicates whether a time entry is marked as extra or not | boolean | |
flag1 | Tracks any characteristic of the time entry. For example, to mark time entries that are tax deductible, you can select this flag for them | boolean | Filterable |
flag2 | Tracks any characteristic of the time entry. For example, to mark time entries that are tax deductible, you can select this flag for them | boolean | Filterable |
flag3 | Tracks any characteristic of the time entry. For example, to mark time entries that are tax deductible, you can select this flag for them | boolean | Filterable |
id | Object identifier | uuid | Filterable |
incomeAccount | Name of an income account associated with a time entry | string | |
incomeAccountId | Identifier of an income account associated with a time entry | uuid | |
integrationSourceId | Identifier of the integration source for this object. This property is only used by internal BQE apps and does not have any significance for external users | string | Filterable, Sortable |
invoiceId | Identifier of an invoice associated with a time entry | uuid | Filterable |
invoiceNumber | Invoice number of an invoice associated with a time entry | string | Filterable, Sortable |
lastUpdated | Last updated date and time value of this object in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss | date-time | Filterable, Sortable |
lastUpdatedById | Identifier of the user who last updated this object | uuid | Filterable |
memo | Records any extra information or details about a time entry | string | |
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 overtime | boolean | Filterable, Sortable |
project | Name of a project on which activity is performed | string | Filterable, Sortable |
resource | Name of an employee or vendor working on a project | string | Filterable, 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 started | string | |
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 stopped | string | |
tax1 | Tax 1 rate used to compute item tax as part of the bill amount | double | |
tax2 | Tax 2 rate used to compute item tax as part of the bill amount | double | |
tax3 | Tax 3 rate used to compute item tax as part of the bill amount | double | |
token | Represents the token for update operations | int32 | |
vendorBillId | Identifier of a vendor bill associated with a time entry | uuid | Filterable |
vendorBillNumber | Vendor bill number associated with a time entry | string | Filterable, Sortable |
version | Implements concurrency on this object | byte | |
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 | Filterable, Sortable |
wudPercent | Percentage at which billable hours are written up or down. | double | Sortable |
Time Entry List
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
Method Overview
HTTP Method:
GET
Content Type:
application/json
Response Format:
json
Requires Authentication?
Yes
Headers:
Module:
Time Entry
Required Scopes:
read:core
Required Subscription:
View Subscription
Request Parameters asterisk denotes required
Name | Parameter Type | Description | Format |
---|---|---|---|
fields | Query | Specifies the nested model properties you want in the response body | string |
where | Query | Specifies only those records that match an expression in the query | string |
orderBy | Query | Specifies the order of the records | string |
page | Query | Specifies the page number and number of records on each page | string |
expand | Query | Specifies the nested model properties you want in the response body | string |
Response Body
Name | Description | Format |
---|---|---|
activityId | Identifier of an activity for which time is entered | uuid |
date | Date of a time entry in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss | date-time |
description | Description of an activity performed | string |
projectId | Identifier of a project on which activity is performed | uuid |
resourceId | Identifier of an employee or vendor working on a project | uuid |
activity | Name of an activity for which time is entered | string |
actualHours | Actual hours worked on a project | double |
billable | Indicates whether a time entry is billable or not | boolean |
billRate | Rate at which a client is billed for per hour of work done by an employee or a vendor on a project | double |
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 class | string |
classId | Identifier of the class | uuid |
classification | Job classification or title of a timekeeper (employee or vendor) | string |
client | Name of a client associated with the time entry | string |
clientHours | Hours billed or charged to a client for work done on a project | double |
compensationTime | Indicates whether the time entry is marked as compensation time | boolean |
costRate | Value representing the cost to your company for per hour of work done by an employee or a vendor working on a project | double |
createdById | Identifier of the user who created this object | uuid |
createdOn | Date and time when this object was created (UTC Now), in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss | date-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 entry | string |
expenseAccountId | Identifier of an expense account associated with a time entry | uuid |
extra | Indicates whether a time entry is marked as extra or not | boolean |
flag1 | Tracks any characteristic of the time entry. For example, to mark time entries that are tax deductible, you can select this flag for them | boolean |
flag2 | Tracks any characteristic of the time entry. For example, to mark time entries that are tax deductible, you can select this flag for them | boolean |
flag3 | Tracks any characteristic of the time entry. For example, to mark time entries that are tax deductible, you can select this flag for them | boolean |
id | Object identifier | uuid |
incomeAccount | Name of an income account associated with a time entry | string |
incomeAccountId | Identifier of an income account associated with a time entry | uuid |
integrationSourceId | Identifier of the integration source for this object. This property is only used by internal BQE apps and does not have any significance for external users | string |
invoiceId | Identifier of an invoice associated with a time entry | uuid |
invoiceNumber | Invoice number of an invoice associated with a time entry | string |
lastUpdated | Last updated date and time value of this object in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss | date-time |
lastUpdatedById | Identifier of the user who last updated this object | uuid |
memo | Records any extra information or details about a time entry | string |
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 overtime | boolean |
project | Name of a project on which activity is performed | string |
resource | Name of an employee or vendor working on a project | string |
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 started | string |
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 stopped | string |
tax1 | Tax 1 rate used to compute item tax as part of the bill amount | double |
tax2 | Tax 2 rate used to compute item tax as part of the bill amount | double |
tax3 | Tax 3 rate used to compute item tax as part of the bill amount | double |
token | Represents the token for update operations | int32 |
vendorBillId | Identifier of a vendor bill associated with a time entry | uuid |
vendorBillNumber | Vendor bill number associated with a time entry | string |
version | Implements concurrency on this object | byte |
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 |
[
{
"activityId": "9effad66-349e-4493-bc3e-05414239056e",
"date": "2025-01-09T05:08:34Z",
"description": "TimeEntry Description",
"projectId": "964313b2-aabe-438e-9c38-accebf6a14a4",
"resourceId": "10444eae-2491-4cdd-af95-a875b0ae2a14",
"activity": "activity",
"actualHours": 1,
"billable": true,
"billRate": 1,
"billStatus": null,
"class": "class",
"classId": "e8d54d5f-3467-4dc7-9929-7d5282914079",
"classification": "classification",
"client": "client",
"clientHours": 1,
"compensationTime": true,
"costRate": 1,
"createdById": "5396ee79-dd2b-416d-9f67-9cbc2f09457d",
"createdOn": "2025-01-09T05:08:34Z",
"customFields": [
{
"definitionId": "c1257a1f-c3bf-447b-9748-038b8c86edf8",
"createdById": "a1e7238f-dc52-4e15-a74d-2e704a7a69e2",
"createdOn": "2025-01-09T05:08:34Z",
"description": "CustomFieldData Description",
"id": "4376521b-6aa0-4741-8ca1-22d81dbacd22",
"integrationSourceId": "integrationSourceId",
"label": "label",
"lastUpdated": "2025-01-09T05:08:34Z",
"lastUpdatedById": "999f35ea-0e18-428f-88d5-b39c3d212d93",
"objectState": null,
"token": 0,
"type": null,
"value": "value",
"version": "U3dhZ2dlciByb2Nrcw=="
}
],
"expenseAccount": "expenseAccount",
"expenseAccountId": "ead62329-3864-45e1-adcd-7f03034ebd71",
"extra": true,
"flag1": true,
"flag2": true,
"flag3": true,
"id": "0889c5f6-b91f-4c60-b013-73368096e6ec",
"incomeAccount": "incomeAccount",
"incomeAccountId": "509e355a-ba53-4222-b498-89251cb9545e",
"integrationSourceId": "integrationSourceId",
"invoiceId": "2d7cb0d7-886b-453a-88c0-a7446eac5e54",
"invoiceNumber": "invoiceNumber",
"lastUpdated": "2025-01-09T05:08:34Z",
"lastUpdatedById": "e2b8ad4f-3382-43b0-8b10-6bdd541062e6",
"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": "82597f85-fb2f-46db-91f3-3a39f73378ff",
"vendorBillNumber": "vendorBillNumber",
"version": "U3dhZ2dlciByb2Nrcw==",
"workflow": [
{
"actionById": "b247b17b-b07f-4cde-8a4a-69f5d62d8533",
"action": null,
"actionBy": "actionBy",
"createdById": "b53ed1af-7972-493c-832c-55bd7295eb40",
"createdOn": "2025-01-09T05:08:34Z",
"date": "2025-01-09T05:08:34Z",
"id": "33acd361-5073-402a-b550-ef6f0e2ea6ab",
"integrationSourceId": "integrationSourceId",
"lastUpdated": "2025-01-09T05:08:34Z",
"lastUpdatedById": "0132cf59-55e3-451a-8ac7-730e46b8001e",
"memo": "memo",
"objectState": null,
"sendTo": "sendTo",
"sendToId": "e45314e6-1d52-4caa-8dd7-a42828f1206b",
"submitTo": null,
"token": 0,
"type": null,
"version": "U3dhZ2dlciByb2Nrcw=="
}
],
"wudMultiplier": 1,
"wudPercent": 1
}
]
Retrieve a Time Entry
Use this method to retrieve a specific time entry. Pass id as the parameter.
Request URL
Method Overview
HTTP Method:
GET
Content Type:
application/json
Response Format:
json
Requires Authentication?
Yes
Headers:
Module:
Time Entry
Required Scopes:
read:core
Required Subscription:
View Subscription
Request Parameters asterisk denotes required
Name | Parameter Type | Description | Format |
---|---|---|---|
id | Path | Time entry identifier | string |
Response Body
Name | Description | Format |
---|---|---|
activityId | Identifier of an activity for which time is entered | uuid |
date | Date of a time entry in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss | date-time |
description | Description of an activity performed | string |
projectId | Identifier of a project on which activity is performed | uuid |
resourceId | Identifier of an employee or vendor working on a project | uuid |
activity | Name of an activity for which time is entered | string |
actualHours | Actual hours worked on a project | double |
billable | Indicates whether a time entry is billable or not | boolean |
billRate | Rate at which a client is billed for per hour of work done by an employee or a vendor on a project | double |
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 class | string |
classId | Identifier of the class | uuid |
classification | Job classification or title of a timekeeper (employee or vendor) | string |
client | Name of a client associated with the time entry | string |
clientHours | Hours billed or charged to a client for work done on a project | double |
compensationTime | Indicates whether the time entry is marked as compensation time | boolean |
costRate | Value representing the cost to your company for per hour of work done by an employee or a vendor working on a project | double |
createdById | Identifier of the user who created this object | uuid |
createdOn | Date and time when this object was created (UTC Now), in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss | date-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 entry | string |
expenseAccountId | Identifier of an expense account associated with a time entry | uuid |
extra | Indicates whether a time entry is marked as extra or not | boolean |
flag1 | Tracks any characteristic of the time entry. For example, to mark time entries that are tax deductible, you can select this flag for them | boolean |
flag2 | Tracks any characteristic of the time entry. For example, to mark time entries that are tax deductible, you can select this flag for them | boolean |
flag3 | Tracks any characteristic of the time entry. For example, to mark time entries that are tax deductible, you can select this flag for them | boolean |
id | Object identifier | uuid |
incomeAccount | Name of an income account associated with a time entry | string |
incomeAccountId | Identifier of an income account associated with a time entry | uuid |
integrationSourceId | Identifier of the integration source for this object. This property is only used by internal BQE apps and does not have any significance for external users | string |
invoiceId | Identifier of an invoice associated with a time entry | uuid |
invoiceNumber | Invoice number of an invoice associated with a time entry | string |
lastUpdated | Last updated date and time value of this object in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss | date-time |
lastUpdatedById | Identifier of the user who last updated this object | uuid |
memo | Records any extra information or details about a time entry | string |
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 overtime | boolean |
project | Name of a project on which activity is performed | string |
resource | Name of an employee or vendor working on a project | string |
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 started | string |
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 stopped | string |
tax1 | Tax 1 rate used to compute item tax as part of the bill amount | double |
tax2 | Tax 2 rate used to compute item tax as part of the bill amount | double |
tax3 | Tax 3 rate used to compute item tax as part of the bill amount | double |
token | Represents the token for update operations | int32 |
vendorBillId | Identifier of a vendor bill associated with a time entry | uuid |
vendorBillNumber | Vendor bill number associated with a time entry | string |
version | Implements concurrency on this object | byte |
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 |
{
"activityId": "97780de1-de2e-488a-87f9-9e05793f37eb",
"date": "2025-01-09T05:08:34Z",
"description": "TimeEntry Description",
"projectId": "7ca73f76-cefe-4689-9200-937d35a113bf",
"resourceId": "0b77433c-dbd9-41d9-b5b6-babb8ee5b776",
"activity": "activity",
"actualHours": 1,
"billable": true,
"billRate": 1,
"billStatus": null,
"class": "class",
"classId": "4623ae92-4b94-444a-8daa-df95605770cf",
"classification": "classification",
"client": "client",
"clientHours": 1,
"compensationTime": true,
"costRate": 1,
"createdById": "b83ef656-2c2f-4891-b09c-39d9a820995a",
"createdOn": "2025-01-09T05:08:34Z",
"customFields": [
{
"definitionId": "14ffb957-19b9-4c72-a105-465dda5e1e3a",
"createdById": "8d031ba1-841e-4368-bbcd-017728fd4a59",
"createdOn": "2025-01-09T05:08:34Z",
"description": "CustomFieldData Description",
"id": "0c2ed085-4cb0-4208-a31b-ee0c1c6e61ba",
"integrationSourceId": "integrationSourceId",
"label": "label",
"lastUpdated": "2025-01-09T05:08:34Z",
"lastUpdatedById": "8f2dcda4-e6f3-435f-b417-0de37658a762",
"objectState": null,
"token": 0,
"type": null,
"value": "value",
"version": "U3dhZ2dlciByb2Nrcw=="
}
],
"expenseAccount": "expenseAccount",
"expenseAccountId": "b5bb2fcb-e4b3-43d0-ab4b-74151ba95c6e",
"extra": true,
"flag1": true,
"flag2": true,
"flag3": true,
"id": "1974ba77-60fe-45f2-858d-33a766f6dfaa",
"incomeAccount": "incomeAccount",
"incomeAccountId": "fd8de99b-8562-4a88-99df-1daaf504b7a8",
"integrationSourceId": "integrationSourceId",
"invoiceId": "89f5907c-cfc2-4e7c-98c7-ae8affbb19e4",
"invoiceNumber": "invoiceNumber",
"lastUpdated": "2025-01-09T05:08:34Z",
"lastUpdatedById": "af2a3b60-8cb9-4201-aefc-8ced3d0dcd6f",
"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": "89bea103-474d-4a8c-b1ad-bdd7a1b7737c",
"vendorBillNumber": "vendorBillNumber",
"version": "U3dhZ2dlciByb2Nrcw==",
"workflow": [
{
"actionById": "4be08479-b4e7-41dc-927e-d0aeaf454dad",
"action": null,
"actionBy": "actionBy",
"createdById": "480dea82-7be4-49aa-8e9c-1b5b80616f4a",
"createdOn": "2025-01-09T05:08:34Z",
"date": "2025-01-09T05:08:34Z",
"id": "40bcda26-728d-484e-816b-1afcec402ac5",
"integrationSourceId": "integrationSourceId",
"lastUpdated": "2025-01-09T05:08:34Z",
"lastUpdatedById": "4271c4f3-d8f2-4e95-90cd-348e0f9cea06",
"memo": "memo",
"objectState": null,
"sendTo": "sendTo",
"sendToId": "aa543634-f3fb-47c1-baea-7abdd521f952",
"submitTo": null,
"token": 0,
"type": null,
"version": "U3dhZ2dlciByb2Nrcw=="
}
],
"wudMultiplier": 1,
"wudPercent": 1
}
Create a Time Entry
Use this method to save a time entry. Pass TimeEntry as the parameter.
Request URL
Method Overview
HTTP Method:
POST
Content Type:
application/json
Response Format:
json
Requires Authentication?
Yes
Headers:
Module:
Time Entry
Required Scopes:
readwrite:core
Required Subscription:
View Subscription
Request Parameters asterisk denotes required
Name | Parameter Type | Description | Format |
---|---|---|---|
body | Body | Time entry object | TimeEntry |
Response Body
Name | Description | Format |
---|---|---|
activityId | Identifier of an activity for which time is entered | uuid |
date | Date of a time entry in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss | date-time |
description | Description of an activity performed | string |
projectId | Identifier of a project on which activity is performed | uuid |
resourceId | Identifier of an employee or vendor working on a project | uuid |
activity | Name of an activity for which time is entered | string |
actualHours | Actual hours worked on a project | double |
billable | Indicates whether a time entry is billable or not | boolean |
billRate | Rate at which a client is billed for per hour of work done by an employee or a vendor on a project | double |
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 class | string |
classId | Identifier of the class | uuid |
classification | Job classification or title of a timekeeper (employee or vendor) | string |
client | Name of a client associated with the time entry | string |
clientHours | Hours billed or charged to a client for work done on a project | double |
compensationTime | Indicates whether the time entry is marked as compensation time | boolean |
costRate | Value representing the cost to your company for per hour of work done by an employee or a vendor working on a project | double |
createdById | Identifier of the user who created this object | uuid |
createdOn | Date and time when this object was created (UTC Now), in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss | date-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 entry | string |
expenseAccountId | Identifier of an expense account associated with a time entry | uuid |
extra | Indicates whether a time entry is marked as extra or not | boolean |
flag1 | Tracks any characteristic of the time entry. For example, to mark time entries that are tax deductible, you can select this flag for them | boolean |
flag2 | Tracks any characteristic of the time entry. For example, to mark time entries that are tax deductible, you can select this flag for them | boolean |
flag3 | Tracks any characteristic of the time entry. For example, to mark time entries that are tax deductible, you can select this flag for them | boolean |
id | Object identifier | uuid |
incomeAccount | Name of an income account associated with a time entry | string |
incomeAccountId | Identifier of an income account associated with a time entry | uuid |
integrationSourceId | Identifier of the integration source for this object. This property is only used by internal BQE apps and does not have any significance for external users | string |
invoiceId | Identifier of an invoice associated with a time entry | uuid |
invoiceNumber | Invoice number of an invoice associated with a time entry | string |
lastUpdated | Last updated date and time value of this object in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss | date-time |
lastUpdatedById | Identifier of the user who last updated this object | uuid |
memo | Records any extra information or details about a time entry | string |
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 overtime | boolean |
project | Name of a project on which activity is performed | string |
resource | Name of an employee or vendor working on a project | string |
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 started | string |
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 stopped | string |
tax1 | Tax 1 rate used to compute item tax as part of the bill amount | double |
tax2 | Tax 2 rate used to compute item tax as part of the bill amount | double |
tax3 | Tax 3 rate used to compute item tax as part of the bill amount | double |
token | Represents the token for update operations | int32 |
vendorBillId | Identifier of a vendor bill associated with a time entry | uuid |
vendorBillNumber | Vendor bill number associated with a time entry | string |
version | Implements concurrency on this object | byte |
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 |
{
"activityId": "a5ea72ce-8f90-43ff-a315-ea288c747bb3",
"date": "2025-01-09T05:08:34Z",
"description": "TimeEntry Description",
"projectId": "c19e9e33-de1a-4506-8eb1-1dd3c010b0f2",
"resourceId": "e0cffad4-53bf-42d4-98c2-4e0f3529a478",
"activity": "activity",
"actualHours": 1,
"billable": true,
"billRate": 1,
"billStatus": null,
"class": "class",
"classId": "0c801103-5287-4ca7-b41b-58beb1216d4f",
"classification": "classification",
"client": "client",
"clientHours": 1,
"compensationTime": true,
"costRate": 1,
"createdById": "9b515ab9-9248-479c-ab7d-7d2dd95fa88a",
"createdOn": "2025-01-09T05:08:34Z",
"customFields": [
{
"definitionId": "4ce86b1c-1a95-4ab7-b978-c9ec9d753ec7",
"createdById": "7ee1cc80-5ee7-40ee-ad84-77d050028105",
"createdOn": "2025-01-09T05:08:34Z",
"description": "CustomFieldData Description",
"id": "29d7a43c-96cf-4875-9840-25813dd337df",
"integrationSourceId": "integrationSourceId",
"label": "label",
"lastUpdated": "2025-01-09T05:08:34Z",
"lastUpdatedById": "41de91f6-dd74-489a-9259-b015ab542b6e",
"objectState": null,
"token": 0,
"type": null,
"value": "value",
"version": "U3dhZ2dlciByb2Nrcw=="
}
],
"expenseAccount": "expenseAccount",
"expenseAccountId": "dda73773-6f52-4bca-bba1-39fc87957932",
"extra": true,
"flag1": true,
"flag2": true,
"flag3": true,
"id": "4d60eceb-b94f-43c2-b197-dc695d24e124",
"incomeAccount": "incomeAccount",
"incomeAccountId": "4a578da2-c9a2-4f3a-85c3-5020181dc407",
"integrationSourceId": "integrationSourceId",
"invoiceId": "b6bedb26-d680-4794-98d1-d020cdef52e2",
"invoiceNumber": "invoiceNumber",
"lastUpdated": "2025-01-09T05:08:34Z",
"lastUpdatedById": "d8d10430-49c5-4ec8-9b06-7fafe3cbbca6",
"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": "ace7782a-ce8b-4b86-9ec7-88487f00a64a",
"vendorBillNumber": "vendorBillNumber",
"version": "U3dhZ2dlciByb2Nrcw==",
"workflow": [
{
"actionById": "90f0f0d0-8e54-4b39-835e-5340e9300fdd",
"action": null,
"actionBy": "actionBy",
"createdById": "339574ea-d7a5-4a31-9974-683f1241dd7c",
"createdOn": "2025-01-09T05:08:34Z",
"date": "2025-01-09T05:08:34Z",
"id": "635d7aca-a41b-439a-a160-0fbc3ade9556",
"integrationSourceId": "integrationSourceId",
"lastUpdated": "2025-01-09T05:08:34Z",
"lastUpdatedById": "ec66c8cc-9c4e-462d-a0ac-99a7cdb3fc78",
"memo": "memo",
"objectState": null,
"sendTo": "sendTo",
"sendToId": "f639a67e-e79b-459a-9444-388d58e930d3",
"submitTo": null,
"token": 0,
"type": null,
"version": "U3dhZ2dlciByb2Nrcw=="
}
],
"wudMultiplier": 1,
"wudPercent": 1
}
Create a Time Entry List
Use this method to save multiple time entries. Pass model as the parameter.
Request URL
Method Overview
HTTP Method:
POST
Content Type:
application/json
Response Format:
json
Requires Authentication?
Yes
Headers:
Module:
Time Entry
Required Scopes:
readwrite:core
Required Subscription:
View Subscription
Request Parameters asterisk denotes required
Name | Parameter Type | Description | Format |
---|---|---|---|
body | Body | Time entry object | TimeEntryBatchRequest |
Response Body
Name | Description | Format |
---|---|---|
batchSize | Represents the number of entities in a batch | int64 |
createdById | Identifier of the user who created this object | uuid |
createdOn | Date and time when this object was created (UTC Now), in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss | date-time |
id | Object identifier | uuid |
integrationSourceId | Identifier of the integration source for this object. This property is only used by internal BQE apps and does not have any significance for external users | string |
lastUpdated | Last updated date and time value of this object in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss | date-time |
lastUpdatedById | Identifier of the user who last updated this object | uuid |
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 processed | int64 |
status | Represents the status of a job e.g., ready, running, completed, or terminated | string |
token | Represents the token for update operations | int32 |
type | Represents the type of a job e.g., create, update, or delete | string |
version | Implements concurrency on this object | byte |
{
"batchSize": 0,
"createdById": "9662f1bd-a625-4820-9a08-95fc92f47b23",
"createdOn": "2025-01-09T05:08:34Z",
"id": "94b39de8-c52d-4931-a9c9-4e42a2af65e7",
"integrationSourceId": "integrationSourceId",
"lastUpdated": "2025-01-09T05:08:34Z",
"lastUpdatedById": "cf921d3d-d19c-45b6-a700-7d0f867e4243",
"objectState": null,
"progress": 0,
"status": "status",
"token": 0,
"type": "type",
"version": "U3dhZ2dlciByb2Nrcw=="
}
Update a Time Entry
Use this method to update a time entry. Pass TimeEntry as the parameter.
Request URL
Method Overview
HTTP Method:
PUT
Content Type:
application/json
Response Format:
json
Requires Authentication?
Yes
Headers:
Module:
Time Entry
Required Scopes:
readwrite:core
Required Subscription:
View Subscription
Request Parameters asterisk denotes required
Name | Parameter Type | Description | Format |
---|---|---|---|
id | Path | Time entry identifier | string |
body | Body | Time entry object | TimeEntry |
Response Body
Name | Description | Format |
---|---|---|
activityId | Identifier of an activity for which time is entered | uuid |
date | Date of a time entry in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss | date-time |
description | Description of an activity performed | string |
projectId | Identifier of a project on which activity is performed | uuid |
resourceId | Identifier of an employee or vendor working on a project | uuid |
activity | Name of an activity for which time is entered | string |
actualHours | Actual hours worked on a project | double |
billable | Indicates whether a time entry is billable or not | boolean |
billRate | Rate at which a client is billed for per hour of work done by an employee or a vendor on a project | double |
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 class | string |
classId | Identifier of the class | uuid |
classification | Job classification or title of a timekeeper (employee or vendor) | string |
client | Name of a client associated with the time entry | string |
clientHours | Hours billed or charged to a client for work done on a project | double |
compensationTime | Indicates whether the time entry is marked as compensation time | boolean |
costRate | Value representing the cost to your company for per hour of work done by an employee or a vendor working on a project | double |
createdById | Identifier of the user who created this object | uuid |
createdOn | Date and time when this object was created (UTC Now), in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss | date-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 entry | string |
expenseAccountId | Identifier of an expense account associated with a time entry | uuid |
extra | Indicates whether a time entry is marked as extra or not | boolean |
flag1 | Tracks any characteristic of the time entry. For example, to mark time entries that are tax deductible, you can select this flag for them | boolean |
flag2 | Tracks any characteristic of the time entry. For example, to mark time entries that are tax deductible, you can select this flag for them | boolean |
flag3 | Tracks any characteristic of the time entry. For example, to mark time entries that are tax deductible, you can select this flag for them | boolean |
id | Object identifier | uuid |
incomeAccount | Name of an income account associated with a time entry | string |
incomeAccountId | Identifier of an income account associated with a time entry | uuid |
integrationSourceId | Identifier of the integration source for this object. This property is only used by internal BQE apps and does not have any significance for external users | string |
invoiceId | Identifier of an invoice associated with a time entry | uuid |
invoiceNumber | Invoice number of an invoice associated with a time entry | string |
lastUpdated | Last updated date and time value of this object in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss | date-time |
lastUpdatedById | Identifier of the user who last updated this object | uuid |
memo | Records any extra information or details about a time entry | string |
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 overtime | boolean |
project | Name of a project on which activity is performed | string |
resource | Name of an employee or vendor working on a project | string |
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 started | string |
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 stopped | string |
tax1 | Tax 1 rate used to compute item tax as part of the bill amount | double |
tax2 | Tax 2 rate used to compute item tax as part of the bill amount | double |
tax3 | Tax 3 rate used to compute item tax as part of the bill amount | double |
token | Represents the token for update operations | int32 |
vendorBillId | Identifier of a vendor bill associated with a time entry | uuid |
vendorBillNumber | Vendor bill number associated with a time entry | string |
version | Implements concurrency on this object | byte |
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 |
{
"activityId": "1193df21-0c18-4745-a93c-8b2676cd0e1f",
"date": "2025-01-09T05:08:34Z",
"description": "TimeEntry Description",
"projectId": "ad45bb78-4961-4683-9d78-552f8b692ad6",
"resourceId": "cad93b16-58f8-4ca1-95a8-e5fea6f61d70",
"activity": "activity",
"actualHours": 1,
"billable": true,
"billRate": 1,
"billStatus": null,
"class": "class",
"classId": "e5f3614c-0d14-4f84-a0a6-0d52798ad06f",
"classification": "classification",
"client": "client",
"clientHours": 1,
"compensationTime": true,
"costRate": 1,
"createdById": "05a7e569-446d-48d7-a31b-6d8839dfa421",
"createdOn": "2025-01-09T05:08:34Z",
"customFields": [
{
"definitionId": "0039d20c-16a9-4d88-a4c4-db416161e528",
"createdById": "1458eafd-87f5-45a3-9330-79d698c2b566",
"createdOn": "2025-01-09T05:08:34Z",
"description": "CustomFieldData Description",
"id": "623eca46-addf-4b74-9a55-63b377b127d7",
"integrationSourceId": "integrationSourceId",
"label": "label",
"lastUpdated": "2025-01-09T05:08:34Z",
"lastUpdatedById": "47fd67a9-e88a-4756-90fc-8dd8307bae12",
"objectState": null,
"token": 0,
"type": null,
"value": "value",
"version": "U3dhZ2dlciByb2Nrcw=="
}
],
"expenseAccount": "expenseAccount",
"expenseAccountId": "46178159-675b-4ef2-a418-dc6d3971d337",
"extra": true,
"flag1": true,
"flag2": true,
"flag3": true,
"id": "a43c6575-3e14-42e9-bd06-d70e19c54597",
"incomeAccount": "incomeAccount",
"incomeAccountId": "362972ac-00a4-476d-9ae1-4b7fafb162c6",
"integrationSourceId": "integrationSourceId",
"invoiceId": "9fd4c685-2017-4ab9-ab7a-0d9e9f7d536a",
"invoiceNumber": "invoiceNumber",
"lastUpdated": "2025-01-09T05:08:34Z",
"lastUpdatedById": "308a6e31-38a8-4b89-a207-9205d07dddb0",
"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": "ae0cfac8-04dd-448f-a043-138fb439bd32",
"vendorBillNumber": "vendorBillNumber",
"version": "U3dhZ2dlciByb2Nrcw==",
"workflow": [
{
"actionById": "5e7fcd6a-56a6-43bf-b667-745b0eb174eb",
"action": null,
"actionBy": "actionBy",
"createdById": "aea825a8-ae57-4f03-b38b-efd28627e0d4",
"createdOn": "2025-01-09T05:08:34Z",
"date": "2025-01-09T05:08:34Z",
"id": "7646b991-fb4d-4175-8bae-086fa9feb038",
"integrationSourceId": "integrationSourceId",
"lastUpdated": "2025-01-09T05:08:34Z",
"lastUpdatedById": "b0a08330-47b2-475a-80eb-c20500dc0404",
"memo": "memo",
"objectState": null,
"sendTo": "sendTo",
"sendToId": "3ddb486e-298d-475f-aa91-9599c30493c0",
"submitTo": null,
"token": 0,
"type": null,
"version": "U3dhZ2dlciByb2Nrcw=="
}
],
"wudMultiplier": 1,
"wudPercent": 1
}
Delete a Time Entry
Use this method to delete a time entry. Pass id as the parameter.
Request URL
Method Overview
HTTP Method:
DELETE
Content Type:
application/json
Response Format:
N/A
Requires Authentication?
Yes
Headers:
Required Scopes:
readwrite:core
Required Subscription:
View Subscription
Request Parameters asterisk denotes required
Name | Parameter Type | Description | Format |
---|---|---|---|
id | Path | Time entry identifier | string |
Patch a Time Entry
Use this method to perform partial modifications to a time entry. Pass id and patch document as parameters.
Request URL
Method Overview
HTTP Method:
PATCH
Content Type:
application/json
Response Format:
json
Requires Authentication?
Yes
Headers:
Module:
Time Entry
Required Scopes:
readwrite:core
Required Subscription:
View Subscription
Request Parameters asterisk denotes required
Name | Parameter Type | Description | Format |
---|---|---|---|
id | Path | Time entry identifier | string |
body | Body | A document containing an array of objects with each object representing a single operation | TimeEntryPatchDocument |
Response Body
Name | Description | Format |
---|