.text-5xl {
	font-size: 3rem;
	line-height: 1;
}
.text-align-center {
	text-align: center;
}

.hero-block {
	position: relative;
	display: flex;
	flex-direction: row;
	padding: 4rem 0;
	text-align: center;
}
.hero-block-illustration {
	flex: 1 1 15%;
	position: relative;
}
.hero-block-illustration span {
	position: initial;
}
.hero-block-illustration img {
	position: absolute;
	max-width: 1000px;
	height: auto;
	width: auto;
	top: -10rem;
	cursor: pointer;
	pointer-events: none;
}
.hero-block-illustration img:is(.dark *) {
	opacity: 0.5;
}
.hero-block-illustration.left img {
	right: 0;
}
.hero-block-illustration.right img {
	left: 0;
}

.hero-block-content {
	flex: 0 1 50%;
	display: flex;
	flex-direction: column;
	align-items: center;
	justify-items: center;
}

.home-subtitle {
	font-size: 1.25rem;
	margin-top: 1rem;
	font-weight: 400;
	max-width: 40rem;
}

#home-footer .home-footer-container {
	flex: 1 1 100%;
	flex-wrap: nowrap;
	justify-content: space-between;
	padding-left: 0;
	padding-right: 0;
}

#home-footer .item-1 {
	cursor: pointer;
	pointer-events: none;
}

.changelog-item .main-illustration img {
	margin: 0;
}

ul.oauth-scopes,
ul.oauth-scopes ul {
	margin: 0 !important;
}
ul.oauth-scopes.single-li {
	padding-left: 0.5rem;
}
ul.oauth-scopes.single-li,
ul.oauth-scopes.single-li ul,
ul.oauth-scopes.single-li li {
	display: inline;
}
ul.oauth-scopes.single-li > li {
	padding: 0 !important;
}
ul.oauth-scopes.single-li > li::before {
	display: none;
}
ul.oauth-scopes li {
	margin: 0 !important;
}
ul.oauth-scopes ul li::before {
	display: none;
}
ul.oauth-scopes > li {
	display: block;
}
ul.oauth-scopes > li:not(:last-child)::after {
	display: block;
	content: "or";
	padding: 0 0.5rem;
	margin: 0.5rem 0;
}
ul.oauth-scopes ul li {
	display: inline-block;
	padding: 0 !important;
}
ul.oauth-scopes ul li:not(:last-child)::after {
	display: inline-block;
	content: "and";
	padding: 0 0.5rem;
}


Status

Lucca API

Home

Documentation

API Reference

Guides

Legacy APIs

Changelog

Sign in

Retrieve variable remuneration items matching a set of filters

List variable items

An amended work contract is defined both by the work contract and the amendment
This is the identifier of the amendment part

The identifier of the employee who owns the contract

An amended work contract is defined both by the work contract and the amendment
This is the identifier of the work contract part

Currency symbol used in this establishment

An unique identifier for the establishment

Is the nature of the remuneration an amount of money or a quantity?

A variable item must be linked to a work contract, or eventually the amendment of a work contract.
If the variable item is linked to an amendment, this is the id of the amendment.

The amount of the variable remuneration item.
Depending on the nature of the variable item, the amount can be either a quantity or a monetary value.

You can attach a comment to explain or justify the variable

Unique identifier of the variable remuneration item

The nature of the variable remuneration item

The nature id of the variable remuneration item

A variable remuneration item is ponctual, and is linked to a specific period

The work contract linked to the variable item.

A variable item must be linked to a work contract, or eventually the amendment of a work contract.
This is the id of the work contract.

Establishments linked to the variable nature

An unique identifier for the variable nature

An internal unique code identifying the category

An unique identifier for the variable nature category

Introduction

Learn how to authenticate on a Legacy API.

Authentication

Behavioral and structural differences between v3 and v4 API generations.

v3 VS v4

Limits

Legacy API Changelog

The file resource

Upload a file

Using Files

The axis resource

List Axes

The axis-section resource

List all AxisSections satisfying query filters.

List AxisSections

Create a new AxisSection

Retrieve a single AxisSection by its unique identifier.

Get an AxisSection by id

