Sign in
latestOpenAPI 3.1.02026-08-20143150682.4 KB

b4bf8a66eaaa

Timesheet Entry

Get Timesheet List

Returns a list of Timesheet entry objects.

get/api/hris/v1/timesheet-entry

Query parameters

remote_idstring

The third-party API ID of the matching object.

Example:3235005483341316245

The third-party API ID of the matching object.

idsstring nullable

The ID of the timesheet entries to fetch

Example:01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a

The ID of the timesheet entries to fetch

employee_idstring nullable

The ID of the employees to fetch timesheet entries for

Example:01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a

The ID of the employees to fetch timesheet entries for

include_raw_databoolean

Whether to include the original data Bindbee fetched from the third-party to produce these models.

Whether to include the original data Bindbee fetched from the third-party to produce these models.

include_custom_fieldsboolean

Whether to include custom fields in the response.

Whether to include custom fields in the response.

page_sizeinteger

Number of results to return per page. Maximum size is 200.

Number of results to return per page. Maximum size is 200.

cursorstring

The pagination cursor value.

The pagination cursor value.

modified_afterstring

If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.

Example:2024-02-21T21:22:12.993Z

If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.

expandstring

Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.

Example:manager[first_name,last_name]

Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.

start_time_fromstring

If provided, will only return objects with start time same or after this value. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.

Example:2023-10-01T00:00:00Z

If provided, will only return objects with start time same or after this value. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.

start_time_tostring

If provided, will only return objects with start time same or before this value. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.

Example:2023-10-31T23:59:59Z

If provided, will only return objects with start time same or before this value. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.

end_time_fromstring

If provided, will only return objects with end time same or after this value. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.

Example:2023-10-01T00:00:00Z

If provided, will only return objects with end time same or after this value. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.

end_time_tostring

If provided, will only return objects with end time same or before this value. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.

Example:2023-10-31T23:59:59Z

If provided, will only return objects with end time same or before this value. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.

Headers

x-connector-tokenstring required

Response

Successful Response

cursorstring nullable required

Cursor value to fetch next set of items

page_sizeinteger required

Indicates the count of items in the response

Example response

{
  "cursor": "MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1",
  "page_size": 50,
  "items": [
    {
      "id": "018b18ef-c487-703c-afd9-0ca478ccd9d6",
      "remote_id": "123321",
      "modified_at": "2021-10-16T00:00:00Z",
      "raw_data": {
        "key_1": "Platform dependent data 1",
        "key_2": "Platform dependent data 2"
      },
      "custom_fields": {
        "category_group": "REG",
        "disability_type": "ASBERG",
        "hire_date": "1991-03-16T00:00:00",
        "hire_source": "REFER",
        "nationality": "USA",
        "original_hire_date": "1991-03-16T00:00:00"
      },
      "employee": "018abccc-4a0a-7e7d-a9d7-56881f57a6b4",
      "date": "2023-11-10T00:00:00Z",
      "hours_worked": 12,
      "break_duration": 2.5,
      "start_time": "2023-11-10T00:00:00Z",
      "end_time": "2023-11-10T00:00:00Z"
    }
  ]
}