List timesheets

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

{
  "data": {
    "items": [
      {
        "id": 123,
        "name": "45 - January 2016 - Approved",
        "ownerId": 2,
        "owner": {
          "id": 2,
          "firstName": "<string>",
          "lastName": "<string>",
          "mail": "[email protected]",
          "legalEntityId": 123,
          "manager": {
            "id": 2,
            "firstName": "<string>",
            "lastName": "<string>",
            "mail": "[email protected]",
            "legalEntityId": 123
          }
        },
        "startsOn": "2023-12-25",
        "endsOn": "2023-12-25",
        "expectedNextActorId": 123,
        "expectedNextActor": {
          "id": 2,
          "firstName": "<string>",
          "lastName": "<string>",
          "mail": "[email protected]",
          "legalEntityId": 123
        },
        "status": 0,
        "statuteId": 123
      }
    ]
  }
}

GET

api

timmitimesheets

List timesheets

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

{
  "data": {
    "items": [
      {
        "id": 123,
        "name": "45 - January 2016 - Approved",
        "ownerId": 2,
        "owner": {
          "id": 2,
          "firstName": "<string>",
          "lastName": "<string>",
          "mail": "[email protected]",
          "legalEntityId": 123,
          "manager": {
            "id": 2,
            "firstName": "<string>",
            "lastName": "<string>",
            "mail": "[email protected]",
            "legalEntityId": 123
          }
        },
        "startsOn": "2023-12-25",
        "endsOn": "2023-12-25",
        "expectedNextActorId": 123,
        "expectedNextActor": {
          "id": 2,
          "firstName": "<string>",
          "lastName": "<string>",
          "mail": "[email protected]",
          "legalEntityId": 123
        },
        "status": 0,
        "statuteId": 123
      }
    ]
  }
}

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

data

object

Show child attributes

data.items

The Timesheet resource · object[]

The list of timesheets satisfying query filters.

Show child attributes

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

Timesheet User · object

A Timesheet limited model of a user

Show child attributes

data.items.owner.id

integer

Unique identifier of this User.

Required range: x >= 1

data.items.owner.firstName

string

Given name.

data.items.owner.lastName

string

Family name

data.items.owner.mail

string<email>

Email address.

data.items.owner.legalEntityId

integer

Unique identifier of the legal establishment this user currently has a work contract with.

data.items.owner.manager

Timesheet User · object

A Timesheet limited model of a user

Show child attributes

data.items.owner.manager.id

integer

Unique identifier of this User.

Required range: x >= 1

data.items.owner.manager.firstName

string

Given name.

data.items.owner.manager.lastName

string

Family name

data.items.owner.manager.mail

string<email>

Email address.

data.items.owner.manager.legalEntityId

integer

Unique identifier of the legal establishment this user currently has a work contract with.

data.items.startsOn

string<date>

The Timesheet starting date (included).

data.items.endsOn

string<date>

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

Timesheet User · object

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

Show child attributes

data.items.expectedNextActor.id

integer

Unique identifier of this User.

Required range: x >= 1

data.items.expectedNextActor.firstName

string

Given name.

data.items.expectedNextActor.lastName

string

Family name

data.items.expectedNextActor.mail

string<email>

Email address.

data.items.expectedNextActor.legalEntityId

integer

Unique identifier of the legal establishment this user currently has a work contract with.

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).

The timesheet resource

List due timesheets

⌘I

Documentation

Files

Organization Structure API

Core HR API

Expenses API

Invoices API

Absences API

Office API

Project API

Schedule API

Timesheet API

Mealvouchers API

Compensation API

Training API

List timesheets

Headers

Query Parameters

Response