Partial or complete update to an existing AxisSection.

Update an AxisSection by id

Delete an AxisSection by id

The department resource

List all Departments satisfying query filters.

List Departments

List all departments as a tree.
Remark: first node is always empty and represents the starting point 
of the tree as multiple departments might be set to the highest level. 

List Departements as a tree

Retrieve a single Department by its unique identifier.

Get Departement by id

The legal-unit resource

Retrieve a paginated list of legal-units.

List legal-units

The establishment resource

List establishments

The user resource

Retrieve a list of Users.

By default, former employees are excluded from the response. In order to retrieve them, you may add the `?dtContractEnd=notequal,null` query parameter to your request.


List Users

Create a new User

Retrieve a single User identified by its unique identifier.

Get a User by Id

Update fields of a single User identified by its unique id.

Update a User by id

Users Examples

The UserProperties API can be used to retrieve information on the structure of all the properties that can be attached to a user. This API is read-only: only the HTTP `GET` request method is therefore available on this API.

Using the user-properties API

Extended Data

Using employees' work-contracts

Delegation

The expense-temp-item resource

Retrieve a list of `ExpenseTempItems`.

The `purchasedOn` query parameter can operate comparisons with a given date-time value:
- `?purchasedOn=2021-01-01`: strict equality.
- `?purchasedOn=since,2021-01-01`: greater than or equal.
- `?purchasedOn=until,2021-01-01`: lower than or equal.
- `?purchasedOn=between,2021-01-01,2021-01-31`: comprised between two dates.

List ExpenseTempItems (temporary expense)

Create a new temporary expense

Retrieve an temporary expense item by its identifier.

Get an ExpenseTempItem by id

Update a temporary expense item by its identifier.

Update an ExpenseTempItem by id

The expense-claim resource

When a user wants to declare his expenses, he creates an `ExpenseClaim`.

An `ExpenseClaim` is created by regrouping one or more `ExpenseTempItems` and converting them into ExpenseClaimItems.

Once created, an `ExpenseClaim` has to be approved by his manager.

Multiple `ExpenseClaims` can be created through a single request.

Create a new ExpenseClaim

Retrieve a list of `ExpenseClaims`.

The `declaredOn` query parameter can operate comparisons with a given date-time value:
- `?declaredOn=2021-01-01`: strict equality.
- `?declaredOn=since,2021-01-01`: greater than or equal.
- `?declaredOn=until,2021-01-01`: lower than or equal.
- `?declaredOn=between,2021-01-01,2021-01-31`: comprised between two dates.

List ExpenseClaims

The leave resource

The leave-account resource

Retrieve a list of approved leaves for one or several users on a given period.

The `leavePeriod.ownerId` query parameter is required ans is used to:
  - retrieve Leaves of a specific user: `?leavePeriod.ownerId=5`
  - retrieve Leaves of several users: `?leavePeriod.ownerId=5,6`
  - retrieve Leaves of a specific group of users: `?leavePeriod.owner.departmentId=3`

The `date` query parameter can operate comparisons with a given date-time value:
  - `?date=2021-01-01`: strict equality.
  - `?date=since,2021-01-01`: greater than or equal.
  - `?date=until,2021-01-01`: lower than or equal.
  - `?date=between,2021-01-01,2021-01-31`: comprised between two dates.

List leaves

Retrieve a single Leave by its unique identifier.

Get a leave by id

Cancel a single Leave by its unique identifier.

Cancellation of a leave

The leave-request resource

The leave-period resource

List leave requests

Retrieve a single Leave Request by its unique identifier.

Get a leave request by id

The leave-request-approval resource

Approve or deny a single Leave Request by its unique identifier

Only the Leave Requests pending approval can be approved or denied.

A comment is required to deny a Leave Request.


Approve or deny a leave request

The cancellation-request resource

Request to cancel a single Leave Request by its unique identifier

Request to cancel a leave request

**Supported file formats:**
- CSV
  - "UTF-8" encoding
  - separator “;”
- XSLX

**Columns to fill in:**

