Getting Started

This page provides a guide to Establishing a Connection to QuickBooks Time in CData Cloud, as well as information on the available resources, and a reference to the available connection properties.

Connecting to QuickBooks Time

Establishing a Connection shows how to authenticate to QuickBooks Time and configure any necessary connection properties to create a database in CData Cloud

Accessing Data from CData Cloud Services

Accessing data from QuickBooks Time through the available standard services and CData Cloud administration is documented in further details in the CData Cloud Documentation.

Establishing a Connection

Connect to QuickBooks Time by selecting the corresponding icon in the Database tab. Required properties are listed under Settings. The Advanced tab lists connection properties that are not typically required.

Connecting to QuickBooks Time

QuickBooks Time supports the OAuth standard for user authentication. To enable this authentication from all OAuth flows, you must create a custom OAuth application, and set AuthScheme to OAuth.

The following subsections describe how to authenticate to QuickBooks Time from three common authentication flows:

Desktop: a connection to a server on the user's local machine, frequently used for testing and prototyping.
Web: access to data via a shared website.
Headless Server: a dedicated computer that provides services to other computers and their users, which is configured to operate without a monitor and keyboard.

For information about how to create a custom OAuth application, see Creating a Custom OAuth Application.

For a complete list of connection string properties available in QuickBooks Time, see Connection.

Automatic refresh of the OAuth access token:

To have the Cloud automatically refresh the OAuth access token:

Before connecting to data for the first time, set these connection parameters:
- InitiateOAuth: REFRESH.
- OAuthClientId: The client Id in your application settings.
- OAuthClientSecret: The client secret in your application settings.
- OAuthAccessToken: The access token returned by GetOAuthAccessToken.
- OAuthSettingsLocation: The path where you want the Cloud to save the OAuth values, which persist across connections.
On subsequent data connections, set:
- InitiateOAuth
- OAuthSettingsLocation

Manual refresh of the OAuth access token:

The only value needed to manually refresh the OAuth access token is the OAuth refresh token.

To manually refresh the OAuthAccessToken after the ExpiresIn period (returned by GetOAuthAccessToken) has elapsed, call the RefreshOAuthAccessToken stored procedure.
Set these connection properties:
- OAuthClientId: The Client Id in your application settings.
- OAuthClientSecret: The Client Secret in your application settings.
Call RefreshOAuthAccessToken with OAuthRefreshToken set to the OAuth refresh token returned by GetOAuthAccessToken.
After the new tokens have been retrieved, set the OAuthAccessToken property to the value returned by RefreshOAuthAccessToken. This opens a new connection.

Store the OAuth refresh token so that you can use it to manually refresh the OAuth access token after it has expired.

Creating a Custom OAuth Application

Creating a custom OAuth application enables you to generate OAuth credentials that are passed during user authentication.

Procedure

Log in to your QuickBooks Time Account.
At the left navigation pane, select Feature Add-ons > Manage Add-ons.
Select API Add-On.
Click Install.
Select Add a new application at bottom left. If a followup window does not display, return to the left navigation pane's Feature Add-ons area and select API.
Enter a short name and a meaningful description for the new application.
Set the Redirect URL to http://localhost:33333 (the Cloud's default) OR set a different port of your choice.
Record this value; you will supply it as the CallbackURL.
Click Save. The admin tool generates the OAuth Client Id and Client Secret.
Record these values for future use.
(Optional:) If you want to generate your access token now and connect with InitiateOAuth set to OFF, click Add Token at the bottom left portion of the display. This generates a token for immediate use.

You can access the custom OAuth application (referred to as the API Add-On) from the left navigation pane's Feature Add-ons section.

SSL Configuration

Customizing the SSL Configuration

By default, the Cloud attempts to negotiate TLS with the server. The server certificate is validated against the default system trusted certificate store. You can override how the certificate gets validated using the SSLServerCert connection property.

To specify another certificate, see the SSLServerCert connection property.

Firewall and Proxy

Connecting Through a Firewall or Proxy

HTTP Proxies

To authenticate to an HTTP proxy, set the following:

ProxyServer: the hostname or IP address of the proxy server that you want to route HTTP traffic through.
ProxyPort: the TCP port that the proxy server is running on.
ProxyAuthScheme: the authentication method the Cloud uses when authenticating to the proxy server.
ProxyUser: the username of a user account registered with the proxy server.
ProxyPassword: the password associated with the ProxyUser.

Other Proxies

Set the following properties:

To use a proxy-based firewall, set FirewallType, FirewallServer, and FirewallPort.
To tunnel the connection, set FirewallType to TUNNEL.
To authenticate, specify FirewallUser and FirewallPassword.
To authenticate to a SOCKS proxy, additionally set FirewallType to SOCKS5.

Data Model

Overview

This section shows the available API objects and provides more information on executing SQL to QuickBooks Time APIs.

Key Features

The Cloud models QuickBooks Time entities like documents, folders, and groups as relational views, allowing you to write SQL to query QuickBooks Time data.
Stored procedures allow you to execute operations to QuickBooks Time
Live connectivity to these objects means any changes to your QuickBooks Time account are immediately reflected when using the Cloud.

Views

Views describes the available views. Views are statically defined to model Timesheets, Users, Files, and more.

Tables

The Cloud models the data in QuickBooks Time as a list of tables in a relational database that can be queried using standard SQL statements.

CData Cloud - QuickBooks Time Tables


Name	Description
CustomFieldItemFilters	Create, Update and Query the Custom Field Item Filters in QuickBooks Time.
CustomFieldItems	Create, Update and Query the Custom Field Items in QuickBooks Time.
CustomFields	Create, Update and Query the Custom Fields in QuickBooks Time.
EstimateItems	Create, Update and Query the Estimate Item in QuickBooks Time.
Estimates	Create, Update and Query the Estimates in QuickBooks Time.
Files	This table contains a list of file objects.
GeoLocations	Retrieves a list of all geofence configs.
Groups	This table contains a list of all groups associated with your company.
JobcodeAssignments	Returns a list of all jobcode assignments associated with users.
JobCodes	This table contains a list of jobcodes associated with your company
Locations	Retrieves a list of all locations associated with your company.
Notifications	Retrieves a list of notifications associated with your company.
ProjectActivityReplies	Create, Update and Query the Project Activity Replies in QuickBooks Time.
ProjectNotes	Create, Update and Query the Project Notes in QuickBooks Time.
Projects	Create, Update and Query the Projects in QuickBooks Time.
Reminders	Retrieves a list of reminders associated with your employees or company.
ScheduleEvents	Retrieves a list of schedule events associated with your employees or company.
TimeOffRequestEntries	Create, Update and Query the Time off Request Entries in QuickBooks Time.
TimeOffRequests	Create, Update and Query the Time off Requests in QuickBooks Time.
Timesheets	This table contains a list of file objects.
Users	Retrieves a list of all users associated with your company.

CustomFieldItemFilters

Create, Update and Query the Custom Field Item Filters in QuickBooks Time.

Table Specific Information

Select

The Cloud uses the QuickBooks Time API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the Cloud.

Id supports the =, IN operators.
Active supports the = operator.
JobCodeId supports the = operator.
UserId supports the = operator.
LastModified supports the <, <=, >, >= operators.
GroupId supports the = operator.
IncludeUserGroup supports the = operator.
IncludeJobCodeFilters supports the = operator.
SupplementalData supports the = operator.

For example, the following queries are processed server-side:

SELECT * FROM CustomFieldItemFilters
SELECT * FROM CustomFieldItemFilters WHERE Id = 11531340

Insert

When executing INSERT queries, specify the CustomFieldId, CustomFieldItemId, Active, AppliesTo, and AppliesToId columns. The columns that are not required can be inserted optionally. The following is an example of how to insert into this table:

INSERT INTO CustomFieldItemFilters (CustomFieldId, Name, ShortCode) VALUES (1140610, 15027812, true, 'jobcodes', 73209298)

Update

When executing Updates, specify the Id in the WHERE clause.

For example:

UPDATE CustomFieldItemFilters SET Active = true WHERE Id = '15011650'

Columns


Name	Type	ReadOnly	Description
Id [KEY]	Integer	True	Id of the CustomField Item filter.
CustomFieldId	Integer	False	Id of the CustomField that this filter belongs to.
CustomFieldItemId	Integer	False	Id of the CustomField item that this filter belongs to.
Active	Boolean	False	Boolean value. If true, the custom field item filter is active and if false, the custom field item filter is archive.
AppliesTo	String	False	Entity type this filter relates to. Together with applies_to_id, determines what this filtered item relates to. The possible values are: 'jobcodes', 'users', or 'groups'. For example: If this value was 'jobcodes' then the applies_to_id value would indicate which jobcode this filter referred to. If requested, the supplemental data will also contain this jobcode.
AppliesToId	Integer	False	The jobcode, user, or group that this filter relates to. Together with applies_to, determines what this filtered item relates to. For example: If the value of the applies_to field was 'jobcodes' this value would indicate which jobcode this filter referred to. If requested, the supplemental data will also contain this jobcode.
LastModified	Datetime	True	Date/time when this custom field item filter was last modified.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
JobCodeId	Integer	Limits the returned filters to only those for the specified jobcode_id.
UserId	Integer	Limits the returned filters to only those for the specified user_id. You can also include items for this user's group automatically if you include the 'include_user_group' parameter.
GroupId	Integer	Limits the returned filters to only those for the specified group_id.
IncludeUserGroup	Boolean	If a user_id is supplied, will return filters for that user's group as well.
IncludeJobCodeFilters	Boolean	If a user_id is supplied, will additionally return jobcode filters.
SupplementalData	Boolean	Default value is 'yes'. Indicates whether supplemental data should be specified.

CustomFieldItems

Create, Update and Query the Custom Field Items in QuickBooks Time.

Table Specific Information

Select

The Cloud uses the QuickBooks Time API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the Cloud.

Id supports the =, IN operators.
CustomFieldId supports the =, IN operators.
Name supports the =, LIKE operators.
Active supports the = operator.
LastModified supports the <, <=, >, >= operators.
SupplementalData supports the = operator.

For example, the following queries are processed server-side:

SELECT * FROM CustomFieldItems WHERE CustomFieldId = 1140610
SELECT * FROM CustomFieldItems WHERE CustomFieldId = 1140610 AND Id = 11531340

Insert

When executing INSERT queries, specify the CustomFieldId, Name and ShortCode columns. The columns that are not required can be inserted optionally. The following is an example of how to insert into this table:

INSERT INTO CustomFieldItems (CustomFieldId, Name, ShortCode) VALUES (1140610, 'testField', 'cf')

Update

When executing UPDATE queries, specify the Id in the WHERE clause. For example:

UPDATE CustomFieldItems SET Name = 'yogesh_customfield', ShortCode = 'ycf' WHERE Id = '15011650'

Columns


Name	Type	ReadOnly	Description
Id [KEY]	Integer	True	Id of the Custom Field Item.
CustomFieldId	Integer	True	Id of the Custom Field that Item belongs to.
Name	String	False	Name of the customfielditem.
Active	Boolean	False	Boolean value. If true, the custom field item is active and if false, the custom field item is archive.
ShortCode	String	False	This is a shortened code or alias that is associated with the customfield item. It may only consist of letters and numbers.
LastModified	Datetime	True	Date/time when this custom field item was last modified.
RequiredCustomFields	String	True	Ids of Custom fields that should be displayed when this custom field item is selected on a timecard.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
SupplementalData	Boolean	Default value is 'yes'. Indicates whether supplemental data should be specified.

CustomFields

Create, Update and Query the Custom Fields in QuickBooks Time.

Table Specific Information

Select

The Cloud uses the QuickBooks Time API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the Cloud.

Id supports the =, IN operators.
Active supports the = operator.
AppliesTo supports the = operator.
Type supports the = operator.
LastModified supports the <, <=, >, >= operators.
SupplementalData supports the = operator.

For example, the following queries are processed server-side:

SELECT * FROM CustomFields
SELECT * FROM CustomFields WHERE Id = 24145

Insert

When executing INSERT queries, specify the Name, Required, Active, AppliesTo, Type, ShowToAll and ShortCode columns. The columns that are not required can be inserted optionally. The following is an example of how to insert into this table:

INSERT INTO CustomFields (Name, Required, Active, AppliesTo, Type, ShowToAll, ShortCode) VALUES ('Test', true, true, 'timesheet', 'managed-list', true, 'cstm')

Update

When executing UPDATE queries, specify the Id in the WHERE clause.

For example:

UPDATE CustomFields SET Name = 'updated name' WHERE Id = '1140410'

Columns


Name	Type	ReadOnly	Description
Id [KEY]	Integer	True	Id of the Custom Field.
Name	String	False	Name of the customfield.
Active	Boolean	False	Boolean value. If true, the custom field is active and if false, the custom field is archive.
Required	Boolean	False	Indicates whether a value for the custom field is required on a timesheet.
AppliesTo	String	False	Indicates what type of object this custom field object applies to. Values are 'timesheet' or 'user' or 'jobode'.
Type	String	False	'managed-list' or 'free-form'. If 'free-form', then it should be displayed in a UI as a text box, where users can enter values for this customfield and they'll get added automatically to the customfield if they don't already exist. If 'managed-list', then it should be displayed as a select-box and users can only choose an existing value.
ShortCode	String	False	This is a shortened code or alias that is associated with the customfield. It may only consist of letters and numbers.
RegexFilter	String	True	Regular expression that will be applied to any new items as they're added to the customfield. If they do not match the regex_filter, they may not be added.
Created	Datetime	True	Date/time when this custom field was created.
LastModified	Datetime	True	Date/time when this custom field was last modified.
UIPreference	String	True	'drop_down' or 'text_box_with_suggest'. Indicates the suggested user interface depending on the specified type.
ShowToAll	Boolean	False	Declares whether this customfield should be shown on timesheets regardless of the jobcode chosen. If false, it will only appear when the chosen jobcode for a timesheet has been associated with this field. This field can only be set to false if the custom field is of type 'timesheet'.
RequiredCustomFields	String	True	Ids of Custom fields that should be displayed when this custom field is visible on a timecard.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
SupplementalData	Boolean	Default value is 'yes'. Indicates whether supplemental data should be specified.

EstimateItems

Create, Update and Query the Estimate Item in QuickBooks Time.

Table Specific Information

Select

The Cloud uses the QuickBooks Time API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the Cloud.

Id supports the =, IN operators.
EstimateId supports the =, IN operators.
Active supports the = operator.
LastModified supports the <, <=, >, >= operators.
SupplementalData supports the = operator.

For example, the following queries are processed server-side:

SELECT * FROM EstimateItems
SELECT * FROM EstimateItems WHERE Id = '11531340'

Insert

When executing INSERT queries, specify the EstimateId, Type and TypeId columns. The columns that are not required can be inserted optionally. The following is an example of how to insert into this table:

INSERT INTO EstimateItems (EstimateId, Type, TypeId) VALUES (47482, 'tag_clouds', 15011650)

Update

When executing UPDATE queries, specify the Id in the WHERE clause. For example:

UPDATE EstimateItems SET EstimatedSeconds = 2 WHERE Id = '11531340'

Columns


