Introduction

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

Timmi Absences API

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

Time-entries
Timesheets
Reports
Guides

Pagga Mealvouchers API

Statutory
Computation

Pagga Remuneration API

Fixed-natures
Fixed-items
Variable-natures
Variable-items

Poplee Training API

Training-demands
Realized-trainings

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

POST

timmi-absences

api

imports

v1.0

leavePeriods

curl --request POST \
  --url https://{account}-{sandboxName}.sandbox.{server}.luccasoftware.com/timmi-absences/api/imports/v1.0/leavePeriods \
  --header 'Content-Type: multipart/form-data' \
  --form 'files=[
  "<string>"
]'

{
  "summaryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "hasError": true
}

Headers

Content-Type

string

required

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

Query Parameters

create

boolean

Use false to simulate the import.

recredit

boolean

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.

originalFileName

string

default:

import.csv

Filename

synchronize

boolean

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.

async

boolean

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

multipart/form-data

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-- ```

files

string[]

Response

200

application/json

summaryId

string

hasError

boolean

Was this page helpful?

Replace entitlements Get import leaves progress

curl --request POST \
  --url https://{account}-{sandboxName}.sandbox.{server}.luccasoftware.com/timmi-absences/api/imports/v1.0/leavePeriods \
  --header 'Content-Type: multipart/form-data' \
  --form 'files=[
  "<string>"
]'

{
  "summaryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "hasError": true
}