| Column name                                     | Description                                              |
| :---------------------------------------------- | :------------------------------------------------------- |
| `LegalEntityCode`                               | Employee legal entity code.                              |
| `EmployeeNumber`                                | Employee payroll number.                                 |
| `LastName`                                      | Last name.                                               |
| `FirstName`                                     | First name.                                              |
| Account number or name (one column per account) | Value to import for the account defined in the header.   |

*Remark:
A template file can be downloaded from the import page (Credit / Debit> A group of collaborators> File import).*

In the event of a malformed (or unrecognized) file, no data will be imported; the problems detected will be specified in the `globalErrors` field.

If successful, the number of imported lines is indicated by the “successLinesCount” field; the lines in error are detailed in the `lineErrors` field.


*Remarks:
Any import made by the API is of course available in the import history.
A simulation returns the same level of information, but does not trigger an import*

**List of errors handled**

Here is the list of fatal errors, which can be returned in the `globalErrors`:
- Unauthorized
- FileEmpty,
- FileExtensionNotSupported,
- ColumnsFormatNotSupported,
- AccountColumnMissing,
- ColumnNamesDistinct,
- LineErrorForbiddenInStrictMode,

The list of line processing errors, which can be restored in the `lineErrors`:
- AccountNotFound,
- AccountsNotFound,
- AccountColumnsProcessing,
- LegalEntityCodesNotFound,
- MissingValuesForAccount,
- AccountNotAvailableForUser,
- LegalEntityCodeRequired,
- EmployeeNumberRequired,
- LoginRequired,
- LoginNotFound,
- AccountNumberRequired,
- LegalEntityNotFound,
- EmployeeNumberNotExist,
- EmployeeNumberNotInLegalEntity,
- FistNameAndLastNameNotMatching,
- FistNameNotMatching,
- LastLameNotMatching,
- FistNameAndLastNameNotMatchingEmployeeNumber,
- FistNameNotMatchingEmployeeNumber,
- LastLameNotMatchingEmployeeNumber,
- FistNameAndLastNameNotMatchingLogin,
- FistNameNotMatchingLogin,
- LastLameNotMatchingLogin,
- DuplicatedLine,
- AmbiguousLegalEntity,
- ColumnNotExists,
- LegalEntityNameNotAvailable,
- AccountNameNotUnique

The list of import generation errors:
- UnableToCreditAccount


Import entitlements

**Supported file formats:**
- CSV
  - "UTF-8" encoding
  - separator “;”
- XSLX

**Columns to fill in:**

| Column name                                     | Description                                              |
| :---------------------------------------------- | :------------------------------------------------------- |
| `LegalEntityCode`                               | Employee legal entity code.                              |
| `EmployeeNumber`                                | Employee payroll number.                                 |
| `LastName`                                      | Last name.                                               |
| `FirstName`                                     | First name.                                              |
| Account number or name (one column per account) | Value to import for the account defined in the header.   |


*Remark:
A template file can be downloaded from the import page (Credit / Debit> A group of collaborators> File import).*

In the event of a malformed (or unrecognized) file, no data will be imported; the problems detected will be specified in the `globalErrors` field.

If successful, the number of imported lines is indicated by the “successLinesCount” field; the lines in error are detailed in the `lineErrors` field.


*Remarks:
Any import made by the API is of course available in the import history.
A simulation returns the same level of information, but does not trigger an import*

**List of errors handled**

Here is the list of fatal errors, which can be returned in the `globalErrors`:
- Unauthorized
- FileEmpty,
- FileExtensionNotSupported,
- ColumnsFormatNotSupported,
- AccountColumnMissing,
- ColumnNamesDistinct,
- LineErrorForbiddenInStrictMode,

The list of line processing errors, which can be restored in the `lineErrors`:
- AccountNotFound,
- AccountsNotFound,
- AccountColumnsProcessing,
- LegalEntityCodesNotFound,
- MissingValuesForAccount,
- AccountNotAvailableForUser,
- LegalEntityCodeRequired,
- EmployeeNumberRequired,
- LoginRequired,
- LoginNotFound,
- AccountNumberRequired,
- LegalEntityNotFound,
- EmployeeNumberNotExist,
- EmployeeNumberNotInLegalEntity,
- FistNameAndLastNameNotMatching,
- FistNameNotMatching,
- LastLameNotMatching,
- FistNameAndLastNameNotMatchingEmployeeNumber,
- FistNameNotMatchingEmployeeNumber,
- LastLameNotMatchingEmployeeNumber,
- FistNameAndLastNameNotMatchingLogin,
- FistNameNotMatchingLogin,
- LastLameNotMatchingLogin,
- DuplicatedLine,
- AmbiguousLegalEntity,
- ColumnNotExists,
- LegalEntityNameNotAvailable,
- AccountNameNotUnique

