get_kpis
Indicateurs commerciaux
Rôle#
CA signé HT du cycle (défaut : cycle actif) avec le nombre de devis signés qui le portent (signedRevenue.quotes) et le cycle précédent, et pipeline HT brut et pondéré par statut, toutes saisons confondues (devis ouverts), filtrables par entité et par commercial (ownerId). Le pont entre cycles et la rétention figurent dans revenueBridge avec quotes:read et companies:read ; sinon revenueBridge vaut null et revenueBridgeUnavailable explique les lectures manquantes.
Accès#
Scope principal : referentials:read. Le scope ne remplace pas les gardes de visibilité, d'organisation, de module ni les scopes complémentaires des gestes composés.
Catalogue complet · Approbations
Paramètres#
Le schéma ci-dessous est produit par la fonction qui enregistre les outils, y compris idempotency_key lorsqu'elle s'applique. Consultez les objets imbriqués dans le schéma complet.
| Champ | Type | Obligatoire | Description |
|---|---|---|---|
cycleId | string | Non | |
businessUnitId | string | Non | |
ownerId | string | Non | Restreint au commercial (ownerId des devis) : « mon pipeline », « les chiffres de Jim » |
Schéma JSON complet des paramètres
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"cycleId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"businessUnitId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"ownerId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Restreint au commercial (ownerId des devis) : « mon pipeline », « les chiffres de Jim »"
}
},
"additionalProperties": false
}