Introduction

Files

Organization Structure API

Axis-sections
Departments
Legal-Units
Establishments

Core HR API

Employees Directory
Guides

Cleemy Expenses API

Expense-temp-items
Expense-claims
Expense-claim-items

Timmi Absences API

Leaves
Leave-requests
Sick-leaves
Imports
Guides

Timmi Office API

User-locations
Work-locations

Timmi Project API

Clients
Projects
Project services
Organizations
Financials

Timmi Settings API

UserDates
Workcycle-exceptions
Working-time-arrangement

Timmi Timesheet API

Pagga Mealvouchers API

Statutory
Computation

Pagga Remuneration API

Fixed-natures
Fixed-items
Variable-natures
Variable-items

Poplee Training API

Training-demands
Realized-trainings

Time-entries

List multiple TimeEntries

List all TimeEntries satisfying query filters.

For technical purposes, a TimeEntry of duration 00:00:00 will be returned for any day if :

The day belongs to a Timesheet that is at least submitted,
And the day has 00:00:00 total working time (a public holiday, a full-day absence, a working day without any work)

Please refer to the TimeEntry API reference for additional information on the TimeEntry object.

Please see this guide on how to retrieve TimeEntries the right way.

GET

api

timeentries

curl --request GET \
  --url https://{account}-{sandboxName}.sandbox.{server}.luccasoftware.com/api/v3/timeentries

{
  "data": {
    "count": 123,
    "items": [
      {
        "id": 552586,
        "ownerId": 90,
        "owner": {
          "id": 90,
          "name": "Hélène Girard",
          "url": "https://demotimmi7.ilucca-test.net/api/v3/timesheetusers/90"
        },
        "unit": 2,
        "startsAt": "2024-04-22T09:30:00",
        "duration": "03:45:00",
        "endsAt": "2024-04-22T13:15:00",
        "authorId": 90,
        "createdAt": "2024-07-04T11:59:51.09",
        "modifierId": 90,
        "modifiedAt": "2024-07-04T17:00:54.4",
        "archivedAt": null,
        "creationSource": 2,
        "layer": 0,
        "axisSections": [
          {
            "id": 41,
            "name": "Conception",
            "url": "https://demotimmi7.ilucca-test.net/api/v3/axissections/41"
          },
          {
            "id": 127,
            "name": "Animal Logic",
            "url": "https://demotimmi7.ilucca-test.net/api/v3/axissections/127"
          },
          {
            "id": 346,
            "name": "Projet Rose  : KPI - tableau de bord",
            "url": "https://demotimmi7.ilucca-test.net/api/v3/axissections/346"
          },
          {
            "id": 347,
            "name": "Art Direction",
            "url": "https://demotimmi7.ilucca-test.net/api/v3/axissections/347"
          }
        ],
        "comment": {
          "id": 59,
          "name": "This is a comment",
          "url": "https://demotimmi7.ilucca-test.net/api/v3/timeentrycomments/59"
        },
        "timeTypeId": null,
        "timesheetId": 10967,
        "timesheet": {
          "id": 10967,
          "name": "90 - avril 2024 - Submitted",
          "url": "https://demotimmi7.ilucca-test.net/api/v3/timmitimesheets/10967"
        }
      }
    ]
  }
}

Query Parameters

paging

string

required

{offset},{limit}. Defaults to 0,1000.

ownerId

any[]

Filter out TimeEntries on its ownerIds

startsAt

string

{comparator},{date-time}. Filter out TimeEntries on its startsAt.

axisSections.id

any[]

Filter on a comma-separated list of AxisSections identifiers.

axisSections.code

any[]

Filter on a comma-separated list of AxisSections codes.

modifiedAt

string

{comparator},{date-time}. Filter out TimeEntries on their modifiedAt.

archivedAt

string

{comparator},{date-time}. Filter out TimeEntries on their startsAt.

orderBy

string

{fieldName},{direction}. Defaults to {id},{asc}

Response

200

application/json

data

object

data.count

integer

data.items

object[]

data.items.ownerId

integer

required

Reference to the TimeEntry owner.

Required range: x > 1

data.items.unit

enum<integer>

required

Unit in which the TimeEntry has been entered.

0: Days (eg "1/2 day")
1: Hours (eg "8h15min")
2: Time (eg "23:45:00")

Available options:

0,

1,

2

data.items.startsAt

string

required

The timeEntry start date and time. Please do NOT send any offset/timezone information ("Z", "+01:00", etc...).

data.items.duration

string

default:

00:00:00

required

Duration of the TimeEntry in the "c" format of a C# timespan In other words : d.hh:mm:ss. Max: "1.00:00:00" (ie 24 hours).

data.items.id

integer

Unique identifier for this object.