The list of import generation errors:
- UnableToCreditAccount


Replace entitlements

Create absences in batch from a CSV file.

**Important notice: Absence imports cannot be cancelled.** 

In case of a mistake absences must be deleted manually through the interface or using the API (see Use cases). **Use import with care!**

**File format**

Content-Type: CSV. Column divider is semicolon ";". Line breaks between rows.

Encoding: UTF-8

All the following fields must be present with the field name in the header:

- legalEntity: Name of the establishment the employee belongs to.
- employeeNumber: Employee number.
- lastName: Family (last) name of the employee.
- firstName: Given (first) name of the employee.
- accountId: Identifier of the absence account in Timmi Absences (can be found in the leave accounts admin page).
- startDate: Start date of the absence, formatted as `DD/MM/YYYY`.
- flagStartDate: `"AM"` if the absence starts in the morning or `"PM"` if the absence starts in the afternoon.
- endDate: End date of the absence, formatted as `DD/MM/YYYY`.
- flagEndDate: `"AM"` if the absence ends at noon or `"PM"` if the absence ends in the afternoon.
- isApproved: `true` or `false`. Dictates whether the absence request should be created and already approved. 
  Required if the type of the absence requires approval, optional otherwise.

**History**
Import history is available in the import module. It includes imports made via the API.


Import leaves

Retrieve the progress of Import leaves API request.

Get import leaves progress

Syncing leaves

The user-location resource

List userLocations

Get specific userLocation

The work-location resource

List workLocations

Retrieve specific workLocation

The client resource

List clients from an organization.

## Search

The search query parameter takes a list of words and enables you to only return clients whose code or name contains all those words.

```http
GET /api/v4/clients?organizationId=1&search=goo,compa&fields.root=count HTP/1.1

{
  "count": 2,
  "items": [
    {
      "id": 1,
      "name": "Google",
      "code": "World company"
    },
    {
      "id": 1,
      "name": "Google company",
      "code": "Alphabet Group"
  ]
}
```

List Clients

Create a new Client

Retrieve a single client identified by its unique identifier.

Get a Client by id

Update fields of a single client identified by its unique id.

Update a Client by id

Delete a single client. Deletion is irrevocable.

Delete a Client by id

The project resource

List projects from an organization. Only returns a subset of a [Project](reference/Timmi-Project.yaml/components/schemas/Project) fields.

## Search

The search query parameter takes a list of words and enables you to only return projects whose code or name (or those of their clients) contains all those words.

```http
GET /api/v4/projects?organizationId=1&search=pro,avat&fields.root=count HTP/1.1

{
  "count": 2,
  "items": [
    {
      "id": 1,
      "name": "Project",
      "code": "Avatar",
      "client": {
        "name": "James Cameron",
        "code": "CAMERON"
      }
    },
    {
      "id": 2,
      "name": "Avatar Project",
      "code": "Awesomeness",
      "client": {
        "name": "Advent",
        "code": "ADVENT"
      }
  ],
  {
    "id": 3,
    "name": "Test",
    "code": "Test",
    "client": {
      "name": "Avatar",
      "code": "project"
    }
  }
}
```

List Projects

Create a new Project

Retrieve a project by its unique identifier.

Get Project by id

Update a Project by id

Only projects at "draft" status can be deleted.

Delete a Project by id

The project-service resource

List all services from a project identified by its unique id.

List a Project's Services

Create a new Project Service on a project.

Create a new Project Service

The organization resource

List organizations.

Conforms to the API v3 constraints (?fields, ?paging, etc...).

List Organizations

The project-financials resource

Retrieve all financial metrics on projects.

