# List Timesheet entries

> Source: https://truto.one/docs/api-reference/unified-hris-api/timesheetentries/list/

`GET /unified/hris/timesheet_entries`

Resource: **TimesheetEntries** · API: **Unified HRIS API**

## Supported integrations

7shifts, Deel, HR WORKS, Paylocity, Remote, Sesame, UKG Dimensions, Workday

## Query parameters

- **`integrated_account_id`** _(string, required)_
  The ID of the integrated account to use for the request.
- **`truto_response_format`** _(string)_
  The format of the response. - `unified` returns the response with unified mappings applied. - `raw` returns the unprocessed, raw response from the remote API. - `normalized` applies the unified mappings and returns the data in a normalized format. - `stream` returns the response as a stream, which is ideal for transmitting large datasets, files, or binary data. Using streaming mode helps to efficiently handle large payloads or real-time data flows without requiring the entire data to be buffered in memory. - `debug` returns the final unified result alongside raw remote fetch information. The response is an envelope containing `result` (identical to unified mode output) and `debug` (with `requestUrl`, `requestOptions`, `data`, `responseHeaders`, and for list operations: `nextCursor`, `isLooping`, `isEmptyResult`, `resultCount`). When the upstream body exceeds 1 MiB, `data` is replaced by `{ truto_truncated: true, truto_max_bytes, truto_excerpt }`. `debug` is `null` for static responses or when `truto_skip_api_call=true`. Defaults to `unified`.
  Allowed: `unified`, `raw`, `normalized`, `stream`, `debug`
- **`truto_key_by`** _(string)_
  By default the `result` attribute is an array of objects. This parameter allows you to specify a field in each `result` objects to use as key, which transforms the `result` array into an object with the array items keyed by the field. This is useful for when you want to use the result as a lookup table.
- **`truto_ignore_limit`** _(boolean)_
  Ignores the `limit` query parameter.
- **`truto_ignore_remote_data`** _(boolean)_
  Excludes the `remote_data` attribute from the response.
- **`truto_exclude_fields`** _(array<string>)_
  Array of fields to exclude from the response.
