Retrieve a delta
Introduction
It’s possible to retrieve changes with the delta.
Caution
Read the Delta page. There is important information on required implementation!
Tip
Check the Swagger page for more technical information on the endpoints.
Endpoint details
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/calculated-totals?delta
Response properties
This list of properties is returned by this endpoint.
| Property | Type | Description |
|---|---|---|
changeVersion |
string | Property to indicate the order of changes. |
id |
integer | Unique identifier for the calculated totals record. |
person.id |
integer | Internal ID the person whom these totals belong to. |
date |
string | Date for which the totals are calculated (YYYY-MM-DD). |
normalTimeDurationInMinutes |
integer | Normal working time in minutes for the date, configured on a schedule. |
timePresentDurationInMinutes |
integer | Minutes the person was present on that date. |
calculatedPresenceDurationInMinutes |
integer | Calculated presence duration in minutes (after rules/corrections). |
weeklyHours1DurationInMinutes |
integer | Weekly hours (type 1) in minutes. The type depends on the configuration in myProtime |
weeklyHours2DurationInMinutes |
integer | Weekly hours (type 2) in minutes. The type depends on the configuration in myProtime |
weeklyHours3DurationInMinutes |
integer | Weekly hours (type 3) in minutes. The type depends on the configuration in myProtime |
payPeriodHoursDurationInMinutes |
integer | Pay period hours in minutes. |
flextimeDurationInMinutes |
integer | Flextime accumulated for the date in minutes. |
flextimeBalanceInMinutes |
integer | Flextime balance in minutes after this date’s totals are applied. |
shiftDefinition.id |
integer | Internal ID of a linked shift definition. |
Filters
This list of filters can be used for this endpoint. Some filters are mandatory.
| Filter | Type | Description |
|---|---|---|
date |
Required | The start date must be a recent date in the past, with the earliest allowed start date being January 1st of the previous year |
Note
- People cannot be used in the delta
- The start date must be a recent date in the past, with the earliest allowed start date being January 1st of the previous year
- The end date isn’t required, when providing an end date there is a max range of 1 year
External references
It’s possible to use predefined external references and custom external references. More information can be found on the External References Page
For a list of predefined external references, see the external reference options section.
Note
Check the query options below the endpoint on the Swagger page for the relevant external references.
Good to know
Shift definition behaviour
The shift definition shown in the calculated totals response is determined by a priority waterfall. This waterfall defines where the system retrieves the shift information from, in the following order:
-
Schedule
The default shift assigned in the day program for that specific date. -
Shift adjustments via rules or calculations
If the shift is modified by if…then rules or other calculation logic (e.g., based on conditions like overtime, exceptions), this updated shift takes precedence over the day program.
Important
The calculated totals response does not distinguish the exact origin of the shift (e.g., whether it came from the day program or a rule). It simply reflects the result after applying the first two levels of the waterfall.
Examples
Delta with date filter
Example with a start date:
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/calculated-totals?delta&filter=date ge '2024-01-01'
Delta with date range filter
Example with a date range:
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/calculated-totals?delta&filter=date ge '2024-01-01' and date le '2024-12-31'