Response contains the sum of all included projects (paginated). The `items` node contains the financial metrics for each project.

List financials by project

The user-date resource

Retrieve a list of UserDates.

### Performance
In order to keep satisfactory response times and performance, please filter the request on a limited set of OwnerId[] and reduce the period  `date=between,{start},{end}`.

As a rule of thumb, do not request for more than ~10 owners over a whole month.

### Format
The `date` query parameter should match the form `?date=between,{start},{includedEnd}`.

List UserDates.

The workcycle-exception resource

Retrieve a paginated list of WorkCycleExceptions that satisfy the 
given query filters.


List WorkCycleExceptions.

**⚠️ Note**:
An employee can only have a single `WorkCycleException` on any given
half-day (indicated by the `startsAt` date and the `isAm` boolean).
As a result, creating a new `WorkCycleException` via a POST request 
may result in the update of the existing one.


Create (or update) a WorkCycleException.

Retrieve a single WorkCycleException by its ID.


Retrieve a WorkCycleException.

**❗Note**: The `WorkCycleException`, once deleted, stays available in the API.
In order to filter out the deleted `WorkCycleException`, you may use the `deletedAt`
query parameter:
```http
GET /api/v3/workcycleexceptions?deletedAt=null HTTP/1.1
Host: example.ilucca.net
Authorization: lucca application=XXXX
```


Delete a WorkCycleException.

The working-time-arrangement resource

<Warning>
**This is a beta feature.** 
You may not benefit from this feature. Working-time-arrangements are the
replacement for the workcycles. If this feature has not been deployed on
your environment, please contact our support.
</Warning>

List of Working Time Arrangements.

List Working Time Arrangements.

<Warning>
**This is a beta feature.** 
You may not benefit from this feature. Working-time-arrangements are the
replacement for the workcycles. If this feature has not been deployed on
your environment, please contact our support.
</Warning>

Get a Working Time Arrangement by id

Get a Working Time Arrangement by id.

The collective-schedule resource

<Warning>
**This is a beta feature.** 
You may not benefit from this feature. Working-time-arrangements are the
replacement for the workcycles. If this feature has not been deployed on
your environment, please contact our support.
</Warning>

Get the list of Collective Schedules from a Working Time Arrangement by id

List Collective Schedules from a Working Time Arrangement

<Warning>
**This is a beta feature.** 
You may not benefit from this feature. Working-time-arrangements are the
replacement for the workcycles. If this feature has not been deployed on
your environment, please contact our support.
</Warning>

Get a Collective Schedule of a Working Time Arrangement by id

Get a Collective Schedule from a Working Time Arrangement by id.

The time-entry resource

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](reference/Timmi-Timesheet-v3.yaml/components/schemas/TimeEntry) for additional information on the TimeEntry object.

Please see [this guide](../docs/Use-cases/Timmi%20Timesheet/Retrieve-time-entries.md) on how to retrieve TimeEntries the right way.

List multiple TimeEntries

Create one or multiple TimeEntries. 

A single request can create TimeEntries for several different owners.

Please refer to the [TimeEntry API reference](reference/Timmi-Timesheet-v3.yaml/components/schemas/TimeEntry) for additional information on the TimeEntry object, and any validation error that you might encounter when using this API.

There are different ways to update TimeEntries. Please see [this guide](../docs/Use-cases/Timmi%20Timesheet/Update-time-entries.md) on how to update TimeEntries the right way depending on your use case.

Create new TimeEntries

Update one or several TimeEntries. 

The "id" field must be sent and correspond to an existing TimeEntry. 

A single request can edit TimeEntries for several different owners.

Please refer to the [TimeEntry API reference](reference/Timmi-Timesheet-v3.yaml/components/schemas/TimeEntry) for additional information on the TimeEntry object, and any validation error that you might encounter when using this API.

There are different ways to update TimeEntries. Please see [this guide](../docs/Use-cases/Timmi%20Timesheet/Update-time-entries.md) on how to update TimeEntries the right way depending on your use case.

Update multiple TimeEntries

Delete one or several TimeEntries. Deletion is irrevocable.