Name	Type	ReadOnly	Description
Id [KEY]	Integer	True	Id of the Estimate item.
EstimateId	Integer	False	The estimate this estimate item belongs to.
EstimatedSeconds	Integer	False	The estimated number of seconds.
Active	Boolean	False	Boolean value. If false, this estimate is considered deleted.
Created	Datetime	True	Date/time when this estimate was created.
LastModified	Datetime	True	Date/time when this estimate was last modified.
Type	String	False	The estimate item type. One of 'none' or 'tag_clouds'. NOTE: A type of 'tag_clouds' should be 'customfields' instead. This will be corrected soon.
TypeId	Integer	False	The customfield item id if type is 'tag_clouds'.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
SupplementalData	Boolean	Default value is 'yes'. Indicates whether supplemental data should be specified.

Estimates

Create, Update and Query the Estimates in QuickBooks Time.

Table Specific Information

Select

The Cloud uses the QuickBooks Time API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the Cloud.

Id supports the =, IN operators.
Active supports the = operator.
LastModified supports the <, <=, >, >= operators.
SupplementalData supports the = operator.

For example, the following queries are processed server-side:

SELECT * FROM Estimates
SELECT * FROM Estimates WHERE Id = '11531340'

Insert

When executing INSERT queries, specify the ProjectId and EstimatedBy columns. The columns that are not required can be inserted optionally. The following is an example of how to insert into this table:

INSERT INTO Estimates (ProjectId, EstimatedBy) VALUES (2064876, 'none')

Update

When executing UPDATE queries, specify the Id in the WHERE clause. For example:

UPDATE Estimates SET Active = true WHERE Id = '11531340'

Columns


Name	Type	ReadOnly	Description
Id [KEY]	Integer	True	Id of the Estimate.
ProjectId	Integer	False	Id of the associated Project.
EstimatedBy	String	False	The estimate type. Values are one of 'none' or 'customfields'.
EstimateById	Integer	False	The customfield id if estimate_by value is 'customfields'.
Active	Boolean	False	Boolean value. If false, this estimate is considered deleted.
Created	Datetime	True	Date/time when this estimate was created.
LastModified	Datetime	True	Date/time when this estimate was last modified.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
SupplementalData	Boolean	Default value is 'yes'. Indicates whether supplemental data should be specified.

Files

This table contains a list of file objects.

Table Specific Information

Select

The Cloud uses the QuickBooks Time API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the Cloud.

Id and UploadByUserIds fields support the =, IN operators.
ActiveStatus filter supports the = operator.
LastModified field supports the <=, <, >=, >, = operators.

For example, the following queries are processed server-side:

SELECT * FROM Files WHERE Name IN ('IMG_20181004_214839.png', 'healthy.jpg')

SELECT * FROM Files WHERE LastModified = '2019-01-01 15:30' AND ActiveStatus = 'both'

Update

When executing UPDATE queries, specify the Id in the WHERE clause. For example:

UPDATE Files SET FileDescription = 'test' WHERE Id = '3688644'

Delete

When executing DELETE queries, specify the Id in the WHERE clause. For example:

DELETE FROM Files WHERE Id = '3688644'

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	Id of this file.
Name	String	False	Name of this file.
UploadByUserId	Int	True	Id of the user that uploaded this file.
Active	Boolean	True	If false, this file is considered deleted.
Size	Int	True	Size of the file in bytes.
Created	Datetime	True	Date/time when this customfield was created
LastModified	Datetime	True	Date/time when this customfield was last modified.
FileDescription	String	False	Description of this file.
ImageRotation	Int	False	Original image orientation in degrees. Accepted values are: 0 (top), 90 (right), 180 (bottom), 270 (left).
LinkedObjects	String	True	This is a key/value map of all the objects linked to this file and the corresponding object ids.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
ActiveStatus	String	Filter column for whether to fetch only active records, only archived records, or both. By default, only active records are fetched. Possible values are: yes, no, both

GeoLocations

Retrieves a list of all geofence configs.

Table Specific Information

Select

The Cloud uses the QuickBooks Time API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the Cloud.

Id, UserId and GroupId fields support the =, IN operators.
LastModified field supports the <=, <, >=, >, = operators.

For example, the following query is processed server-side:

SELECT * FROM GeoLocations WHERE GroupId IN ('29474', '29474') AND LastModified <= '2020-01-01 00:00'

Insert

When executing INSERT queries, specify the Created, UserId, Accuracy, Altitude, Latitude and Longitude columns. The columns that are not required can be inserted optionally. The following is an example of how to insert into this table:.

INSERT INTO Geolocations (Created, UserId, Accuracy, Altitude, Latitude, Longitude) VALUES ('2018-08-19T11:30:09-06:00', '1242515', '20.375', '0', '43.68662580', '-116.35166460')

Columns


Name	Type	ReadOnly	Description
Id [KEY]	Int	True	Id of geolocation.
UserId	Int	False	User id for the user that this geolocation belongs to.
Accuracy	Double	False	Indicates the radius of accuracy around the geolocation in meters.
Altitude	Double	False	Indicates the altitude of the geolocation in meters.
Latitude	Double	False	Indicates the latitude of the geolocation in degrees.
Longitude	Double	False	Indicates the longitude of the geolocation in degrees.
Speed	Double	False	Indicates the speed of travel (meters per second) when the geolocation was recorded.
Source	String	False	Indicates how the GPS point was obtained. One of 'gps', 'wifi', or 'cell'.
DeviceIdentifier	String	False	Unique identifier (for the given client) for the device associated with this geolocation.
Created	Datetime	False	Date/time when this geolocation was created.
Heading	Int	False	Indicates the heading of the geolocation in degrees.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
LastModified	Datetime	Date/time when this geofence config was last modified.
GroupId	String	A comma-separated list of group ids. Only geolocations linked to users from these groups will be returned.

Groups

This table contains a list of all groups associated with your company.

Table Specific Information

Select

The Cloud uses the QuickBooks Time API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the Cloud.

Id, Name and ManagerIdsfields support the =, IN operators.
ActiveStatus filter supports the = operator.
LastModified field supports the <=, <, >= , >, = operators.

For example, the following queries are processed server-side:

SELECT * FROM Groups WHERE Name IN ('Group 1', 'Group 2') AND LastModified > '2019-01-01 15:30'

SELECT * FROM Groups WHERE ActiveStatus = 'both'

Insert

When executing INSERT queries, specify the Name column. The columns that are not required can be inserted optionally. The following is an example of how to insert into this table:

INSERT INTO Groups (Name) VALUES ('Group 1')
INSERT INTO Groups (Name, ManagerIds) VALUES ('Group 1', '300, 316')

Update

When executing UPDATE queries, specify the Id in the WHERE clause. For example:

UPDATE Groups SET Name = 'Group 1a', Active = 'false'  WHERE Id = '10055'

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	ID of this group.
Active	Boolean	False	If false, this group is considered archived.
Name	String	False	Name associated with this group
LastModified	Datetime	True	Date/time when this group was last modified
Created	Datetime	True	Date/time when this group was created
ManagerIds	String	False	List of id's for the users allowed to manage this group.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
ActiveStatus	String	Filter column for whether to fetch only active records, only archived records, or both. By default, only active records are fetched. Possible values are: yes, no, both

JobcodeAssignments

Returns a list of all jobcode assignments associated with users.

Table Specific Information

Select

The Cloud uses the QuickBooks Time API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the Cloud.

Id and UserId fields support the =, IN operators.
JobcodeId, JobCodeType, JobCodeParentId fields and ActiveStatus filter all support the = operator.
LastModified field supports the <=, <, >=, >, = operators.

For example, the following queries are processed server-side:

SELECT * FROM JobcodeAssignments WHERE UserId IN (1242515, 1242515)

SELECT * FROM JobcodeAssignments WHERE JobCodeParentId = 17285791

Insert

When executing INSERT queries, specify the UserId and JobcodeId columns. The columns that are not required can be inserted optionally. The following is an example of how to insert into this table:

INSERT INTO JobcodeAssignments (UserId, JobcodeId) VALUES ('1234', '39')

Delete

When executing DELETE queries, specify the Id in the WHERE clause. For example:

DELETE FROM JobcodeAssignments WHERE Id = '41321421'

DELETE FROM JobcodeAssignments WHERE Id IN ('41321421', '41321435')

Columns


Name	Type	ReadOnly	Description
Id [KEY]	Int	True	Id of jobcode assignment.
UserId	Int	False	Id of the user that this assignment pertains to.
JobcodeId	Int	False	Id of the jobcode that this assignment pertains to.
Active	Boolean	False	Whether or not this assignment is 'active'. If false, then the assignment has been deleted. true means it is in force.
LastModified	Datetime	True	Date/time when this jobcode assignment was last modified.
Created	Datetime	True	Date/time when this jobcode assignment was created

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
JobCodeType	String	Refers to the jobcode type - 'regular', 'pto', 'unpaid_break', 'paid_break', or 'all'. Defaults to 'regular'.
JobCodeParentId	Integer	When omitted, all jobcode assignments are returned regardless of jobcode parent. If specified, only assignments for jobcodes with the given jobcode parent_id are returned. To get a list of only top-level jobcode assignments, pass in a jobcode_parent_id of 0.
ActiveStatus	String	Filter column for whether to fetch only active records, only archived records, or both. By default, only active records are fetched. Possible values are: yes, no, both

JobCodes

This table contains a list of jobcodes associated with your company

Table Specific Information

Select

The Cloud uses the QuickBooks Time API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the Cloud.

Id and ParentID fields support the =, IN operators.
Type field and ActiveStatus filter support the = operator.
LastModified field supports the <=, <, >=, >, = operators.
Name field supports the =, LIKE operators.

For example, the following queries are processed server-side:

SELECT * FROM Jobcodes WHERE Id IN (1242515, 1242515)

SELECT * FROM Jobcodes WHERE Type = 'unpaid_break'

Insert

When executing INSERT queries, specify the Name and Type columns. The columns that are not required can be inserted optionally. The following is an example of how to insert into this table:

INSERT INTO Jobcodes (Name, Type) VALUES ('Group 1', 'pto')

Update

When executing UPDATE queries, specify the Id in the WHERE clause. For example:

UPDATE Jobcodes SET Name = 'Group 2', Type = 'pto'  WHERE Id = '10055'

Columns


Name	Type	ReadOnly	Description
Id [KEY]	Int	True	Id of jobcode.
ParentId	Int	False	Id of this jobcode's parent. 0 if it's top-level.
Name	String	False	Name of the jobcode. Cannot be more than 64 characters and must be unique for all jobcodes that share the same parent_id.
ShortCode	String	False	This is a shortened code or alias that is associated with the jobcode. It may only consist of letters and numbers. Must be unique for all jobcodes that share the same parent id.
Type	String	False	Indicates jobcode type. One of 'regular', 'pto', 'paid_break', or 'unpaid_break'
Billable	Boolean	False	Indicates whether this jobcode is billable or not.
BillableRate	Double	False	Dollar amount associated with this jobcode for billing purposes. Only effective if billable is true.
HasChildren	Boolean	True	If true, there are jobcodes that exist underneath this one, so this jobcode should be treated as a container or folder with children jobcodes underneath it.
AssignedToAll	Boolean	False	Indicates whether this jobcode is assigned to all employees or not.
RequiredCustomFields	String	True	Ids of customfields that should be displayed when this jobcode is selected on a timecard.
Active	Boolean	False	If true, this jobcode is active. If false, this jobcode is archived. To archive a jobcode, set this field to false. When a jobcode is archived, any children underneath the jobcode are archived as well. Note that when you archive a jobcode, any jobcode assignments or customfield dependencies are removed. To restore a jobcode, set this field to true. When a jobcode is restored, any parents of that jobcode are also restored.
LastModified	Datetime	True	Date/time when this jobcode was last modified.
Created	Datetime	True	Date/time when this jobcode was created
FilteredCustomFieldItems	String	True	Displays which customfielditems should be displayed when this jobcode is chosen for a timesheet. Each property of the object is a customfield id with its value being an array of customfielditem id. If none, an empty string is returned.
ConnectWithQuickBooks	Boolean	False	If true and the beta feature for two-way sync is enabled, then changes made to the jobcode are immediately shared with QBO.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
ActiveStatus	String	Filter column for whether to fetch only active records, only archived records, or both. By default, only active records are fetched. Possible values are: yes, no, both

Locations

Retrieves a list of all locations associated with your company.

Table Specific Information

Select

The Cloud uses the QuickBooks Time API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the Cloud.

Id and GeoCodingStatus fields support the =, IN operators.
ActiveStatus and ByJobCodeAssignment filter supports the = operator.
LastModified field supports the <=, <, >=, >, = operators.

For example, the following queries are processed server-side:

SELECT * FROM Locations WHERE GeoCodingStatus IN ('in_progress', 'retry')

SELECT * FROM Locations WHERE ByJobcodeAssignment = true

Insert

When executing INSERT queries, specify the any columns. The following is an example of how to insert into this table:

INSERT INTO Locations (Address1, City, State, Country) VALUES ('CData office', 'Bangalore', 'KA', 'IN')

INSERT INTO Locations (Address1, City, State, Country, Zip) VALUES ('CData office', 'Bangalore', 'KA', 'IN', '560100')

Update

When executing UPDATE queries, specify the Id in the WHERE clause. For example:

UPDATE Locations SET Address1 = 'Microsoft' WHERE Id = '10055'

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	Id of location.
Address1	String	False	The first line of the location's address.
Address2	String	False	The second line of the location's address.
City	String	False	The city of the location's address.
State	String	False	The state of the location's address.
Zip	String	False	The postal code of the location's address.
Country	String	False	The country of the location's address.
FormattedAddress	String	True	Formatted address built from the objects addr1, addr2, city, state, and zip. If the location doesn't contain addr1, addr2, or city properties, the value will default what is set in the label property.
Active	Boolean	False	Whether this location is active. If false, this location is archived.
Latitude	Double	False	The latitude of the location (in signed degrees format).
Longitude	Double	False	The longitude of the location (in signed degrees format).
PlaceIdHash	String	True	The MD5 hash of the unique id for the location returned from the geocoding service.
Label	String	True	The formated name for the location. If the location was found using the geocode service the formated address will be saved in this field, otherwise it will be what the user has named the location.
Notes	String	False	Notes related to the location.
GeoCodingStatus	String	True	The geocoding status of this address. Will be one of: 'none', 'in_progress', 'retry', 'error', or 'complete'.
Created	Datetime	True	Date/time when this location was created
LastModified	Datetime	True	Date/time when this customfield was last modified.
LinkedObjects	String	False	A key/value map of all the objects linked to this location and the corresponding object ids.
GeofenceConfigId	Int	True	Id of the geofence_config associated with this location.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
ByJobcodeAssignment	Boolean	If specified, only locations mapped to a jobcode the user is assigned to will be returned.
ActiveStatus	String	Filter column for whether to fetch only active records, only archived records, or both. By default, only active records are fetched. Possible values are: yes, no, both

Notifications

Retrieves a list of notifications associated with your company.

Table Specific Information

Select

The Cloud uses the QuickBooks Time API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the Cloud.

Id field supports the =, IN operators.
MessageTrackingId and UserId fields support the = operator.
DeliveryTime field supports the <=, <, >=, >, = operators.

For example, the following queries are processed server-side:

SELECT * FROM Notifications WHERE Id IN (94140223, 94140225) AND UserId = 37

SELECT * FROM Notifications WHERE MessageTrackingId = 'baabeb0ab03d62ce'