- **`remote_query`** _(object)_
  Query parameters to pass to the underlying API without any transformations. Refer [this guide](https://truto.one/docs/api-reference/overview/querying#remote-query-parameters) to see how to structure the query parameters.
- **`company`** _(object)_
  The company to use, referencing companies.id. Optional: when omitted the account's company is looked up automatically. The request fails if the account can see more than one company and none is given.
- **`company_id`** _(string)_
  Flat alternative to company.id.
- **`employee`** _(object)_
  The employee who worked the time, not the person who entered it
- **`employee_id`** _(string)_
- **`location`** _(object)_
  Filter by location (locations.id).
- **`job_role`** _(object)_
  Filter by role (job_roles.id).
- **`groups`** _(object)_
  Filter by department (groups.id).
- **`status`** _(string)_
  The approval status of the entry. draft: not yet submitted. pending: awaiting approval. approved: approved. rejected: rejected or sent back for correction. processed: paid, exported or locked by payroll. Providers that only record an approved flag return approved when it is set, and otherwise pending for completed entries and draft for entries that are still open.
  Allowed: `approved`, `draft`, `pending`, `processed`, `rejected`
- **`work_date`** _(object)_
  The local calendar date the time counts toward, in YYYY-MM-DD format: the provider's own work, business or payroll date when it has one, otherwise the date of start_time in timezone. It is never taken from the UTC date. A shift that crosses midnight counts toward the date the provider attributes it to.
- **`start_time`** _(string)_
  When the time block started, as an ISO 8601 date-time with an explicit offset (Z or +HH:MM). Provider local times without an offset are converted using timezone. Empty when the provider records only a duration, or when the time zone is unknown.
- **`updated_at`** _(string)_
  The date and time the timesheet entry was last updated
- **`employment`** _(object)_
  Deel-specific: filter by contract, referencing employments.id. Use it to list one worker's timesheets (employee filtering is not supported by Deel). Each entry's employee is matched against the first 100 contractors Deel lists, so in larger organizations some entries come back without an employee.
- **`employment_id`** _(string)_
  Flat alternative to employment.id.
- **`end_time`** _(string)_
  End of the date interval to read (HR WORKS endDate). Required, inclusive. HR WORKS returns working times for a date interval and requires both ends. Truto always asks for interval=days, because the day bucket HR WORKS puts an entry in is the only work date it publishes; that shortens the maximum interval to 31 days, and a longer or negative one is refused with a 400 before calling. Accepts a date (YYYY-MM-DD), a date-time (only the date part is sent) or the operator forms [eq]/[gte]/[gt] and [eq]/[lte]/[lt]; gt and lt are treated as inclusive, because HR WORKS's window is inclusive. Several values, [ne] or a nested object are refused with a 400.
- **`hyperfind`** _(object)_
  UKG-specific alternative to employee: a Hyperfind query ID (a saved UKG population filter, for example 1 for All Home) whose employees' timecards are read. One Hyperfind per call. Accepts one value, several comma-separated, a repeated key (x[]=a&x[]=b) or an eq/in filter; a filter form UKG cannot express is refused with 400 rather than ignored.
- **`hyperfind_id`** _(string)_
  Flat alternative to hyperfind.id.
- **`project`** _(object)_
  Filter by Workday project (WID).

## Response body

- **`result`** _(array<object>)_
  List of Timesheet entries
  - **`id`** _(string, required)_
    The unique identifier for the timesheet entry
  - **`employee`** _(object)_
    The employee who worked the time, not the person who entered it
    - **`id`** _(string)_
      The unique identifier for employees
    - **`name`** _(string)_
      The name of the employee
  - **`work_date`** _(string)_
    The local calendar date the time counts toward, in YYYY-MM-DD format: the provider's own work, business or payroll date when it has one, otherwise the date of start_time in timezone. It is never taken from the UTC date. A shift that crosses midnight counts toward the date the provider attributes it to.
  - **`start_time`** _(string)_
    When the time block started, as an ISO 8601 date-time with an explicit offset (Z or +HH:MM). Provider local times without an offset are converted using timezone. Empty when the provider records only a duration, or when the time zone is unknown.
  - **`end_time`** _(string)_
    When the time block ended, in the same format as start_time. Empty while the entry is still open, when the provider records only a duration, or when the time zone is unknown.
  - **`hours_worked`** _(number)_
    The number of hours worked in this entry, excluding unpaid breaks. It is the provider's own worked or payable figure when it has one, otherwise end_time minus start_time minus unpaid breaks, and it is empty while the entry is still open. Summing it across entries gives the time worked: unpaid breaks, time off and holidays count as 0 and paid breaks count their length.
  - **`breaks`** _(array<object>)_
    The breaks taken during this entry
    - **`start_time`** _(string)_
      When the break started
    - **`end_time`** _(string)_
      When the break ended. Empty while the break is in progress.
    - **`is_paid`** _(boolean)_
      Whether the break is paid
  - **`type`** _(string)_
    The kind of time recorded: regular working time, overtime, on call, a break, time off or a holiday. Providers that store breaks as separate entries return them with type break.
    Allowed: `regular`, `overtime`, `on_call`, `break`, `time_off`, `holiday`, `other`
  - **`status`** _(string)_
    The approval status of the entry. draft: not yet submitted. pending: awaiting approval. approved: approved. rejected: rejected or sent back for correction. processed: paid, exported or locked by payroll. Providers that only record an approved flag return approved when it is set, and otherwise pending for completed entries and draft for entries that are still open.
    Allowed: `draft`, `pending`, `approved`, `rejected`, `processed`
  - **`job_role`** _(object)_
    The job role the time was worked in
    - **`id`** _(string)_
      The unique identifier for job roles
    - **`name`** _(string)_
      The name of the job role
  - **`location`** _(object)_
    The location where the time was worked
    - **`id`** _(string)_
      The unique identifier for locations
    - **`name`** _(string)_
      The name of the location
  - **`groups`** _(array<object>)_
    The groups, such as departments or cost centers, the time is attributed to
    - **`id`** _(string)_
      The unique identifier for groups
    - **`name`** _(string)_
      The name of the group
    - **`type`** _(string)_
      The type of the group
  - **`project`** _(object)_
    The project the time was logged against
    - **`id`** _(string)_
      The unique identifier for the project
    - **`name`** _(string)_
      The name of the project
  - **`pay_rate`** _(number)_
    The hourly pay rate applied to this entry, in major units of pay_currency (for example 15.5)
  - **`pay_currency`** _(string)_
    The currency of the pay rate, as an ISO 4217 code
  - **`timezone`** _(string)_
    The IANA time zone name the time was recorded in, for example America/New_York
  - **`notes`** _(string)_
    The notes attached to the entry
  - **`created_at`** _(string)_
    The date and time the timesheet entry was created
  - **`updated_at`** _(string)_
    The date and time the timesheet entry was last updated
  - **`remote_data`** _(object)_
    Raw data returned from the remote API call.
- **`next_cursor`** _(string)_
  The cursor to use for the next page of results. Pass this value as `next_cursor` in the query parameter in the next request to get the next page of results.
- **`debug`** _(object)_
  Present only when `truto_response_format=debug`. Contains raw fetch details: `requestUrl`, `requestOptions`, `data`, `responseHeaders`, `nextCursor`, `isLooping`, `isEmptyResult`, `resultCount`. `data` is the parsed upstream body; when its JSON form exceeds 1 MiB it is replaced by `{ truto_truncated: true, truto_max_bytes, truto_excerpt }`, where `truto_excerpt` is the leading bytes of that body. The same applies to a string `requestOptions.body`. `null` for static responses or when `truto_skip_api_call=true`.
  - **`requestUrl`** _(string)_
  - **`requestOptions`** _(object)_
  - **`data`** _(unknown)_
  - **`responseHeaders`** _(object)_
  - **`nextCursor`** _(string)_
  - **`isLooping`** _(boolean)_
  - **`isEmptyResult`** _(boolean)_
  - **`resultCount`** _(number)_

## Code examples

### Truto CLI

```bash
truto unified hris timesheetentries \
  -a '<integrated_account_id>' \
  -o json
```

### Truto TS SDK

```typescript
import Truto from '@truto/truto-ts-sdk';

const truto = new Truto({
  token: '<your_api_token>',
});

const result = await truto.unifiedApi.list(
  'hris',
  'timesheetentries',
  { integrated_account_id: '<integrated_account_id>' }
);

console.log(result);
```

### Truto Python SDK

```python
import asyncio
from truto_python_sdk import TrutoApi

truto_api = TrutoApi(token="<your_api_token>")

async def main():
    async for item in truto_api.unified_api.list(
        "hris",
        "timesheetentries",
        {"integrated_account_id": "<integrated_account_id>"}
    ):
        print(item)

asyncio.run(main())
```

### curl

```bash
curl -X GET 'https://api.truto.one/unified/hris/timesheet_entries?integrated_account_id=<integrated_account_id>' \
  -H 'Authorization: Bearer <your_api_token>' \
  -H 'Content-Type: application/json'
```

### JavaScript

```javascript
const integratedAccountId = '<integrated_account_id>';

const response = await fetch(`https://api.truto.one/unified/hris/timesheet_entries?integrated_account_id=${integratedAccountId}`, {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer <your_api_token>',
    'Content-Type': 'application/json',
  },
});

const data = await response.json();
console.log(data);
```

### Python

```python
import requests

url = "https://api.truto.one/unified/hris/timesheet_entries"
headers = {
    "Authorization": "Bearer <your_api_token>",
    "Content-Type": "application/json",
}
params = {
    "integrated_account_id": "<integrated_account_id>"
}

response = requests.get(url, headers=headers, params=params)
print(response.json())
```