Imports

Import leaves

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

post/timmi-absences/api/imports/v1.0/leavePeriods

Request

Query parameters

createboolean

Use false to simulate the import.

recreditboolean

Use true if absences should not be deducted from the user balance. Use false if absences should be deducted from the user balance. Note: if the absence type doesn’t have balance management, absence won’t impact the balance in any case.

originalFileNamestring

Filename

synchronizeboolean

Use true to force synchronization of the absences in the sync webservice (sync to Exchange/0365, Google Calendar, Webhook or ADP GXP, depending on configuration). Use false to import absences without synchronizing absences.

asyncboolean

Use true if you want to import absences with the asynchronous processing (you have to request figgo/api/imports/v1.0/leavePeriods/{summaryId}/progress API to track the status). Use false if you want import absences with the synchronous processing (the response is sent when the file is fully imported).

overrideLeavesboolean

Use true to override (i.e. replace) existing absences that overlap with the imported ones, instead of letting the import fail on the conflicting rows. Use false (default) to leave existing absences untouched.

⚠️ This option only takes effect if the corresponding feature has been enabled on your environment (opt-in). If you would like to use it, please contact our support beforehand.

Headers

Content-Typestring required

Multipart boundary MUST be set in the Content-Type header.

Request body multipart/form-data

filesstring[]

Changes

No recorded changes to this operation across all 1 revision of this API.