COconductor-is

Retrieve a time tracking activity

Changed on

Retrieves a time tracking activity by ID.

IMPORTANT: If you need to fetch multiple specific time tracking activities by ID, use the list endpoint instead with the ids parameter. It accepts an array of IDs so you can batch the request into a single call, which is significantly faster.

get/quickbooks-desktop/time-tracking-activities/{id}

Request

Path parameters

idstring required

The QuickBooks-assigned unique identifier of the time tracking activity to retrieve.

Example:123ABC-1234567890

Headers

Conductor-End-User-Idstring required

The ID of the End-User to receive this request.

Example:end_usr_1234567abcdefg

Response

Returns the specified time tracking activity.

idstring required

The unique identifier assigned by QuickBooks to this time tracking activity. This ID is unique across all transaction types.

objectType'qbd_time_tracking_activity' required

The type of object. This value is always "qbd_time_tracking_activity".

createdAtstring required

The date and time when this time tracking activity was created, in ISO 8601 format (YYYY-MM-DDThh:mm:ss±hh:mm), which QuickBooks Desktop interprets in the local timezone of the end-user's computer.

updatedAtstring required

The date and time when this time tracking activity was last updated, in ISO 8601 format (YYYY-MM-DDThh:mm:ss±hh:mm), which QuickBooks Desktop interprets in the local timezone of the end-user's computer.

revisionNumberstring required

The current QuickBooks-assigned revision number of this time tracking activity object, which changes each time the object is modified. When updating this object, you must provide the most recent revisionNumber to ensure you're working with the latest data; otherwise, the update will return an error.

transactionDatestring date required

The date of this time tracking activity, in ISO 8601 format (YYYY-MM-DD).

durationstring required

The time spent performing the service during this time tracking activity, in ISO 8601 format for time intervals (PTnHnMnS). For example, 1 hour and 30 minutes is represented as PT1H30M.

NOTE: Although seconds can be specified when creating a time tracking activity, they are not returned in responses since QuickBooks Desktop's UI does not display seconds.

IMPORTANT: This field is required for updating time tracking activities, even if the field is not being modified, because of a bug in QuickBooks itself.

notestring nullable required

A note or comment about this time tracking activity.

billingStatus'billable' | 'has_been_billed' | 'not_billable' nullable required

The billing status of this time tracking activity.

IMPORTANT: When this field is set to "billable" for time tracking activities, both customer and serviceItem are required so that an invoice can be created.

externalIdstring nullable required

A globally unique identifier (GUID) you, the developer, can provide for tracking this object in your external system. This field is immutable and can only be set during object creation.

isBilledboolean nullable required

Indicates whether this time tracking activity has been billed.

Example response

{
  "id": "123ABC-1234567890",
  "objectType": "qbd_time_tracking_activity",
  "createdAt": "2025-01-01T12:34:56+00:00",
  "updatedAt": "2025-02-01T12:34:56+00:00",
  "revisionNumber": "1721172183",
  "transactionDate": "2024-10-01",
  "entity": {
    "id": "80000001-1234567890",
    "fullName": "Acme Corporation"
  },
  "customer": {
    "id": "80000001-1234567890",
    "fullName": "Acme Corporation"
  },
  "serviceItem": {
    "id": "80000001-1234567890",
    "fullName": "Legal Consulting"
  },
  "duration": "PT1H30M",
  "class": {
    "id": "80000001-1234567890",
    "fullName": "Project Management"
  },
  "payrollWageItem": {
    "id": "80000001-1234567890",
    "fullName": "Regular Pay"
  },
  "note": "Project planning meeting with client.",
  "billingStatus": "billable",
  "externalId": "12345678-abcd-1234-abcd-1234567890ab"
}

Changes

  • 1de07095c4b7Revision changes
    • warning

      for the path request parameter id, the maxLength was set to 36

  • 10d4e9ebd1dfRevision changes
    • breaking

      response property billingStatus list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property entity/fullName list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property entity/id list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property externalId list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property isBilled list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property note list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      the response's property type changed from object null to no type for status

    • breaking

      the response's property type changed from object null to no type for status

    • breaking

      the response's property type changed from object null to no type for status

    • breaking

      the response's property type changed from object null to no type for status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • info

      added subschema #1 subschema #2 to the response property anyOf list for the response status

    • info

      added subschema #1 subschema #2 to the response property anyOf list for the response status

    • info

      added subschema #1 subschema #2 to the response property anyOf list for the response status

    • info

      added subschema #1 subschema #2 to the response property anyOf list for the response status

    • info

      removed the billable enum value from the response property for the response status

    • info

      removed the has_been_billed enum value from the response property for the response status

    • info

      removed the not_billable enum value from the response property for the response status

    • info

      removed the undefined enum value from the response property for the response status