The CData Sync App provides a straightforward way to continuously pipeline your TSheets data to any database, data lake, or data warehouse, making it easily available for Analytics, Reporting, AI, and Machine Learning.
The TSheets connector can be used from the CData Sync application to pull data from TSheets and move it to any of the supported destinations.
The Sync App leverages the TSheets API to enable bidirectional access to TSheets.
For required properties, see the Settings tab.
For connection properties that are not typically required, see the Advanced tab.
TSheets supports the OAuth standard for user authentication. To enable this authentication from all OAuth flows, you must create a custom OAuth application, and set AuthScheme to OAuth.
The following subsections describe how to authenticate to TSheets from three common authentication flows:
For information about how to create a custom OAuth application, see Creating a Custom OAuth Application.
For a complete list of connection string properties available in TSheets, see Connection.
Automatic refresh of the OAuth access token:
To have the Sync App automatically refresh the OAuth access token:
Manual refresh of the OAuth access token:
The only value needed to manually refresh the OAuth access token is the OAuth refresh token.
Store the OAuth refresh token so that you can use it to manually refresh the OAuth access token after it has expired.
This section details a selection of advanced features of the TSheets Sync App.
The Sync App allows you to define virtual tables, called user defined views, whose contents are decided by a pre-configured query. These views are useful when you cannot directly control queries being issued to the drivers. See User Defined Views for an overview of creating and configuring custom views.
Use SSL Configuration to adjust how Sync App handles TLS/SSL certificate negotiations. You can choose from various certificate formats; see the SSLServerCert property under "Connection String Options" for more information.
Configure the Sync App for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.
The Sync App offloads as much of the SELECT statement processing as possible to TSheets and then processes the rest of the query in memory (client-side).
See Query Processing for more information.
See Logging for an overview of configuration settings that can be used to refine CData logging. For basic logging, you only need to set two connection properties, but there are numerous features that support more refined logging, where you can select subsets of information to be logged using the LogModules connection property.
By default, the Sync App attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store.
To specify another certificate, see the SSLServerCert property for the available formats to do so.
To connect through the Windows system proxy, you do not need to set any additional connection properties. To connect to other proxies, set ProxyAutoDetect to false.
In addition, to authenticate to an HTTP proxy, set ProxyAuthScheme, ProxyUser, and ProxyPassword, in addition to ProxyServer and ProxyPort.
Set the following properties:
This section shows the available API objects and provides more information on executing SQL to TSheets APIs.
Views describes the available views. Views are statically defined to model Timesheets, Users, Files, and more.
The Sync App models the data in TSheets as a list of tables in a relational database that can be queried using standard SQL statements.
| Name | Description |
| 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. |
| 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. |
| Timesheets | This table contains a list of file objects. |
| Users | Retrieves a list of all users associated with your company. |
Retrieves a list of all geofence configs.
Query the GeoLocations table. The Sync App will use the TSheets 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.
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 can be executed by specifying the Created, UserId, Accuracy, Altitude, Latitude and Longitude columns. The columns that are not required can be inserted optionally. 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')
| 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 | True |
Date/time when this geolocation was created |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| LastModified | Datetime |
Date/time when this geofence config was last modified. |
| GroupId | String |
A comma-separated list of group ids. Only geolocations linked to users from these groups will be returned. |
This table contains a list of all groups associated with your company.
Query the Groups table. The Sync App will use the TSheets 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.
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 can be executed by specifying the Name column. The columns that are not required can be inserted optionally. 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 can be executed by specifying the Id in the WHERE Clause. The columns that are not read-only can be Updated.
For example:
UPDATE Groups SET Name = 'Group 1a', Active = 'false' WHERE Id = '10055'
| 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 | True |
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 |
Returns a list of all jobcode assignments associated with users.
Query the JobcodeAssignments table. The Sync App will use the TSheets 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.
For example, the following queries are processed server side:
SELECT * FROM JobcodeAssignments WHERE UserId IN (1242515, 1242515) SELECT * FROM JobcodeAssignments WHERE JobCodeParentId = 17285791
Insert can be executed by specifying the UserId and JobcodeId columns. The columns that are not required can be inserted optionally. Following is an example of how to insert into this table
INSERT INTO JobcodeAssignments (UserId, JobcodeId) VALUES ('1234', '39')
Delete can be executed by specifying the Id in the WHERE Clause.
For example:
DELETE FROM JobcodeAssignments WHERE Id = '41321421'
DELETE FROM JobcodeAssignments WHERE Id IN ('41321421', '41321435')
| 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 | True |
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 column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| JobCodeType | String |
Refers to the jobcode type - 'regular', 'pto', 'unpaid_break', 'paid_break', or 'all'. Defaults to 'regular'. |
| JobCodeParentId | Integer |
When omitted, all jobcode assignments are returned regardless of jobcode parent. If specified, only assignments for jobcodes with the given jobcode parent_id are returned. To get a list of only top-level jobcode assignments, pass in a jobcode_parent_id of 0. |
| ActiveStatus | String |
Filter column for whether to fetch only active records, only archived records, or both. By default, only active records are fetched. Possible values are: yes, no, both |
This table contains a list of jobcodes associated with your company
Query the Jobcodes table. The Sync App will use the TSheets 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.
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 can be executed by specifying the Name and Type columns. The columns that are not required can be inserted optionally. Following is an example of how to insert into this table
INSERT INTO Jobcodes (Name, Type) VALUES ('Group 1', 'pto')
Update can be executed by specifying the Id in the WHERE Clause. The columns that are not read-only can be Updated.
For example:
UPDATE Jobcodes SET Name = 'Group 2', Type = 'pto' WHERE Id = '10055'
| 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 |
Id of this jobcode's parent. 0 if it's top-level. |
| 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 | True |
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 |
| FilteredCustomFiledsItems | 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 | True |
If true and the beta feature for two-way sync is enabled, then changes made to the jobcode are immediately shared with QBO. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| ActiveStatus | String |
Filter column for whether to fetch only active records, only archived records, or both. By default, only active records are fetched. Possible values are: yes, no, both |
Retrieves a list of all locations associated with your company.
Query the Locations table. The Sync App will use the TSheets 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.
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 can be executed by specifying any columns. 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 can be executed by specifying the Id in the WHERE Clause. The columns that are not read-only can be Updated.
For example:
UPDATE Locations SET Address1 = 'Microsoft' WHERE Id = '10055'
| 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 | False |
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 | False |
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 column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| ByJobcodeAssignment | Boolean |
If specified, only locations mapped to a jobcode the user is assigned to will be returned. |
| ActiveStatus | String |
Filter column for whether to fetch only active records, only archived records, or both. By default, only active records are fetched. Possible values are: yes, no, both |
Retrieves a list of notifications associated with your company.
Query the Notifications table. The Sync App will use the TSheets 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.
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 can be executed by specifying the Message column. The columns that are not required can be inserted optionally. 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 can be executed by specifying the Id in the WHERE Clause.
For example:
DELETE FROM Notifications WHERE Id = '41321421'
DELETE FROM Notifications WHERE Id IN ('41321421', '4132567')
| Name | Type | ReadOnly | Description |
| Id [KEY] | Integer | True |
Id of the notification. |
| UserId | Integer | True |
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. |
Retrieves a list of reminders associated with your employees or company.
Query the Reminders table. The Sync App will use the TSheets 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.
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 can be executed by specifying UserId, ReminderType, DueTime, DueDaysOfWeek, DistributionMethods, Active and Enabled columns. The columns that are not required can be inserted optionally. 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 can be executed by specifying the Id in the WHERE Clause. The columns that are not read-only can be Updated.
For example:
UPDATE Reminders SET DueTime = '08:10:00', DistributionMethods = 'Email' WHERE Id = '10055'
| 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 | True |
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 column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| ActiveStatus | String |
Filter column for whether to fetch only active records, only archived records, or both. By default, only active records are fetched. Possible values are: yes, no, both |
Retrieves a list of schedule events associated with your employees or company.
Query the ScheduleEvents table. The Sync App will use the TSheets 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.
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 can be executed by specifying ScheduleCalendarId, Start, End and AllDay columns. The columns that are not required can be inserted optionally. 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 can be executed by specifying the Id in the WHERE Clause. The columns that are not read-only can be Updated.
For example:
UPDATE ScheduleEvents SET Title = 'New Title' WHERE Id = '14055'
| Name | Type | ReadOnly | Description |
| Id [KEY] | Integer | True |
Id of the schedule calendar. |
| ScheduleCalendarId | Integer | True |
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. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| TeamEvents | String |
Possible values: base or instance. Default is 'instance'. If 'instance' is specified, events that are assigned to multiple users will be returned as individual single events for each assigned user. If 'base' is specified, events that are assigned to multiple users will be returned as one combined event for all assignees. |
| ActiveUsers | Integer |
'0', '-1' or '1' . Default is '1'. Only schedule events whose users are active will be returned by default. 0 will return events for inactive users. -1 will return events for active and inactive users. |
| ActiveStatus | String |
Filter column for whether to fetch only active records, only archived records, or both. By default, only active records are fetched. Possible values are: yes, no, both |
This table contains a list of file objects.
Query the Timesheets table. The Sync App will use the TSheets 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.
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 can be executed by specifying 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. 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 can be executed by specifying the Id in the WHERE Clause. The columns that are not read-only can be Updated.
For example:
UPDATE Timesheets SET Date = '2018-08-08', EndTime = '2018-08-08T14:00:00-07:00' WHERE Id = '1242123'
Delete can be executed by specifying the Id in the WHERE Clause.
For example:
DELETE FROM Timesheets WHERE Id = '41321421'
| 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 | False |
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' |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| PayrollIds | Int |
A comma-separated string of payroll ids. Only time recorded against users with these payroll ids will be returned. |
| GroupIds | Int |
A comma-separated list of group ids. Only timesheets linked to users from these groups will be returned. |
Retrieves a list of all users associated with your company.
Query the Users table. The Sync App will use the TSheets 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.
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 can be executed by specifying UserName, FirstName and LastName columns. The columns that are not required can be inserted optionally. Following is an example of how to insert into this table
INSERT INTO Users (UserName, FirstName, LastName) VALUES ('cdatagroup@123', 'cdata', 'group')
Update can be executed by specifying the Id or UserName in the WHERE Clause. The columns that are not read-only can be Updated.
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'
| Name | Type | ReadOnly | Description |
| Id [KEY] | Integer | False |
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 | False |
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. |
| String | False |
Email address associated with this user. | |
| EmailVerified | Boolean | False |
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 | False |
Date/time when this user was last modified. |
| LastActive | Datetime | False |
Date/time when this user last performed any action. |
| Created | Datetime | False |
Date/time when this user was created |
| ClientUrl | String | False |
Client account url identifier associated with this user. |
| CompanyName | String | False |
Client account name identifier associated with the user. |
| ProfileImageUrl | String | False |
Url identifier associated with this user's profile image. |
| MobileNumber | String | False |
Mobile phone number associated with this user. |
| PTOBalances | String | False |
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 | False |
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. |
| PayRate | Double | False |
The rate of pay associated with this user. Only visible to admins. |
| PayInterval | String | False |
The timeframe to which this user's pay rate applies, either 'hour' or 'year'. Only visible to admins. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| ActiveStatus | String |
Filter column for whether to fetch only active records, only archived records, or both. By default, only active records are fetched. Possible values are: yes, no, both |
Views are similar to tables in the way that data is represented; however, views are read-only.
Queries can be executed against a view as if it were a normal table.
| Name | Description |
| CurrentTotalsReport | Report for the current totals (shift and day) along with additional information provided for those who are currently on the clock. |
| Files | This table contains a list of file objects. |
| 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 |
| ProjectReport | Retrieves a project report. |
| ScheduleCalendars | Retrieves a list of schedule calendars associated with your employees or company. |
| UserPermissions | The rights assignable to an individual user. |
Report for the current totals (shift and day) along with additional information provided for those who are currently on the clock.
Query the CurrentTotalsReport table. The Sync App will use the TSheets 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.
For example, the following query is processed server side:
SELECT * FROM CurrentTotalsReport WHERE GroupId IN ('29474', '29474') AND OnTheClock IN (true, false)
SELECT * FROM CurrentTotalsReport WHERE UserId IN (1751136, 1738864) AND OnTheClock = false
| 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. |
This table contains a list of file objects.
Query the Files table. The Sync App will use the TSheets 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.
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'
| Name | Type | Description |
| Id [KEY] | String | Id of this file. |
| Name | String | Name of this file. |
| UploadByUserId | Int | Id of the user that uploaded this file. |
| Active | Boolean | If false, this file is considered deleted. |
| Size | Int | Size of the file in bytes. |
| Created | Datetime | Date/time when this customfield was created |
| LastModified | Datetime | Date/time when this customfield was last modified. |
| FileDescription | String | Description of this file. |
| ImageRotation | Int | Original image orientation in degrees. Accepted values are: 0 (top), 90 (right), 180 (bottom), 270 (left). |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| ActiveStatus | String | Filter column for whether to fetch only active records, only archived records, or both. By default, only active records are fetched. Possible values are: yes, no, both |
Retrieves a list of all effective settings associated with a single user.
Query the GeneralSettings table. All the filters are executed client side within the Sync App.
| 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. |
Retrieves a list of all geofence configs.
Query the GeofenceConfigs table. The Sync App will use the TSheets 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.
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
| 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 column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| ActiveStatus | String | Filter column for whether to fetch only active records, only archived records, or both. By default, only active records are fetched. Possible values are: yes, no, both |
Retrieves a list of last_modified timestamps associated with each requested API endpoint.
Query a list of last modified timestamps associated with each requested API endpoint.
For example, the following queries are processed server side:
SELECT * FROM LastModifiedTimestamps WHERE endpoints = 'timesheets,current_user,groups'
| 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 column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| Endpoints | String | Comma separated list of one or more endpoints. |
Retrieves a list of all locations maps associated with your company.
Query the LocationMaps table. The Sync App will use the TSheets 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.
For example, the following queries are processed server side:
SELECT * FROM LocationMaps WHERE Id IN ('102839', '110761')
SELECT * FROM LocationMaps WHERE ByJobcodeAssignment = true
| 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 column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| ByJobcodeAssignment | Boolean | If specified only locations maps mapped to a jobcode the user is assigned to will be returned. |
Retrieves a list of managed clients available from your account.
Query the ManagedClients table. The Sync App will use the TSheets 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.
For example, the following queries are processed server side:
SELECT * FROM ManagedClients WHERE ActiveStatus = 'both'
| Name | Type | Description |
| Id [KEY] | String | Id of the managed client. |
| CompanyUrl | String | URL used by the managed client to sign in to TSheets. |
| 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 column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| ActiveStatus | String | Filter column for whether to fetch only active records, only archived records, or both. By default, only active records are fetched. Possible values are: yes, no, both |
Payroll Report associated with a timeframe.
Query the PayrollReport table to retrieve payrolls associated with a timeframe, with filters to narrow down the results. The Sync App will use the TSheets 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.
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'
| 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 |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| GroupId | String | A comma-seperated list of group ids. Only time for users from these groups will be included. |
| IncludeZeroTime | String | If true, all users will be included in the output, even if they had zero hours for the time period. |
Payroll Report broken down by jobcode
Query the PayrollReportByJobCode table to retrieve a payroll report, broken down by jobcode, with filters to narrow down the results. The Sync App will use the TSheets 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.
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
| 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 column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| GroupId | String | A comma-seperated list of group ids. Only time for users from these groups will be included. |
| IncludeAdvancedOvertime | Boolean | If true, overtime will be formatted such that it includes the time for individual multipliers and can support more than just 1.5x (ot) and 2x (dt) overtime. |
Retrieves a project report.
Query the ProjectReport table to retrieve a project report, broken down by user, group or jobcode. The Sync App will use the TSheets 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.
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
| 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. |
Retrieves a list of schedule calendars associated with your employees or company.
Query the ScheduleCalendars table. The Sync App will use the TSheets 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.
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'
| 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. |
The rights assignable to an individual user.
Query the UserPermissions table. All the filters are executed client side within the Sync App.
| 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. |
The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.
For more information on establishing a connection, see Establishing a Connection.
| Property | Description |
| OAuthClientId | The client Id assigned when you register your application with an OAuth authorization server. |
| OAuthClientSecret | The client secret assigned when you register your application with an OAuth authorization server. |
| Property | Description |
| SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
| Property | Description |
| FirewallType | The protocol used by a proxy-based firewall. |
| FirewallServer | The name or IP address of a proxy-based firewall. |
| FirewallPort | The TCP port for a proxy-based firewall. |
| FirewallUser | The user name to use to authenticate with a proxy-based firewall. |
| FirewallPassword | A password used to authenticate to a proxy-based firewall. |
| Property | Description |
| ProxyAutoDetect | This indicates whether to use the system proxy settings or not. |
| ProxyServer | The hostname or IP address of a proxy to route HTTP traffic through. |
| ProxyPort | The TCP port the ProxyServer proxy is running on. |
| ProxyAuthScheme | The authentication type to use to authenticate to the ProxyServer proxy. |
| ProxyUser | A user name to be used to authenticate to the ProxyServer proxy. |
| ProxyPassword | A password to be used to authenticate to the ProxyServer proxy. |
| ProxySSLType | The SSL type to use when connecting to the ProxyServer proxy. |
| ProxyExceptions | A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer . |
| Property | Description |
| LogModules | Core modules to be included in the log file. |
| Property | Description |
| Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
| BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC. |
| Tables | This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC. |
| Views | Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC. |
| Property | Description |
| IncludeCustomFields | A boolean indicating if you would like to include custom fields in the column listing. |
| MaxRows | Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses. |
| Other | These hidden properties are used only in specific use cases. |
| Pagesize | The maximum number of results to return per page from TSheets. |
| PseudoColumns | This property indicates whether or not to include pseudo columns as columns to the table. |
| Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
| UserDefinedViews | A filepath pointing to the JSON configuration file containing your custom views. |
This section provides a complete list of the OAuth properties you can configure in the connection string for this provider.
| Property | Description |
| OAuthClientId | The client Id assigned when you register your application with an OAuth authorization server. |
| OAuthClientSecret | The client secret assigned when you register your application with an OAuth authorization server. |
The client Id assigned when you register your application with an OAuth authorization server.
As part of registering an OAuth application, you will receive the OAuthClientId value, sometimes also called a consumer key, and a client secret, the OAuthClientSecret.
The client secret assigned when you register your application with an OAuth authorization server.
As part of registering an OAuth application, you will receive the OAuthClientId, also called a consumer key. You will also receive a client secret, also called a consumer secret. Set the client secret in the OAuthClientSecret property.
This section provides a complete list of the SSL properties you can configure in the connection string for this provider.
| Property | Description |
| SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
The certificate to be accepted from the server when connecting using TLS/SSL.
If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.
This property can take the following forms:
| Description | Example |
| A full PEM Certificate (example shortened for brevity) | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
| A path to a local file containing the certificate | C:\cert.cer |
| The public key (example shortened for brevity) | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
| The MD5 Thumbprint (hex values can also be either space or colon separated) | ecadbdda5a1529c58a1e9e09828d70e4 |
| The SHA1 Thumbprint (hex values can also be either space or colon separated) | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
If not specified, any certificate trusted by the machine is accepted.
Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.
This section provides a complete list of the Firewall properties you can configure in the connection string for this provider.
| Property | Description |
| FirewallType | The protocol used by a proxy-based firewall. |
| FirewallServer | The name or IP address of a proxy-based firewall. |
| FirewallPort | The TCP port for a proxy-based firewall. |
| FirewallUser | The user name to use to authenticate with a proxy-based firewall. |
| FirewallPassword | A password used to authenticate to a proxy-based firewall. |
The protocol used by a proxy-based firewall.
This property specifies the protocol that the Sync App will use to tunnel traffic through the FirewallServer proxy. Note that by default, the Sync App connects to the system proxy; to disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.
| Type | Default Port | Description |
| TUNNEL | 80 | When this is set, the Sync App opens a connection to TSheets and traffic flows back and forth through the proxy. |
| SOCKS4 | 1080 | When this is set, the Sync App sends data through the SOCKS 4 proxy specified by FirewallServer and FirewallPort and passes the FirewallUser value to the proxy, which determines if the connection request should be granted. |
| SOCKS5 | 1080 | When this is set, the Sync App sends data through the SOCKS 5 proxy specified by FirewallServer and FirewallPort. If your proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes. |
To connect to HTTP proxies, use ProxyServer and ProxyPort. To authenticate to HTTP proxies, use ProxyAuthScheme, ProxyUser, and ProxyPassword.
The name or IP address of a proxy-based firewall.
This property specifies the IP address, DNS name, or host name of a proxy allowing traversal of a firewall. The protocol is specified by FirewallType: Use FirewallServer with this property to connect through SOCKS or do tunneling. Use ProxyServer to connect to an HTTP proxy.
Note that the Sync App uses the system proxy by default. To use a different proxy, set ProxyAutoDetect to false.
The TCP port for a proxy-based firewall.
This specifies the TCP port for a proxy allowing traversal of a firewall. Use FirewallServer to specify the name or IP address. Specify the protocol with FirewallType.
The user name to use to authenticate with a proxy-based firewall.
The FirewallUser and FirewallPassword properties are used to authenticate against the proxy specified in FirewallServer and FirewallPort, following the authentication method specified in FirewallType.
A password used to authenticate to a proxy-based firewall.
This property is passed to the proxy specified by FirewallServer and FirewallPort, following the authentication method specified by FirewallType.
This section provides a complete list of the Proxy properties you can configure in the connection string for this provider.
| Property | Description |
| ProxyAutoDetect | This indicates whether to use the system proxy settings or not. |
| ProxyServer | The hostname or IP address of a proxy to route HTTP traffic through. |
| ProxyPort | The TCP port the ProxyServer proxy is running on. |
| ProxyAuthScheme | The authentication type to use to authenticate to the ProxyServer proxy. |
| ProxyUser | A user name to be used to authenticate to the ProxyServer proxy. |
| ProxyPassword | A password to be used to authenticate to the ProxyServer proxy. |
| ProxySSLType | The SSL type to use when connecting to the ProxyServer proxy. |
| ProxyExceptions | A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer . |
This indicates whether to use the system proxy settings or not.
This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.
To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.
The hostname or IP address of a proxy to route HTTP traffic through.
The hostname or IP address of a proxy to route HTTP traffic through. The Sync App can use the HTTP, Windows (NTLM), or Kerberos authentication types to authenticate to an HTTP proxy.
If you need to connect through a SOCKS proxy or tunnel the connection, see FirewallType.
By default, the Sync App uses the system proxy. If you need to use another proxy, set ProxyAutoDetect to false.
The TCP port the ProxyServer proxy is running on.
The port the HTTP proxy is running on that you want to redirect HTTP traffic through. Specify the HTTP proxy in ProxyServer. For other proxy types, see FirewallType.
The authentication type to use to authenticate to the ProxyServer proxy.
This value specifies the authentication type to use to authenticate to the HTTP proxy specified by ProxyServer and ProxyPort.
Note that the Sync App will use the system proxy settings by default, without further configuration needed; if you want to connect to another proxy, you will need to set ProxyAutoDetect to false, in addition to ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.
The authentication type can be one of the following:
If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.
A user name to be used to authenticate to the ProxyServer proxy.
The ProxyUser and ProxyPassword options are used to connect and authenticate against the HTTP proxy specified in ProxyServer.
You can select one of the available authentication types in ProxyAuthScheme. If you are using HTTP authentication, set this to the user name of a user recognized by the HTTP proxy. If you are using Windows or Kerberos authentication, set this property to a user name in one of the following formats:
user@domain domain\user
A password to be used to authenticate to the ProxyServer proxy.
This property is used to authenticate to an HTTP proxy server that supports NTLM (Windows), Kerberos, or HTTP authentication. To specify the HTTP proxy, you can set ProxyServer and ProxyPort. To specify the authentication type, set ProxyAuthScheme.
If you are using HTTP authentication, additionally set ProxyUser and ProxyPassword to HTTP proxy.
If you are using NTLM authentication, set ProxyUser and ProxyPassword to your Windows password. You may also need these to complete Kerberos authentication.
For SOCKS 5 authentication or tunneling, see FirewallType.
By default, the Sync App uses the system proxy. If you want to connect to another proxy, set ProxyAutoDetect to false.
The SSL type to use when connecting to the ProxyServer proxy.
This property determines when to use SSL for the connection to an HTTP proxy specified by ProxyServer. This value can be AUTO, ALWAYS, NEVER, or TUNNEL. The applicable values are the following:
| AUTO | Default setting. If the URL is an HTTPS URL, the Sync App will use the TUNNEL option. If the URL is an HTTP URL, the component will use the NEVER option. |
| ALWAYS | The connection is always SSL enabled. |
| NEVER | The connection is not SSL enabled. |
| TUNNEL | The connection is through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy. |
A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .
The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.
Note that the Sync App uses the system proxy settings by default, without further configuration needed; if you want to explicitly configure proxy exceptions for this connection, you need to set ProxyAutoDetect = false, and configure ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.
This section provides a complete list of the Logging properties you can configure in the connection string for this provider.
| Property | Description |
| LogModules | Core modules to be included in the log file. |
Core modules to be included in the log file.
Only the modules specified (separated by ';') will be included in the log file. By default all modules are included.
See the Logging page for an overview.
This section provides a complete list of the Schema properties you can configure in the connection string for this provider.
| Property | Description |
| Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
| BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC. |
| Tables | This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC. |
| Views | Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC. |
A path to the directory that contains the schema files defining tables, views, and stored procedures.
The path to a directory which contains the schema files for the Sync App (.rsd files for tables and views, .rsb files for stored procedures). The folder location can be a relative path from the location of the executable. The Location property is only needed if you want to customize definitions (for example, change a column name, ignore a column, and so on) or extend the data model with new tables, views, or stored procedures.
If left unspecified, the default location is "%APPDATA%\\CData\\TSheets Data Provider\\Schema" with %APPDATA% being set to the user's configuration directory:
| Platform | %APPDATA% |
| Windows | The value of the APPDATA environment variable |
| Linux | ~/.config |
This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.
This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the Sync App.
This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.
Specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.
Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.
Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.
Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the Sync App.
This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.
Specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.
Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.
This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.
| Property | Description |
| IncludeCustomFields | A boolean indicating if you would like to include custom fields in the column listing. |
| MaxRows | Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses. |
| Other | These hidden properties are used only in specific use cases. |
| Pagesize | The maximum number of results to return per page from TSheets. |
| PseudoColumns | This property indicates whether or not to include pseudo columns as columns to the table. |
| Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
| UserDefinedViews | A filepath pointing to the JSON configuration file containing your custom views. |
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.
Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
These hidden properties are used only in specific use cases.
The properties listed below are available for specific use cases. Normal driver use cases and functionality should not require these properties.
Specify multiple properties in a semicolon-separated list.
| DefaultColumnSize | Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000. |
| ConvertDateTimeToGMT | Determines whether to convert date-time values to GMT, instead of the local time of the machine. |
| RecordToFile=filename | Records the underlying socket data transfer to the specified file. |
The maximum number of results to return per page from TSheets.
The Pagesize property affects the maximum number of results to return per page from TSheets. Setting a higher value may result in better performance at the cost of additional memory allocated per page consumed.
This property indicates whether or not to include pseudo columns as columns to the table.
This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; for example, "*=*".
The value in seconds until the timeout error is thrown, canceling the operation.
If Timeout = 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.
If Timeout expires and the operation is not yet complete, the Sync App throws an exception.
A filepath pointing to the JSON configuration file containing your custom views.
User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The Sync App automatically detects the views specified in this file.
You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the Sync App.
This User Defined View configuration file is formatted as follows:
For example:
{
"MyView": {
"query": "SELECT * FROM Timesheets WHERE MyColumn = 'value'"
},
"MyView2": {
"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
}
}
Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:
"UserDefinedViews", C:\Users\yourusername\Desktop\tmp\UserDefinedViews.jsonNote that the specified path is not embedded in quotation marks.