Analytics

La section Analytics permet de récupérer des données statistiques à l’échelle d'un réseau (niveau organisation).

Contrairement aux autres endpoints de l’API, qui sont accessibles au niveau d’un point de vente, les endpoints Analytics sont accessibles uniquement au niveau de l’organisation et permettent de récupérer des données consolidées sur l’ensemble des points de vente rattachés à celle-ci.

L’accès aux endpoints Analytics se fait via un token unique, associé à une organisation.
Un token donne accès uniquement aux données du périmètre de l’organisation authentifiée.

ENDPOINTS

• GET /organizations/analytics/sales Récupérer la liste des ventes pour une organisation, en paramètres :
  • token (string) * : Identifiant unique de l'organisation.
  • start_date (string) : Date de début de la période de recherche (format YYYY-MM-DD).
  • end_date (string) : Date de fin de la période de recherche (format YYYY-MM-DD).
  • external_ids (array[string]) : Liste des identifiants externes des points de vente.
  • page (int) : Numéro de la page à récupérer (pagination). Valeur par défaut : 1
  • per_page (int) : Nombre de ressources retournées par page. Valeur par défaut : 25
• GET /organizations/analytics/commissions Récupérer la liste des commissions pour une organisation, en paramètres :
  • token (string) * : Identifiant unique de l'organisation.
  • start_date (string) : Date de début de la période de recherche (format YYYY-MM-DD).
  • end_date (string) : Date de fin de la période de recherche (format YYYY-MM-DD).
  • external_ids (array[string]) : Liste des identifiants externes des points de vente.
  • page (int) : Numéro de la page à récupérer (pagination). Valeur par défaut : 1
  • per_page (int) : Nombre de ressources retournées par page. Valeur par défaut : 25

L’objet Sales

L’objet Sales représente une vente réalisée par un point de vente.
Il contient les informations liées au contrat, au point de vente, au vendeur et aux montants financiers associés à la vente.

Attributs

• id (string) : Identifiant unique de la vente / du contrat d’assurance.
• status (string) : Statut actuel du contrat d’assurance.
• cancellation_date (string | null) : Date de résiliation du contrat, si celui-ci a été annulé, null si le contrat est toujours actif.
• monthly (boolean) : Indique si le contrat est facturé mensuellement (true) ou en one-shot (false).
• date (string) : Date de souscription / de vente du contrat (format ISO YYYY-MM-DD).
• store (string) Nom du point de vente ayant réalisé la vente.
• store_id (integer) : Identifiant estaly du store.
• store_external_id (string) Identifiant externe du store, utilisé pour les rapprochements ERP ou systèmes tiers.
• product_reference_id (string) Référence du produit assuré (SKU, référence fabricant ou identifiant produit marchand).
• category (string) Catégorie / formule d'assurance vendue.
• price (float) : Prix du contrat d’assurance pour le client, exprimé dans la devise du store.
• seller (string) : Nom du vendeur ayant réalisé la vente.
• front_eur (float | null) Montant de commission FRONT, exprimé en euros.
  • Dans le cas d’une vente mensuelle : Correspond au montant de commission avancée en année 1, versé en one-shot, uniquement si une avance de commission est configurée. Si null, cela signifie qu’aucune avance de commission n’est appliquée sur le contrat.
  • Dans le cas d’une vente annuelle : Correspond au montant total de la commission générée par la vente, versée en une seule fois.
• air_eur (float | null) Montant de commission AIR, exprimé en euros.
  • Dans le cas d’une vente mensuelle : Correspond au montant de commission mensuelle. Si front_eur est non nul (avance de commission appliquée), la commission air_eur est versée à partir de l’année 2, chaque mois. Si front_eur est null, la commission air_eur est versée dès l’année 1 chaque mois.
  • Dans le cas d’une vente annuelle: Toujours null (aucune commission récurrente mensuelle).

L’objet Commissions

L’objet Commissions représente une commission pour un point de vente liée à un encaissement d'un contrat.
Il contient les informations liées au contrat, au point de vente et aux montants financiers associés.

Attributs

• id (string) : Identifiant unique de la commission.
• date (string) : Date de l'encaissement.
• store (string) Nom du point de vente ayant réalisé la vente.
• store_id (integer) : Identifiant estaly du store.
• store_external_id (string) Identifiant externe du store, utilisé pour les rapprochements ERP ou systèmes tiers.
• amount (float) : Montant de la commission reversée au point de vente, exprimé en euros.
• price (float) : Montant de l'encaissement, exprimé en euros.
• plan_sale_id (string) : Identifiant unique de la vente / du contrat d'assurance.
• monthly (boolean) : Indique si le contrat est facturé mensuellement (true) ou en one-shot (false).
• billing_type (enum) : Encaissement ou remboursement
  • Valeurs possibles : "collected" | "refunded"
• type (enum) : Type de commission.
  • Valeurs possibles : "front" | "air"
  • front correspond à une commission FRONT, versée en une seule fois.
    • Dans le cas d’un contrat mensuel :
      Correspond à une avance de commission versée en année 1, payée en une seule fois lors de l’encaissement initial, uniquement si une avance de commission est configurée pour le contrat.
    • Dans le cas d’un contrat annuel :
      Correspond à la commission totale générée par la vente, versée en une seule fois lors de l’encaissement.
  • air correspond à une commission AIR, c’est-à-dire une commission récurrente liée aux encaissements mensuels du contrat.
    • Dans le cas d’un contrat mensuel : Correspond à la commission versée chaque mois lors de l’encaissement de la prime mensuelle. Les commissions AIR sont versées à partir de l’année 2.
    • Dans le cas d’un contrat annuel : Toujours absent, car aucune commission récurrente n’existe pour les contrats annuels.