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:
trueorfalse. 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.
Headers
API key. Value must be formatted like so: lucca application={api_key}.
Multipart boundary MUST be set in the Content-Type header.
Query Parameters
Use false to simulate the import.
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.
Filename
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.
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).
Body
Content of the CSV file to import. Each file in its dedicated part of the multipart request. Parts are divided by the 'boundary' string set in the Content-Type HTTP header.
Example of a single file request body:
--myBoundary
Content-Disposition: form-data; name="figgo-import-5875e9dd-0b1f-4a9f-8756-0f25fb0a2946.csv"; filename="figgo-import-5875e9dd-0b1f-4a9f-8756-0f25fb0a2946.csv"
Content-Type: application/vnd.ms-excel
legalEntity;employeeNumber;lastName;firstName;accountId;startDate;flagStartDate;endDate;flagEndDate;isApproved
Lucca FR;M0029;Bart;Maurice;1322;16/08/2022;am;17/08/2022;pm;true
Lucca FR;M0029;Bart;Maurice;1322;22/08/2022;am;23/08/2022;pm;false
Lucca FR;M0029;Bart;Maurice;8;29/08/2022;am;30/08/2022;pm;true
--myBoundary--The body is of type object.
Response
OK
The response is of type object.