SELECT * FROM Notifications WHERE DeliveryTime = '2019-12-25 19:00'

Insert

When executing INSERT queries, specify the Message column. The columns that are not required can be inserted optionally. The following is an example of how to insert into this table:

INSERT INTO Notifications (Message) VALUES ('Please clock Out!')

INSERT INTO Notifications (Message, UserId) VALUES ('Please clock Out!', '56329')

Delete

When executing DELETE queries, specify the Id in the WHERE clause. For example:

DELETE FROM Notifications WHERE Id = '41321421'

DELETE FROM Notifications WHERE Id IN ('41321421', '4132567')

Columns


Name	Type	ReadOnly	Description
Id [KEY]	Integer	True	Id of the notification.
UserId	Integer	False	User id for the user that this notification will be sent to.
MessageTrackingId	String	True	A GUID string used for additional tracking.
Message	String	False	The message text of the notification. The maximum message length is 2000 characters.
Method	String	False	The transport method of the notification. We support 'push', 'email', and 'dashboard'.
Precheck	String	False	The precheck macro name. Supported macros are 'on_the_clock', 'off_the_clock', and 'none'.
Created	Datetime	True	Date/time when this notification was created
DeliveryTime	Datetime	False	Date/time when this notification will be delivered.

ProjectActivityReplies

Create, Update and Query the Project Activity Replies in QuickBooks Time.

Table Specific Information

Select

The Cloud uses the QuickBooks Time API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the Cloud.

Id supports the =, IN operators.
UserId supports the =, IN operators.
ProjectActivityId supports the = operator.
Active supports the = operator.
LastModified supports the <, <=, >, >= operators.
SupplementalData supports the = operator.

For example, the following queries are processed server-side:

SELECT * FROM ProjectActivityReplies WHERE ProjectActivityId = 8348378
SELECT * FROM ProjectActivityReplies WHERE ProjectActivityId = 8348378 AND Id = 2062894

Insert

When executing INSERT queries, specify the ProjectActivityId and Note columns. The columns that are not required can be inserted optionally. The following is an example of how to insert into this table:

INSERT INTO ProjectActivityReplies (ProjectActivityId, Note) VALUES (8348382, 'Test')

Update

When executing UPDATE queries, specify the Id in the WHERE clause. For example:

UPDATE ProjectActivityReplies SET Note = 'updated' WHERE Id = '2062894'

Columns


Name	Type	ReadOnly	Description
Id [KEY]	Integer	True	Id of the Project Activity Replies.
ProjectActivityId	Integer	False	Id of the associated Project Activity.
UserId	Integer	True	Id of the associated user.
Note	String	False	Content of note.
Active	Boolean	False	Boolean value. If false, this project activity reply is considered archive.
Created	Datetime	True	Date/time when this project note was created.
LastModified	Datetime	True	Date/time when this project note was last modified.
Mentions	String	True	Mentions.
LinkedObjects	String	False	A key/value map of all the objects linked to this project and the corresponding object ids.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
SupplementalData	Boolean	Default value is 'yes'. Indicates whether supplemental data should be specified.

ProjectNotes

Create, Update and Query the Project Notes in QuickBooks Time.

Table Specific Information

Select

The Cloud uses the QuickBooks Time API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the Cloud.

Id supports the =, IN operators.
UserId supports the =, IN operators.
ProjectId supports the = operator.
Active supports the = operator.
LastModified supports the <, <=, >, >= operators.
SupplementalData supports the = operator.

For example, the following queries are processed server-side:

SELECT * FROM ProjectNotes
SELECT * FROM ProjectNotes WHERE ProjectId = 203282

Insert

When executing INSERT queries, specify the ProjectId and Note columns. The columns that are not required can be inserted optionally. The following is an example of how to insert into this table:

INSERT INTO ProjectNotes (ProjectId, Note) VALUES (203282, 'Test note')

Update

When executing UPDATE queries, specify the Id in the WHERE clause. For example:

UPDATE ProjectNotes SET Note = 'updated value' WHERE Id = '1675236'

Columns


Name	Type	ReadOnly	Description
Id [KEY]	Integer	True	Id of the Project Note.
ProjectId	Integer	True	Id of the associated Project.
UserId	Integer	True	Id of the associated user.
Note	String	False	Content of note.
Active	Boolean	False	Boolean value. If false, this project note is considered archive.
Created	Datetime	True	Date/time when this project note was created.
LastModified	Datetime	True	Date/time when this project note was last modified.
Mentions	String	False	Mentions.
Files	String	True	List of ids for file attached to this note.
LinkedObjects	String	False	A key/value map of all the objects linked to this project and the corresponding object ids.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
SupplementalData	Boolean	Default value is 'yes'. Indicates whether supplemental data should be specified.

Projects

Create, Update and Query the Projects in QuickBooks Time.

Table Specific Information

Select

The Cloud uses the QuickBooks Time API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the Cloud.

Id supports the =, IN operators.
JobCodeId supports the =, IN operators.
ParentJobCodeId supports the = operator.
Name supports the = operator.
Active supports the = operator.
ByJobCodeAssignment supports the = operator.

For example, the following queries are processed server-side:

SELECT * FROM Projects
SELECT * FROM Projects WHERE Id = 2056676

Insert

When executing INSERT queries, specify the Name column. The columns that are not required can be inserted optionally. The following is an example of how to insert into this table:

INSERT INTO Projects (Name, Description) VALUES ('ProjectTest', 'This is a test project')

Update

When executing UPDATE queries, specify the Id in the WHERE clause. For example:

UPDATE Projects SET Status = 'complete' WHERE Id = '2062894'

Columns


Name	Type	ReadOnly	Description
Id [KEY]	Integer	True	ID of this project.
JobCodeId	Integer	False	The jobcode that represents the project for time tracking.
ParentJobCodeId	Integer	False	Id of the project jobcode's parent. 0 if it's top-level.
Name	String	False	Name of project. Limited to 64 characters.
Description	String	False	Description text associated with project. Limited to 300 characters.
Status	String	False	Status of project. The allowed values are not_started, in_progress, complete.
StartDate	Datetime	False	YYYY-MM-DD formatted date string. Must be before due date if one is defined.
DueDate	Datetime	False	YYYY-MM-DD formatted date string. Must be after the start date if one is defined.
CompletedDate	Datetime	False	YYYY-MM-DD formatted date string. Must be after the start date if one is defined.
Active	Boolean	False	True or false. If false, the project is considered deleted.
LastModified	Datetime	True	Date/time when this project was last modified, in ISO 8601 format.
Created	Datetime	True	Date/time when this project was created, in ISO 8601 format.
LinkedObjects	String	False	A key/value map of all the objects linked to this project and the corresponding object ids.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
ByJobCodeAssignment	Boolean	If specified, only projects with a jobcode_id the user is assigned to will be returned.

Reminders

Retrieves a list of reminders associated with your employees or company.

Table Specific Information

Select

The Cloud uses the QuickBooks Time API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the Cloud.

UserId fields support the =, IN operators.
ReminderType field support the =, IN operators.
LastModified field supports the <=,<,>=,>,= operators.

For example, the following queries are processed server-side:

SELECT * FROM Reminders WHERE Id IN (72595, 72599) AND UserId = 37

SELECT * FROM Reminders WHERE ReminderType = 'clock-in'

Insert

When executing INSERT queries, specify the UserId, ReminderType, DueTime, DueDaysOfWeek, DistributionMethods, Active and Enabled columns. The columns that are not required can be inserted optionally. The following is an example of how to insert into this table:

INSERT INTO Reminders (UserId, ReminderType, DueTime, DueDaysOfWeek, DistributionMethods, Active, Enabled) VALUES ('37', 'clock-in', '08:10:00', 'Mon, Tue, Sat', 'Push', 'true', 'true')

Update

When executing UPDATE queries, specify the Id in the WHERE clause. For example:

UPDATE Reminders SET DueTime = '08:10:00', DistributionMethods = 'Email'  WHERE Id = '10055'

Columns


Name	Type	ReadOnly	Description
Id [KEY]	Integer	True	Id of the reminder.
UserId	Integer	True	User id for the user that this reminder pertains to. 0 indicates that this is a company-wide reminder.
ReminderType	String	False	The type of this reminder object. Supported reminder_types are 'clock-in' and 'clock-out'.
DueTime	String	False	The 24-hour time that the reminder should be sent, expressed as 'hh:mm:ss'.
DueDaysOfWeek	String	False	A comma-separated list of the days of the week when the reminder should be sent. The value can be any combination of 'Sun', 'Mon', 'Tue', 'Wed', 'Thu', 'Fri' and 'Sat'.
DistributionMethods	String	False	The message text of the notification. The maximum message length is 2000 characters.
Active	Boolean	False	If true, this reminder is active and will be evaluated at the 'due_time' and 'due_days_of_week'. If false, this reminder is inactive and will not be evaluated. If active=false for user-specific reminders, then the company-wide reminder of the same reminder type will apply.
Enabled	Boolean	False	If true, the reminder is enabled and will be sent at the 'due_time' and 'due_days_of_week'. If false, the reminder is disabled and will not be sent. A user with an active (active = true), but disabled (enabled = false) reminder will not receive that reminder type regardless of how company-wide reminders are configured.
Created	Datetime	True	Date/time when this reminder was created
LastModified	Datetime	True	Date/time when this reminder was last modified,

ScheduleEvents

Retrieves a list of schedule events associated with your employees or company.

Table Specific Information

Select

The Cloud uses the QuickBooks Time API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the Cloud.

Id, JobcodeId and ScheduleCalendarId fields support the =, IN operators.
Start supports the >= operator.
End supports the <= operator.
ActiveStatus and ActiveUsers filters, and Draft and TeamEvents fields support the = operator.
LastModified field supports the <=, <, >=, >, = operators.

For example, the following queries are processed server-side:

SELECT * FROM ScheduleEvents WHERE TeamEvents = 'instance'

SELECT * FROM ScheduleEvents WHERE LastModified > '2019-01-01 18:30' AND Id IN (1, 2, 3)

SELECT * FROM ScheduleEvents WHERE End <= '2019-12-31 18:00'

Insert

When executing INSERT queries, specify the ScheduleCalendarId, Start, End and AllDay columns. The columns that are not required can be inserted optionally. The following is an example of how to insert into this table:

INSERT INTO ScheduleEvents (ScheduleCalendarId, Start, End, AllDay) VALUES ('37', '2018-12-05T16:00:00+00:00', '2020-12-05T16:00:00+00:00', 'true')

INSERT INTO ScheduleEvents (ScheduleCalendarId, Start, End, AllDay, AssignedUserIds) VALUES ('37', '2018-12-05T16:00:00+00:00', '2020-12-05T16:00:00+00:00', 'true', '11, 1365, 729')

Update

When executing UPDATE queries, specify the Id in the WHERE clause. For example:

UPDATE ScheduleEvents SET Title = 'New Title'  WHERE Id = '14055'

Columns


Name	Type	ReadOnly	Description
Id [KEY]	Integer	True	Id of the scheduled event.
ScheduleCalendarId	Integer	False	Id of the calendar that contains this event.
Start	Datetime	False	Date/time that represents the start time of this schedule event.
End	Datetime	False	Date/time that represents the end time of this schedule event.
AllDay	Boolean	False	If true, the event duration is all day on the day specified in start. If false, the event duration is determined by date/time specified in end.
AssignedUserIds	String	True	Ids of the user(s) assigned to this event. Empty array if the event is unassigned.
JobcodeId	String	False	Id of the jobcode associated with this event.
Active	Boolean	False	Whether the event is active. If false, the event has been deleted/archived.
Draft	Boolean	False	Whether the event the event is a draft. If false, the event is published. Saving a published event will send the appropriate event published notifications to the assigned users.
TimeZone	String	False	Timezone of the schedule event.
Title	String	False	Title or name of this event.
Notes	String	False	Notes associated with the event.
Location	String	False	Location of the event. Location can be an address, business name, GPS coordinate, etc., so when users click on the location it will open it up in their mapping application.
Color	String	False	Hex color code assigned to this schedule event.
Created	Datetime	True	Date/time when this schedule event was created
LastModified	Datetime	True	Date/time when this schedule event was last modified.
CustomFields	String	False	Only present if the Advanced Tracking Add-on is installed. This is a key / value map of customfield ids to the customfield items that are associated with the event.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
TeamEvents	String	Possible values: base or instance. Default is 'instance'. If 'instance' is specified, events that are assigned to multiple users will be returned as individual single events for each assigned user. If 'base' is specified, events that are assigned to multiple users will be returned as one combined event for all assignees.
ActiveUsers	Integer	'0', '-1' or '1' . Default is '1'. Only schedule events whose users are active will be returned by default. 0 will return events for inactive users. -1 will return events for active and inactive users.
ActiveStatus	String	Filter column for whether to fetch only active records, only archived records, or both. By default, only active records are fetched. Possible values are: yes, no, both

TimeOffRequestEntries

Create, Update and Query the Time off Request Entries in QuickBooks Time.

Table Specific Information

Select

The Cloud uses the QuickBooks Time API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the Cloud.

Id supports the =, IN operators.
TimeOffRequestId supports the =, IN operators.
Status supports the = operators.
ApproverUserId supports the =, IN operators.
UserId supports the =, IN operators.
JobcodeId supports the =, IN operators.
Date supports the = operator.
StartTime supports the = operator.
EndTime supports the = operator.
SupplementalData supports the = operator.

For example, the following queries are processed server-side:

SELECT * FROM TimeOffRequestEntries
SELECT * FROM TimeOffRequestEntries WHERE Id = 11531340

Insert

When executing INSERT queries, specify the TimeOffRequestId, EntryMethod, Duration, JobcodeId and Date columns. The columns that are not required can be inserted optionally. The following is an example of how to insert into this table:

INSERT INTO TimeOffRequestEntries (TimeOffRequestId, EntryMethod, Duration, JobcodeId, Date) VALUES (12345, 'manual', 3600, 10984254, '2024-05-29')

Update

When executing UPDATE queries, specify the Id in the WHERE clause. For example:

UPDATE TimeOffRequestEntries SET Duration = 500 WHERE Id = '15011650'

Columns


Name	Type	ReadOnly	Description
Id [KEY]	Integer	True	Id of the time of request entry.
TimeOffRequestId	Integer	False	Id of the Time Off Request that this entry belongs to.
Status	String	False	One of 'pending', 'approved', 'denied', or 'canceled'.
ApproverUserId	Integer	True	User Id of the user that approved or denied the time off request entry.
Date	Date	False	The date the time off request entry is for (YYYY-MM-DD format).
EntryMethod	String	False	Either 'manual' or 'regular'. Manual time off request entries have a date and a duration (in seconds). Regular time off request entries have a start/end time (duration is calculated by QuickBooks Time) for determining availability in Schedule. Unique properties for each entry method type are below.
Duration	Integer	False	The total number of seconds recorded for this time off request entry.
StartTime	Datetime	False	Start time.
EndTime	Datetime	False	End time.
TzString	String	True	The timezone of the entry in string format.
JobcodeId	Integer	False	Jobcode Id for the jobcode that this time off request entry is recorded against.
UserId	Integer	False	User id for the user that this time off request entry belongs to.
ApprovedTimesheetId	Integer	True	Id of the timesheet associated with this time off request entry when it is approved.
Active	Boolean	True	If true, this time off request entry is active. If false, this time off request entry is archived.
Created	Datetime	True	Date/time when this time off request entry was created.
LastModified	Datetime	True	Date/time when this time off request entry was last modified.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
SupplementalData	Boolean	Default value is 'yes'. Indicates whether supplemental data should be specified.

