Consulter le solde restant d’une proposition

  • Proposals
  • Paiement
  • 1 route
Comment récupérer l’échéancier de paiement d’une proposition et consulter le solde restant ?

Ce scénario explique comment récupérer l'échéancier de paiement associé à une proposition afin d'exposer le solde restant, la structure des échéances et la chronologie de paiement avant confirmation du booking ou encaissement.

Vue d'ensemble

Utilisez GET/v1/proposals/{proposal_id}/payment_schedule pour lire l'échéancier de paiement attaché à une proposition. Cela permet d'afficher les montants dus, les jalons de paiement ou le solde restant dans un contexte de proposition.

Prérequis

  • Le proposal_id doit identifier une proposition existante.
  • accept-language et x-api-key sont requis sur l'appel documenté.
  • Les options de requête complémentaires ne sont pas entièrement visibles dans la matière source disponible.
1

Récupérer l’échéancier de paiement d’une proposition

Obligatoire

Utilisez GET/v1/proposals/{proposal_id}/payment_schedule pour récupérer les échéances de paiement attendues pour une proposition avant sa conversion ou avant d’afficher le solde restant au client.

Prérequis

  • Header x-api-key
  • Path proposal_id

Calling CURL

curl -X GET "https://api.clubmed.com/v1/proposals/123456/payment_schedule" \
  -H "x-api-key: <your-api-key>"

Example answer

{
  "currency": "EUR",
  "commission_included": true,
  "households": [
    {
      "attendees": [
        {
          "id": "A",
          "customer_id": "123456789"
        }
      ],
      "total": 2060,
      "deposit_repayment_schedule": [
        {
          "expected_payment_amount": 1000,
          "deadline": "20100430"
        }
      ]
    }
  ]
}

info: Réutilisez les totaux par foyer, les échéances et les montants attendus pour afficher le calendrier d’acompte et expliquer ce qu’il reste à payer avant confirmation.

Codes de réponse

  • 200 : échéancier retourné avec succès.
  • 400 : requête invalide ou erreur de validation.
  • 403 : accès interdit.
  • 404 : proposition introuvable.
  • 409 : promotion non applicable à la proposition ciblée.
GET/v1/proposals/{proposal_id}/payment_schedule
Voir plus