Timecard Endpoint Follow
This endpoint returns information about the timecards in the system.
https://api.workwelltech.com/timecards
A UserId must be provided.
Filter
A filter can be applied by specifying any of the following parameters in the body of the request:
| Field | Type | Optional | Example |
| UserId | Integer | No | 2160023 |
| Date | String | Yes | 2026-01-01 |
An example request body with a filter might look like the following:
{
"UserId": 2160023,
"Date": "2026-01-01"
}This would return the Timecard for UserId 2160023 dated 01 Jan 2026
Response Object
The response object contains two properties, the Product, which will always return “uAttend” and the Body.
The body contains three properties, Timecard, Response and ResponseList as you can see below:
{
"Product": "uAttend",
"Body": {
"Timecard": {
"StartDate": "2026-01-01",
"EndDate": "2026-01-31",
"LastName": "Ford",
"FirstName": "Dan",
"PayrollNumber": "5026",
"WeekCount": "6",
"Week1": "",
"Week2": "7:30",
"Week3": "",
"Week4": "",
"Week5": "",
"Week6": "",
"RegularTime": "7:30",
"Overtime1Time": "",
"Overtime2Time": "",
"VacationTime": "",
"HolidayTime": "",
"SickTime": "",
"OtherTime": "",
"SumOfTotalHours": "7:30",
"RegularGrossPay": "75",
"Overtime1GrossPay": "",
"Overtime2GrossPay": "",
"VacationGrossPay": "",
"HolidayGrossPay": "",
"SickGrossPay": "",
"OtherGrossPay": "",
"TotalGrossPay": "75",
"Tips": [],
"DepartmentTransfers": [
{
"departmentId": "46960",
"departmentCode": "SU01",
"departmentName": "Support Office",
"Hours": "7:30",
"totalHours": "7:30",
"BgColor": null
}
],
"Accruals": [],
"Workdays": [
{
"Day1": "Tue",
"Day2": "01/01/26",
"Day3": "2026-01-01",
"RegularTime": null,
"Overtime1Time": null,
"Overtime2Time": null,
"VacationTime": null,
"HolidayTime": null,
"SickTime": null,
"OtherTime": null,
"PunchPairs": [
{
"PunchId": "687931978",
"Paycode": "1",
"Day1": "Tue",
"Day2": "01/01/26",
"Day3": "2026-01-01",
"DepartmentName": "SU01",
"InDate": "2026-01-01",
"OutDate": "2026-01-01",
"InTime": "08:24",
"OutTime": "17:05",
"RegularHours": "7:30",
"Overtime1Hours": "",
"Overtime2Hours": "",
"VacationHours": "",
"HolidayHours": "",
"SickHours": "",
"OtherHours": "",
"TotalHours": "",
"Description": "",
"Note": "",
"RegularTime": null,
"Overtime1Time": null,
"Overtime2Time": null,
"VacationTime": null,
"HolidayTime": null,
"SickTime": null,
"OtherTime": null,
"RegularGrossPay": null,
"Overtime1GrossPay": null,
"Overtime2GrossPay": null,
"VacationGrossPay": null,
"HolidayGrossPay": null,
"SickGrossPay": null,
"OtherGrossPay": null,
"TotalGrossPay": null,
"IsLast": "0",
"BgColor": "f0f0f0",
"DeadTime": ""
},
{
"PunchId": "",
"Paycode": "99",
"Day1": "",
"Day2": "",
"Day3": "2022-01-04",
"DepartmentName": "SU01",
"InDate": "",
"OutDate": "",
"InTime": "",
"OutTime": "",
"RegularHours": "",
"Overtime1Hours": "",
"Overtime2Hours": "",
"VacationHours": "",
"HolidayHours": "",
"SickHours": "",
"OtherHours": "",
"TotalHours": "7:30",
"Description": "Lunch",
"Note": "",
"RegularTime": null,
"Overtime1Time": null,
"Overtime2Time": null,
"VacationTime": null,
"HolidayTime": null,
"SickTime": null,
"OtherTime": null,
"RegularGrossPay": null,
"Overtime1GrossPay": null,
"Overtime2GrossPay": null,
"VacationGrossPay": null,
"HolidayGrossPay": null,
"SickGrossPay": null,
"OtherGrossPay": null,
"TotalGrossPay": null,
"IsLast": "1",
"BgColor": "f0f0f0",
"DeadTime": "-1:00"
}
]
}]
},
"Response": {
"$id": "1",
"PkId": "0",
"PkFieldName": null,
"Success": true,
"Keys": {},
"Messages": {}
},
"ResponseList": []
}
}
The response object contains a summary of the hours worked in each week of the pay period selected, as well as a breakdown of clockings and hours worked for each day.
This is a cutdown version of the response as each work day in the period is listed (in this case 31 days).
The clockings are unrounded.
Data Types
The Timecard array contains the following properties:
| PropertyName | Type | Description |
| StartDate | String (Date) | Start day |
| EndDate | String (Date) | End day |
| LastName | String | Last name |
| FirstName | String | First name |
| PayrollNumber | String | Payroll number |
| WeekCount | integer | Number of weeks in the timecard/pay period |
| Week1 | String | Hours worked in week 1 (ex. "40:00") |
| Week2 | String | Hours worked in week 2 (ex. "40:00") |
| Week3 | String | Hours worked in week 3 (ex. "40:00"). |
| Week4 | String | Hours worked in week 4 (ex. "40:00") |
| Week5 | String | Hours worked in week 5 (ex. "40:00"). |
| Week6 | String | Hours worked in week 6 (ex. "40:00") |
| RegularTime | String | Regular time (ex. "40:00") |
| Overtime1Time | String | Overtime 1 time total (ex. "40:00") |
| Overtime2Time | String | Overtime 2 time total (ex. "40:00") |
| VacationTime | String | Annual leave time (ex. "40:00") |
| HolidayTime | String | Public holiday time (ex. "40:00") |
| SickTime | String | Sick time (ex. "40:00") |
| OtherTime | String | Other total (ex. "40:00") |
| SumOfTotalHours | String | Sum of total hours (Reg, OT1, OT2, VAC, SIC, HOL, OTH). (ex. "40:00") |
| RegularGrossPay | String | Regular gross pay |
| Overtime1GrossPay | String | Overtime 1 gross pay |
| Overtime2GrossPay | String | Overtime 2 gross pay |
| VacationGrossPay | String | Annual leave gross pay |
| HolidayGrossPay | String | Public holiday gross pay |
| SickGrossPay | String | Sick gross pay |
| OtherGrossPay | String | Other gross pay |
| TotalGrossPay | String | Sum of total gross pay (rp, o1p, o2p, vp, sp, hp, op) |
| Workdays | List<Workday> | List of workdays |
| Tips | List<Tip> | List of tips |
| Accruals | List<Accrual> | List of accruals |
Workday List
Contains date information, totals per pay code for the day, and a list of punch pairs for the day
| Workday | ||
| PropertyName | Type | Description |
| Day1 | String | Day of the week ("Sat") |
| Day2 | String | Day 2 ("11/30/19") |
| Day3 | String | Day 3 ("2019-11-30") |
| RegularTime | String | Daily total regular time (ex. "8:00") |
| Overtime1Time | String | Daily total overtime 1 time (ex. "2:00") |
| Overtime2Time | String | Daily total overtime 2 time (ex. "2:00") |
| VacationTime | String | Daily total annual leave time (ex. "0:00") |
| HolidayTime | String | Daily total public holiday time (ex. "0:00") |
| SickTime | String | Daily total sick time (ex. "0:00") |
| OtherTime | String | Daily total other time (ex. "10:00") |
| PunchPairs | List<PunchPair> | 1 if last record of the day |
Punch Pair List
Contains punch id, punch times, and hour totals broken down by pay code. Each punch is broken into a separate PunchPair, the last punch pair of the day has a 1 in IsLast signifying when punches for the next day start.
| PunchPair | ||
| PropertyName | Type | Description |
| PunchId | String | Punch id |
| Paycode | String | Paycode |
| Day1 | String | Day of the week ("Sat") |
| Day2 | String | Day 2 ("11/30/19") |
| Day3 | String | Day 3 ("2019-11-30") |
| DepartmentName | String | Department name if pay code 1, break if paycode 6 and lunch if paycode 7 |
| InDate | String | In Date (ex. “2019-12-02”) |
| OutDate | String | Out Date |
| InTime | String | In time (ex. “08:00 AM”) |
| OutTime | String | Out time (ex. “05:00 PM”) |
| RegularHours | String | Regular hour of punch pair (ex. "40:00") |
| Overtime1Hours | String | Daily overtime 1 (ex. "40:00") |
| Overtime2Hours | String | Daily overtime 2 (ex. "40:00") |
| VacationHours | String | Annual leave hour (ex. "40:00") |
| HolidayHours | String | Public holiday hour (ex. "40:00") |
| SickHours | String | Sick hour (ex. "40:00") |
| OtherHours | String | Oth hour (ex. "40:00") |
| TotalHours | String | Daily total hour (ex. "40:00") |
| Description | String | Description |
| Note | String | Note |
| RegularTime | String | Daily total regular time (ex. "40:00") |
| Overtime1Time | String | Daily total overtime 1 time (ex. "40:00") |
| Overtime2Time | String | Daily total overtime 2 time (ex. "40:00") |
| VacationTime | String | Daily total annual leave time (ex. "40:00") |
| SickTime | String | Daily total sick time (ex. "40:00") |
| OtherTime | String | Daily total other time (ex. "40:00") |
| HolidayTime | String | Daily total holiday time (ex. "40:00") |
| RegularGrossPay | Number | Daily regular gross pay |
| Overtime1GrossPay | Number | Daily overtime 1 gross pay |
| Overtime2GrossPay | Number | Daily overtime 2 gross pay |
| VacationGrossPay | Number | Daily annual leave gross pay |
| HolidayGrossPay | Number | Daily public holiday gross pay |
| SickGrossPay | Number | Daily sick gross pay |
| OtherGrossPay | Number | Daily other gross pay |
| TotalGrossPay | Number | Daily total gross pay |
| IsLast | Integer | 1 if last record of the day |
Accrual List
Accrual totals for the timecard:
| Accrual | ||
| PropertyName | Type | Description |
| BenefitCategory | String | Benefit category (“VAC”) |
| AccruedBenefitBalance | String | Accrued benefit balance (ex. “80:00”) |
| UsedBenefitHours | String | Used benefit hours (ex. “20:00”) |
| AvailableBenefitHours | String | Available benefit hours (ex. “60:00”) |