TimeOffRequests

Create, Update and Query the Time off Requests in QuickBooks Time.

Table Specific Information

Select

The Cloud uses the QuickBooks Time API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the Cloud.

Id supports the =, IN operators.
UserId supports the =, IN operators.
SupplementalData supports the = operator.

For example, the following queries are processed server-side:

SELECT * FROM TimeOffRequests
SELECT * FROM TimeOffRequests WHERE Id = 11531340

Insert

When executing INSERT queries, specify the TimeOffRequestNotes, and TimeOffRequestEntries columns. The columns that are not required can be inserted optionally. The following is an example of how to insert into this table:

INSERT INTO TimeOffRequests (TimeOffRequestNotes, TimeOffRequestEntries) VALUES ('[{"note":"Taking a four day weekend to go on vacation."}]', '[{"date":"2024-05-29","start_time":"2024-01-17T00:00:00-06:00","end_time":"2024-04-17T00:00:00-06:00","entry_method":"regular","duration":28800,"jobcode_id":10984254}]')

Update

When executing UPDATE queries, specify the Id in the WHERE clause. For example:

UPDATE TimeOffRequests SET TimeOffRequestNotes = '[{"note":"Taking a four day weekend to go on vacation."}]' WHERE Id = '15011650'

Columns


Name	Type	ReadOnly	Description
Id [KEY]	Integer	True	Id of the time off request.
UserId	Integer	False	User id for the user that this time off request belongs to.
TimeOffRequestNotes	String	False	An array of Time Off Request Note ids associated with this time off request.
TimeOffRequestEntries	String	False	An array of Time Off Request Entry ids associated with this time off request.
Status	String	False	One of 'pending', 'approved', 'denied' or 'canceled'.
Active	Boolean	False	If true, this time off request is active. If false, this time off request is archived.
Created	Datetime	True	Date/time when this time off request entry was created.
LastModified	Datetime	True	Date/time when this time off request entry was last modified.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
SupplementalData	Boolean	Default value is 'yes'. Indicates whether supplemental data should be specified.

Timesheets

This table contains a list of file objects.

Table Specific Information

Select

The Cloud uses the QuickBooks Time API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the Cloud.

Id, UserId, JobcodeId, PayrollIds, GroupIds fields support the =, IN operators.
OnTheClock and JobCodeType fields support the = operator.
LastModified and Date fields support the <=, <, >=, >, = operators.

For example, the following queries are processed server-side:

SELECT * FROM Timesheets WHERE OnTheClock = false

SELECT * FROM Timesheets WHERE LastModified > '2019-01-01 18:30' AND GroupIds IN (1, 2, 3)

SELECT * FROM Timesheets WHERE JobcodeId IN (1, 2, 3)

Insert

When executing INSERT queries, specify the UserId, JobcodeId, Type and StartTime, EndTime columns in case of Type = regular or UserId, JobcodeId, Type and Duration, Date in case of Type = manual. The columns that are not required can be inserted optionally. The following is an example of how to insert into this table:

INSERT INTO Timesheets (UserId, JobcodeId, Type, StartTime, EndTime) VALUES ('1242123', '17288283', 'regular', '2019-12-05', '2019-12-05')

INSERT INTO Timesheets (UserId, JobcodeId, Type, Date, Duration) VALUES ('1242123', '17288283', 'manual', '2019-12-05', 600)

Update

When executing UPDATE queries, specify the Id in the WHERE clause. For example:

UPDATE Timesheets SET Date = '2018-08-08', EndTime = '2018-08-08T14:00:00-07:00'  WHERE Id = '1242123'

Delete

When executing DELETE queries, specify the Id in the WHERE clause. For example:

DELETE FROM Timesheets WHERE Id = '41321421'

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	Id of the timesheet.
UserId	String	False	User id for the user that this timesheet belongs to.
JobcodeId	Int	False	Jobcode id for the jobcode that this timesheet is recorded against.
Locked	Boolean	True	If greater than 0, the timesheet is locked for editing. A timesheet could be locked for various reasons.
Notes	String	False	Notes associated with this timesheet.
LastModified	Datetime	True	Date/time when this timesheet was last modified.
Type	String	False	Either 'regular' or 'manual'.
OnTheClock	Boolean	True	If true, the user is currently on the clock . If false the user is not currently working on this timesheet. Manual timesheets will always have this property set as false.
CreatedByUserId	String	True	User id for the user that initially created this timesheet.
StartTime	Datetime	False	Date/time that represents the start time of this timesheet. Will always be an empty string for manual timesheets.
EndTime	Datetime	False	Date/time that represents the end time of this timesheet. Will always be an empty string for manual timesheets.
Date	Date	False	The timesheet's date
Duration	Int	False	The total number of seconds recorded for this timesheet.
OriginHint	String	False	A string that will be logged as part of the timesheet history when someone is clocked in, clocked out, or a timesheet is created (with both in/out). Will always be an empty string for manual timesheets.
JobCodeType	String	True	The type of the jobcode linked with this timesheet. Any of the 'regular', 'pto', 'paid_break', 'unpaid_break'
AttachedFiles	String	False	Ids of files attached to this timesheet.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
PayrollIds	Int	A comma-separated string of payroll ids. Only time recorded against users with these payroll ids will be returned.
GroupIds	Int	A comma-separated list of group ids. Only timesheets linked to users from these groups will be returned.

Users

Retrieves a list of all users associated with your company.

Table Specific Information

Select

The Cloud uses the QuickBooks Time API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the Cloud.

Id and GroupId fields supports the =, IN, !=, NOT IN operators.
Username, PayrollId and EmployeeNumber fields support the =, IN operators.
FirstName and LastName fields support the = operators.
ActiveStatus filter supports the = operator.
LastModified field supports the <=, <, >= , >, = operators.

For example, the following queries are processed server-side:

SELECT * FROM Users WHERE ActiveStatus = 'both'

SELECT * FROM Users WHERE LastModified > '2019-01-01 18:30' AND GroupId IN (1, 2, 3)

SELECT * FROM Users WHERE FirstName LIKE 'josh%' AND PayrollId IN ('562348', '45457')

Insert

When executing INSERT queries, specify the UserName, FirstName and LastName columns. The columns that are not required can be inserted optionally. The following is an example of how to insert into this table:

INSERT INTO Users (UserName, FirstName, LastName) VALUES ('cdatagroup@123', 'cdata', 'group')

Update

When executing UPDATE queries, specify the Id or UserName in the WHERE clause. For example:

UPDATE Users SET FirstName = 'New Name'  WHERE Id = '14055' 

UPDATE Users SET FirstName = 'New User Name', LastName = 'New Title' WHERE UserName = 'cdatagroup@123'

Columns


Name	Type	ReadOnly	Description
Id [KEY]	Integer	True	Id of this user.
FirstName	String	False	First name of user.
LastName	String	False	Last name of user.
DisplayName	String	False	The display name of user. NOTE: field will be null unless feature GED_INCLUSION is enabled (contact support for more info), if feature is enabled then value will be a non-null display_name value (users who have not setup their display_name will return empty string)
GroupId	Integer	False	Id of the group this user belongs to.
Active	Boolean	False	Whether this user is active. If false, this user is considered archived.
EmployeeNumber	Integer	False	Unique number associated with this user.
Salaried	Boolean	False	Indicates whether or not the user is salaried.
Exempt	Boolean	False	Indicates whether or not the user is eligible for overtime pay.
Username	String	False	Username associated with this user.
Email	String	False	Email address associated with this user.
EmailVerified	Boolean	True	Indicates whether or not the user is eligible for overtime pay.
PayrollId	String	False	Unique company wide string associated with this user. Usually used for linking with external systems.
HireDate	Date	False	Date on which this user was hired.
TermDate	Date	False	Date on which this user was terminated.
LastModified	Datetime	True	Date/time when this user was last modified.
LastActive	Datetime	True	Date/time when this user last performed any action.
Created	Datetime	True	Date/time when this user was created
ClientUrl	String	True	Client account url identifier associated with this user.
CompanyName	String	True	Client account name identifier associated with the user.
ProfileImageUrl	String	True	Url identifier associated with this user's profile image.
MobileNumber	String	False	Mobile phone number associated with this user.
PTOBalances	String	True	List of jobcode identifiers and their respective PTO balances for this user (in seconds).
SubmittedTo	Date	False	The latest date this user has submitted timesheets up to.
ApprovedTo	Date	False	The latest date this user has had timesheets approved to.
ManagerOfGroupIds	String	True	The group ids that this user manages.
RequirePasswordChange	Boolean	False	Whether this user will be required to change their password on their next login.
LoginPIN	Integer	False	Used for logging into a Kiosk or similar. This field is only used for create/update user.
PayRate	Double	True	The rate of pay associated with this user. Only visible to admins.
PayInterval	String	True	The timeframe to which this user's pay rate applies, either 'hour' or 'year'. Only visible to admins.
CustomFields	String	False	A key/value map of customfield ids to the customfield items that are associated with the user.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
ActiveStatus	String	Filter column for whether to fetch only active records, only archived records, or both. By default, only active records are fetched. Possible values are: yes, no, both

Views

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

CData Cloud - QuickBooks Time Views


Name	Description
CurrentTotalsReport	Report for the current totals (shift and day) along with additional information provided for those who are currently on the clock.
CurrentUser	Query the current user details in QuickBooks Time.
CustomFieldItemJobCodeFilters	Query the Custom Field Item JobCode Filters in QuickBooks Time.
CustomFieldItemUserFilters	Query the Custom Field Item User Filters in QuickBooks Time.
GeneralSettings	Retrieves a list of all effective settings associated with a single user.
GeofenceConfigs	Retrieves a list of all geofence configs.
LastModifiedTimestamps	Retrieves a list of last_modified timestamps associated with each requested API endpoint.
LocationMaps	Retrieves a list of all locations maps associated with your company.
ManagedClients	Retrieves a list of managed clients available from your account.
PayrollReport	Payroll Report associated with a timeframe.
PayrollReportByJobCode	Payroll Report broken down by jobcode
ProjectActivities	Query the Project Activities in QuickBooks Time.
ProjectActivityReadTimes	Update and Query the ProjectActivity read time in QuickBooks Time.
ProjectEstimateDetailReport	Retrieves a project estimate detail report.
ProjectEstimateReport	Retrieves a project estimate report.
ProjectReport	Retrieves a project report.
ScheduleCalendars	Retrieves a list of schedule calendars associated with your employees or company.
TimesheetsDeleted	Query the Project Notes in QuickBooks Time.
UserPermissions	The rights assignable to an individual user.

CurrentTotalsReport

Report for the current totals (shift and day) along with additional information provided for those who are currently on the clock.

Table Specific Information

Select

The Cloud uses the QuickBooks Time API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the Cloud.

GroupId, UserId and OnTheClock fields support the =, IN operators.

For example, the following query is processed server-side:

SELECT * FROM CurrentTotalsReport

SELECT * FROM CurrentTotalsReport WHERE GroupId IN ('29474', '29474') AND OnTheClock IN (true, false)

SELECT * FROM CurrentTotalsReport WHERE UserId IN (1751136, 1738864) AND OnTheClock = false

Columns


Name	Type	Description
UserId	Int	Id of the users these totals are calculated for.
GroupId	String	Unique group id for this user,value of zero represents those without a group.
OnTheClock	Boolean	Whether this user is currently on the clock.
ShiftGeolocationsAvailable	Boolean	Whether geolocations are available for the current timesheet.
ShiftSeconds	Int	Total time for the current shift, in seconds.
DaySeconds	Int	Total time for the day, in seconds.
JobCodeId	Int	Id of the JobCode.
TimesheetId	Int	Id of the Timesheet.
LatestShiftGeolocationId	Int	Latest shift geolocation id.
LatestShiftProximityPointDistance	Int	Latest shift proximity point distance.

CurrentUser

Query the current user details in QuickBooks Time.

Table Specific Information

Select

The WHERE clause conditions are not supported on the API side. Only a basic unfiltered SELECT query works on the API side. The filters are executed client-side within the Cloud.

For example, the following query is processed server-side:

SELECT * FROM CurrentUser

Columns


Name	Type	Description
Id [KEY]	Integer	Id of the current user.
FirstName	String	First name of user.
LastName	String	Last name of user.
DisplayName	String	The display name of user.
GroupId	Integer	Id of the group this user belongs to.
Active	Boolean	Boolean value which show the active status.
EmployeeNumber	Integer	Unique number associated with this user.
Salaried	Boolean	Indicates whether or not the user is salaried.
Exempt	Boolean	Indicates e.g. whether or not the user is eligible for overtime pay.
UserName	String	Username associated with this user.
Email	String	Email address associated with this user.
EmailVerified	Boolean	Indicates whether or not the email address has been confirmed by the user.
PayrollId	String	Unique company wide string associated with this user. Usually used for linking with external systems.
HireDate	Date	Date on which this user was hired.
TermDate	Date	Date on which this user was terminated.
LastModified	Datetime	Date/time when this user was last modified, in ISO 8601 format.
LastActive	Datetime	Date/time when this user last performed any action, in ISO 8601 format.
Created	Datetime	Date/time when this user was created, in ISO 8601 format.
ClientUrl	String	Client account url identifier associated with this user.
CompanyName	String	Client account name identifier associated with the user.
ProfileImageUrl	String	Url identifier associated with this user's profile image.
MobileNumber	String	Mobile phone number associated with this user.
PtoBalances	String	List of jobcode identifiers and their respective PTO balances for this user (in seconds).
SubmittedTo	Datetime	The latest date this user has submitted timesheets up to.
ApprovedTo	Datetime	The latest date this user has had timesheets approved to.
ManagerOfGroupIds	String	The group ids that this user manages.
RequirePasswordChange	Boolean	If true, this user will be required to change their password on their next login.
PayRate	Float	The rate of pay associated with this user. Only visible to admins.
PayInterval	String	The timeframe to which this user's pay rate applies, either 'hour' or 'year'. Only visible to admins.
PermissionsAdmin	Boolean	Permissions - Administrator, can perform any changes on the account.
PermissionsMobile	Boolean	Permissions - Allowed to use mobile devices to record time.
PermissionsStatusBox	Boolean	Permissions - Able to view the list of users currently working for the company.
PermissionsReports	Boolean	Permissions - Able to run/view all reports for the company.
PermissionsManageTimesheets	Boolean	Permissions - Able to create/edit/delete timesheets for anyone in the company.
PermissionsManageAuthorization	Boolean	Permissions - Able to manage computer authorization for the company.
PermissionsManageUsers	Boolean	Permissions - Able to create/edit/delete users, groups, and managers for the entire company.
PermissionsManageMyTimesheets	Boolean	Permissions - Able to completely manage own timesheets.
PermissionsManageJobcodes	Boolean	Permissions - Able to create/edit/delete jobcodes and custom field items for the entire company.
PermissionsPinLogin	Boolean	Permissions - Able to login to apps via PIN.
PermissionsApproveTimesheets	Boolean	Permissions - Able to run approval reports and approve time for all employees.
PermissionsManageSchedules	Boolean	Permissions - Able to create/edit/delete events within the schedule for the groups that the user can manage.
PermissionsExternalAccess	Boolean	Permissions - External Access
PermissionsManageMySchedule	Boolean	Permissions - Able to create/edit/delete events within the schedule for only themselves.
PermissionsManageCompanySchedules	Boolean	Permissions - Able to create/edit/delete events within the schedule for any user in the company.
PermissionsViewCompanySchedules	Boolean	Permissions - Able to view published events within the schedule for any user in the company.
PermissionsViewGroupSchedules	Boolean	Permissions - Able to view published events within the schedule for the groups that the user is a member of.
PermissionsManageNoSchedules	Boolean	Permissions - Not able to create/edit/delete events within the schedule for any user.
PermissionsViewMySchedules	Boolean	Permissions - Able to view published events within the schedule for themselves.
PermissionsViewProjects	Boolean	Permissions - View Projects
PermissionsManageProjects	Boolean	Permissions - Manage Projects
PermissionsTimeTracking	Boolean	Permissions - Able to track time and have time tracked on their behalf.
CustomFields	String	A key/value map of customfield ids to the customfield items that are associated with the user.

