Organization Structure API
- Axis-sections
- Departments
- Legal-Units
- Establishments
Core HR API
- Employees Directory
- Guides
Cleemy Expenses API
- Expense-temp-items
- Expense-claims
- Expense-claim-items
Timmi Absences API
- Leaves
- Leave-requests
- Sick-leaves
- Imports
- Guides
Timmi Office API
- User-locations
- Work-locations
Timmi Project API
- Clients
- Projects
- Project services
- Organizations
- Financials
Timmi Settings API
- UserDates
- Workcycle-exceptions
- Working-time-arrangement
Timmi Timesheet API
- Time-entries
- Timesheets
- Reports
- Guides
Pagga Mealvouchers API
- Statutory
- Computation
Pagga Remuneration API
- Fixed-natures
- Fixed-items
- Variable-natures
- Variable-items
Poplee Training API
- Training-demands
- Realized-trainings
List UserDates.
Retrieve a list of UserDates.
Performance
In order to keep satisfactory response times and performance, please filter the request on a limited set of OwnerId[] and reduce the period date=between,{start},{end}
.
As a rule of thumb, do not request for more than ~10 owners over a whole month.
Format
The date
query parameter should match the form ?date=between,{start},{includedEnd}
.
curl --request GET \
--url https://{account}-{sandboxName}.sandbox.{server}.luccasoftware.com/api/v3/userdates
{
"data": {
"items": [
{
"dtt": "07:00:00",
"drt": "04:15:00",
"draj": "03:30:00",
"isHoliday": true,
"isWeeklyRest": true,
"items": [
{
"type": "ptt",
"startsAt": "2023-11-07T05:31:56Z",
"duration": "<string>",
"timeline": "WorkCycle"
}
],
"am": {
"dtt": "07:00:00",
"drt": "04:15:00",
"draj": "03:30:00",
"isHoliday": true,
"isWeeklyRest": true,
"items": [
{
"type": "ptt",
"startsAt": "2023-11-07T05:31:56Z",
"duration": "<string>",
"timeline": "WorkCycle"
}
]
},
"pm": {
"dtt": "07:00:00",
"drt": "04:15:00",
"draj": "03:30:00",
"isHoliday": true,
"isWeeklyRest": true,
"items": [
{
"type": "ptt",
"startsAt": "2023-11-07T05:31:56Z",
"duration": "<string>",
"timeline": "WorkCycle"
}
]
}
}
]
}
}
Query Parameters
User's identifiers.
The period over which working hours should be returned for given Users. Format: 'between,{start},{includedEnd}'.
List of all fields to be returned by the server.
Example: ?fields=ownerId,date,dtt,drt,draj, items[startsAt,duration,type,timeline
Response
Theoretical working time. The work duration the User should comply with on this day.
Actual working time. The actual time the User spent working on this day.
Leave duration.
Is this day a holiday in the User's holidays calendar?
Is this the weekly rest day (most often, Sundays) in the User's workcycle?
All events for this day and User.
Type of event:
ptt
: Theoretical working hours, eg "What the User should be working".prt
: Actual working hours, eg "What the User actually did". If nothing was entered in Timmi Timesheet nor Timmi Absences, then ptt are duplicated as prt.praj
: Leave of absences.
ptt
, prt
, praj
Start of the event.
Duration of the event.
The source from which this event was pushed.
WorkCycle
, PublicHoliday
, Exception
, Leave
, Entry
Description of the first half of the day.
Theoretical working time. The work duration the User should comply with on this day.
Actual working time. The actual time the User spent working on this day.
Leave duration.
Is this day a holiday in the User's holidays calendar?
Is this the weekly rest day (most often, Sundays) in the User's workcycle?
All events for this day and User.
Type of event:
ptt
: Theoretical working hours, eg "What the User should be working".prt
: Actual working hours, eg "What the User actually did". If nothing was entered in Timmi Timesheet nor Timmi Absences, then ptt are duplicated as prt.praj
: Leave of absences.
ptt
, prt
, praj
Start of the event.
Duration of the event.
The source from which this event was pushed.
WorkCycle
, PublicHoliday
, Exception
, Leave
, Entry
Description of the second half of this day.
Theoretical working time. The work duration the User should comply with on this day.
Actual working time. The actual time the User spent working on this day.
Leave duration.
Is this day a holiday in the User's holidays calendar?
Is this the weekly rest day (most often, Sundays) in the User's workcycle?
All events for this day and User.
Type of event:
ptt
: Theoretical working hours, eg "What the User should be working".prt
: Actual working hours, eg "What the User actually did". If nothing was entered in Timmi Timesheet nor Timmi Absences, then ptt are duplicated as prt.praj
: Leave of absences.
ptt
, prt
, praj
Start of the event.
Duration of the event.
The source from which this event was pushed.
WorkCycle
, PublicHoliday
, Exception
, Leave
, Entry
Was this page helpful?
curl --request GET \
--url https://{account}-{sandboxName}.sandbox.{server}.luccasoftware.com/api/v3/userdates
{
"data": {
"items": [
{
"dtt": "07:00:00",
"drt": "04:15:00",
"draj": "03:30:00",
"isHoliday": true,
"isWeeklyRest": true,
"items": [
{
"type": "ptt",
"startsAt": "2023-11-07T05:31:56Z",
"duration": "<string>",
"timeline": "WorkCycle"
}
],
"am": {
"dtt": "07:00:00",
"drt": "04:15:00",
"draj": "03:30:00",
"isHoliday": true,
"isWeeklyRest": true,
"items": [
{
"type": "ptt",
"startsAt": "2023-11-07T05:31:56Z",
"duration": "<string>",
"timeline": "WorkCycle"
}
]
},
"pm": {
"dtt": "07:00:00",
"drt": "04:15:00",
"draj": "03:30:00",
"isHoliday": true,
"isWeeklyRest": true,
"items": [
{
"type": "ptt",
"startsAt": "2023-11-07T05:31:56Z",
"duration": "<string>",
"timeline": "WorkCycle"
}
]
}
}
]
}
}