API — Endpoint rentals/summary

Portée requise : rentals:read (flux « Application OAuth ») ou rental:read (flux partenaire).

Renvoie, pour chaque projet en location accessible à votre jeton, un résumé financier par année :

• attendu : loyers + charges + frais attendus sur l'année, tous types de location confondus ;
• depenses : dépenses enregistrées sur l'année (global) ;
• encaisse : montants réellement encaissés sur l'année, tous types confondus ;
• benefices : encaisse - depenses ;
• taux_occupation : moyenne des taux d'occupation mensuels de l'année ;
• taux_recouvrement : encaisse / attendu * 100 ;
• par_mois : le détail mois par mois (clé YYYY-MM) de attendu, encaisse, depenses et taux_occupation ;
• benefices_par_type : le même détail (attendu, encaisse, depenses_allouees, benefices, taux_recouvrement) séparément pour long_terme et court_terme (location saisonnière). Les dépenses n'étant pas rattachées à un type précis dans les données, elles sont réparties au prorata de l'encaissé de chaque type.

curl https://construction.my-smartlife.fr/api/rentals/summary \
  -H 'Authorization: Bearer VOTRE_ACCESS_TOKEN'

Exemple de réponse :

{
  "rentals": [
    {
      "id": "12",
      "name": "Résidence Les Palmiers",
      "currency": "XOF",
      "resume": {
        "2025": {
          "attendu": 4860000.0,
          "depenses": 40000.0,
          "encaisse": 405000.0,
          "benefices": 365000.0,
          "taux_occupation": 100.0,
          "taux_recouvrement": 8.33,
          "par_mois": {
            "2025-01": { "attendu": 405000.0, "encaisse": 405000.0, "depenses": 40000.0, "taux_occupation": 100.0 }
          },
          "benefices_par_type": {
            "long_terme": { "attendu": 1260000.0, "encaisse": 105000.0, "depenses_allouees": 10370.37, "benefices": 94629.63, "taux_recouvrement": 8.33 },
            "court_terme": { "attendu": 3600000.0, "encaisse": 300000.0, "depenses_allouees": 29629.63, "benefices": 270370.37, "taux_recouvrement": 8.33 }
          }
        }
      }
    }
  ]
}