CustomFieldItemJobCodeFilters

Query the Custom Field Item JobCode Filters in QuickBooks Time.

Table Specific Information

Select

The Cloud uses the QuickBooks Time API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the Cloud.

JobCodeId supports the =, IN operators.
LastModified supports the <, <=, >, >= operators.

For example, the following queries are processed server-side:

SELECT * FROM CustomFieldItemJobCodeFilters
SELECT * FROM CustomFieldItemJobCodeFilters WHERE JobCodeId = '679721'

Columns


Name	Type	Description
Id [KEY]	Integer	Id of the JobCode to which the filter belong.
LastModified	Datetime	The latest date/time when one of the filtered items was updated.
FilteredCustomFieldItems	String	Each entity represents a custom field's active filters where the key is the custom field id and the value is an array of item ids to which the jobcode is assigned.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
JobCodeId	Integer	Comma separated list of one or more jobcode ids you'd like to filter on.

CustomFieldItemUserFilters

Query the Custom Field Item User Filters in QuickBooks Time.

Table Specific Information

Select

The Cloud uses the QuickBooks Time API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the Cloud.

UserId supports the = operator.
GroupId supports the = operator.
IncludeUserGroup supports the = operator.
LastModified supports the <, <=, >, >= operators.

For example, the following queries are processed server-side:

SELECT * FROM CustomFieldItemUserFilters
SELECT * FROM CustomFieldItemUserFilters WHERE JobCodeId = '679721'

Columns


Name	Type	Description
Id [KEY]	Integer	Id of the JobCode to which the filter belong.
Type	String	The entities filter type: user or group.
LastModified	Datetime	The latest date/time when one of the filtered items was updated.
FilteredCustomFieldItems	String	Each entity represents a custom field's active filters where the key is the custom field id and the value is an array of item ids to which the user is assigned.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
UserId	Integer	Limits the returned filters to only those for the specified user_id. You can also include items for this user's group automatically if you include the include_user_group parameter.
GroupId	Integer	Limits the returned filter to only those for the specified group_id.
IncludeUserGroup	Boolean	Boolean value. If a user_id is supplied, will return filters for that user's group as well.

GeneralSettings

Retrieves a list of all effective settings associated with a single user.

Table Specific Information

Select

Query the GeneralSettings table. The Cloud will use the QuickBooks Time API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.

LastModified field supports the <=,<,>=,>,= operators.

For example, the following queries are processed server side:

SELECT * FROM GeneralSettings WHERE LastModified = '2021-12-17 05:08:02.0'

Columns


Name	Type	Description
CalculateOvertime	Boolean	The CalculateOvertime setting.
ClockoutOverride	Boolean	The ClockoutOverride setting.
ClockoutOverrideHours	Integer	The ClockoutOverrideHours setting.
ClockoutOverrideNotifyAdmin	Boolean	The ClockoutOverrideNotifyAdmin setting.
ClockoutOverrideNotifyManager	Boolean	The ClockoutOverrideNotifyManager setting.
DailyDoubletime	Integer	The DailyDoubletime setting.
DailyOvertime	Integer	The DailyOvertime setting.
DailyRegularHours	Integer	The DailyRegularHours setting.
DateLocale	String	The DateLocale setting.
EmpPanel	Boolean	The EmpPanel setting.
EmpPanelMail	String	The EmpPanelMail setting.
EmpPanelPassword	String	The EmpPanelPassword setting.
EmployeePtoEntry	Boolean	The EmployeePtoEntry setting.
EnableTimesheetNotes	String	The EnableTimesheetNotes setting.
HideWorkingTime	String	The HideWorkingTime setting.
JcLabel	String	The JcLabel setting.
LunchDeduct	Boolean	The LunchDeduct setting.
LunchLength	Boolean	The LunchLength setting.
LunchThreshold	Integer	The LunchThreshold setting.
MaxCustomFieldItems	Integer	The MaxCustomFieldItems setting.
MaxJobCodes	Integer	The MaxJobCodes setting.
ParentClockinDisplay	Integer	The ParentClockinDisplay setting.
PayrollEndDate	Date	The PayrollEndDate setting.
PayrollFirstEndDay	String	The PayrollFirstEndDay setting.
PayrollLastEndDay	String	The PayrollLastEndDay setting.
PayrollMonthEndDay	String	The PayrollMonthEndDay setting.
PayrollType	String	The PayrollType setting.
PtoEntry	Boolean	The PtoEntry setting.
PtoOvertime	Boolean	The PtoOvertime setting.
SimpleClockin	Boolean	The SimpleClockin setting.
TimeFormat	Integer	The TimeFormat setting.
TimecardFields	String	The TimecardFields setting.
TimeclockLabel	String	The TimeclockLabel setting.
TimesheetEditNotesForAllUsers	Boolean	The TimesheetEditNotesForAllUsers setting.
TimesheetNotesNotifyAdmin	Boolean	The TimesheetNotesNotifyAdmin setting.
TimesheetNotesNotifyManagers	Boolean	The TimesheetNotesNotifyManagers setting.
TimesheetNotesRequired	Boolean	The TimesheetNotesRequired setting.
Timezone	String	The Timezone setting.
WeekStart	String	The WeekStart setting.
WeeklyRegularHours	String	The WeeklyRegularHours setting.
LastModified	Datetime	When the record was last modified.
EmpPanelTz	String	The EmpPanelTz setting.

GeofenceConfigs

Retrieves a list of all geofence configs.

Table Specific Information

Select

The Cloud uses the QuickBooks Time API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the Cloud.

Id, TypeId and Type fields support the =, IN operators.
Enabled field and ActiveStatus filter support the = operator.
LastModified field supports the <=, <, >=, >, = operators.

For example, the following queries are processed server-side:

SELECT * FROM GeofenceConfigs WHERE TypeId IN (282316, 323445) AND Type = 'Locations'

SELECT * FROM GeofenceConfigs WHERE Enabled = false

Columns


Name	Type	Description
Id [KEY]	Int	Id of geofence config.
Type	String	The type of entity the geofence config is related to.
TypeId	Int	The id of the entity the geofence config is related to.
Active	Boolean	Whether this geofence config is active. If false, this geofence config is archived.
Enabled	Boolean	Indicates whether a geofence for the associated entity should be enabled.
Radius	Int	Configures the size of the geofence.
Created	Datetime	Date/time when this geofence config was created
LastModified	Datetime	Date/time when this geofence config was last modified.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
ActiveStatus	String	Filter column for whether to fetch only active records, only archived records, or both. By default, only active records are fetched. Possible values are: yes, no, both

LastModifiedTimestamps

Retrieves a list of last_modified timestamps associated with each requested API endpoint.

Table Specific Information

Select

Query a list of last modified timestamps associated with each requested API endpoint. The Cloud will use the QuickBooks Time API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.

Endpoint field support the '=' and IN operators.

For example, the following queries are processed server-side:

SELECT * FROM LastModifiedTimestamps WHERE endpoints = 'timesheets,current_user,groups'

Columns


Name	Type	Description
CurrentUser	Datetime	Date/time when this current user was last modified.
CustomFields	Datetime	Date/time when this custom fields was last modified.
CustomFielditems	Datetime	Date/time when this custom field items was last modified.
CustomFieldItemFilters	Datetime	Date/time when this custom field item filters was last modified.
CustomFieldItemUserFilters	Datetime	Date/time when this custom field item user filters was last modified.
CustomFieldItemJobCodeFilters	Datetime	Date/time when this custom field item jobcode filters was last modified.
ContactInfo	Datetime	Date/time when this contact info was last modified.
EffectiveSettings	Datetime	Date/time when this effective settings was last modified.
GeoLocations	Datetime	Date/time when this geo locations was last modified.
GeofenceConfigs	Datetime	Date/time when this geofence configs was last modified.
GeofenceActiveHours	Datetime	Date/time when this geofence active hours was last modified.
Groups	Datetime	Date/time when this groups was last modified.
JobCodes	Datetime	Date/time when this job codes was last modified.
JobCodeAssignments	Datetime	Date/time when this job code assignments was last modified.
Locations	Datetime	Date/time when this locations deleted was last modified.
LocationsMap	Datetime	Date/time when this locations map was last modified.
Reminders	Datetime	Date/time when this reminders was last modified.
ScheduleCalendars	Datetime	Date/time when this schedule calendars was last modified.
ScheduleEvents	Datetime	Date/time when this schedule events was last modified.
TimeSheets	Datetime	Date/time when this timesheets was last modified.
TimeSheetsDeleted	Datetime	Date/time when this timesheets deleted was last modified.
TimeOffRequests	Datetime	Date/time when this time off requests was last modified.
TimeOffRequestEntries	Datetime	Date/time when this time off request entries was last modified.
Terms	Datetime	Date/time when this terms was last modified.
Users	Datetime	Date/time when this users was last modified.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
Endpoints	String	Comma separated list of one or more endpoints.

LocationMaps

Retrieves a list of all locations maps associated with your company.

Table Specific Information

Select

The Cloud uses the QuickBooks Time API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the Cloud.

Id field supports the =, IN operators.
ByJobcodeAssignment field supports the = operator.
LastModified field supports the <=, <, >=, >, = operators.

For example, the following queries are processed server-side:

SELECT * FROM LocationMaps WHERE Id IN ('102839', '110761')

SELECT * FROM LocationMaps WHERE ByJobcodeAssignment = true

Columns


Name	Type	Description
Id [KEY]	String	Id of location map.
XTable	String	The name of the entity the location is mapped to.
XId	Integer	The id of the entity the location is mapped to.
LocationId	Integer	The id of the location that is mapped to the entity.
Created	Datetime	Date/time when this locations map was created
LastModified	Datetime	Date/time when this locations map was last modified.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
ByJobcodeAssignment	Boolean	If specified only locations maps mapped to a jobcode the user is assigned to will be returned.

ManagedClients

Retrieves a list of managed clients available from your account.

Table Specific Information

Select

The Cloud uses the QuickBooks Time API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the Cloud.

ActiveStatus filter supports the = operator.

For example, the following queries are processed server-side:

SELECT * FROM ManagedClients WHERE ActiveStatus = 'both'

Columns


Name	Type	Description
Id [KEY]	String	Id of the managed client.
CompanyUrl	String	URL used by the managed client to sign in to QuickBooks Time.
CompanyName	String	Name of the managed client's company.
Active	Boolean	Whether this client is active. If false, this client is considered archived.
Created	Datetime	Date/time when this managed client record was created
LastModified	Datetime	Date/time when this managed client record was last modified.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
ActiveStatus	String	Filter column for whether to fetch only active records, only archived records, or both. By default, only active records are fetched. Possible values are: yes, no, both

PayrollReport

Payroll Report associated with a timeframe.

Table Specific Information

Select

Query the PayrollReport table to retrieve payrolls associated with a timeframe, with filters to narrow down the results. The Cloud uses the QuickBooks Time API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the Cloud. By default the report will include results for a time range within the last 30 days. You can filter by StartDate and EndDate filters to get a payroll report over a different time range.

UserId and GroupId fields support the =, IN operators.
StartDate, EndDate and IncludeZeroTime fields support the = operator.

For example, the following queries are processed server-side:

SELECT * FROM PayrollReport WHERE GroupId IN ('29474', '29475') AND IncludeZeroTime = false
SELECT * FROM PayrollReport WHERE StartDate = '2019-11-01' AND EndDate = '2019-12-31'

Columns


Name	Type	Description
UserId	Int	Id of the users these totals are calculated for.
ClientId	Int	Id of the client.
StartDate	Date	Start of reporting timeframe.
EndDate	Date	End of the payroll reporting timeframe.
TotalReSeconds	Int	Total time for the current shift, in seconds.
TotalOTSeconds	Int	Overtime, in seconds.
TotalDTSeconds	Int	Doubletime, in seconds.
TotalPTOSeconds	Int	Total PTO time, in seconds.
TotalWorkSeconds	Int	Total overall time, in seconds.
OvertimeSeconds	String	The overtime seconds object, where the key is the multiplier rate and the value is the number of seconds of overtime at that rate
FixedRateSeconds	String	The fixed rate seconds object, where the key is the multiplier rate and the value is the number of seconds of overtime at that rate
PtoSeconds	String	The pto seconds object, where the key is the multiplier rate and the value is the number of seconds of overtime at that rate

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
GroupId	String	A comma-seperated list of group ids. Only time for users from these groups will be included.
IncludeZeroTime	String	If true, all users will be included in the output, even if they had zero hours for the time period.

PayrollReportByJobCode

Payroll Report broken down by jobcode

Table Specific Information

Select

Query the PayrollReportByJobCode table to retrieve a payroll report, broken down by jobcode, with filters to narrow down the results. The Cloud uses the QuickBooks Time API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the Cloud. By default the report will include results for a time range within the last 30 days. You can filter by StartDate and EndDate filters to get a payroll report over a different time range. The date range defined by StartDate and EndDate must not exceed 31 days.

GroupId field supports the =, IN operators.
StartDate, EndDate and IncludeAdvancedOvertime fields support the = operator.

For example, the following queries are processed server-side:

SELECT * FROM PayrollReportByJobCode WHERE GroupId IN ('29474', '29474') AND IncludeAdvancedOvertime = false
SELECT * FROM PayrollReport WHERE StartDate = '2019-11-01' AND EndDate = '2019-12-31'

Based on the columns selected in projection explicitly, the aggregated data displayed may change. Aggregate payroll metrics broken down by jobcode id:

SELECT * FROM PayrollReport WHERE StartDate = '2019-11-01' AND EndDate = '2019-12-31'

Aggregate payroll metrics broken down by jobcode id per each user:

SELECT UserId, JobCodeId, TotalWorkSeconds, TotalReSeconds, TotalPtoSeconds, OvertimeSeconds FROM PayrollReportByJobCode

Aggregate payroll metrics broken down by jobcode id and date per each user:

SELECT Date, UserId, JobCodeId, TotalWorkSeconds, TotalReSeconds, TotalPtoSeconds, OvertimeSeconds FROM PayrollReportByJobCode

Columns


