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 driver 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 driver. 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 '=' and 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 |
Pseudo-Columns
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| GroupId | String | A comma-seperated list of group ids. Only time for users from these groups will be included. |
| IncludeZeroTime | String | If true, all users will be included in the output, even if they had zero hours for the time period. |