Export Excel

Génération de fichiers Excel contenant les données d'activité des salariés

API REST - Validation de l'export

Avant le téléchargement des fichiers d'activités, nous vous recommandons de valider les paramètres de l'export afin prévisualiser combien de fichier seront générés et comment les données seront réparties entre les fichiers. Pour la génération de ces fichiers, certaines règles s'appliquent en fonctions de la période et du nombre de salariés sélectionnés.

POST /companies/validate_export_params
Content-Type: application/json

{
  "company_ids": [1],
  "user_ids": [100],
  "min_date": "2021-12-16",
  "max_date": "2022-02-14",
  "one_file_by_employee": false,
  "detailed": false,
}

Règles de génération de fichiers (stratégies)

Stratégie	Règle
OVER_365_DAYS	Période de date ≥ 1 an Génération : 1 fichier par année ET par salarié fichiers : <nom_prenom>_YYYY ou <nom_prenom>_YYYY_YYYY Tri : Alphabétique par nom de famille, puis chronologique Paramètre one_file_by_employee : ❌ Ignoré (toujours 1 fichier par salarié)
OVER_31_DAYS	Période > 31 jours (mais < 365 jours) Génération : Si ≤ 100 salariés : 1 fichier par mois Si > 100 salariés 1 fichier par mois ET par tranche de 100 salariés fichiers : YYYY-MM__YYYY (ex : 2024-03_mars_2024) Tri : Chronologique (grâce au préfixe YYYY-MM) Paramètre one_file_by_employee : ❌ Ignoré
OVER_100_USERS	> 100 salariés (et période ≤ 31 jours) Génération : 1 fichier par tranche de 100 salariés Fichiers : batch_1, batch_2, etc. Tri : Alphabétique par nom de famille Paramètre one_file_by_employee : ❌ Ignoré
SINGLE_OR_CONSOLIDATED	≤ 100 salariés ET période ≤ 31 jours Génération : one_file_by_employee = true -> 1 fichier par salarié Si one_file_by_employee = false (défaut) -> 1 fichier consolidé, le paramètre one_file_by_employee est Pris en compte

Authentification

Afin de pouvoir utiliser cette API, vous devez être authentifié : Authentification.

Requête

Champ	Description	Format	Obligatoire
company_ids	Entreprises pour lesquelles on souhaite exporter les données	Liste d'identifiants d'entreprises	Oui
user_ids	Salariés pour lesquels on souhaite filtrer les données. Par défaut, on remonte les données pour tous les salariés	Liste d'identifiants de salariés	Non (par défaut: [])
min_date	Date de début de la période souhaitée	Date au format "YYYY-MM-dd"	Non
max_date	Date de fin de la période souhaitée	Date au format "YYYY-MM-dd"	Non
one_file_by_employee	Permet de spécifier si le fichier doit être unique pour chaque salarié ou en un seul fichier pour tous les salariés	Booléen	Non (par défaut: false)
detailed	Retourne le détail de chaque fichiers (chunks)	Booléen	Non (défaut : false)

Réponse

{
  "strategy": "string",
  "message": "string",
  "can_choose_consolidated": boolean,
  "num_chunks": integer,
  "chunks": [ ... ]  // Optionnel si detailed=true
}

Champs de la réponse

Champ	Type	Requis	Description
strategy	string	Oui	Identifiant de la stratégie de chunking appliquée. Valeurs possibles : over_365_days, over_31_days, over_100_users, single_or_consolidated
message	string	Oui	Message explicatif en français décrivant la stratégie appliquée et le nombre de fichiers attendus. À afficher directement à l'utilisateur.
can_choose_consolidated	boolean	Oui	Indique si le paramètre one_file_by_employee peut influencer le résultat. true uniquement pour la stratégie single_or_consolidated, false dans tous les autres cas.
num_chunks	integer	Oui	Nombre total de fichiers Excel qui seront générés lors de l'export.
chunks	array	Non	Tableau contenant le détail de chaque chunk (fichier). Présent uniquement si le paramètre detailed=true est envoyé dans la requête.

Structure des objets dans chunks (si detailed=true)

Champ	Type	Description
user_ids	array[integer]	Liste des identifiants des salariés inclus dans ce fichier.
min_date	string (ISO 8601)	Date de début de la période couverte par ce fichier (format YYYY-MM-DD).
max_date	string (ISO 8601)	Date de fin de la période couverte par ce fichier (format YYYY-MM-DD).
file_suffix	string	Suffixe du nom de fichier qui sera généré (ex: 2026-01_janvier_2026, Martin_Jean_2024, batch_1).

API REST - Téléchargement de l'export

Pour exporter les données d'activité des salariés d'une entreprise au format ZIP contenant plusieurs fichiers excel, utiliser l'API REST suivante :

POST /companies/download_activity_report
Content-Type: application/json

{
  "company_ids": [1],
  "user_ids": [100],
  "min_date": "2021-12-16",
  "max_date": "2022-02-14",
  "one_file_by_employee": false
}

Authentification

Afin de pouvoir utiliser cette API, vous devez être authentifié : Authentification.

Requête

Champ	Description	Format	Obligatoire
company_ids	Entreprises pour lesquelles on souhaite exporter les données	Liste d'identifiants d'entreprises	Oui
user_ids	Salariés pour lesquels on souhaite filtrer les données. Par défaut, on remonte les données pour tous les salariés	Liste d'identifiants de salariés	Non (par défaut: [])
min_date	Date de début de la période souhaitée	Date au format "YYYY-MM-dd"	Non
max_date	Date de fin de la période souhaitée	Date au format "YYYY-MM-dd"	Non
one_file_by_employee	Permet de spécifier si le fichier doit être unique pour chaque salarié ou en un seul fichier pour tous les salariés	Booléen	Non (par défaut: false)

Réponse

En cas de succès, l'API retourne un fichier ZIP :

HTTP/1.1 200 OK
Content-Disposition: attachment; filename=fichiers_Excel.zip
Content-Type: application/zip
Content-Length: ...

Cas d'erreurs

Description	HTTP Status
Pas de token d'authentification	401 Unauthorized
Le token d'authentification ne correspond pas à une des entreprises renseignées	403 Forbidden
La requête est mal formée (le détail est dans le corps de la réponse)	404 Bad request