Name	Type	Description
UserId	Int	Id of the users these totals are calculated for.
JobcodeId	Int	Id of the jobcode the metrics apply to.
StartDate	Date	Start of reporting timeframe.
EndDate	Date	End of the payroll reporting timeframe.
Date	String	Date that these total are calculated for.
TotalReSeconds	Int	Total time for the current shift, in seconds.
TotalOTSeconds	Int	Overtime, in seconds.
TotalDTSeconds	Int	Doubletime, in seconds.
TotalPTOSeconds	Int	Total PTO time, in seconds.
TotalWorkSeconds	Int	Total overall time, in seconds.
OvertimeSeconds	String	The overtime seconds object, where the key is the multiplier rate and the value is the number of seconds of overtime at that rate
FixedRateSeconds	String	The fixed rate seconds object, where the key is the multiplier rate and the value is the number of seconds of overtime at that rate

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
GroupId	String	A comma-seperated list of group ids. Only time for users from these groups will be included.
IncludeAdvancedOvertime	Boolean	If true, overtime will be formatted such that it includes the time for individual multipliers and can support more than just 1.5x (ot) and 2x (dt) overtime.

ProjectActivities

Query the Project Activities in QuickBooks Time.

Table Specific Information

Select

The Cloud uses the QuickBooks Time API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the Cloud.

Id supports the =,IN operators.
ProjectId supports the = operator.
ActivityType supports the =,IN operators.
LastModified supports the <,<=,>,>= operators.
SupplementalData supports the = operator.

For example, the following queries are processed server-side:

SELECT * FROM ProjectActivities WHERE ProjectId = 2056676
SELECT * FROM ProjectActivities WHERE ProjectId = 2056676 AND Id = 8375474

Columns


Name	Type	Description
Id [KEY]	Integer	ID of this project activity.
UserId	Integer	Id of the associated user.
ProjectId	Integer	Id of the associated project.
Active	Boolean	Boolean value. If false, this project activity is considered archive.
UnreadRepliesCount	Integer	The count of unread replies.
Following	Boolean	Following.
ActivityType	String	Activity type.
LastModified	Datetime	Date/time when this project was last modified, in ISO 8601 format.
Created	Datetime	Date/time when this project was created, in ISO 8601 format.
ProjectActivityMetadata	String	Project activity metadata.
LinkedObjects	String	A key/value map of all the objects linked to this project and the corresponding object ids.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
SupplementalData	Boolean	Default value is 'yes'. Indicates whether supplemental data should be specified.

ProjectActivityReadTimes

Update and Query the ProjectActivity read time in QuickBooks Time.

Table Specific Information

Select

The Cloud uses the QuickBooks Time API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the Cloud.

Id supports the =, IN operators.
LatestReadTime supports the <, <=, >, >= operators.
SupplementalData supports the = operator.

For example, the following queries are processed server-side:

SELECT * FROM ProjectActivityReadTimes
SELECT * FROM ProjectActivities WHERE Id = 8375474

Columns


Name	Type	Description
Id [KEY]	Integer	ID of this project activity read time.
ProjectId	Integer	Id of the associated project.
UserId	Integer	Id of the associated user. Only the current user id is allowed.
LatestReadTime	Datetime	Date/time when this project activity was last read.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
SupplementalData	Boolean	Default value is 'yes'. Indicates whether supplemental data should be specified.

ProjectEstimateDetailReport

Retrieves a project estimate detail report.

Table Specific Information

Select

The Cloud uses the QuickBooks Time API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the Cloud.

Id supports the = operator.
SupplementalData supports the = operator.
ResultsAsArray supports the = operator.

For example, the following queries are processed server-side:

SELECT * FROM ProjectEstimateDetailReport
SELECT * FROM ProjectEstimateDetailReport WHERE Id = 8375474

Columns


Name	Type	Description
Id	Int	Id of the Project estimate report.
JobcodeId	Int	The JobCode Id.
ParentJobcodeId	Int	A JobCode Id. Only time for projects under this jobcode will be included.
Name	String	Name.
Status	String	Status. The allowed values are in_progress, complete.
Description	String	Description.
StartDate	Datetime	Start date.
DueDate	Datetime	Due date.
CompletedDate	Datetime	Completed date.
Active	Boolean	Boolean value which represents the active status.
LastModified	Datetime	Last modified date.
Created	Datetime	Created date.
EstimateId	Int	Estimate id.
EstimateBy	String	Estimate by.
EstimateById	Int	Estimate by id.
TotalClockedInSeconds	Int	Total clocked in seconds.
TotalClockedOutSeconds	Int	Total clocked out seconds.
TotalTrackedSeconds	Int	Total tracked seconds.
TotalEstimatedSeconds	Int	Total estimated seconds.
TotalNoteCount	Int	Total note count.
UnreadPostsCount	Int	Unread posts count.
UnreadRepliesCount	Int	Unread replies count.
BudgetProgress	String	Budget progress.
ClockedInUserIds	String	Clocked in User Ids.
QboMapped	Boolean	Boolean value.
EstimateItems	String	Estimate items.
CustomFieldItemId	Int	Custom field item id.
assigned_to_all	Boolean	Assigned to all.
PreviewAssignedUserIds	String	Preview assigned user ids.
TotalAssignedUsers	Int	Total assigned users.
TrackedTimeUsers	String	Tracked time users.
TrackedTimeGroups	String	Tracked time groups.
TrackedTimeJobcodes	String	Tracked time jobcodes.
TrackedTimeCustomFields	String	Tracked time customfields.
OnTheClock	Boolean	On The Clock.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
SupplementalData	Boolean	Default value is 'yes'. Indicates whether supplemental data should be specified.
ResultsAsArray	Boolean	Default value is 'yes'. Indicates whether results should be returned as an array instead of an object.

ProjectEstimateReport

Retrieves a project estimate report.

Table Specific Information

Select

The Cloud uses the QuickBooks Time API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the Cloud.

JobcodeId supports the =, IN operators.
ProjectId supports the =, IN operators.
ParentJobcodeId supports the = operator.
Status supports the = operator.
Active supports the = operator.
SupplementalData supports the = operator.
ResultsAsArray supports the = operator.
HasTimeTracked supports the = operator.
TimeTrackedStartDate supports the = operator.
TimeTrackedEndDate supports the = operator.

For example, the following queries are processed server-side:

SELECT * FROM ProjectEstimateReport
SELECT * FROM ProjectEstimateReport WHERE ProjectId = 8375474

Columns


Name	Type	Description
Id	Int	Id of the Project estimate report.
JobcodeId	Int	The JobCode Id.
ParentJobcodeId	Int	A JobCode Id. Only time for projects under this jobcode will be included.
Name	String	Name.
Status	String	Status.
Description	String	Description.
StartDate	Datetime	Start date.
DueDate	Datetime	Due date.
CompletedDate	Datetime	Completed date.
Active	Boolean	Boolean value which represents the active status.
LastModified	Datetime	Last modified date.
Created	Datetime	Created date.
EstimateId	Int	Estimate id.
EstimateBy	String	Estimate by.
EstimateById	Int	Estimate by id.
TotalClockedInSeconds	Int	Total clocked in seconds.
TotalClockedOutSeconds	Int	Total clocked out seconds.
TotalTrackedSeconds	Int	Total tracked seconds.
TotalEstimatedSeconds	Int	Total estimated seconds.
TotalNoteCount	Int	Total note count.
UnreadPostsCount	Int	Unread posts count.
UnreadRepliesCount	Int	Unread replies count.
BudgetProgress	String	Budget progress.
ClockedInUserIds	String	Clocked in User Ids.
QboMapped	Boolean	Boolean value.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
ProjectId	Integer	Array of one or more project ids. Only time for these projects will be included.
SupplementalData	Boolean	Default value is 'yes'. Indicates whether supplemental data should be specified.
ResultsAsArray	Boolean	Default value is 'yes'. Indicates whether results should be returned as an array instead of an object.
HasTimeTracked	Boolean	Default value is 'no'. Indicates whether to filter results on time tracked dates.

ProjectReport

Retrieves a project report.

Table Specific Information

Select

Query the ProjectReport table to retrieve a project report, broken down by user, group or jobcode. The Cloud uses the QuickBooks Time API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the Cloud. By default the report will include results for a time range within the last 30 days. You can filter by StartDate and EndDate filters to get a payroll report over a different time range.

UserId, JobcodeId and GroupId fields support the =, IN operators.
StartDate and EndDate fields support the = operator.

For example, the following queries are processed server-side:

SELECT * FROM ProjectReport WHERE GroupId IN (29474, 29474)
SELECT * FROM ProjectReport WHERE StartDate = '2019-11-01' AND EndDate = '2019-12-31'

Based on the columns selected in projection explicitly, the aggregated data displayed may change. Aggregate projects metrics broken down by user id:

SELECT * FROM ProjectReport WHERE StartDate = '2019-11-01' AND EndDate = '2019-12-31'
SELECT UserId, TotalHours FROM ProjectReport WHERE StartDate = '2019-11-01' AND EndDate = '2019-12-31'

Aggregate project metrics broken down by jobcode id:

SELECT JobCodeId, TotalHours FROM ProjectReport

Aggregate payroll metrics broken down by group id:

SELECT GroupId, TotalHours FROM ProjectReport

Columns


Name	Type	Description
UserId	Int	Id of the users these totals are calculated for.
JobcodeId	Int	Id of the jobcode the metrics apply to.
GroupId	Int	Id of the group the metrics apply to.
StartDate	Date	Start of reporting timeframe.
EndDate	Date	End of the payroll reporting timeframe.
TotalHours	Double	Total number of hours per each user, group or jobcode.
CustomFieldItems	String	An object with customfield_id as the properties, and each value being an array of customfielditem values.

ScheduleCalendars

Retrieves a list of schedule calendars associated with your employees or company.

Table Specific Information

Select

The Cloud uses the QuickBooks Time API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the Cloud.

Id field supports the =, IN operators.
LastModified field supports the <=, <, >=, >, = operators.

For example, the following queries are processed server-side:

SELECT * FROM ScheduleCalendars WHERE Id IN (72595, 72597)

SELECT * FROM ScheduleCalendars WHERE LastModified < '2019-01-01 18:30'

Columns


Name	Type	Description
Id [KEY]	Integer	Id of the schedule calendar.
Name	String	The name of the schedule calendar.
Created	Datetime	Date/time when this schedule calendar was created
LastModified	Datetime	Date/time when this schedule calendar was last modified.

TimesheetsDeleted

Query the Project Notes in QuickBooks Time.

Table Specific Information

Select

The Cloud uses the QuickBooks Time API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the Cloud.

Id supports the =, IN operators.
UserId supports the =, IN operators.
JobcodeId supports the =, IN operators.
StartDate supports the = operator.
EndDate supports the = operator.
Type supports the = operator.
LastModified supports the <, <=, >, >= operators.
GroupId supports the =, IN operators.
Username supports the = operator.
JobcodeType supports the = operator.
SupplementalData supports the = operator.

Either StartDate and EndDate or Id is required to query the TimesheetsDeleted view. For example, the following queries are processed server-side:

SELECT * FROM TimesheetsDeleted WHERE StartDate = '2023-02-01' AND EndDate = '2024-07-01'
SELECT * FROM TimesheetsDeleted WHERE Id = 8375474

Columns


Name	Type	Description
Id [KEY]	String	Id of the timesheet.
UserId	Integer	User id for the user that this timesheet belongs to.
JobcodeId	Integer	Jobcode id for the jobcode that this timesheet is recorded
StartDate	Datetime	Date/time that represents the start time of this timesheet, in ISO 8601 format.
EndDate	Datetime	Date/time that represents the end time of this timesheet, in ISO 8601 format.
Duration	Int	The total number of seconds recorded for this timesheet.
Date	Datetime	The timesheet's date, in YYYY-MM-DD format.
Tz	Int	Time zone.
TzStr	String	Time zone str.
Type	String	Either 'regular' or 'manual'. Regular timesheets have a start & end time (duration is calculated by TSheets). Manual timesheets have a date and a duration (in seconds). Unique properties for each timesheet type are below.
Location	String	Location.
Active	Boolean	Active.
Locked	String	If greater than 0, the timesheet is locked for editing. A timesheet could be locked for various reasons, such as being exported, invoiced, etc.
Notes	String	Notes associated with this timesheet.
LastModified	Datetime	Date/time when this timesheet was last modified, in ISO 8601 format.
Created	Datetime	Date/time when this timesheet was created, in ISO 8601 format.
CustomFields	String	A key/value map of customfield ids to the customfield items that are associated with the timesheet.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
GroupId	Integer	Id of the associated groups.
Username	String	User name.
JobcodeType	String	Job code type.
SupplementalData	Boolean	Default value is 'yes'. Indicates whether supplemental data should be specified.

UserPermissions

The rights assignable to an individual user.

Table Specific Information

Select

Query the UserPermissions table. The Cloud will use the QuickBooks Time API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.

UserId field supports the =, !=, IN, NOT IN operators.

For example, the following queries are processed server side:

SELECT * FROM UserPermissions WHERE UserID = 3600098

SELECT * FROM UserPermissions WHERE UserID != 3600098

SELECT * FROM UserPermissions WHERE UserID NOT IN (3600098, 66025, 66021)

SELECT * FROM UserPermissions WHERE UserID IN (3600098, 66025, 66021)

Columns


Name	Type	Description
UserId [KEY]	String	The Id of the user these permissions apply to.
Admin	Boolean	Administrator, can perform any changes on the account.
Mobile	Boolean	Whether this user is allowed to use mobile devices to record time.
StatusBox	Boolean	Whether this user is able to view the list of users currently working for the company.
Reports	Boolean	Whether this user is able to run/view all reports for the company.
ManageTimesheets	Boolean	Whether this user is able to create/edit/delete timesheets for anyone in the company.
ManageAuthorization	Boolean	Whether this user is able to manage computer authorization for the company.
ManageUsers	Boolean	Whether this user is able to create/edit/delete users, groups, and managers for the entire company.
ManageMyTimesheets	Boolean	Whether this user is able to completely manage own timesheets.
ManageJobcodes	Boolean	Whether this user is able to create/edit/delete jobcodes and custom field items for the entire company.
PinLogin	Boolean	Whether this user is able to login to apps via PIN.
ApproveTimesheets	Boolean	Whether this user is able to run approval reports and approve time for all employees.
ManageSchedules	Boolean	Whether this user is able to create/edit/delete events within the schedule for the groups that the user can manage.
ManageMySchedule	Boolean	Whether this user is able to create/edit/delete events within the schedule for only themselves.
ManageCompanySchedules	Boolean	Whether this user is able to create/edit/delete events within the schedule for any user in the company.
ManageNoSchedule	Boolean	Whether this user is not able to create/edit/delete events within the schedule for any user.
ViewCompanySchedules	Boolean	Whether this user is able to view published events within the schedule for any user in the company.
ViewGroupSchedules	Boolean	Whether this user is able to view published events within the schedule for the groups that the user is a member of.
ViewMySchedules	Boolean	Whether this user is able to view published events within the schedule for themselves.
TimeTracking	Boolean	Whether this user is able to track time and have time tracked on their behalf.

Stored Procedures

Stored procedures are function-like interfaces that extend the functionality of the Cloud beyond simple SELECT/INSERT/UPDATE/DELETE operations with QuickBooks Time.

Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from QuickBooks Time, along with an indication of whether the procedure succeeded or failed.

CData Cloud - QuickBooks Time Stored Procedures


Name	Description
CreateInvitation	Invite one or more users to your company.
UpdateProjectActivityReadTime	Update the last read time for one or more projects.

