Get a time-entry by id

curl --request GET \
  --url https://{host}/api/v3/timeentries/{timeEntryId} \
  --header 'Authorization: <authorization>'

const options = {method: 'GET', headers: {Authorization: '<authorization>'}};

fetch('https://{host}/api/v3/timeentries/{timeEntryId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{host}/api/v3/timeentries/{timeEntryId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{host}/api/v3/timeentries/{timeEntryId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<authorization>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://{host}/api/v3/timeentries/{timeEntryId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'

response = http.request(request)
puts response.read_body

{
  "data": {
    "ownerId": 90,
    "unit": 2,
    "startsAt": "2024-04-22T08:30:00",
    "duration": "04:45:00",
    "creationSource": 2,
    "axisSections": [
      {
        "id": 42
      },
      {
        "id": 127
      },
      {
        "id": 346
      },
      {
        "id": 347
      }
    ],
    "comment": {
      "id": 59,
      "content": "This is another comment"
    },
    "timeTypeId": 1
  }
}

{
  "Status": 401,
  "Message": "Unauthorized"
}

{
  "Status": 401,
  "Message": "Unauthorized"
}

{
  "Status": 401,
  "Message": "Unauthorized"
}

{
  "Status": 401,
  "Message": "Unauthorized"
}

GET

api

timeentries

{timeEntryId}

Get a time-entry by id

curl --request GET \
  --url https://{host}/api/v3/timeentries/{timeEntryId} \
  --header 'Authorization: <authorization>'

const options = {method: 'GET', headers: {Authorization: '<authorization>'}};

fetch('https://{host}/api/v3/timeentries/{timeEntryId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{host}/api/v3/timeentries/{timeEntryId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{host}/api/v3/timeentries/{timeEntryId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<authorization>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://{host}/api/v3/timeentries/{timeEntryId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'

response = http.request(request)
puts response.read_body

{
  "data": {
    "ownerId": 90,
    "unit": 2,
    "startsAt": "2024-04-22T08:30:00",
    "duration": "04:45:00",
    "creationSource": 2,
    "axisSections": [
      {
        "id": 42
      },
      {
        "id": 127
      },
      {
        "id": 346
      },
      {
        "id": 347
      }
    ],
    "comment": {
      "id": 59,
      "content": "This is another comment"
    },
    "timeTypeId": 1
  }
}

{
  "Status": 401,
  "Message": "Unauthorized"
}

{
  "Status": 401,
  "Message": "Unauthorized"
}

{
  "Status": 401,
  "Message": "Unauthorized"
}

{
  "Status": 401,
  "Message": "Unauthorized"
}

Headers

Authorization

string

required

API key. Value must be formatted like so: lucca application={api_key}.

Path Parameters

timeEntryId

integer

required

Identifier of the time-entry.

Response

data

The time-entry resource · object

time-entries are the working time sequences spent by a user on any given day.

time-entries come in different units and submission modes that should match the timesheet configuration of a given owner on a given day.

About units & duration

Lucca Timesheet supports up to 3 different units when it comes to entering time-entries. These are:

0: Days In this case, the user does not enter the exact hours he/she started working, but rather the total duration spent as a fraction of a day. For example: "John worked half a day on Monday".
1: Hours In this case, the user still does not enter the exact hours, but only the duration spent in hours. For example: "John worked 7h30min yesterday".
2: Time In this unit, the user has to enter the actual time he/she started working, as well as the end time. For example: "John started working at 08:00 for 3 hours, thus ending at 11:00".

enum TimeEntryUnit:
{
    Days = 0,
    Hours = 1,
    Time = 2
}

Whichever the unit, the time-entry is mainly determined by three properties:

(int) ownerId: The user it belongs to.
(date-time) startsAt: The date and time when the user started working. In Days and Hours units, the time part can only be 00:00:00 for "morning" (AM) or 12:00:00 for the "afternoon" (PM).
(duration) duration: The total time spent by the user from the time he/she started. In all units, this property is serialized as a string compliant with the Timespan formating: d.hh:mm:ss where d is the number of days (can be omitted if equal to zero which is in most cases), hh the number of hours, mm the number of minutes, and ss the number of seconds.

Some examples :

// TIME UNIT
// Case: "John (id: 416) worked between 09:45 and 12:15 on January, 1st 2021."
var timeEntry = {
  "ownerId": 416,
  "startsAt": "2021-01-01 09:45:00",
  "duration: "02:30:00",
  "unit": 2
};

// HOURS UNIT
// Case: "John (id: 416) spent 4h45min working on January, 1st 2021 in the morning"
var timeEntry = {
  "ownerId": 416,
  "startsAt": "2021-01-01 00:00:00",
  "duration: "04:45:00",
  "unit": 1
}

// DAYS UNIT
// Case: "John (id: 416) worked on the afternoon of January, 1st 2021"
var timeEntry = {
  "ownerId": 416,
  "startsAt": "2021-01-01 12:00:00",
  "duration: "12:00:00",
  "unit": 0
}

About submission modes

There are 2 submission modes in Lucca Timesheet:

Attendance: the user is expected to enter the sequences of work without much detail.
Activities: the user is expected to enter the time spent on each task / project / whatever.

Therefore, time-entries in activities mode have a supplementary property: the set of task / project / cost center / ... the user worked on. These analytical items are called AxisSections. More info here [blocked].

The time-entry is NOT determined by the axisSection[] it is associated with as a user can change the axisSection[].

{
  "ownerId": 416,
  "startsAt": "2021-01-01 00:00:00",
  "duration: "04:45:00",
  "unit": 1,
  "axisSections": [
    {
      "name": "R&D",
      "axis": {
        "name": "Cost centers"
      }
    },
    {
      "name": "My awesome project",
      "axis": {
        "name": "Projects"
      }
    },
    {
      "name": "Testing",
      "axis": {
        "name": "Tasks"
      }
    }
  ]
}

About time types

Each time-entry can reference a time type via its timeTypeId property.

Time types are a configured working time classification. It is generally used as a way of discriminating different types of working hours regarding compensation:

Attendance
Travels
etc...

Time types can only be used on users that belong to a specific regulation (ie time and attendance policy) mode: timeTrackingMode: typed. Whenever it is not the case, the timeTypeId property should be left null.

Validation rules

Locked timeentries after timesheet submission

A time-entry cannot be modified if its startsAt date belongs to an already submitted or approved timesheet.

StartsAt and timezones

The startsAt date-time property must be considered a floating date-time. As such, no UTC offset should be sent when creating or editing a time-entry.

Max duration

A time-entry cannot have a duration longer than 24h00 (ie one full day).

Cut at midnight

A time-entry cannot overlap 2 different days (example startsAt = 18:00:00 and duration = 10:00:00). It should be two distinct time-entries cut at 00:00:00.

Mandatory axisSection on activity timesheets

A time-entry must have axisSection if the corresponding timesheet is in activity mode, and vice-versa.

Inactive axisSection

A time-entry cannot be modified if one of its axisSection is no longer active (active=false).

Incompatible axisSections

A time-entry cannot have nested axisSections that does not meet a correct parent-child tree structure.

Fields

Show child attributes

Example:

{
  "id": 552586,
  "ownerId": 90,
  "owner": {
    "id": 90,
    "name": "Hélène Girard",
    "url": "https://example.ilucca.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://example.ilucca.net/api/v3/axissections/41"
    },
    {
      "id": 127,
      "name": "Animal Logic",
      "url": "https://example.ilucca.net/api/v3/axissections/127"
    },
    {
      "id": 346,
      "name": "Projet Rose  : KPI - tableau de bord",
      "url": "https://example.ilucca.net/api/v3/axissections/346"
    },
    {
      "id": 347,
      "name": "Art Direction",
      "url": "https://example.ilucca.net/api/v3/axissections/347"
    }
  ],
  "comment": {
    "id": 59,
    "name": "This is a comment",
    "url": "https://example.ilucca.net/api/v3/timeentrycomments/59"
  },
  "timeTypeId": null,
  "timesheetId": 10967,
  "timesheet": {
    "id": 10967,
    "name": "90 - avril 2024 - Submitted",
    "url": "https://example.ilucca.net/api/v3/timmitimesheets/10967"
  }
}

Documentation

Files

Organization Structure API

Core HR API

Recruitment API

Expenses API

Invoices API

Absences API

Office API

Project API

Schedule API

Timesheet API

Mealvouchers API

Compensation API

Training API

Get a time-entry by id

Headers

Path Parameters

Response

About units & duration

About submission modes

About time types

Validation rules

Locked timeentries after timesheet submission

StartsAt and timezones

Max duration

Cut at midnight

Mandatory axisSection on activity timesheets

Inactive axisSection

Incompatible axisSections

Fields