接続の確立

QuickBooks Time への接続を追加

QuickBooks Time への接続を追加するには：

アプリケーションコンソールで、接続ページに移動します。
接続の追加パネルで、追加したい接続のアイコンを選択します。
QuickBooks Time アイコンが利用できない場合は、Add More アイコンをクリックしてCData サイトからQuickBooks Time コネクタをダウンロードおよびインストールします。

必須プロパティについては、設定タブを参照してください。

通常必須ではない接続プロパティについては、高度な設定タブを参照してください。

QuickBooks Time への接続

QuickBooks Time は、ユーザー認証のためのOAuth 標準をサポートしています。この認証を有効にするには、すべてのOAuth フローでカスタムOAuth アプリケーションを作成し、AuthScheme をOAuth に設定する必要があります。

以下のサブセクションでは、3つの一般的な認証フローでのQuickBooks Time への認証について詳しく説明します。

デスクトップ：ユーザーのローカルマシン上でのサーバーへの接続で、テストやプロトタイピングによく使用されます。
Web：共有ウェブサイト経由でデータにアクセスします。
ヘッドレスサーバー：他のコンピュータやそのユーザーにサービスを提供する専用コンピュータで、モニタやキーボードなしで動作するように構成されています。

カスタムOAuth アプリケーションの作成については、カスタムOAuth アプリケーションの作成を参照してください。

QuickBooks Time で利用可能な接続文字列プロパティの全リストは、Connection を参照してください。

OAuth アクセストークンの自動リフレッシュ：

Sync App がOAuth アクセストークンを自動的にリフレッシュするようにするには：

はじめてデータに接続する前に、次の接続パラメータを設定します。
- InitiateOAuth： REFRESH。
- OAuthClientId：アプリケーション設定のクライアントId。
- OAuthClientSecret：アプリケーション設定のクライアントシークレット。
- OAuthAccessToken：GetOAuthAccessToken によって返されたアクセストークン。
- OAuthSettingsLocation：Sync App がOAuth 値を保存する場所のパス。これは接続間で維持されます。
その後のデータ接続では、以下を設定します。
- InitiateOAuth
- OAuthSettingsLocation

OAuth アクセストークンの手動リフレッシュ：

OAuth アクセストークンを手動でリフレッシュするために必要な唯一の値は、OAuth リフレッシュトークンです。

ExpiresIn 期間（GetOAuthAccessToken が返す）が経過した後にOAuthAccessToken を手動でリフレッシュするには、RefreshOAuthAccessToken ストアドプロシージャを呼び出します。
次の接続プロパティを設定します。
- OAuthClientId：アプリケーション設定のクライアントId。
- OAuthClientSecret：アプリケーション設定のクライアントシークレット。
RefreshOAuthAccessToken を呼び出し、OAuthRefreshToken にGetOAuthAccessToken によって返されたOAuth リフレッシュトークンを設定します。
新しいトークンが取得できたら、OAuthAccessToken プロパティにRefreshOAuthAccessToken によって返された値を設定します。これで新規接続が開かれます。

OAuth リフレッシュトークンを保存し、OAuth アクセストークンの有効期限が切れた後に手動でリフレッシュできるようにします。

高度な機能

このセクションでは、QuickBooks Time Sync App の高度な機能を厳選して説明します。

ユーザー定義ビュー

Sync App はユーザー定義ビューの使用をサポートします。これは事前設定されたユーザー定義クエリによって内容が決定される仮想テーブルです。このビューは、ドライバーに発行されるクエリを直接制御できない場合に有効です。カスタムビューの作成と設定の概要については、ユーザー定義ビューを参照してください。

SSL の設定

SSL の設定を使用して、Sync App が証明書のネゴシエーションをどのように扱うかを調整します。さまざまな証明書形式を選択できます。詳しくは、「接続文字列オプション」にあるSSLServerCert プロパティを参照してください。

ファイアウォールとプロキシ