CreateInvitation

Invite one or more users to your company.

Input


Name	Type	Required	Description
ContactMethod	String	False	Method to be used for the invitation, either 'sms' or 'email'.
ContactInfo	String	False	The email address or mobile phone number matching the type specified by the contact_method parameter.
UserId	String	False	Id of the user to invite.
ContactAggregate	String	False

UpdateProjectActivityReadTime

Update the last read time for one or more projects.

Stored Procedure Specific Information

QuickBooks Time allows only a small subset of columns to be used in the EXECUTE query. These columns can typically only be used with the = comparison. For example:

EXECUTE UpdateProjectActivityReadTime ProjectId = '10001'

EXECUTE UpdateProjectActivityReadTime ProjectId = '10001, 10002'

Input


Name	Type	Required	Description
ProjectId	String	True	Id of the Project. If you have multiple Project IDs, please provide them as comma-separated values.

Result Set Columns


Name	Type	Description
Success	String	This value shows a boolean indication of whether the operation was successful or not.

System Tables

You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.

Schema Tables

The following tables return database metadata for QuickBooks Time:

sys_catalogs: Lists the available databases.
sys_schemas: Lists the available schemas.
sys_tables: Lists the available tables and views.
sys_tablecolumns: Describes the columns of the available tables and views.
sys_procedures: Describes the available stored procedures.
sys_procedureparameters: Describes stored procedure parameters.
sys_keycolumns: Describes the primary and foreign keys.
sys_indexes: Describes the available indexes.

Data Source Tables

The following tables return information about how to connect to and query the data source:

sys_connection_props: Returns information on the available connection properties.
sys_sqlinfo: Describes the SELECT queries that the Cloud can offload to the data source.

Query Information Tables

The following table returns query statistics for data modification queries, including batch operations::

sys_identity: Returns information about batch operations or single updates.

sys_catalogs

Lists the available databases.

The following query retrieves all databases determined by the connection string:

SELECT * FROM sys_catalogs

Columns


Name	Type	Description
CatalogName	String	The database name.

sys_schemas

Lists the available schemas.

The following query retrieves all available schemas:

          SELECT * FROM sys_schemas

Columns


Name	Type	Description
CatalogName	String	The database name.
SchemaName	String	The schema name.

sys_tables

Lists the available tables.

The following query retrieves the available tables and views:

          SELECT * FROM sys_tables

Columns


Name	Type	Description
CatalogName	String	The database containing the table or view.
SchemaName	String	The schema containing the table or view.
TableName	String	The name of the table or view.
TableType	String	The table type (table or view).
Description	String	A description of the table or view.
IsUpdateable	Boolean	Whether the table can be updated.

sys_tablecolumns

Describes the columns of the available tables and views.

The following query returns the columns and data types for the Timesheets table:

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Timesheets'

Columns


Name	Type	Description
CatalogName	String	The name of the database containing the table or view.
SchemaName	String	The schema containing the table or view.
TableName	String	The name of the table or view containing the column.
ColumnName	String	The column name.
DataTypeName	String	The data type name.
DataType	Int32	An integer indicating the data type. This value is determined at run time based on the environment.
Length	Int32	The storage size of the column.
DisplaySize	Int32	The designated column's normal maximum width in characters.
NumericPrecision	Int32	The maximum number of digits in numeric data. The column length in characters for character and date-time data.
NumericScale	Int32	The column scale or number of digits to the right of the decimal point.
IsNullable	Boolean	Whether the column can contain null.
Description	String	A brief description of the column.
Ordinal	Int32	The sequence number of the column.
IsAutoIncrement	String	Whether the column value is assigned in fixed increments.
IsGeneratedColumn	String	Whether the column is generated.
IsHidden	Boolean	Whether the column is hidden.
IsArray	Boolean	Whether the column is an array.
IsReadOnly	Boolean	Whether the column is read-only.
IsKey	Boolean	Indicates whether a field returned from sys_tablecolumns is the primary key of the table.
ColumnType	String	The role or classification of the column in the schema. Possible values include SYSTEM, LINKEDCOLUMN, NAVIGATIONKEY, REFERENCECOLUMN, and NAVIGATIONPARENTCOLUMN.

sys_procedures

Lists the available stored procedures.

The following query retrieves the available stored procedures:

          SELECT * FROM sys_procedures

Columns


Name	Type	Description
CatalogName	String	The database containing the stored procedure.
SchemaName	String	The schema containing the stored procedure.
ProcedureName	String	The name of the stored procedure.
Description	String	A description of the stored procedure.
ProcedureType	String	The type of the procedure, such as PROCEDURE or FUNCTION.

sys_procedureparameters

Describes stored procedure parameters.

The following query returns information about all of the input parameters for the CreateInvitation stored procedure:

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'CreateInvitation' AND Direction = 1 OR Direction = 2

To include result set columns in addition to the parameters, set the IncludeResultColumns pseudo column to True:

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'CreateInvitation' AND IncludeResultColumns='True'

Columns


Name	Type	Description
CatalogName	String	The name of the database containing the stored procedure.
SchemaName	String	The name of the schema containing the stored procedure.
ProcedureName	String	The name of the stored procedure containing the parameter.
ColumnName	String	The name of the stored procedure parameter.
Direction	Int32	An integer corresponding to the type of the parameter: input (1), input/output (2), or output(4). input/output type parameters can be both input and output parameters.
DataType	Int32	An integer indicating the data type. This value is determined at run time based on the environment.
DataTypeName	String	The name of the data type.
NumericPrecision	Int32	The maximum precision for numeric data. The column length in characters for character and date-time data.
Length	Int32	The number of characters allowed for character data. The number of digits allowed for numeric data.
NumericScale	Int32	The number of digits to the right of the decimal point in numeric data.
IsNullable	Boolean	Whether the parameter can contain null.
IsRequired	Boolean	Whether the parameter is required for execution of the procedure.
IsArray	Boolean	Whether the parameter is an array.
Description	String	The description of the parameter.
Ordinal	Int32	The index of the parameter.
Values	String	The values you can set in this parameter are limited to those shown in this column. Possible values are comma-separated.
SupportsStreams	Boolean	Whether the parameter represents a file that you can pass as either a file path or a stream.
IsPath	Boolean	Whether the parameter is a target path for a schema creation operation.
Default	String	The value used for this parameter when no value is specified.
SpecificName	String	A label that, when multiple stored procedures have the same name, uniquely identifies each identically-named stored procedure. If there's only one procedure with a given name, its name is simply reflected here.
IsCDataProvided	Boolean	Whether the procedure is added/implemented by CData, as opposed to being a native QuickBooks Time procedure.

Pseudo-Columns


Name	Type	Description
IncludeResultColumns	Boolean	Whether the output should include columns from the result set in addition to parameters. Defaults to False.

sys_keycolumns

Describes the primary and foreign keys.

The following query retrieves the primary key for the Timesheets table:

         SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Timesheets'

Columns


Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
IsKey	Boolean	Whether the column is a primary key in the table referenced in the TableName field.
IsForeignKey	Boolean	Whether the column is a foreign key referenced in the TableName field.
PrimaryKeyName	String	The name of the primary key.
ForeignKeyName	String	The name of the foreign key.
ReferencedCatalogName	String	The database containing the primary key.
ReferencedSchemaName	String	The schema containing the primary key.
ReferencedTableName	String	The table containing the primary key.
ReferencedColumnName	String	The column name of the primary key.

sys_foreignkeys

Describes the foreign keys.

The following query retrieves all foreign keys which refer to other tables:

         SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'

Columns


Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
PrimaryKeyName	String	The name of the primary key.
ForeignKeyName	String	The name of the foreign key.
ReferencedCatalogName	String	The database containing the primary key.
ReferencedSchemaName	String	The schema containing the primary key.
ReferencedTableName	String	The table containing the primary key.
ReferencedColumnName	String	The column name of the primary key.
ForeignKeyType	String	Designates whether the foreign key is an import (points to other tables) or export (referenced from other tables) key.

sys_primarykeys

Describes the primary keys.

The following query retrieves the primary keys from all tables and views:

         SELECT * FROM sys_primarykeys

Columns


Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
KeySeq	String	The sequence number of the primary key.
KeyName	String	The name of the primary key.

sys_indexes

Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.

The following query retrieves all indexes that are not primary keys:

          SELECT * FROM sys_indexes WHERE IsPrimary='false'

Columns


Name	Type	Description
CatalogName	String	The name of the database containing the index.
SchemaName	String	The name of the schema containing the index.
TableName	String	The name of the table containing the index.
IndexName	String	The index name.
ColumnName	String	The name of the column associated with the index.
IsUnique	Boolean	True if the index is unique. False otherwise.
IsPrimary	Boolean	True if the index is a primary key. False otherwise.
Type	Int16	An integer value corresponding to the index type: statistic (0), clustered (1), hashed (2), or other (3).
SortOrder	String	The sort order: A for ascending or D for descending.
OrdinalPosition	Int16	The sequence number of the column in the index.

sys_connection_props

Returns information on the available connection properties and those set in the connection string.

The following query retrieves all connection properties that have been set in the connection string or set through a default value:

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns


Name	Type	Description
Name	String	The name of the connection property.
ShortDescription	String	A brief description.
Type	String	The data type of the connection property.
Default	String	The default value if one is not explicitly set.
Values	String	A comma-separated list of possible values. A validation error is thrown if another value is specified.
Value	String	The value you set or a preconfigured default.
Required	Boolean	Whether the property is required to connect.
Category	String	The category of the connection property.
IsSessionProperty	String	Whether the property is a session property, used to save information about the current connection.
Sensitivity	String	The sensitivity level of the property. This informs whether the property is obfuscated in logging and authentication forms.
PropertyName	String	A camel-cased truncated form of the connection property name.
Ordinal	Int32	The index of the parameter.
CatOrdinal	Int32	The index of the parameter category.
Hierarchy	String	Shows dependent properties associated that need to be set alongside this one.
Visible	Boolean	Informs whether the property is visible in the connection UI.
ETC	String	Various miscellaneous information about the property.

sys_sqlinfo

Describes the SELECT query processing that the Cloud can offload to the data source.

See SQL Compliance for SQL syntax details.

Discovering the Data Source's SELECT Capabilities

Below is an example data set of SQL capabilities. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.


Name	Description	Possible Values
AGGREGATE_FUNCTIONS	Supported aggregation functions.	AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNT	Whether COUNT function is supported.	YES, NO
IDENTIFIER_QUOTE_OPEN_CHAR	The opening character used to escape an identifier.	[
IDENTIFIER_QUOTE_CLOSE_CHAR	The closing character used to escape an identifier.	]
SUPPORTED_OPERATORS	A list of supported SQL operators.	=, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BY	Whether GROUP BY is supported, and, if so, the degree of support.	NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
OJ_CAPABILITIES	The supported varieties of outer joins supported.	NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS
OUTER_JOINS	Whether outer joins are supported.	YES, NO
SUBQUERIES	Whether subqueries are supported, and, if so, the degree of support.	NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED
STRING_FUNCTIONS	Supported string functions.	LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE
NUMERIC_FUNCTIONS	Supported numeric functions.	ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE
TIMEDATE_FUNCTIONS	Supported date/time functions.	NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT
REPLICATION_SKIP_TABLES	Indicates tables skipped during replication.
REPLICATION_TIMECHECK_COLUMNS	A string array containing a list of columns which will be used to check for (in the given order) to use as a modified column during replication.
IDENTIFIER_PATTERN	String value indicating what string is valid for an identifier.
SUPPORT_TRANSACTION	Indicates if the provider supports transactions such as commit and rollback.	YES, NO
DIALECT	Indicates the SQL dialect to use.
KEY_PROPERTIES	Indicates the properties which identify the uniform database.
SUPPORTS_MULTIPLE_SCHEMAS	Indicates if multiple schemas may exist for the provider.	YES, NO
SUPPORTS_MULTIPLE_CATALOGS	Indicates if multiple catalogs may exist for the provider.	YES, NO
DATASYNCVERSION	The CData Data Sync version needed to access this driver.	Standard, Starter, Professional, Enterprise
DATASYNCCATEGORY	The CData Data Sync category of this driver.	Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQL	Whether enhanced SQL functionality beyond what is offered by the API is supported.	TRUE, FALSE
SUPPORTS_BATCH_OPERATIONS	Whether batch operations are supported.	YES, NO
SQL_CAP	All supported SQL capabilities for this driver.	SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX
PREFERRED_CACHE_OPTIONS	A string value specifies the preferred cacheOptions.
ENABLE_EF_ADVANCED_QUERY	Indicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side.	YES, NO
PSEUDO_COLUMNS	A string array indicating the available pseudo columns.
MERGE_ALWAYS	If the value is true, The Merge Mode is forcibly executed in Data Sync.	TRUE, FALSE
REPLICATION_MIN_DATE_QUERY	A select query to return the replicate start datetime.
REPLICATION_MIN_FUNCTION	Allows a provider to specify the formula name to use for executing a server side min.
REPLICATION_START_DATE	Allows a provider to specify a replicate startdate.
REPLICATION_MAX_DATE_QUERY	A select query to return the replicate end datetime.
REPLICATION_MAX_FUNCTION	Allows a provider to specify the formula name to use for executing a server side max.
IGNORE_INTERVALS_ON_INITIAL_REPLICATE	A list of tables which will skip dividing the replicate into chunks on the initial replicate.
CHECKCACHE_USE_PARENTID	Indicates whether the CheckCache statement should be done against the parent key column.	TRUE, FALSE
CREATE_SCHEMA_PROCEDURES	Indicates stored procedures that can be used for generating schema files.

The following query retrieves the operators that can be used in the WHERE clause:

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'

Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.

Columns


Name	Type	Description
NAME	String	A component of SQL syntax, or a capability that can be processed on the server.
VALUE	String	Detail on the supported SQL or SQL syntax.

sys_identity

Returns information about attempted modifications.

The following query retrieves the Ids of the modified rows in a batch operation:

         SELECT * FROM sys_identity

Columns


Name	Type	Description
Id	String	The database-generated Id returned from a data modification operation.
Batch	String	An identifier for the batch. 1 for a single operation.
Operation	String	The result of the operation in the batch: INSERTED, UPDATED, or DELETED.
Message	String	SUCCESS or an error message if the update in the batch failed.

sys_information

Describes the available system information.

The following query retrieves all columns:

SELECT * FROM sys_information

Columns


Name	Type	Description
Product	String	The name of the product.
Version	String	The version number of the product.
Datasource	String	The name of the datasource the product connects to.
NodeId	String	The unique identifier of the machine where the product is installed.
HelpURL	String	The URL to the product's help documentation.
License	String	The license information for the product. (If this information is not available, the field may be left blank or marked as 'N/A'.)
Location	String	The file path location where the product's library is stored.
Environment	String	The version of the environment or rumtine the product is currently running under.
DataSyncVersion	String	The tier of CData Sync required to use this connector.
DataSyncCategory	String	The category of CData Sync functionality (e.g., Source, Destination).

Connection String Options

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.

For more information on establishing a connection, see Establishing a Connection.

OAuth

Property	Description
OAuthClientId	Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
OAuthClientSecret	Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).

SSL

Property	Description
SSLServerCert	Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

Logging

Property	Description
Verbosity	Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.

Schema

Property	Description
BrowsableSchemas	Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .

