GET
/
quickbooks-desktop
/
time-tracking-activities
/
{id}
import Conductor from 'conductor-node';

const client = new Conductor({
  apiKey: process.env['CONDUCTOR_SECRET_KEY'], // This is the default and can be omitted
});

async function main() {
  const timeTrackingActivity = await client.qbd.timeTrackingActivities.retrieve('123ABC-1234567890', {
    conductorEndUserId: 'end_usr_1234567abcdefg',
  });

  console.log(timeTrackingActivity.id);
}

main();
{
  "id": "123ABC-1234567890",
  "objectType": "qbd_time_tracking_activity",
  "createdAt": "2021-10-01T17:34:56.000Z",
  "updatedAt": "2021-10-01T20:45:30.000Z",
  "revisionNumber": "1721172183",
  "transactionDate": "2021-10-01T00:00:00.000Z",
  "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",
  "isBilled": false
}

Authorizations

​
Authorization
string
header
required

Your Conductor secret key using Bearer auth (e.g., "Authorization: Bearer {{YOUR_SECRET_KEY}}").

Headers

​
Conductor-End-User-Id
string
required

The ID of the EndUser to receive this request (e.g., "Conductor-End-User-Id: {{END_USER_ID}}").

Path Parameters

​
id
string
required

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

Response

200 - application/json
Returns the specified time tracking activity.
​
id
string
required

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

​
objectType
string
required

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

Allowed value: "qbd_time_tracking_activity"
​
createdAt
string
required

The date and time when this time tracking activity was created, in ISO 8601 format (YYYY-MM-DDThh:mm:ss±hh:mm). The time zone is the same as the user's time zone in QuickBooks.

​
updatedAt
string
required

The date and time when this time tracking activity was last updated, in ISO 8601 format (YYYY-MM-DDThh:mm:ss±hh:mm). The time zone is the same as the user's time zone in QuickBooks.

​
revisionNumber
string
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.

​
transactionDate
string
required

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

​
entity
object
required

The employee, vendor, or person on QuickBooks's “Other Names” list whose time is being tracked in this time tracking activity. This cannot refer to a customer - use the customer field to associate a customer or customer-job with this time tracking activity.

​
customer
object | null
required

The customer or customer-job to which this time could be billed. If billingStatus is set to "billable", this field is required.

​
serviceItem
object | null
required

The type of service performed during this time tracking activity, referring to billable or purchasable services such as specialized labor, consulting hours, and professional fees.

NOTE: This field is not required if no customer is specified. However, if billingStatus is set to "billable", both this field and customer are required.

​
duration
string
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.

​
class
object | null
required

The time tracking activity's class. Classes can be used to categorize objects into meaningful segments, such as department, location, or type of work. In QuickBooks, class tracking is off by default.

​
payrollWageItem
object | null
required

The payroll wage item (e.g., Regular Pay, Overtime Pay) to use for this time tracking activity. This field can only be used for time tracking if: (1) the person specified in entity is an employee in QuickBooks, and (2) the "Use time data to create paychecks" preference is enabled in their payroll settings.

​
note
string | null
required

A note or comment about this time tracking activity.

​
billingStatus
enum<string> | null
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.

Available options:
billable,
has_been_billed,
not_billable
​
externalId
string | null
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.

​
isBilled
boolean | null
required

Indicates whether this time tracking activity has been billed.

Update a time tracking activityList all time tracking activities