Windows プロキシとHTTP プロキシを含むファイアウォールとプロキシに合致するようSync App を設定します。トンネル接続を設定することもできます。

クエリ処理

Sync App は、QuickBooks Time にできるだけ多くのSELECT ステートメント処理をオフロードし、残りのクエリをクライアント側のインメモリで処理します。

詳しくは、クエリ処理を参照してください。

ログ

CData ログを調整するために使用可能な設定の概要については、ログを参照してください。基本的なロギングに必要なのは2つの接続プロパティだけですが、より詳細なロギングをサポートする多くの機能があり、LogModules 接続プロパティを使用してロギングする情報のサブセットを指定することができます。

SSL の設定

SSL 設定のカスタマイズ

デフォルトでは、Sync App はサーバーとのTLS のネゴシエーションを試みます。サーバー証明書は、デフォルトのシステム信頼済み証明書ストアで検証されます。SSLServerCert 接続プロパティを使用して、証明書の検証方法をオーバーライドできます。

別の証明書を指定するには、SSLServerCert 接続プロパティを参照してください。

ファイアウォールとプロキシ

Firewall またはProxy 経由の接続

HTTP プロキシ

HTTP プロキシへの認証には、以下のように設定します。

ProxyServer：HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。
ProxyPort：プロキシサーバーが起動しているTCP ポート。
ProxyAuthScheme：プロキシサーバーに対して認証する際にSync App が使用する認証方法。
ProxyUser：プロキシサーバーに登録されているユーザーアカウントのユーザー名。
ProxyPassword：ProxyUser に紐付けられたパスワード。

その他のプロキシ

次のプロパティを設定します。

プロキシベースのファイヤーウォールを使用するには、FirewallType、FirewallServer、およびFirewallPort を設定します。
接続をトンネルするには、FirewallType をTUNNEL に設定します。
認証するには、FirewallUser とFirewallPassword を設定します。
SOCKS プロキシへの認証には、さらにFirewallType をSOCKS5 に設定します。

データモデル

概要

このセクションでは、利用可能なAPI オブジェクトを示し、QuickBooks Time API へのSQL の実行について詳しく説明します。

主要機能

Sync App はドキュメント、フォルダ、およびグループなどのQuickBooks Time エンティティをリレーショナルビューとしてモデル化し、SQL を記述してQuickBooks Time データをクエリできるようにします。
ストアドプロシージャを使用するとQuickBooks Time の操作を実行できます。
これらのオブジェクトへのライブ接続により、Sync App を使用するとQuickBooks Time アカウントへのあらゆる変更が即座に反映されます。

ビュー

ビューでは、利用可能なビューを説明します。ビューは、Timesheets、Users、Files などを静的にモデル化するように定義されています。

テーブル

Sync App はQuickBooks Time のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。

QuickBooks Time Connector for CData Sync テーブル


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 Sync App 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 Sync App.

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

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。


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 Sync App 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 Sync App.

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

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。


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 Sync App 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 Sync App.

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

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。


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 Sync App 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 Sync App.

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

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。


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 Sync App 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 Sync App.

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

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。


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 Sync App 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 Sync App.

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

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。


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 Sync App 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 Sync App.

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

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。


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 Sync App 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 Sync App.

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

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。


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 Sync App 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 Sync App.

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

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。


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 Sync App 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 Sync App.

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	String	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

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。


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 Sync App 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 Sync App.

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

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。


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 Sync App 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 Sync App.

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 Sync App 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 Sync App.

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

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。


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 Sync App 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 Sync App.

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

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。


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 Sync App 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 Sync App.

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. 使用できる値は次のとおりです。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

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。


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 Sync App 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 Sync App.

UserId fields support the =, IN operators.
ReminderType field support the =, IN operators.
ActiveStatus filter support the = operator.
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,

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。


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

ScheduleEvents

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

Table Specific Information

Select