Miscellaneous

Property	Description
IncludeCustomFields	A boolean indicating if you would like to include custom fields in the column listing.
MaxRows	Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
Pagesize	Specifies the maximum number of records per page the provider returns when requesting data from QuickBooks Time.
PseudoColumns	Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
RowScanDepth	The maximum number of rows to scan to look for the columns available in a table.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.

OAuth

This section provides a complete list of the OAuth properties you can configure in the connection string for this provider.

Property	Description
OAuthClientId	Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
OAuthClientSecret	Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).

OAuthClientId

Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.

Data Type

string

Default Value

""

Remarks

This property is required in two cases:

When using a custom OAuth application, such as in web-based authentication flows, service-based authentication, or certificate-based flows that require application registration.
If the driver does not provide embedded OAuth credentials.

(When the driver provides embedded OAuth credentials, this value may already be provided by the Cloud and thus not require manual entry.)

OAuthClientId is generally used alongside other OAuth-related properties such as OAuthClientSecret and OAuthSettingsLocation when configuring an authenticated connection.

OAuthClientId is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can usually find this value in your identity provider’s application registration settings. Look for a field labeled Client ID, Application ID, or Consumer Key.

While the client ID is not considered a confidential value like a client secret, it is still part of your application's identity and should be handled carefully. Avoid exposing it in public repositories or shared configuration files.

For more information on how this property is used when configuring a connection, see Establishing a Connection.

OAuthClientSecret

Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).

Data Type

string

Default Value

""

Remarks

This property (sometimes called the application secret or consumer secret) is required when using a custom OAuth application in any flow that requires secure client authentication, such as web-based OAuth, service-based connections, or certificate-based authorization flows. It is not required when using an embedded OAuth application.

The client secret is used during the token exchange step of the OAuth flow, when the driver requests an access token from the authorization server. If this value is missing or incorrect, authentication fails with either an invalid_client or an unauthorized_client error.

OAuthClientSecret is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can obtain this value from your identity provider when registering the OAuth application.

Notes:

This value should be stored securely and never exposed in public repositories, scripts, or unsecured environments.
Client secrets may also expire after a set period. Be sure to monitor expiration dates and rotate secrets as needed to maintain uninterrupted access.

For more information on how this property is used when configuring a connection, see Establishing a Connection

SSL

This section provides a complete list of the SSL properties you can configure in the connection string for this provider.

Property	Description
SSLServerCert	Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

SSLServerCert

Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

Data Type

string

Default Value

""

Remarks

If you are using a TLS/SSL connection, use this property to specify the TLS/SSL certificate to be accepted from the server. If you specify a value for this property, all other certificates that are not trusted by the machine are rejected.

This property can take the following forms:


Description	Example
A full PEM Certificate (example shortened for brevity)	`-----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----`
A path to a local file containing the certificate	C:\cert.cer
The public key (example shortened for brevity)	`-----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----`
The MD5 Thumbprint (hex values can also be either space- or colon-separated)	`ecadbdda5a1529c58a1e9e09828d70e4`
The SHA1 Thumbprint (hex values can also be either space- or colon-separated)	`34a929226ae0819f2ec14b4a3d904f801cbb150d`

Note: It is possible to use '*' to signify that all certificates should be accepted, but due to security concerns this is not recommended.

Logging

This section provides a complete list of the Logging properties you can configure in the connection string for this provider.

Property	Description
Verbosity	Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.

Verbosity

Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.

Data Type

string

Default Value

"1"

Remarks

This property defines the level of detail the Cloud includes in the log file. Higher verbosity levels increase the detail of the logged information, but may also result in larger log files and slower performance due to the additional data being captured.

The default verbosity level is 1, which is recommended for regular operation. Higher verbosity levels are primarily intended for debugging purposes. For more information on each level, refer to Logging.

When combined with the LogModules property, Verbosity can refine logging to specific categories of information.

Schema

This section provides a complete list of the Schema properties you can configure in the connection string for this provider.

Property	Description
BrowsableSchemas	Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .

BrowsableSchemas

Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .

Data Type

string

Default Value

""

Remarks

Listing all available database schemas can take extra time, thus degrading performance. Providing a list of schemas in the connection string saves time and improves performance.

Miscellaneous

This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.

Property	Description
IncludeCustomFields	A boolean indicating if you would like to include custom fields in the column listing.
MaxRows	Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
Pagesize	Specifies the maximum number of records per page the provider returns when requesting data from QuickBooks Time.
PseudoColumns	Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
RowScanDepth	The maximum number of rows to scan to look for the columns available in a table.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.

IncludeCustomFields

A boolean indicating if you would like to include custom fields in the column listing.

Data Type

bool

Default Value

true

Remarks

Setting this to true will cause custom fields to be included in the column listing, but may cause poor performance when listing metadata.

MaxRows

Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.

Data Type

int

Default Value

-1

Remarks

The default value for this property, -1, means that no row limit is enforced unless the query explicitly includes a LIMIT clause. (When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting.)

Setting MaxRows to a whole number greater than 0 ensures that queries do not return excessively large result sets by default.

This property is useful for optimizing performance and preventing excessive resource consumption when executing queries that could otherwise return very large datasets.

Pagesize

Specifies the maximum number of records per page the provider returns when requesting data from QuickBooks Time.

Data Type

int

Default Value

200

Remarks

When processing a query, instead of requesting all of the queried data at once from QuickBooks Time, the Cloud can request the queried data in pieces called pages.

This connection property determines the maximum number of results that the Cloud requests per page.

Note: Setting large page sizes may improve overall query execution time, but doing so causes the Cloud to use more memory when executing queries and risks triggering a timeout.

PseudoColumns

Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.

Data Type

string

Default Value

""

Remarks

This property allows you to define which pseudocolumns the Cloud exposes as table columns.

To specify individual pseudocolumns, use the following format:

Table1=Column1;Table1=Column2;Table2=Column3

To include all pseudocolumns for all tables use:

*=*

RowScanDepth

The maximum number of rows to scan to look for the columns available in a table.

Data Type

int

Default Value

100

Remarks

The columns in a table must be determined by scanning table rows. This value determines the maximum number of rows that will be scanned.

Setting a high value may decrease performance. Setting a low value may prevent the data type from being determined properly, especially when there is null data.

Timeout

Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.

Data Type

int

Default Value

60

Remarks

The timeout applies to each individual communication with the server rather than the entire query or operation. For example, a query could continue running beyond 60 seconds if each paging call completes within the timeout limit.

Timeout is set to 60 seconds by default. To disable timeouts, set this property to 0.

Disabling the timeout allows operations to run indefinitely until they succeed or fail due to other conditions such as server-side timeouts, network interruptions, or resource limits on the server.

Note: Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.

Third Party Copyrights

LZMA from 7Zip LZMA SDK

LZMA SDK is placed in the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or distribute the original LZMA SDK code, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.

LZMA2 from XZ SDK

Version 1.9 and older are in the public domain.

Xamarin.Forms

Xamarin SDK

The MIT License (MIT)

Copyright (c) .NET Foundation Contributors

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

NSIS 3.10

Copyright (C) 1999-2025 Contributors THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS COMMON PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.

1. DEFINITIONS

"Contribution" means:

a) in the case of the initial Contributor, the initial code and documentation distributed under this Agreement, and b) in the case of each subsequent Contributor:

i) changes to the Program, and

ii) additions to the Program;

where such changes and/or additions to the Program originate from and are distributed by that particular Contributor. A Contribution 'originates' from a Contributor if it was added to the Program by such Contributor itself or anyone acting on such Contributor's behalf. Contributions do not include additions to the Program which: (i) are separate modules of software distributed in conjunction with the Program under their own license agreement, and (ii) are not derivative works of the Program.

"Contributor" means any person or entity that distributes the Program.

"Licensed Patents " mean patent claims licensable by a Contributor which are necessarily infringed by the use or sale of its Contribution alone or when combined with the Program.

"Program" means the Contributions distributed in accordance with this Agreement.

"Recipient" means anyone who receives the Program under this Agreement, including all Contributors.

2. GRANT OF RIGHTS

a) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, distribute and sublicense the Contribution of such Contributor, if any, and such derivative works, in source code and object code form.

b) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free patent license under Licensed Patents to make, use, sell, offer to sell, import and otherwise transfer the Contribution of such Contributor, if any, in source code and object code form. This patent license shall apply to the combination of the Contribution and the Program if, at the time the Contribution is added by the Contributor, such addition of the Contribution causes such combination to be covered by the Licensed Patents. The patent license shall not apply to any other combinations which include the Contribution. No hardware per se is licensed hereunder.

c) Recipient understands that although each Contributor grants the licenses to its Contributions set forth herein, no assurances are provided by any Contributor that the Program does not infringe the patent or other intellectual property rights of any other entity. Each Contributor disclaims any liability to Recipient for claims brought by any other entity based on infringement of intellectual property rights or otherwise. As a condition to exercising the rights and licenses granted hereunder, each Recipient hereby assumes sole responsibility to secure any other intellectual property rights needed, if any. For example, if a third party patent license is required to allow Recipient to distribute the Program, it is Recipient's responsibility to acquire that license before distributing the Program.

d) Each Contributor represents that to its knowledge it has sufficient copyright rights in its Contribution, if any, to grant the copyright license set forth in this Agreement.

3. REQUIREMENTS

A Contributor may choose to distribute the Program in object code form under its own license agreement, provided that:

a) it complies with the terms and conditions of this Agreement; and

b) its license agreement:

i) effectively disclaims on behalf of all Contributors all warranties and conditions, express and implied, including warranties or conditions of title and non-infringement, and implied warranties or conditions of merchantability and fitness for a particular purpose;

ii) effectively excludes on behalf of all Contributors all liability for damages, including direct, indirect, special, incidental and consequential damages, such as lost profits;

iii) states that any provisions which differ from this Agreement are offered by that Contributor alone and not by any other party; and

iv) states that source code for the Program is available from such Contributor, and informs licensees how to obtain it in a reasonable manner on or through a medium customarily used for software exchange.

When the Program is made available in source code form:

a) it must be made available under this Agreement; and

b) a copy of this Agreement must be included with each copy of the Program.

Contributors may not remove or alter any copyright notices contained within the Program.

Each Contributor must identify itself as the originator of its Contribution, if any, in a manner that reasonably allows subsequent Recipients to identify the originator of the Contribution.

4. COMMERCIAL DISTRIBUTION

Commercial distributors of software may accept certain responsibilities with respect to end users, business partners and the like. While this license is intended to facilitate the commercial use of the Program, the Contributor who includes the Program in a commercial product offering should do so in a manner which does not create potential liability for other Contributors. Therefore, if a Contributor includes the Program in a commercial product offering, such Contributor ("Commercial Contributor") hereby agrees to defend and indemnify every other Contributor ("Indemnified Contributor") against any losses, damages and costs (collectively "Losses") arising from claims, lawsuits and other legal actions brought by a third party against the Indemnified Contributor to the extent caused by the acts or omissions of such Commercial Contributor in connection with its distribution of the Program in a commercial product offering. The obligations in this section do not apply to any claims or Losses relating to any actual or alleged intellectual property infringement. In order to qualify, an Indemnified Contributor must: a) promptly notify the Commercial Contributor in writing of such claim, and b) allow the Commercial Contributor to control, and cooperate with the Commercial Contributor in, the defense and any related settlement negotiations. The Indemnified Contributor may participate in any such claim at its own expense.

For example, a Contributor might include the Program in a commercial product offering, Product X. That Contributor is then a Commercial Contributor. If that Commercial Contributor then makes performance claims, or offers warranties related to Product X, those performance claims and warranties are such Commercial Contributor's responsibility alone. Under this section, the Commercial Contributor would have to defend claims against the other Contributors related to those performance claims and warranties, and if a court requires any other Contributor to pay any damages as a result, the Commercial Contributor must pay those damages.

5. NO WARRANTY

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the appropriateness of using and distributing the Program and assumes all risks associated with its exercise of rights under this Agreement, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and unavailability or interruption of operations.

6. DISCLAIMER OF LIABILITY

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

7. GENERAL

If any provision of this Agreement is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this Agreement, and without further action by the parties hereto, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.

If Recipient institutes patent litigation against a Contributor with respect to a patent applicable to software (including a cross-claim or counterclaim in a lawsuit), then any patent licenses granted by that Contributor to such Recipient under this Agreement shall terminate as of the date such litigation is filed. In addition, if Recipient institutes patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Program itself (excluding combinations of the Program with other software or hardware) infringes such Recipient's patent(s), then such Recipient's rights granted under Section 2(b) shall terminate as of the date such litigation is filed.

All Recipient's rights under this Agreement shall terminate if it fails to comply with any of the material terms or conditions of this Agreement and does not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all Recipient's rights under this Agreement terminate, Recipient agrees to cease use and distribution of the Program as soon as reasonably practicable. However, Recipient's obligations under this Agreement and any licenses granted by Recipient relating to the Program shall continue and survive.

Everyone is permitted to copy and distribute copies of this Agreement, but in order to avoid inconsistency the Agreement is copyrighted and may only be modified in the following manner. The Agreement Steward reserves the right to publish new versions (including revisions) of this Agreement from time to time. No one other than the Agreement Steward has the right to modify this Agreement. IBM is the initial Agreement Steward. IBM may assign the responsibility to serve as the Agreement Steward to a suitable separate entity. Each new version of the Agreement will be given a distinguishing version number. The Program (including Contributions) may always be distributed subject to the version of the Agreement under which it was received. In addition, after a new version of the Agreement is published, Contributor may elect to distribute the Program (including its Contributions) under the new version. Except as expressly stated in Sections 2(a) and 2(b) above, Recipient receives no rights or licenses to the intellectual property of any Contributor under this Agreement, whether expressly, by implication, estoppel or otherwise. All rights in the Program not expressly granted under this Agreement are reserved.

This Agreement is governed by the laws of the State of New York and the intellectual property laws of the United States of America. No party to this Agreement will bring a legal action under this Agreement more than one year after the cause of action arose. Each party waives its rights to a jury trial in any resulting litigation.

Cloud

QuickBooks Time - CData Cloud

Overview

Key Features

Getting Started

Connecting to QuickBooks Time

Accessing Data from CData Cloud Services

Establishing a Connection

Connecting to QuickBooks Time

Creating a Custom OAuth Application

Creating a Custom OAuth Application

Procedure

SSL Configuration

Customizing the SSL Configuration

Firewall and Proxy

Connecting Through a Firewall or Proxy

HTTP Proxies

Other Proxies

Data Model

Overview

Key Features

Views

Tables

CData Cloud - QuickBooks Time Tables

CustomFieldItemFilters

Table Specific Information

Select

Insert

Update

Columns

Pseudo-Columns

CustomFieldItems

Table Specific Information

Select

Insert

Update

Columns

Pseudo-Columns

CustomFields

Table Specific Information

Select

Insert

Update

Columns

Pseudo-Columns

EstimateItems

Table Specific Information

Select

Insert

Update

Columns

Pseudo-Columns

Estimates

Table Specific Information

Select

Insert

Update

Columns

Pseudo-Columns

Files

Table Specific Information

Select

Update

Delete

Columns

Pseudo-Columns

GeoLocations

Table Specific Information

Select

Insert

Columns

Pseudo-Columns

Groups

Table Specific Information

Select

Insert

Update

Columns

Pseudo-Columns

JobcodeAssignments