The "id" field of each TimeEntry must be sent and correspond to existing TimeEntries.

A single request can delete TimeEntries for several different owners.

It actually doest not delete entirely the object, but rather sets the "archivedAt" field to the current DateTime.

Please refer to the [TimeEntry API reference](reference/Timmi-Timesheet-v3.yaml/components/schemas/TimeEntry) for additional information on the TimeEntry object, and any validation error that you might encounter when using this API.

There are different ways to update TimeEntries. Please see [this guide](../docs/Use-cases/Timmi%20Timesheet/Update-time-entries.md) on how to update TimeEntries the right way depending on your use case.

Delete multiple TimeEntries

Retrieve a single TimeEntry identified by its unique identifier.

Please refer to the [TimeEntry API reference](reference/Timmi-Timesheet-v3.yaml/components/schemas/TimeEntry) for additional information on the TimeEntry object.

Please see [this guide](../docs/Use-cases/Timmi%20Timesheet/Retrieve-time-entries.md) on how to retrieve TimeEntries the right way.

Get a TimeEntry by id

Update fields of a single TimeEntry identified by its unique id.

The "id" field must be sent and correspond to an existing TimeEntry. 

Please refer to the [TimeEntry API reference](reference/Timmi-Timesheet-v3.yaml/components/schemas/TimeEntry) for additional information on the TimeEntry object, and any validation error that you might encounter when using this API.

There are different ways to update TimeEntries. Please see [this guide](../docs/Use-cases/Timmi%20Timesheet/Update-time-entries.md) on how to update TimeEntries the right way depending on your use case.

Update a TimeEntry by id

Delete a TimeEntry. Deletion is irrevocable.

The "id" field must be set and correspond to an existing TimeEntry.

It actually doest not delete entirely the object, but rather sets the "archivedAt" field to the current DateTime.

Please refer to the [TimeEntry API reference](reference/Timmi-Timesheet-v3.yaml/components/schemas/TimeEntry) for additional information on the TimeEntry object, and any validation error that you might encounter when using this API.

There are different ways to update TimeEntries. Please see [this guide](../docs/Use-cases/Timmi%20Timesheet/Update-time-entries.md) on how to update TimeEntries the right way depending on your use case.

Delete a TimeEntry by id

## Before using this service

This service is aimed at updating a given user TimeEntries easily, as it automatically detects and applies changes needed to transform whatever TimeEntries might currently exist to what you send it. It create, edit, or delete TimeEntries. **An algorithm tries to match and update any existing TimeEntries, but it might wipe clean TimeEntries before adding new ones.**

There are different ways to update TimeEntries. Please see [this guide](../docs/Use-cases/Timmi%20Timesheet/Update-time-entries.md) for a guide on how to update TimeEntries the right way depending on your use case.

## How to use

It will create, edit, or delete existing TimeEntries for a given period and owner to match the TimeEntries of the request body.

The request body is an array of 'simplified' TimeEntries, [please see the API reference for a TimeEntry model for additional information and main validation rules](reference/Timmi-Timesheet-v3.yaml/components/schemas/TimeEntry).

Here the TimeEntry `id` field is optional as the matching algorithm does not take it into account.

TimeEntries update service

The timesheet resource

List all timesheets satisfying query filters.

Please refer to the [Timesheet API reference](reference/Timmi-Timesheet-v3.yaml/components/schemas/Timesheet) for additional information on the Timesheet resource.

List timesheets

List timesheets that are not yet submitted (status: 0). 

You must filter on either `ownerIds`, `managerIds` or `legalEntityIds`.
As long as a timesheet is not submitted, its unique identifier is equal to zero.

Please refer to the [Timesheet API reference](reference/Timmi-Timesheet-v3.yaml/components/schemas/Timesheet) for additional information on the Timesheet resource.

List due timesheets

Remind users of a due timesheet. Sends him/her an email.

Introduction

Files

Organization Structure API

Core HR API

Cleemy Expenses API

Timmi Absences API

Timmi Office API

Timmi Project API

Timmi Settings API

Timmi Timesheet API

Pagga Mealvouchers API

Pagga Remuneration API

Poplee Training API

List variable items

Query Parameters

Response