QuickBooks: Read a timeactivity object — response body — Time Activity
Read a timeactivity object: response body, field TimeActivity. Complete fields and constraints for contract 2026-10-20.
API reference · Contract 2026-10-20
SDK schema: Read a timeactivity object — response body — Time Activity
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
BillableStatus | string | Optional | Billable status of the time recorded. This field is not updatable through an API request. The value automatically changes when an invoice is created. Valid values: Billable , NotBillable , HasBeenBilled . You cannot directly update the status to HasBeenBilled . To set the status to HasBeenBilled , create an Invoice object and attach this TimeActivity object as a linked transaction to that Invoice. Read only: true |
ClassRef | Model | Optional | Expand Read an item — response body — Item Class Ref Reference to the Class associated with this object. Available if Preferences.AccountingInfoPrefs.ClassTrackingPerTxn is set to true . Query the Class name list resource to determine the appropriate Class object for this reference. Use Class.Id and Class.Name from that object for ClassRef.value and ClassRef.name , respectively. |
CostRate | JSON | Optional | Pay rate of the employee or vendor for this time activity. Decimal string |
CostRate (anyOf 1) | JSON | Alternative | |
CostRate (anyOf 1) (anyOf 1) | number | Alternative | |
CostRate (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
CostRate (anyOf 2) | string | Alternative | |
CustomerRef | Model | Optional | Expand Read an item — response body — Item Class Ref Reference to a customer or job. Query the Customer name list resource to determine the appropriate Customer object for this reference. Use Customer.Id and Customer.DisplayName from that object for CustomerRef.value and CustomerRef.name , respectively. Required if BillableStatus is set to Billable Conditionally required |
DepartmentRef | Model | Optional | Expand Read an item — response body — Item Class Ref A reference to a Department object specifying the location of this object. Available if Preferences.AccountingInfoPrefs.TrackDepartments is set to true . Query the Department name list resource to determine the appropriate department object for this reference. Use Department.Id and Department.Name from that object for DepartmentRef.value and DepartmentRef.name , respectively. |
Description | string | Optional | Description of work completed during time activity. |
EmployeeRef | Model | Optional | Expand Read an item — response body — Item Class Ref Specifies the employee whose time is being recorded. Query the Employee name list resource to determine the appropriate Employee object for this reference. Use Employee.Id and Employee.DisplayName from that object for EmployeerRef.value and EmployeeRef.Name , respectively. Required if NameOf is set to Employee Conditionally required |
EndTime | string | Optional | Time that work starts and ends, respectively. Required if Hours and Minutes not specified. Note: Kindly consider only the Hours without including the timeZone offset as it does not impact time activity hours calculation. Conditionally required |
HourlyRate | JSON | Optional | Hourly bill rate of the employee or vendor for this time activity. Required if BillableStatus is set to Billable Conditionally required Decimal string |
HourlyRate (anyOf 1) | JSON | Alternative | |
HourlyRate (anyOf 1) (anyOf 1) | number | Alternative | |
HourlyRate (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
HourlyRate (anyOf 2) | string | Alternative | |
Hours | JSON | Optional | Hours and minutes worked. Required if StartTime and EndTime not specified Conditionally required |
Hours (anyOf 1) | JSON | Alternative | |
Hours (anyOf 1) (anyOf 1) | integer | Alternative | |
Hours (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Hours (anyOf 2) | string | Alternative | |
Id | string | Optional | Unique identifier for this object. Read only: true |
ItemRef | Model | Optional | Expand Read an item — response body — Item Class Ref Reference to the service item associated with this object. Query the Item name list resource, where Item.Type is set to Service , to determine the appropriate Item object for this reference. Use Item.Id and Item.Name from that object for ItemRef.value and ItemRef.name , respectively. For France locales: The account associated with the referenced Item object is looked up in the account category list. If this account has same location as specified in the transaction by the TransactionLocationType attribute and the same VAT as in the line item TaxCodeRef attribute, then the item account is used. If there is a mismatch, then the account from the account category list that matches the transaction location and VAT is used. If this account is not present in the account category list, then a new account is created with the new location, new VAT code, and all other attributes as in the default account. |
MetaData | Model | Optional | Expand Read a bill — response body — Bill Meta Data Descriptive information about the object. The MetaData values are set by Data Services and are read only for all applications. |
NameOf | string | Optional | Enumeration of time activity types. Required in conjunction with either EmployeeRef or VendorRef attributes for create operations. Valid values: Vendor or Employee . |
PayrollItemRef | Model | Optional | Expand Read an item — response body — Item Class Ref Specifies how much the employee should be paid for doing the work specified by the Compensation Id. Query the EmployeeCompensation resource to determine the appropriate PayrollCompensation object for an employee. Use EmployeeCompensation.Id and EmployerCompensation.Name from that object for PayrollItemRef.value and PayrollItemRef.name , respectively. This field is available as part of the Payroll Compensation resource in the Workforce API. Read more about the Payroll Compensation resource , available to Silver, Gold, and Platinum partners. |
ProjectRef | Model | Optional | Expand Read an item — response body — Item Class Ref Reference to the Project ID associated with this transaction. Conditionally required |
StartTime | string | Optional | Time that work starts and ends, respectively. Required if Hours and Minutes not specified. Note: Kindly consider only the Hours without including the timeZone offset as it does not impact time activity hours calculation. Conditionally required |
SyncToken | string | Optional | Version number of the object. It is used to lock an object for use by one app at a time. As soon as an application modifies an object, its SyncToken is incremented. Attempts to modify an object specifying an older SyncToken fails. Only the latest version of the object is maintained by QuickBooks Online. Read only: true |
Taxable | JSON | Optional | True if the time recorded is both billable and taxable. |
Taxable (anyOf 1) | boolean | Alternative | |
Taxable (anyOf 2) | string | Alternative | Known values: true, false |
TxnDate | string | Optional | The date for the time activity. This is the posting date that affects financial statements. If the date is not supplied, the current date on the server is used. Sort order is ASC by default. If you provide the StartTime and EndTime without including the timeZone offset, then you would need to pass the TxnDate for any historical or future dates. Lets say if you want to create a historical time activity then pass the TxnDate as the date and pass StartTime and EndTime as Hours without including the timeZone offset. Conditionally required |
VendorRef | Model | Optional | Expand Read an item — response body — Item Class Ref Specifies the vendor whose time is being recorded. Query the Vendor name list resource to determine the appropriate Vendor object for this reference. Use Vendor.Id and Vendor.Name from that object for VendorRef.value and VendorRef.name , respectively. Required if NameOf is set to Vendor Conditionally required |
Minutes | JSON | Optional | Hours and minutes worked. Required if StartTime and EndTime not specified Conditionally required |
Minutes (anyOf 1) | JSON | Alternative | |
Minutes (anyOf 1) (anyOf 1) | integer | Alternative | |
Minutes (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Minutes (anyOf 2) | string | Alternative | |
BreakHours | JSON | Optional | Hours and minutes of break taken between StartTime and EndTime . use when StartTime and EndTime are specified Conditionally required |
BreakHours (anyOf 1) | JSON | Alternative | |
BreakHours (anyOf 1) (anyOf 1) | integer | Alternative | |
BreakHours (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
BreakHours (anyOf 2) | string | Alternative | |
BreakMinutes | JSON | Optional | Hours and minutes of break taken between StartTime and EndTime . use when StartTime and EndTime are specified Conditionally required |
BreakMinutes (anyOf 1) | JSON | Alternative | |
BreakMinutes (anyOf 1) (anyOf 1) | integer | Alternative | |
BreakMinutes (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
BreakMinutes (anyOf 2) | string | Alternative |
Referenced models: Read a bill — response body — Bill Meta Data, Read an item — response body — Item Class Ref