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/paid-presences?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 paid presence record (read-only). |
person.id |
integer | Internal ID of the person for whom this paid presence applies. |
date |
string | Date for which the paid presence is recorded (YYYY-MM-DD). |
durationInMinutes |
integer | Duration of the paid presence in minutes. |
shiftDefinition.id |
integer | Internal ID of the linked shift definition (optional). |
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
Check the Fetching Resources page on how to use the filter.
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
Multiple instances per day
Unlike calculated totals which return a single record per person per day, paid presences can return multiple records for the same person on the same date. This happens when the paid presence is divided across multiple shifts based on the configuration in myProtime.
Shift definition behaviour
The shiftDefinition is optional and will be included when the paid presence is associated with a specific shift. If no shift is assigned, this field will be omitted from the response.
Examples
Delta with start date filter
Example with a start date:
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/paid-presences?delta&filter=date ge '2025-01-01'
Delta with date range filter
Example with a date range:
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/paid-presences?delta&filter=date ge '2025-01-01' and date le '2025-12-31'