fonciqAPI
Facturation

Lire les documents du journal estimé

Portée `billing:read`. Même périmètre que `GET /v1/billing` : les frais du Registre, par période et par document. Pas les frais de plateforme de Fonciq. Aucun relevé du portail n'est lu. `source` vaut `estimate`. Chaque ligne porte `rf_account_id`, la date (`at`), le type (`document_type`), le lot, l'inscription s'il y en a une, le montant en cents (`amount_cents`) et `rf_reference` (nul). `reconciliation` vaut `log_only`. La même valeur de compte est répétée dans `account_id`. `mismatches` est vide. Il n'y a pas de champ `estimate`. Sur cette estimation, lorsqu'un acte est récupéré, `amount_cents` vaut 150, les frais du Registre (1,50 $). Un acte conservé n'a pas de frais du Registre. Ce n'est pas un montant lu sur un écran du portail.

GET
/v1/billing/usage
AuthorizationBearer <token>

Clé d'API de l'organisation. Le secret n'est montré qu'une fois. Le préfixe affichable d'une clé d'essai est fq_test_. Le hachage SHA-256 est la seule forme conservée. Le panneau d'essai de cette documentation n'envoie qu'une clé fq_test_ et n'effectue aucun débit.

Dans : en-tête

Paramètres de requête

rf_account_id?string

Limite la réponse à un compte. Omis, tous les comptes de l'organisation sont renvoyés. account_id est accepté comme alias du même paramètre.

Corps de la réponse

application/json

application/json

application/json

application/json

curl -X GET "https://api.fonciq.ca/v1/billing/usage"
{
  "period": {
    "start": "2026-10-01T04:00:00.000Z",
    "end": "2026-11-01T04:00:00.000Z",
    "timezone": "America/Toronto"
  },
  "currency": "CAD",
  "source": "estimate",
  "source_note": "Aucun relevé du portail n’est lu. Les lignes reprennent le journal fonciq des tirages sur ce compte et sont une estimation. Le relevé du Registre foncier fait foi.",
  "transactions": [
    {
      "id": "rftx_exemple",
      "rf_account_id": "rfa_exemple",
      "account_id": "rfa_exemple",
      "at": "2026-10-24T15:04:00.000Z",
      "document_type": "acte",
      "lot": "1234567",
      "inscription": "21 014 436",
      "amount_cents": 150,
      "rf_reference": null,
      "source": "estimate",
      "reconciliation": "log_only",
      "fonciq_request_id": "req_exemple",
      "fonciq_job_id": "job_exemple"
    }
  ],
  "mismatches": [],
  "next_cursor": null
}
{
  "error": {
    "code": "unauthorized",
    "message": "Clé d'API refusée.",
    "request_id": "req_01HZX"
  }
}
{
  "error": {
    "code": "account_not_found",
    "message": "Ce compte du Registre n'appartient pas à l'organisation.",
    "request_id": "req_01HZX"
  }
}
{
  "error": {
    "code": "rate_limited",
    "message": "Trop de requêtes pour cette clé.",
    "request_id": "req_01HZX"
  }
}