Required range: x > 1

data.items.owner

object

The owner of this TimeEntry.

data.items.endsAt

string

Automatically set as startsAs + duration when editing a timeentry.

data.items.authorId

integer

Identifier of the user who initially created this TimeEntry.

data.items.createdAt

string

Date and time when TimeEntry was first created. (Central European Time)

data.items.modifierId

integer

The unique identifier of the user who last updated the TimeEntry.

data.items.modifiedAt

string

Date and time when TimeEntry was last modified. (Central European Time). The TimeEntry is modified by any change made to the TimeEntry, including when corresponding timesheet is sent for approbation (status=1) and when the timesheet is completely approved (status=2).

data.items.archivedAt

string

Date and time when TimeEntry was deleted (Central European Time). When null, implies that the TimeEntry still has not been deleted (and maybe never will).

data.items.creationSource

enum<integer>

default:

Attribute used to identify last modification source :

0: Automatic fallback on theoretical TimeEntries from workcycles.
1: Entered with Timmi Timesheet quick-fill tools.
2: Manually created or edited (default).
3: Imported from external sources. Is read-only on Timmi Timesheet user interfaces only if Timesheet regulation is in following modes : attendance schedule with clock-in clock-out, and activity schedule.
4: Entered with Timmi Timesheet clock-in clock-out tool.

Available options:

0,

1,

2,

3

data.items.layer

integer

Used to store the original workcycle at the time of TimeEntry modification. In 99.999% of use cases, you will want the 0 : Actual TimeEntry.

0: Actual TimeEntry.
1: Theoretical workcycle.

data.items.axisSections

object[] | null

Represent the activities that TimeEntry should be associated with. When not in activity mode, send an empty array, or do not serialize this property.

data.items.axisSections.id

integer

Required range: x > 1

data.items.axisSections.code

string

data.items.axisSections.name

string

data.items.axisSections.multilingualName

string

data.items.axisSections.description

string

data.items.axisSections.ownerId

integer

Required range: x > 1

data.items.axisSections.startOn

string

data.items.axisSections.endOn

string

data.items.axisSections.active

boolean

data.items.axisSections.axisId

integer

data.items.axisSections.parentAxisSections

object[]

data.items.axisSections.childrenAxisSections

object[]

data.items.comment

object | null

A comment to add additional information about the given TimeEntry. It will be visible on Timmi Timesheet user interface.

data.items.timeTypeId

integer | null

Optional reference of a configured Time Type. To use only if the timesheet is set up to use Time Types. Null otherwise.

data.items.timesheetId

integer

The reference to the timeshet this timeentry is associated with when the timesheet is at least sent for approval. Is null if the timesheet is still pending submission.

Was this page helpful?

The time-entry resource Create new TimeEntries

curl --request GET \
  --url https://{account}-{sandboxName}.sandbox.{server}.luccasoftware.com/api/v3/timeentries

{
  "data": {
    "count": 123,
    "items": [
      {
        "id": 552586,
        "ownerId": 90,
        "owner": {
          "id": 90,
          "name": "Hélène Girard",
          "url": "https://demotimmi7.ilucca-test.net/api/v3/timesheetusers/90"
        },
        "unit": 2,
        "startsAt": "2024-04-22T09:30:00",
        "duration": "03:45:00",
        "endsAt": "2024-04-22T13:15:00",
        "authorId": 90,
        "createdAt": "2024-07-04T11:59:51.09",
        "modifierId": 90,
        "modifiedAt": "2024-07-04T17:00:54.4",
        "archivedAt": null,
        "creationSource": 2,
        "layer": 0,
        "axisSections": [
          {
            "id": 41,
            "name": "Conception",
            "url": "https://demotimmi7.ilucca-test.net/api/v3/axissections/41"
          },
          {
            "id": 127,
            "name": "Animal Logic",
            "url": "https://demotimmi7.ilucca-test.net/api/v3/axissections/127"
          },
          {
            "id": 346,
            "name": "Projet Rose  : KPI - tableau de bord",
            "url": "https://demotimmi7.ilucca-test.net/api/v3/axissections/346"
          },
          {
            "id": 347,
            "name": "Art Direction",
            "url": "https://demotimmi7.ilucca-test.net/api/v3/axissections/347"
          }
        ],
        "comment": {
          "id": 59,
          "name": "This is a comment",
          "url": "https://demotimmi7.ilucca-test.net/api/v3/timeentrycomments/59"
        },
        "timeTypeId": null,
        "timesheetId": 10967,
        "timesheet": {
          "id": 10967,
          "name": "90 - avril 2024 - Submitted",
          "url": "https://demotimmi7.ilucca-test.net/api/v3/timmitimesheets/10967"
        }
      }
    ]
  }
}