The Sync App 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 Sync App.

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

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。


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 Sync App 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 Sync App.

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

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。


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 Sync App 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 Sync App.

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

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。


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 Sync App 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 Sync App.

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

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。


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 Sync App 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 Sync App.

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)
Pronouns	String	True	The personal pronouns 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 pronouns value (users who have not setup their pronouns 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

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。


Name	Type	Description
ActiveStatus	Boolean	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

ビュー

ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。

クエリは、ビューに対して通常のテーブルと同様に実行することができます。

QuickBooks Time Connector for CData Sync ビュー


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 Sync App 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 Sync App.

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 Sync App.

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	String	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	String	Date on which this user was hired.
TermDate	String	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	Integer	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 Sync App 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 Sync App.

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

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。


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 Sync App 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 Sync App.

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

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。


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 Sync App 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 Sync App.

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 Sync App 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 Sync App.

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

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。


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 Sync App 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 Sync App.

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

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。


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 Sync App 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 Sync App.

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

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。


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 Sync App 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 Sync App.

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

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。


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 Sync App 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 Sync App. 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

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。


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 Sync App 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 Sync App. 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

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。


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 Sync App 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 Sync App.

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

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。


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 Sync App 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 Sync App.

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

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。


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 Sync App 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 Sync App.

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. 使用できる値は次のとおりです。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	Int	Preview assigned user ids.
TotalAssignedUsers	Int	Total assigned users.
TrackedTimeUsers	Int	Tracked time users.
TrackedTimeGroups	Int	Tracked time groups.
TrackedTimeJobcodes	Int	Tracked time jobcodes.
TrackedTimeCustomFields	Int	Tracked time customfields.
OnTheClock	Boolean	On The Clock.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。


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 Sync App 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 Sync App.

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

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。


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 Sync App 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 Sync App. 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 Sync App 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 Sync App.

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 Sync App 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 Sync App.

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

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。


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 Sync App 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 Sync App.

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.

接続文字列オプション

接続文字列プロパティは、接続を確立するために使用できるさまざまなオプションです。このセクションでは、本プロバイダーの接続文字列で設定できるオプションの一覧を示します。詳細については各リンクをクリックしてください。

接続を確立する方法について詳しくは、接続の確立を参照してください。

OAuth

プロパティ	説明
OAuthClientId	カスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。（コンシューマーキーとも呼ばれます。）このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。
OAuthClientSecret	カスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。（コンシューマーシークレットとも呼ばれます。）このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。

SSL

プロパティ	説明
SSLServerCert	TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。

Firewall

プロパティ	説明
FirewallType	provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。
FirewallServer	ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。
FirewallPort	プロキシベースのファイアウォールで使用するTCP ポートを指定します。
FirewallUser	プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。
FirewallPassword	プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。

Proxy

プロパティ	説明
ProxyAutoDetect	provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。
ProxyServer	HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。
ProxyPort	クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバー（ProxyServer 接続プロパティで設定）のTCP ポート。
ProxyAuthScheme	ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。
ProxyUser	ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名。
ProxyPassword	ProxyUser 接続プロパティで指定されたユーザーに紐付けられたパスワード。
ProxySSLType	ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプ。
ProxyExceptions	ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

Logging

プロパティ	説明
LogModules	ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。

Schema

プロパティ	説明
Location	テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。
BrowsableSchemas	レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
Tables	レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。
Views	レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。

Miscellaneous

プロパティ	説明
IncludeCustomFields	A boolean indicating if you would like to include custom fields in the column listing.
MaxRows	集計やGROUP BY を使用しないクエリで返される最大行数を指定します。
Other	特定のユースケースに対して追加の隠しプロパティを指定します。これらは通常のprovider の機能では必要ありません。複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。
Pagesize	QuickBooks Time から返される、1ページあたりの結果の最大数を指定します。この設定は、ほとんどのユースケースに最適化されている、データソースによって設定されたデフォルトのページサイズをオーバーライドします。
PseudoColumns	テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。
RowScanDepth	テーブルで利用可能なカラムを探すためにスキャンする行数の最大値。
Timeout	provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。
UserDefinedViews	カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。

OAuth

このセクションでは、本プロバイダーの接続文字列で設定可能なOAuth プロパティの全リストを提供します。

プロパティ	説明
OAuthClientId	カスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。（コンシューマーキーとも呼ばれます。）このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。
OAuthClientSecret	カスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。（コンシューマーシークレットとも呼ばれます。）このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。

OAuthClientId

カスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。（コンシューマーキーとも呼ばれます。）このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。

解説

OAuthClientId は、ユーザーがOAuth 経由で認証を行う前に設定する必要があるいくつかの接続パラメータの1つです。詳細は接続の確立を参照してください。

OAuthClientSecret

カスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。（コンシューマーシークレットとも呼ばれます。）このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。

解説

OAuthClientSecret は、ユーザーがOAuth 経由で認証を行う前に設定する必要があるいくつかの接続パラメータの1つです。詳細は接続の確立を参照してください。

SSL

このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。

プロパティ	説明
SSLServerCert	TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。

SSLServerCert

TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。

解説

TLS/SSL 接続を使用する場合は、このプロパティを使用して、サーバーが受け入れるTLS/SSL 証明書を指定できます。コンピュータによって信頼されていない他の証明書はすべて拒否されます。

このプロパティは、次のフォームを取ります：


説明	例
フルPEM 証明書（例では省略されています）	-----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
証明書を保有するローカルファイルへのパス。	C:\cert.cer
公開鍵（例では省略されています）	-----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
MD5 Thumbprint （hex 値はスペースおよびコロン区切り）	ecadbdda5a1529c58a1e9e09828d70e4
SHA1 Thumbprint （hex 値はスペースおよびコロン区切り）	34a929226ae0819f2ec14b4a3d904f801cbb150d

これを指定しない場合は、マシンが信用するすべての証明書が受け入れられます。

すべての証明書の受け入れを示すには、'*'を使用します。セキュリティ上の理由から、これはお勧めできません。

Firewall

このセクションでは、本プロバイダーの接続文字列で設定可能なFirewall プロパティの全リストを提供します。

プロパティ	説明
FirewallType	provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。
FirewallServer	ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。
FirewallPort	プロキシベースのファイアウォールで使用するTCP ポートを指定します。
FirewallUser	プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。
FirewallPassword	プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。

FirewallType

provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。

解説

プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

Note：デフォルトでは、Sync App はシステムプロキシに接続します。この動作を無効化し、次のプロキシタイプのいずれかに接続するには、ProxyAutoDetect をfalse に設定します。

次の表は、サポートされている各プロトコルのポート番号情報です。


プロトコル	デフォルトポート	説明
TUNNEL	80	Sync App がQuickBooks Time への接続を開くポート。トラフィックはこの場所のプロキシを経由して行き来します。
SOCKS4	1080	Sync App がQuickBooks Time への接続を開くポート。SOCKS 4 は次にFirewallUser 値をプロキシに渡し、接続リクエストが許容されるかどうかを決定します。
SOCKS5	1080	Sync App がQuickBooks Time にデータを送信するポート。SOCKS 5 プロキシに認証が必要な場合には、FirewallUser およびFirewallPassword をプロキシが認識する認証情報に設定します。

HTTP プロキシへの接続には、ProxyServer およびProxyPort ポートを使ってください。HTTP プロキシへの認証には、ProxyAuthScheme、ProxyUser、およびProxyPassword を使ってください。

FirewallServer

ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。

解説

プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

FirewallPort

プロキシベースのファイアウォールで使用するTCP ポートを指定します。

解説

プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

FirewallUser

プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。

解説

プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

FirewallPassword

プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。

解説

プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

Proxy

このセクションでは、本プロバイダーの接続文字列で設定可能なProxy プロパティの全リストを提供します。

プロパティ	説明
ProxyAutoDetect	provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。
ProxyServer	HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。
ProxyPort	クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバー（ProxyServer 接続プロパティで設定）のTCP ポート。
ProxyAuthScheme	ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。
ProxyUser	ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名。
ProxyPassword	ProxyUser 接続プロパティで指定されたユーザーに紐付けられたパスワード。
ProxySSLType	ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプ。
ProxyExceptions	ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

ProxyAutoDetect

provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。

解説

この接続プロパティをTrue に設定すると、Sync App は既存のプロキシサーバー構成についてシステムプロキシ設定をチェックします（プロキシサーバーの詳細を手動で入力する必要はありません）。

この接続プロパティは他のプロキシ設定より優先されます。特定のプロキシサーバーに接続するためにSync App を手動で構成する場合は、False に設定します。

HTTP プロキシへの接続には、ProxyServer を参照してください。SOCKS やトンネリングなどの他のプロキシには、FirewallType を参照してください。

ProxyServer

HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。

解説

ProxyAutoDetect がFalse に設定されている場合、Sync App はこの接続プロパティで指定されたプロキシサーバーを通じてのみHTTP トラフィックをルーティングします。ProxyAutoDetect がTrue に設定されている場合（デフォルト）、Sync App は代わりにシステムプロキシ設定で指定されたプロキシサーバーを介してHTTP トラフィックをルーティングします。

ProxyPort

クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバー（ProxyServer 接続プロパティで設定）のTCP ポート。

解説

ProxyAutoDetect がFalse に設定されている場合、Sync App はこの接続プロパティで指定されたプロキシサーバーポートを通じてのみHTTP トラフィックをルーティングします。ProxyAutoDetect がTrue に設定されている場合（デフォルト）、Sync App は代わりにシステムプロキシ設定で指定されたプロキシサーバーポートを介してHTTP トラフィックをルーティングします。

その他のプロキシタイプについては、FirewallType を参照してください。

ProxyAuthScheme

ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。

解説

認証タイプは次のいずれかです。

BASIC：Sync App はHTTP BASIC 認証を行います。
DIGEST：Sync App はHTTP DIGEST 認証を行います。
NTLM：Sync App はNTLM トークンを取得します。
NEGOTIATE：Sync App は認証において有効なプロトコルに応じて、NTLM もしくはKerberos トークンを取得します。
NONE：ProxyServer が認証を必要としない場合に設定します。

"NONE" 以外のすべての値については、ProxyUser およびProxyPassword 接続プロパティも設定する必要があります。

SOCKS 5 認証のような他の認証タイプを使用するには、FirewallType を参照してください。

ProxyUser

ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名。

解説

ProxyUser および ProxyPassword 接続プロパティは、ProxyServer で指定されたHTTP プロキシに対して接続よび認証するために使用されます。

ProxyAuthScheme で利用可能な認証タイプを1つ選択した後、このプロパティを以下のように設定します。


ProxyAuthScheme の値	ProxyUser に設定する値
BASIC	プロキシサーバーに登録されているユーザーのユーザー名。
DIGEST	プロキシサーバーに登録されているユーザーのユーザー名。
NEGOTIATE	プロキシサーバーが属するドメインまたは信頼されたドメイン内の有効なユーザーであるWindows ユーザーのユーザー名。`user@domain` または`domain\user` の形式で指定。
NTLM	プロキシサーバーが属するドメインまたは信頼されたドメイン内の有効なユーザーであるWindows ユーザーのユーザー名。`user@domain` または`domain\user` の形式で指定。
NONE	ProxyPassword 接続プロパティは設定しないでください。

Sync App は、ProxyAutoDetect がFalse に設定されている場合にのみ、このユーザー名を使用します。ProxyAutoDetect がTrue に設定されている場合（デフォルト）、Sync App は代わりにシステムのプロキシ設定で指定されているユーザー名を使用します。

ProxyPassword

ProxyUser 接続プロパティで指定されたユーザーに紐付けられたパスワード。

解説

ProxyUser および ProxyPassword 接続プロパティは、ProxyServer で指定されたHTTP プロキシに対して接続よび認証するために使用されます。

ProxyAuthScheme で利用可能な認証タイプを1つ選択した後、このプロパティを以下のように設定します。


ProxyAuthScheme の値	ProxyPassword に設定する値
BASIC	ProxyUser で指定したプロキシサーバーユーザーに紐付けられたパスワード。
DIGEST	ProxyUser で指定したプロキシサーバーユーザーに紐付けられたパスワード。
NEGOTIATE	ProxyUser で指定したWindows ユーザーアカウントに紐付けられたパスワード。
NTLM	ProxyUser で指定したWindows ユーザーアカウントに紐付けられたパスワード。
NONE	ProxyPassword 接続プロパティは設定しないでください。

SOCKS 5 認証もしくは、トンネリングは、FirewallType を参照してください。

Sync App は、ProxyAutoDetect がFalse に設定されている場合にのみ、このパスワードを使用します。ProxyAutoDetect がTrue に設定されている場合（デフォルト）、Sync App は代わりにシステムのプロキシ設定で指定されているパスワードを使用します。

ProxySSLType

ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプ。

解説

このプロパティは、ProxyServer で指定されたHTTP プロキシへの接続にSSL を使用するかどうかを決定します。この接続プロパティには、以下の値を設定できます。


AUTO	デフォルト設定。ProxyServer がHTTPS URL に設定されている場合、Sync App は、TUNNEL オプションを使用します。ProxyServer がHTTP URL に設定されている場合、コンポーネントはNEVER オプションを使用します。
ALWAYS	接続は、常にSSL 有効となります。
NEVER	接続は、SSL 有効になりません。
TUNNEL	接続はトンネリングプロキシ経由で行われます。プロキシサーバーがリモートホストへの接続を開き、プロキシを経由して通信が行われます。

ProxyExceptions

ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

解説

ProxyServer は、このプロパティで定義されたアドレスを除くすべてのアドレスに使用されます。セミコロンを使用してエントリを区切ります。

Sync App はデフォルトでシステムプロキシ設定を使用するため、それ以上の設定は必要ありません。この接続にプロキシ例外を明示的に設定する場合は、ProxyAutoDetect をFalse に設定します。

Logging

このセクションでは、本プロバイダーの接続文字列で設定可能なLogging プロパティの全リストを提供します。

プロパティ	説明
LogModules	ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。

LogModules

ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。

解説

このプロパティは、含めるログモジュールを指定することでログファイルの内容をカスタマイズすることができます。ログモジュールは、クエリ実行、メタデータ、SSL 通信などの異なる領域にログ情報を分類します。各モジュールは4文字のコードで表され、文字の名前の場合は末尾にスペースが必要なものもあります。

例えば、EXEC はクエリ実行をログに記録し、INFO は一般的なプロバイダーメッセージをログに記録します。複数のモジュールを含めるには、次のように名前をセミコロンで区切ります：INFO;EXEC;SSL。

Verbosity 接続プロパティは、このプロパティで指定されたモジュールベースのフィルタリングよりも優先されます。 Verbosity レベルを満たし、指定されたモジュールに属するログエントリのみが記録されます。利用可能なすべてのモジュールをログファイルに含めるには、このプロパティを空白のままにします。

利用可能なモジュールの完全なリストとログの設定に関する詳細な手引きについては、ログの「高度なログの記録」セクションを参照してください。

Schema

このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。

プロパティ	説明
Location	テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。
BrowsableSchemas	レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
Tables	レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。
Views	レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。

Location

テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。

解説

Location プロパティは、定義をカスタマイズしたり（例えば、カラム名を変更する、カラムを無視するなど）、新しいテーブル、ビュー、またはストアドプロシージャでデータモデルを拡張する場合にのみ必要です。

指定しない場合、デフォルトの場所は%APPDATA%\\CData\\QuickBooksTime Data Provider\\Schema となり、%APPDATA%はユーザーのコンフィギュレーションディレクトリに設定されます：


プラットフォーム	%APPDATA%
Windows	APPDATA 環境変数の値
Linux	~/.config

BrowsableSchemas

レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。

解説

利用可能なデータベーススキーマをすべてリストすると余分な時間がかかり、パフォーマンスが低下します。接続文字列にスキーマのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。

Tables

レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。

解説

データベースによっては、利用可能なすべてのテーブルをリストするのに時間がかかり、パフォーマンスが低下する場合があります。接続文字列にテーブルのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。

利用可能なテーブルがたくさんあり、すでに作業したいテーブルが決まっている場合、このプロパティを使用して対象のテーブルのみに表示を制限することができます。これを行うには、カンマ区切りのリストで使用したいテーブルを指定します。各テーブルは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。例えば、Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space` です。

Note：複数のスキーマまたはカタログを持つデータソースに接続する場合は、表示する各テーブルを完全修飾名で指定する必要があります。これにより、複数のカタログやスキーマに存在するテーブルが混同されることを防ぎます。

Views

レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。

解説

データベースによっては、利用可能なすべてのビューをリストするのに時間がかかり、パフォーマンスが低下する場合があります。接続文字列にビューのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。

利用可能なビューがたくさんあり、すでに作業したいビューが決まっている場合、このプロパティを使用して対象のビューのみに表示を制限することができます。これを行うには、カンマ区切りのリストで使用したいビューを指定します。各ビューは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。例えば、Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space` です。

Note：複数のスキーマまたはカタログを持つデータソースに接続する場合は、確認する各ビューを完全修飾名で指定する必要があります。これにより、複数のカタログやスキーマに存在するビューが混同されることを防ぎます。

Miscellaneous

このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。

プロパティ	説明
IncludeCustomFields	A boolean indicating if you would like to include custom fields in the column listing.
MaxRows	集計やGROUP BY を使用しないクエリで返される最大行数を指定します。
Other	特定のユースケースに対して追加の隠しプロパティを指定します。これらは通常のprovider の機能では必要ありません。複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。
Pagesize	QuickBooks Time から返される、1ページあたりの結果の最大数を指定します。この設定は、ほとんどのユースケースに最適化されている、データソースによって設定されたデフォルトのページサイズをオーバーライドします。
PseudoColumns	テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。
RowScanDepth	テーブルで利用可能なカラムを探すためにスキャンする行数の最大値。
Timeout	provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。
UserDefinedViews	カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。

IncludeCustomFields

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

解説

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

MaxRows

集計やGROUP BY を使用しないクエリで返される最大行数を指定します。

解説

このプロパティは、集計やGROUP BY 句を含まないクエリに対してSync App が返す行数の上限を設定します。この制限により、クエリがデフォルトで過度に大きな結果セットを返さないようにします。

クエリにLIMIT 句が含まれている場合、クエリで指定された値がMaxRows 設定よりも優先されます。 MaxRows が"-1" に設定されている場合、LIMIT 句が明示的にクエリに含まれていない限り、行の制限は行われません。

このプロパティは、非常に大きなデータセットを返す可能性のあるクエリを実行する際に、パフォーマンスを最適化し過剰なリソース消費を防ぐのに役立ちます。

Other

特定のユースケースに対して追加の隠しプロパティを指定します。これらは通常のprovider の機能では必要ありません。複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。

解説

このプロパティは、シニアユーザーが特定のシナリオに対して隠しプロパティを設定できるようにします。これらの設定は通常のユースケースには必要ありませんが、特定の要件に対応したり、追加の機能を提供したりすることができます。複数のプロパティをセミコロン区切りのリストで定義できます。

Note： 特定のシナリオや問題に対処するためにサポートチームから助言があった場合にのみ、これらのプロパティを設定することを強く推奨します。

複数のプロパティをセミコロン区切りリストで指定します。

統合およびフォーマット


DefaultColumnSize	データソースがメタデータにカラムの長さを提供しない場合に、文字列フィールドのデフォルトの長さを設定します。デフォルト値は2000です。
ConvertDateTimeToGMT	日時の値を、マシンのローカルタイムではなくGMT グリニッジ標準時に変換するかどうかを決定します。
RecordToFile=filename	基底のソケットデータ転送を指定のファイルに記録します。

Pagesize

QuickBooks Time から返される、1ページあたりの結果の最大数を指定します。この設定は、ほとんどのユースケースに最適化されている、データソースによって設定されたデフォルトのページサイズをオーバーライドします。

解説

クエリする特定のオブジェクトやサービスエンドポイントの結果を最適化するために、デフォルトのページサイズを調整したい場合があります。ページサイズを大きくするとパフォーマンスが向上するかもしれませんが、ページあたりのメモリ消費量が増える可能性もあることに注意してください。

PseudoColumns

テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。

解説

このプロパティを使用すると、Sync App がテーブルカラムとして公開する擬似カラムを定義できます。

個々の擬似カラムを指定するには、以下の形式を使用します。"Table1=Column1;Table1=Column2;Table2=Column3"

すべてのテーブルのすべての擬似カラムを含めるには、次のようにします："*=*"

RowScanDepth

テーブルで利用可能なカラムを探すためにスキャンする行数の最大値。

解説

テーブルのカラムはテーブル行をスキャンすることで決定される必要があります。この値はスキャンされる行数の最大値を設定します。

大きい値を設定すると、パフォーマンスが低下する場合があります。小さい値を設定すると、特にnull データがある場合には、データ型を正しく判定できない場合があります。

Timeout

provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。

解説

このプロパティは、Sync App が操作をキャンセルする前に操作の完了を待機する最大時間を秒単位で制御します。操作の完了前にタイムアウト時間が経過すると、Sync App は操作をキャンセルして例外をスローします。

タイムアウトは、クエリや操作全体ではなくサーバーとの個々の通信に適用されます。例えば、各ページング呼び出しがタイムアウト制限内に完了する場合、クエリは60秒を超えて実行を続けることができます。

このプロパティを0に設定するとタイムアウトが無効になり、操作が成功するか、サーバー側のタイムアウト、ネットワークの中断、またはサーバーのリソース制限などの他の条件で失敗するまで無期限に実行されます。このプロパティは慎重に使用してください。長時間実行される操作がパフォーマンスを低下させたり、応答しなくなる可能性があるためです。

UserDefinedViews

カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。

解説

このプロパティを使用すると、UserDefinedViews.json というJSON 形式の構成ファイルを通じてカスタムビューを定義および管理できます。これらのビューはSync App によって自動的に認識され、標準のデータベースビューのようにカスタムSQL クエリを実行できるようになります。 JSON ファイルは、各ビューをルート要素として定義し、その子要素として"query" を持ちます。この"query" にはビューのSQL クエリが含まれています。次に例を示します。

{
	"MyView": {
		"query": "SELECT * FROM Timesheets WHERE MyColumn = 'value'"
	},
	"MyView2": {
		"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
	}
}

このプロパティを使用して、1つのファイルに複数のビューを定義し、ファイルパスを指定できます。例：UserDefinedViews=C:\Path\To\UserDefinedViews.json。このプロパティを使用すると、指定されたビューのみがSync App によって検知されます。

詳しくは、ユーザー定義ビューを参照してください。

QuickBooks Time Connector for CData Sync

QuickBooks Time Connector for CData Sync

概要

QuickBooks Time バージョンサポート

接続の確立

QuickBooks Time への接続を追加

QuickBooks Time への接続

高度な機能

ユーザー定義ビュー

SSL の設定

ファイアウォールとプロキシ

クエリ処理

ログ

SSL の設定

SSL 設定のカスタマイズ

ファイアウォールとプロキシ

Firewall またはProxy 経由の接続

HTTP プロキシ

その他のプロキシ

データモデル

概要

主要機能

ビュー

テーブル

QuickBooks Time Connector for CData Sync テーブル

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