Reporting synthèse
boond_reporting_synthesisRetrieve aggregated totals (revenue, margin, rates, volumes) across perimeters and periods for commercial, HR, recruitment, and billing reporting. Returns calculated indicators, not record lists.
Instructions
Reporting de synthèse globale (commercial, RH, recrutement, facturation...).
Quand : pour obtenir des agrégats (CA, marge, taux, volumes) sur un périmètre et une période.
Plutôt que : un boond_reporting_* plus ciblé (sociétés, projets, ressources) pour la liste des enregistrements eux-mêmes : ce reporting renvoie des totaux calculés, pas les lignes qui les composent.
Filtres clés : périmètre (perimeterDynamic / perimeterManagers / perimeterAgencies…), période (period, periodDynamic), reportingType, reportingCategory, period, resources/projects/contacts/companies, compareIndicators.
⚠️
startDate+endDate(YYYY-MM-DD) sont REQUIS : l'API répond 422 sans eux.Sans filtre de périmètre, l'agrégation porte sur tout le périmètre autorisé du compte — un total « entreprise » là où l'utilisateur attendait souvent son équipe.
Les états et types sont des ID entiers du dictionnaire (
boond_application_dictionary), pas des libellés.Une agrégation large peut durer plusieurs dizaines de secondes ; l'avancement est signalé via
notifications/progressquand le client fournit unprogressToken.
Returns : tableau d'indicateurs agrégés, rendu en texte. Lecture seule.
Pagination :
pageSize1–500 (défaut 30),page1–100 — au-delà : refus, affiner les filtres.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Numéro de page (défaut: 1, max: 100) | |
| period | No | Découpage temporel : 'onePeriod' (unique, entre startDate/endDate), 'dynamicPeriod' (selon periodDynamic), 'monthly' (6 mois depuis startDate), 'quarterly', 'semiAnnual', 'annual'. La synthèse accepte aussi 'weekly'. | |
| endDate | No | Date de fin (YYYY-MM-DD). | |
| contacts | No | Filtrer sur ces IDs de contacts. | |
| keywords | No | Mots-clés. | |
| pageSize | No | Nombre de résultats par page (max: 500, défaut: 30) | |
| projects | No | Filtrer sur ces IDs de projets. | |
| useCache | No | Cache de reporting : 'withCache' (valeurs mises en cache) ou 'withoutCache' (recalcul, défaut). | |
| companies | No | Filtrer sur ces IDs de sociétés. | |
| resources | No | Filtrer sur ces IDs de ressources. | |
| startDate | Yes | Date de début (YYYY-MM-DD). Requis par l'API. | |
| scorecards | No | IDs des scorecards (indicateurs) à retourner. | |
| periodDynamic | No | Période dynamique relative à aujourd'hui (avec period='dynamicPeriod') : today, thisWeek, thisMonth, thisTrimester, thisSemester, thisYear, thisFiscalYear, yesterday, lastWeek, lastMonth, lastTrimester, lastSemester, lastYear, lastFiscalYear, tomorrow, nextWeek, nextMonth, nextTrimester, nextSemester, nextYear, nextFiscalYear, lastCustomPeriod, nextCustomPeriod. | |
| reportingType | No | Type de données : 'realData' (défaut, réel) ou 'targetsData' (objectifs). | |
| perimeterPoles | No | IDs de pôles. Conserve les entités dont le responsable appartient à ces pôles. | |
| narrowPerimeter | No | Si true, jointure ET entre les filtres `perimeter*` (au lieu de OU par défaut). | |
| perimeterDynamic | No | Périmètre dynamique relatif à l'utilisateur courant (raccourci sans avoir à connaître son propre ID). Valeurs : 'data' (mes propres données), 'managers' (mon équipe / mes N-1), 'agencies' (mes agences), 'poles' (mes pôles), 'businessUnits' (mes BU). Combinable. | |
| compareIndicators | No | Indicateurs à comparer entre deux périodes. | |
| perimeterAgencies | No | IDs d'agences. Conserve les entités dont le responsable appartient à ces agences. | |
| perimeterManagers | No | IDs des managers (ressources). Conserve les entités dont le responsable est l'un de ces managers. Pour 'mon équipe / N-1 d'une personne X', passer [X_id]. Obtenir son propre ID via boond_application_current_user. | |
| reportingCategory | No | Catégorie de synthèse (défaut 'commercialSynthesis') : commercial, RH, recrutement, activité & frais, facturation, ou globale. `resources` n'est pas disponible hors d'une vue par ressources. | |
| perimeterBusinessUnits | No | IDs de business units. Conserve les entités dont le responsable appartient à ces BU. | |
| compareIndicatorsPeriod | No | Période de comparaison des indicateurs (défaut 'period'). | |
| periodDynamicParameters | No | Paramètres de la période personnalisée (utilisé avec periodDynamic=lastCustomPeriod/nextCustomPeriod). |