Récupérer la commission d'une proposition

  • Proposals
  • Réservation
  • 1 route
Comment récupérer la commission vendeur associée à une proposition ?

Ce scénario explique comment récupérer le montant de commission associé à une proposition avant la finalisation du booking. Il permet d'exposer la marge commerciale liée à l'état courant de la proposition.

La réponse est volontairement concise et renvoie le total de commission avec sa devise, ce qui facilite son intégration dans un tableau de bord vendeur ou un écran de revue de proposition.

Vue d'ensemble

Utilisez ce scénario lorsque vous devez afficher ou vérifier la commission associée à une proposition existante. Cette route est utile dans les contextes vendeur où la rentabilité d'une proposition doit être contrôlée avant l'action commerciale suivante.

Le scénario couvre une lecture simple et ne modifie pas la proposition.

Prérequis

  • Disposer d'un x-api-key valide.
  • Disposer d'un bearer token valide.
  • Connaître le proposal_id obtenu via un parcours de création ou de consultation de proposition.

Notes fonctionnelles

  • Ce scénario récupère la commission attachée à l'état courant de la proposition.
  • La réponse peut être utilisée telle quelle dans une synthèse commerciale car elle renvoie total et currency.
  • Si la proposition n'existe plus ou n'est pas visible dans le contexte courant, la route renvoie une erreur de type not found ou forbidden.
1

Récupérer la commission de la proposition

Obligatoire

Cette route retourne la commission vendeur calculée pour la proposition ciblée.

Prérequis

Munissez-vous de l'identifiant de proposition et d'un jeton d'autorisation valide. Vous pouvez ajouter filter si votre implémentation exploite des vues filtrées.

Calling CURL

curl -X GET \
  -H "x-api-key: $API_KEY" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  "https://api.clubmed.com/v0/proposals/{proposal_id}/sales_commission?filter[status][_eq]=ACTIVE"

Example answer

{
  "total": 846,
  "currency": "EUR"
}

info: Le montant retourné est utile pour un affichage back-office ou un contrôle avant validation commerciale.

Codes de réponse

  • 200 OK : la commission est renvoyée.
  • 400 Bad Request : paramètres invalides.
  • 401 Unauthorized : jeton manquant ou invalide.
  • 403 Forbidden : accès refusé.
  • 404 Not Found : proposition introuvable.
GET/v0/proposals/{proposal_id}/sales_commission
Voir plus