---
title: "Répartition des quittances par origine"
method: GET
path: "/receipts/origin-summary"
tags: ["Rent Receipts"]
---

# Répartition des quittances par origine

`GET /receipts/origin-summary`

## Request

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

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`.

## Query parameters

- `period_start` string, date
- `period_end` string, date

## Response `200`

OK

- object
  - `period_start` string, date, nullable, required
  - `period_end` string, date, nullable, required
  - `total` integer, required: Toutes les quittances de la période, tracées ou non.
  - `tracees` integer, required: Celles dont l'origine est connue: le dénominateur de `part_automatique`.
  - `by_origin` object, required: Les quatre clés sont toujours présentes, à zéro si aucune quittance ne les porte.
    - `OWNER_LINK` integer, required: Confirmée en un clic depuis le mail de relance.
    - `APP_CONFIRM` integer, required: Confirmée depuis l'application (`POST /leases/{lease_id}/rent-confirm`).
    - `APP_MANUAL` integer, required: Quittance produite à la main.
    - `UNKNOWN` integer, required: Antérieure au suivi d'origine. Comptée dans `total`, exclue de `tracees`.
  - `part_automatique` number, float, nullable, required: `OWNER_LINK / tracees`, arrondi au millième. `null` si `tracees` vaut 0.

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `429`: Rate limit exceeded. Every endpoint sits behind a plan-aware limiter, and the public tools carry an additional per-endpoint one. `error.details.retry_after_seconds` says how long to wait; the `Retry-After`, `X-RateLimit-Limit` and `X-RateLimit-Remaining` headers carry the same information.
- `500`: Internal Server Error

---

[API](https://skmtc.dev/faireplace/apis/faireplace-property-management-api.md) · [All operations](https://skmtc.dev/faireplace/apis/faireplace-property-management-api/llms.txt) · [OpenAPI document](https://skmtc.dev/faireplace/apis/faireplace-property-management-api/revisions/69de39762919?raw)