Reporting sociétés
boond_reporting_companiesRead-onlyIdempotent
Generate company reports on revenue, margin, and activity for a specified date range. Filter by managers, agencies, periods, company states, and more.
Instructions
Reporting des sociétés (CA, marge, activité...).
⚠️ startDate + endDate (YYYY-MM-DD) sont REQUIS par l'API.
Filtres clés : périmètre (perimeterDynamic/perimeterManagers/perimeterAgencies...), période (period, periodDynamic), companiesStates, companies, maxCompanies, showPercentage. Les états/types sont des IDs entiers issus de boond_application_dictionary. Sans filtre de périmètre, le reporting porte sur tout le périmètre autorisé.
Returns: Données de reporting.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Numéro de page (défaut: 1, max: 100) | |
| endDate | Yes | Date de fin (YYYY-MM-DD). Requis par l'API. | |
| keywords | No | Mots-clés. | |
| pageSize | No | Nombre de résultats par page (max: 500, défaut: 30) | |
| 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. | |
| startDate | Yes | Date de début (YYYY-MM-DD). Requis par l'API. | |
| scorecards | No | IDs des scorecards (indicateurs) à retourner. | |
| maxCompanies | No | Nombre de sociétés par page (1-10, défaut 1). Le nombre de résultats = sociétés × indicateurs. | |
| 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. | |
| perimeterPoles | No | IDs de pôles. Conserve les entités dont le responsable appartient à ces pôles. | |
| showPercentage | No | Afficher les valeurs en pourcentage plutôt qu'en valeur réelle. | |
| companiesStates | No | IDs d'états de sociétés (dictionnaire setting.state.company). | |
| 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. | |
| 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. | |
| perimeterBusinessUnits | No | IDs de business units. Conserve les entités dont le responsable appartient à ces BU. | |
| periodDynamicParameters | No | Paramètres de la période personnalisée (utilisé avec periodDynamic=lastCustomPeriod/nextCustomPeriod). |