Sign in

Create a time tracking activity

Creates a new time tracking activity.

post/quickbooks-desktop/time-tracking-activities

Headers

Conductor-End-User-Idstring required

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

Example:end_usr_1234567abcdefg

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

Request body

transactionDatestring date required

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

entityIdstring 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.

customerIdstring

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

serviceItemIdstring

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.

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.

Must use QuickBooks Desktop's ISO 8601 time interval format (for example, "PT1H30M" represents 1 hour and 30 minutes).

classIdstring

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.

payrollWageItemIdstring

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.

notestring

A note or comment about this time tracking activity.

billingStatus'billable' | 'has_been_billed' | 'not_billable'

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 uuid

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.

IMPORTANT: This field must be formatted as a valid GUID; otherwise, QuickBooks will return an error.

Example request

{
  "transactionDate": "2024-10-01",
  "entityId": "80000001-1234567890",
  "customerId": "80000001-1234567890",
  "serviceItemId": "80000001-1234567890",
  "duration": "PT1H30M",
  "classId": "80000001-1234567890",
  "payrollWageItemId": "80000001-1234567890",
  "note": "Project planning meeting with client.",
  "billingStatus": "billable",
  "externalId": "12345678-abcd-1234-abcd-1234567890ab"
}

Response

Returns the newly created 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

Changed in 4 of the 46 revisions of this API.52938

  • 1de07095c4b75See the full diff
    • ●

      the classId request property's maxLength was set to 36

      request-property-max-length-set

    • ●

      the customerId request property's maxLength was set to 36

      request-property-max-length-set

    • ●

      the entityId request property's maxLength was set to 36

      request-property-max-length-set

    • ●

      the payrollWageItemId request property's maxLength was set to 36

      request-property-max-length-set

    • ●

      the serviceItemId request property's maxLength was set to 36

      request-property-max-length-set

  • 10d4e9ebd1df188See the full diff
    • ▲

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

      response-property-list-of-types-widened

    • ▲

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

      response-property-list-of-types-widened

    • ▲

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

      response-property-list-of-types-widened

    • ▲

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

      response-property-list-of-types-widened

    • ▲

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

      response-property-list-of-types-widened

    • ▲

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

      response-property-list-of-types-widened

    • ▲

      the class response's property type/format changed from object null/ to / for status 200

      response-property-type-changed

    • ▲

      the customer response's property type/format changed from object null/ to / for status 200

      response-property-type-changed

    • ▲

      the payrollWageItem response's property type/format changed from object null/ to / for status 200

      response-property-type-changed

    • ▲

      the serviceItem response's property type/format changed from object null/ to / for status 200

      response-property-type-changed

    • ▲

      removed the required property class/fullName from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property class/id from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property customer/fullName from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property customer/id from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property payrollWageItem/fullName from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property payrollWageItem/id from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property serviceItem/fullName from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property serviceItem/id from the response with the 200 status

      response-required-property-removed

    • ○

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

      response-property-any-of-added

    • ○

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

      response-property-any-of-added

    • ○

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

      response-property-any-of-added

    • ○

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

      response-property-any-of-added

    • ○

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

      response-property-enum-value-removed

    • ○

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

      response-property-enum-value-removed

    • ○

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

      response-property-enum-value-removed

    • ○

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

      response-property-enum-value-removed

  • 8e0b7df2044d14421See the full diff
    • ▲

      the response property billingStatus became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property class became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property customer became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property entity/fullName became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property entity/id became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property externalId became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property isBilled became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property note became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property payrollWageItem became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property serviceItem became nullable for the status 200

      response-property-became-nullable

    • ▲

      the class response's property type/format changed from / to object null/ for status 200

      response-property-type-changed

    • ▲

      the customer response's property type/format changed from / to object null/ for status 200

      response-property-type-changed

    • ▲

      the payrollWageItem response's property type/format changed from / to object null/ for status 200

      response-property-type-changed

    • ▲

      the serviceItem response's property type/format changed from / to object null/ for status 200

      response-property-type-changed

    • ●

      added the new billable enum value to the billingStatus response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new has_been_billed enum value to the billingStatus response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new not_billable enum value to the billingStatus response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new undefined enum value to the billingStatus response property for the response status 200

      response-property-enum-value-added

    • ○

      removed the pattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$ from the request property transactionDate

      request-property-pattern-removed

    • ○

      removed the pattern ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ from the request property externalId

      request-property-pattern-removed

    • ○

      removed subschema #1 subschema #2 from the class response property anyOf list for the response status 200

      response-property-any-of-removed

    • ○

      removed subschema #1 subschema #2 from the customer response property anyOf list for the response status 200

      response-property-any-of-removed

    • ○

      removed subschema #1 subschema #2 from the payrollWageItem response property anyOf list for the response status 200

      response-property-any-of-removed

    • ○

      removed subschema #1 subschema #2 from the serviceItem response property anyOf list for the response status 200

      response-property-any-of-removed

    • ○

      response property billingStatus list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • ○

      response property entity/fullName list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • ○

      response property entity/id list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • ○

      response property externalId list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • ○

      response property isBilled list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • ○

      response property note list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • ○

      the transactionDate response's property pattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$ was removed for the status 200

      response-property-pattern-removed

    • ○

      added the required property class/fullName to the response with the 200 status

      response-required-property-added

    • ○

      added the required property class/id to the response with the 200 status

      response-required-property-added

    • ○

      added the required property customer/fullName to the response with the 200 status

      response-required-property-added

    • ○

      added the required property customer/id to the response with the 200 status

      response-required-property-added

    • ○

      added the required property payrollWageItem/fullName to the response with the 200 status

      response-required-property-added

    • ○

      added the required property payrollWageItem/id to the response with the 200 status

      response-required-property-added

    • ○

      added the required property serviceItem/fullName to the response with the 200 status

      response-required-property-added

    • ○

      added the required property serviceItem/id to the response with the 200 status

      response-required-property-added

  • 5f832f695675209See the full diff
    • ▲

      added the pattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$ to the request property transactionDate

      request-property-pattern-added

    • ▲

      added the pattern ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ to the request property externalId

      request-property-pattern-added

    • ▲

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

      response-property-list-of-types-widened

    • ▲

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

      response-property-list-of-types-widened

    • ▲

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

      response-property-list-of-types-widened

    • ▲

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

      response-property-list-of-types-widened

    • ▲

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

      response-property-list-of-types-widened

    • ▲

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

      response-property-list-of-types-widened

    • ▲

      the class response's property type/format changed from object null/ to / for status 200

      response-property-type-changed

    • ▲

      the customer response's property type/format changed from object null/ to / for status 200

      response-property-type-changed

    • ▲

      the payrollWageItem response's property type/format changed from object null/ to / for status 200

      response-property-type-changed

    • ▲

      the serviceItem response's property type/format changed from object null/ to / for status 200

      response-property-type-changed

    • ▲

      removed the required property class/fullName from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property class/id from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property customer/fullName from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property customer/id from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property payrollWageItem/fullName from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property payrollWageItem/id from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property serviceItem/fullName from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property serviceItem/id from the response with the 200 status

      response-required-property-removed

    • ○

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

      response-property-any-of-added

    • ○

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

      response-property-any-of-added

    • ○

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

      response-property-any-of-added

    • ○

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

      response-property-any-of-added

    • ○

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

      response-property-enum-value-removed

    • ○

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

      response-property-enum-value-removed

    • ○

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

      response-property-enum-value-removed

    • ○

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

      response-property-enum-value-removed

    • ○

      the transactionDate response's property pattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$ was added for the status 200

      response-property-pattern-added