We want to use the timesheet API (/api/v1.0/companies/{companyID}/employees/{employeeID}/timesheets/) to pull the clock on / clock off time stamps - see attached. However what I get are the jobs and activities only; i.e. in the attached I get the 4 timestamps for the scheduled time but the API documentation doesn't seem to be allowing anything other than
"Activity,Job,Lead,Quote"
"Includes=Job,Quote"
Set the type of schedule required.
How I get the clocked hours for an individual timesheet?
Timesheets API to pull clocked hours
Forum rules
- Check the documentation first. Before posting questions, please check the documentation to ensure it doesn't already cover what you need.
- No spam. All automated messages, advertisements, and links to competitor websites will be deleted immediately.
- Post in relevant sub-forums only. Messages posted in the wrong topic area will be removed and placed in the correct sub-forum by moderators.
- Respect other users. No flaming or abusing fellow forum members. Users who continue to post inflammatory, abusive comments will be deleted from the forum after two warnings are issued by moderators.
- Harassment. No threats or harassment of other users will be tolerated. Any instance of threatening or harassing behavior is grounds for deletion from the forums.
- Adult content. No profanity or pornography is allowed. Posts containing adult material will be deleted.
- Bandwidth. All images and signatures must be 500 x 500 pixels or smaller. Posts containing over-sized images and signatures will be removed.
- Illegal content. No re-posting of copyrighted materials or other illegal content is allowed. Any posts containing illegal content or copyrighted materials will be deleted.
-
SimproAPITeam
- Posts: 831
- Joined: Wed May 01, 2024 2:31 am
Re: Timesheets API to pull clocked hours
Hi,
On the time sheet endpoint you get a href link which gives you the specific schedule. This will give you time blocks for that schedule.
You can also get these actual time blocks on the work order endpoints. See examples here:
https://developer.simprogroup.com/apido ... ork-Orders
Regards
On the time sheet endpoint you get a href link which gives you the specific schedule. This will give you time blocks for that schedule.
You can also get these actual time blocks on the work order endpoints. See examples here:
https://developer.simprogroup.com/apido ... ork-Orders
Regards
Simpro API Team | Simpro Software Group
Re: Timesheets API to pull clocked hours
Hi,
We ahve run into a a similar issue, where we need access to the CLOCK ON?CLOCK OFF time directly. not the schedulled time.
the closest we've been able to get through BI reporting is the start of an activity (ie: start travelling) however this time is still inconcistant with the CLOCK ON/OFF time.
Is there a way we can get the actual CLOCK times?
We ahve run into a a similar issue, where we need access to the CLOCK ON?CLOCK OFF time directly. not the schedulled time.
the closest we've been able to get through BI reporting is the start of an activity (ie: start travelling) however this time is still inconcistant with the CLOCK ON/OFF time.
Is there a way we can get the actual CLOCK times?
-
SimproAPITeam
- Posts: 831
- Joined: Wed May 01, 2024 2:31 am
Re: Timesheets API to pull clocked hours
Hi there,
So when the user updates the times (through mobile app or desktop) there are a few ways to access this through the API depending on the use case.
The best way for this use case is the high level job work orders endpoint with the Approved=true filter and show the 'blocks' used like so
{{BASE_URL}}/0/jobWorkOrders/?columns=ID,Blocks&Approved=true
User can search for all the fields listed in the response (ID, Employee.ID) and theres more about this in our documentation here:
https://developer.simprogroup.com/apido ... ork-Orders
Below is a stripped down response body and this is gotten from the detail view URL
{{BASE_URL}}/0/jobWorkOrders/{jobWorkOrderID}
{
"Blocks": [
{
"Hrs": 8,
"StartTime": "08:00",
"ISO8601StartTime": "2018-05-21T19:53:39+10:00",
"EndTime": "16:00",
"ISO8601EndTime": "2018-05-21T19:53:39+10:00",
"ScheduleRate": {
"ID": 12345,
"Name": "Overtime"
}
}
],
"ScheduledHrs": 8,
"ScheduledStartTime": "08:00",
"ISO8601ScheduledStartTime": "2018-05-21T19:53:39+10:00",
"ScheduledEndTime": "16:00",
"ISO8601ScheduledEndTime": "2018-05-21T19:53:39+10:00",
"DateModified": "2018-05-21T19:53:39+10:00",
}
Within those blocks, the StartTime and EndTime are the times that are set by the user in the application and get updated when the user updates them (say when the clock in or out), the scheduled fields are the ones that are set initially but aren't the actual times.
There's a bunch of ways to see these block values so if you're curious can see the following pages on our documentation site
https://developer.simprogroup.com/apido ... cc8c41e061 (Schedules)
and there's also the other tabs on the work orders page
https://developer.simprogroup.com/apido ... 44cc5478bd
Hope this helps,
So when the user updates the times (through mobile app or desktop) there are a few ways to access this through the API depending on the use case.
The best way for this use case is the high level job work orders endpoint with the Approved=true filter and show the 'blocks' used like so
{{BASE_URL}}/0/jobWorkOrders/?columns=ID,Blocks&Approved=true
User can search for all the fields listed in the response (ID, Employee.ID) and theres more about this in our documentation here:
https://developer.simprogroup.com/apido ... ork-Orders
Below is a stripped down response body and this is gotten from the detail view URL
{{BASE_URL}}/0/jobWorkOrders/{jobWorkOrderID}
{
"Blocks": [
{
"Hrs": 8,
"StartTime": "08:00",
"ISO8601StartTime": "2018-05-21T19:53:39+10:00",
"EndTime": "16:00",
"ISO8601EndTime": "2018-05-21T19:53:39+10:00",
"ScheduleRate": {
"ID": 12345,
"Name": "Overtime"
}
}
],
"ScheduledHrs": 8,
"ScheduledStartTime": "08:00",
"ISO8601ScheduledStartTime": "2018-05-21T19:53:39+10:00",
"ScheduledEndTime": "16:00",
"ISO8601ScheduledEndTime": "2018-05-21T19:53:39+10:00",
"DateModified": "2018-05-21T19:53:39+10:00",
}
Within those blocks, the StartTime and EndTime are the times that are set by the user in the application and get updated when the user updates them (say when the clock in or out), the scheduled fields are the ones that are set initially but aren't the actual times.
There's a bunch of ways to see these block values so if you're curious can see the following pages on our documentation site
https://developer.simprogroup.com/apido ... cc8c41e061 (Schedules)
and there's also the other tabs on the work orders page
https://developer.simprogroup.com/apido ... 44cc5478bd
Hope this helps,
Simpro API Team | Simpro Software Group
DEVELOPER CENTER