Rent Receipts

Répartition des quittances par origine

Compte les quittances de l'organisation selon la façon dont le loyer a été confirmé. Sert à mesurer l'adoption de la boucle automatique.

Lire part_automatique

C'est la part de OWNER_LINK parmi les quittances tracées, pas parmi le total. Les quittances antérieures au suivi d'origine comptent dans total mais sont exclues du dénominateur : les y laisser écraserait mécaniquement le ratio vers le bas les premiers mois.

La valeur est null quand aucune quittance n'est tracée: null dit « on ne sait pas », là où 0 dirait « personne n'utilise l'automatique », ce qui serait faux.

Requiert la permission reports:read.

get/receipts/origin-summary

Request

  • Base URL: https://api.faireplace.com/api
  • URL: https://api.faireplace.com/api/receipts/origin-summary
  • Auth: HTTP bearer

Query parameters

period_startstring date

Ne compter que les quittances dont la période commence à partir de cette date.

period_endstring date

Ne compter que les quittances dont la période finit avant cette date.

Response

OK

period_startstring date nullable required
period_endstring date nullable required
totalinteger required

Toutes les quittances de la période, tracées ou non.

traceesinteger required

Celles dont l'origine est connue: le dénominateur de part_automatique.

part_automatiquenumber float nullable required

OWNER_LINK / tracees, arrondi au millième. null si tracees vaut 0.

Changes

No recorded changes to this operation across all 1 revision of this API.