List timesheets - Lucca API

Community

Status

Documentation

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
Exports

Cleemy Invoices API

Guides

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

GET

api

timmitimesheets

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

{
  "data": {
    "items": [
      {
        "id": 10959,
        "name": "45 - avril 2024 - Approved",
        "ownerId": 45,
        "owner": {
          "id": 45,
          "name": "Noël Flantier",
          "url": "https://demotimmi7.ilucca-test.net/api/v3/timesheetusers/45"
        },
        "startsOn": "2024-04-29T00:00:00",
        "endsOn": "2024-05-06T00:00:00",
        "statuteId": 4,
        "expectedNextActorId": null,
        "expectedNextActor": null,
        "status": 2,
        "timeEntries": [
          {
            "id": 551915,
            "name": "",
            "url": "https://demotimmi7.ilucca-test.net/api/v3/timeentries/551915"
          },
          {
            "id": 551916,
            "name": "",
            "url": "https://demotimmi7.ilucca-test.net/api/v3/timeentries/551916"
          },
          {
            "id": 551917,
            "name": "",
            "url": "https://demotimmi7.ilucca-test.net/api/v3/timeentries/551917"
          },
          {
            "id": 551918,
            "name": "",
            "url": "https://demotimmi7.ilucca-test.net/api/v3/timeentries/551918"
          },
          {
            "id": 551919,
            "name": "",
            "url": "https://demotimmi7.ilucca-test.net/api/v3/timeentries/551919"
          },
          {
            "id": 551920,
            "name": "",
            "url": "https://demotimmi7.ilucca-test.net/api/v3/timeentries/551920"
          },
          {
            "id": 551921,
            "name": "",
            "url": "https://demotimmi7.ilucca-test.net/api/v3/timeentries/551921"
          },
          {
            "id": 551922,
            "name": "",
            "url": "https://demotimmi7.ilucca-test.net/api/v3/timeentries/551922"
          }
        ]
      }
    ]
  }
}

Headers

Authorization

string

required

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

Query Parameters

ownerId

any[]

User's identifier.

startsOn

string

Filter on the start date of the timesheet.

Example:

"between,2022-01-01,2022-02-01"

status

any[]

Filter on the timesheet workflow status. 0 for temporary, 1 for pending, 2 for approved, 3 for rejected.

endsOn

string

Filter on the end date of the timesheet.

Example:

"until,2022-01-01"

Response

200

application/json

data

object

data.items

object[]

The list of timesheets satisfying query filters.

Definitions

Timesheets are TimeEntries containers. A timesheet belongs to a single user owner and ranges over several days [startsOn - endsOn[ (endsOn excluded). Its range depends on the submission frequency set up in Timmi Timesheet (weekly / monthly).

A timesheet purpose is to ease the approval workflow: rather than approving each TimeEntry individually, they are approved in a weekly / monthly batch.

The approval workflow looks like this:

Timmi Timesheet - Approval workflow

Thus, a timesheet:

is created upon submission ;
is "pending approval" or "submitted" (status: 1) as long as all approvers have not approved it ;
is "approved" (status: 2) once all approvers have approved it ;
may become "rejected" (status: 3) whenever:
- the submitter cancels the submission, which is possible as long as the timesheet is not fully approved ;
- one of the approvers denies the timesheet ;
- an administrator invalidates the timesheet, which is only possible once the timesheet is fully approved.

Once a timesheet is rejected, a new one has to be submitted and the workflow starts again.

Timesheets are created and their status are set to submitted. In some cases, timesheets may then be automatically approved, depending on the approval workflow settings.

Once submitted, all timeentries on the period for that user can no longer be modified. In order to be able to modify them, the timesheet must first be rejected through cancel, deny or invalidate operations (depends on the current timesheet status).

Available guide

Please see this guide on how to submit timesheets the right way.

Fields

data.items.id

integer

Uniquer identifier of the timesheet.

data.items.name

string

Human-readable description of the Timesheet

Example:

"45 - January 2016 - Approved"

data.items.ownerId

integer

Reference to the Timesheet owner.

Required range: x >= 1

data.items.owner

object

A Timesheet limited model of a user

data.items.startsOn

string

The Timesheet starting date (included).

data.items.endsOn

string

The Timesheet ending date (excluded).

data.items.expectedNextActorId

integer

Reference to the TimesheetUser responsible for the next approval workflow step. Is null if status <> 1

data.items.expectedNextActor

object

Reference to the TimesheetUser responsible for the next approval workflow step. Is null if status <> 1

data.items.status

enum<integer>

Approval workflow status for this timesheet

0: the timesheet is yet to be submitted
1: the timesheet has been submitted and approval is still pending
2: the timesheet has been submitted and approved.
3: the timesheet has been rejected (cancelled after submission, denied upon approval or invalidated after having been approved)

Available options:

0,

1,

2,

3

data.items.statuteId

integer

Reference to the applicable "statute" (configuration).

Was this page helpful?

The timesheet resource

List due timesheets

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

{
  "data": {
    "items": [
      {
        "id": 10959,
        "name": "45 - avril 2024 - Approved",
        "ownerId": 45,
        "owner": {
          "id": 45,
          "name": "Noël Flantier",
          "url": "https://demotimmi7.ilucca-test.net/api/v3/timesheetusers/45"
        },
        "startsOn": "2024-04-29T00:00:00",
        "endsOn": "2024-05-06T00:00:00",
        "statuteId": 4,
        "expectedNextActorId": null,
        "expectedNextActor": null,
        "status": 2,
        "timeEntries": [
          {
            "id": 551915,
            "name": "",
            "url": "https://demotimmi7.ilucca-test.net/api/v3/timeentries/551915"
          },
          {
            "id": 551916,
            "name": "",
            "url": "https://demotimmi7.ilucca-test.net/api/v3/timeentries/551916"
          },
          {
            "id": 551917,
            "name": "",
            "url": "https://demotimmi7.ilucca-test.net/api/v3/timeentries/551917"
          },
          {
            "id": 551918,
            "name": "",
            "url": "https://demotimmi7.ilucca-test.net/api/v3/timeentries/551918"
          },
          {
            "id": 551919,
            "name": "",
            "url": "https://demotimmi7.ilucca-test.net/api/v3/timeentries/551919"
          },
          {
            "id": 551920,
            "name": "",
            "url": "https://demotimmi7.ilucca-test.net/api/v3/timeentries/551920"
          },
          {
            "id": 551921,
            "name": "",
            "url": "https://demotimmi7.ilucca-test.net/api/v3/timeentries/551921"
          },
          {
            "id": 551922,
            "name": "",
            "url": "https://demotimmi7.ilucca-test.net/api/v3/timeentries/551922"
          }
        ]
      }
    ]
  }
}