Actual

Actuals capture the worked hours for an Employee during a completed work shift. This data is used to provide insights into actual worked hours compared to contractual hours, and also helps steer the optimization algorithm towards creating a balanced work week that fulfills contractual hours without significant undershooting or overshooting.

By their nature, Actuals should always represent completed work shifts and therefore should always be in the past, adding Actuals that end in the future could lead to undesired behaviour.

Operations

Get cursor-based actuals for an employee

Request

Retrieve actuals for an employee in bulk using cursor-based paging (see the Cursor-based pagination documentation on the PTV Developer Portal).

Security

clientCredentials

Path

employee_idstringrequired

employee_id of the employee that the actuals applies to

Example:my-employee-id

Query

cursorstring

The cursor of the page to return. No cursor is expected for the initial request. The cursors returned by this endpoint can be used for subsequent requests.

limitinteger, [ 1 .. 1000 ]

Number of results to return per page.

Default:100

Payload

// No request payload

Responses

The results for the current paged request and optional pointers to related result pages.

Bodyapplication/json

dataArray of objects(EmployeeActual)

The set of results for the current page.

cursorsobject(Cursors)

The cursors represent pointers to pages of results in relation to the page that was retrieved by the current request. These pointers are nullable. For more information on these pointers, view the Developer Portal.

Response

{
  "data": [
    { … }
  ],
  "cursors": {
    "previous": "string",
    "self": "string",
    "next": "string"
  }
}