Sign in

v1

latestOpenAPI 3.0.02026-07-14800227.2 KB
Attendance

Returns expected time per user for a given date range (paginated).

Returns a paginated list of the daily Net Expected Time per user for the given date range. This value represents the contractual working hours after subtracting deductions from Public Holidays and approved Time Off (based on either the Shiftplan or the theoretical work schedule pattern). Limitations:

  • The date range (from and to) must not exceed 90 days.
  • The limit parameter is capped at 100 users per page.
get/attendances/expected-time

Query parameters

fromstring required
Example:2020-01-01

Start date of the range (YYYY-MM-DD). The range from-to must not exceed 90 days.

tostring required
Example:2020-01-10

End date of the range (YYYY-MM-DD). The range from-to must not exceed 90 days.

companyIdstring
Example:80a2db290da29e126a18789a

Optional filter. The company id of the Kenjo employee.

officeIdstring
Example:80a2db290da29e126a18789d

Optional filter. The office id of the Kenjo employee.

departmentIdstring
Example:80a2db290da29e126a18789c

Optional filter. The department id of the Kenjo employee.

userIdstring
Example:80a2db290da29e126a18789c

Optional filter. Kenjo employee id(s). Two formats are accepted:<br><br>1. A single employee id.<br>Example: userId=80a2db290da29e126a18789c<br><br>2. Comma-separated list of up to 15 employee ids.<br>Example: userId=80a2db290da29e126a18789c,80a2db290da29e126a18789b,80a2db290da29e126a187891

offsetnumber

Number of records to skip for pagination. If not provided, defaults to 0.

limitnumber
Example:50

Number of users to return per page. If not provided, defaults to 50. The value is capped at 100.

Headers

Authorizationstring required
Example:Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJodHRwczovL2FwaS5rZW5qby5pbyIsInN1YiI6IjYwZjBhOTE2MjE0OTg3MjU2YmU5YzhmZiIsImF1ZCI6Imh0dHBzOi8vYXBpLmtlbmpvLmlvIiwiaWF0IjoxNjI2Mzg1MTE1LCJuYmYiOjE2MjYzODUxMTUsImV4cCI6MTYyNjU1NzkxNSwiYWNjZXNzVHlwZSI6IkFwaUFjY2VzcyIsInNfb3JnSWQiOiI2MGYwNGVhN2RmN2JhMjFlY2U0YmYzYzIifQ.cxG_7dIS-VbmDXdJuLkekoyuyCIzQG2fMcgc0nkfbWE8cihhcb5FnALbQkjU9b5-qVcEoMHZlSuUA-jMEBMMVQ

A valid bearer token.

Response

OK.

Example response

{
  "data": [
    {
      "userId": "80a2db290da29e126a18789a",
      "days": [
        {
          "date": "2020-01-01",
          "expectedHours": 8,
          "expectedMinutes": 480
        },
        {
          "date": "2020-01-02",
          "expectedHours": 8,
          "expectedMinutes": 480
        },
        {
          "date": "2020-01-03",
          "expectedHours": 8,
          "expectedMinutes": 480
        },
        {
          "date": "2020-01-04",
          "expectedHours": 8,
          "expectedMinutes": 480
        },
        {
          "date": "2020-01-05",
          "expectedHours": 8,
          "expectedMinutes": 480
        },
        {
          "date": "2020-01-06",
          "expectedHours": 0,
          "expectedMinutes": 0
        },
        {
          "date": "2020-01-07",
          "expectedHours": 0,
          "expectedMinutes": 0
        },
        {
          "date": "2020-01-08",
          "expectedHours": 8,
          "expectedMinutes": 480
        },
        {
          "date": "2020-01-09",
          "expectedHours": 8,
          "expectedMinutes": 480
        },
        {
          "date": "2020-01-10",
          "expectedHours": 8,
          "expectedMinutes": 480
        }
      ],
      "totalExpectedHours": 64,
      "expectedMinutes": 3840
    },
    {
      "userId": "80a2db290da29e126a18789b",
      "days": [
        {
          "date": "2020-01-01",
          "expectedHours": 8,
          "expectedMinutes": 480
        },
        {
          "date": "2020-01-02",
          "expectedHours": 8,
          "expectedMinutes": 480
        },
        {
          "date": "2020-01-03",
          "expectedHours": 8,
          "expectedMinutes": 480
        },
        {
          "date": "2020-01-04",
          "expectedHours": 8,
          "expectedMinutes": 480
        },
        {
          "date": "2020-01-05",
          "expectedHours": 8,
          "expectedMinutes": 480
        },
        {
          "date": "2020-01-06",
          "expectedHours": 0,
          "expectedMinutes": 0
        },
        {
          "date": "2020-01-07",
          "expectedHours": 0,
          "expectedMinutes": 0
        },
        {
          "date": "2020-01-08",
          "expectedHours": 0,
          "expectedMinutes": 0
        },
        {
          "date": "2020-01-09",
          "expectedHours": 0,
          "expectedMinutes": 0
        },
        {
          "date": "2020-01-10",
          "expectedHours": 0,
          "expectedMinutes": 0
        }
      ],
      "totalExpectedHours": 40,
      "expectedMinutes": 2400
    }
  ],
  "metadata": {
    "count": 2,
    "offset": 1,
    "limit": 50,
    "total": 2
  }
}