Catalogue des états

Les 24 états prédéfinis, par famille, avec leur code, leur source, leur date de référence et leur règle de calcul.

Lire le catalogue

curl -s "$API/provider/reports/catalog?search=production&favorites=false" -H "Authorization: Bearer $TOKEN"

Paramètre	Description
`search`	Filtre texte sur le titre et la description
`format`	Ne garder que les états disponibles dans ce format (`PDF`, `CSV`, `XLSX`)
`favorites`	`true` : uniquement vos favoris

Chaque carte expose code, title, description, formats, popular, favorite, sourceCode, version. Le détail d'une carte, GET /provider/reports/catalog/{code}, ajoute methodologyNote (la règle de calcul) et defaultSpec, la spécification appliquée par défaut : c'est le meilleur point de départ pour un état personnalisé.

Favoris : POST / DELETE /provider/reports/catalog/{code}/favorite (réponse 204).

Comment lire les tableaux ci-dessous

Source : la table interrogée (voir Sources et champs).
Basé sur : l'ancre de date par défaut, celle que scope.relativeRange ou scope.dateRange borne. Vous pouvez en choisir une autre avec scope.basedOn.
Période par défaut : CURRENT_MONTH sauf mention contraire.
Mode : détail (une ligne par enregistrement), récapitulatif (une ligne par groupe, avec Nombre et les totaux), détail groupé (lignes de détail avec ruptures et sous-totaux).

Production

Code	Titre	Source	Basé sur	Filtre par défaut	Règle
`LISTE_CONTRATS` ★	Liste des contrats	`CONTRACTS`	`effectiveDate`	`status IN (ACTIVE, DRAFT)`	Montants lus sur les avenants émis, jamais sur l'en-tête du contrat ; projets et brouillons inclus s'ils ont été créés dans la période.
`AVENANTS`	Avenants	`ENDORSEMENTS`	`issuedAt`	`status = ISSUED`	Une ligne par avenant, affaire nouvelle incluse (n° d'ordre 0). Filtrer `typeCode` pour isoler un type.
`PROJETS_CONTRATS`	Projets de contrats	`CONTRACTS`	`createdDate`	`status IN (DRAFT, PENDING_VALIDATION)`	Explicitement hors chiffres de production. CSV et XLSX seulement.
`ATTESTATIONS_EDITEES`	Attestations éditées	`CERTIFICATES`	`issuedDate`	—	Les annulations sont rattachées à leur avenant justificatif.

Récapitulatifs Pool

Ce sont les éditions historiques du Pool. Toutes sont basées sur la date d'émission (issuedAt) des quittances, sauf mention contraire.

Code	Titre	Source	Mode	Regroupement	Colonnes
`RECAP_PROD_COMPAGNIE` ★	Récapitulatif de la production / Compagnie	`RECEIPTS`	récapitulatif	`companyLabel`	nombre, prime nette, accessoires, part apériteur, part coassurance, C.A., taxe unique, FGA, CEDEAO, prime totale, commission, frais d'apérition, frais de gestion Pool, part Cnie
`RECAP_PROD_SOUS_CATEGORIE` ★	Récapitulatif de la production / Sous-catégorie	`RECEIPTS`	récapitulatif	`seatCategory`	prime nette, accessoires, part coassurance, C.A., TVA, prime totale, commission, frais de gestion, part Cnie. Tranches : Taxi 0-4, 5-8, Minicar 9-22, Car 23-40, +40 places (en flotte : premier véhicule)
`PRODUCTION_DETAIL_SOUS_CATEGORIE`	Production détaillée / Sous-catégorie	`RECEIPTS`	détail groupé	`seatCategory`	n° quittance, souscripteur, places, prime nette, accessoires, part coassurance, C.A., TVA, prime totale, commission, frais de gestion, part Cnie ; tri `issuedAt ASC`
`RECAP_PROD_DUREE`	Récapitulatif de la production / Durée	`RECEIPTS`	récapitulatif	`durationLabel`	idem sous-catégorie
`RECAP_PROD_INTERMEDIAIRE`	Récapitulatif de la production / Intermédiaire	`RECEIPTS`	récapitulatif	`brokerName`, `companyLabel`	idem sous-catégorie
`RECAP_PROD_PRODUCTEUR`	Récapitulatif de la production / Producteur	`RECEIPTS`	récapitulatif	`producteurName`	prime nette, accessoires, prime totale, commission
`PRODUCTION_EMISSIONS`	État de la production [Émissions]	`RECEIPTS`	détail groupé	`companyLabel`	police, n° d'ordre, souscripteur, date d'effet, échéance, date d'émission, prime nette, accessoires, TVA, prime totale, commission, n° attestation, CEDEAO, état quittance ; tri `issuedAt ASC`
`ANNULATIONS_EMISSION`	État des annulations / Émission	`ENDORSEMENTS`	détail groupé	`companyLabel`	référence, n° d'ordre, type, proposition, souscripteur, delta de prime, prime totale, date d'annulation. Basé sur `cancelledAt`, filtre `status = CANCELLED`
`BORDEREAU_CESSION`	Bordereau de cession de primes	`COINSURANCE`	détail groupé	`companyLabel`	proposition, n° d'ordre, effet, échéance, souscripteur, prime TTC, prime nette, part apériteur de l'acte, part compagnie, frais d'apérition, commission, frais de gestion, net dû. À générer en `PER_COMPANY` pour un bordereau par compagnie
`RECAP_ENCAISSEMENTS_COMPAGNIE`	Récapitulatif des encaissements / Compagnie	`COLLECTIONS`	récapitulatif	`companyLabel`	montant encaissé, prime TTC. Basé sur `confirmedDate` (date d'encaissement)
`TAXES_FONDS_MENSUEL`	État mensuel des taxes et fonds	`RECEIPTS`	récapitulatif	`emissionMonth`	TVA, FGA, CEDEAO, total taxes. Période par défaut : `CURRENT_YEAR`

Formules du récapitulatif par compagnie : C.A. = prime nette + accessoires − part coassurance ; Part Cnie = prime totale − part coassurance. Les parts et frais sont lus sur la répartition réelle (premium_allocation), pas recalculés.

Renouvellements

Code	Titre	Source	Basé sur	Filtre par défaut	Règle
`CONTRATS_A_RENOUVELER`	Contrats à renouveler	`CONTRACTS`	`expiryDate`	`status = ACTIVE`	Échéances de la période, tri `expiryDate ASC`.
`CONTRATS_RENOUVELES`	Contrats renouvelés	`ENDORSEMENTS`	`issuedAt`	`status = ISSUED`, `typeCode = RENOUVELLEMENT`	Avenants de renouvellement émis.
`RESILIATIONS_EXPIRATIONS`	Résiliations & expirations	`CONTRACTS`	`expiryDate`	`status IN (TERMINATED, EXPIRED, CANCELLED, SUSPENDED)`	Contrats sortis du portefeuille.

Encaissements & quittances

Code	Titre	Source	Basé sur	Règle
`QUITTANCEMENT` ★	Quittancement	`RECEIPTS`	`issuedAt`	Une quittance = un avenant émis. Décomposition prime nette / accessoires / taxe unique / FGA / CEDEAO. Ancre stable, rapprochable de la comptabilité.
`IMPAYES`	Impayés	`UNPAID`	`dueDate`	Règlements non confirmés (en attente, partiels, échoués) avec antériorité 0-30 / 31-60 / 61-90 / +90 jours. Tri `dueDate ASC`.
`ENCAISSEMENTS` ★	Encaissements	`COLLECTIONS`	`confirmedDate`	Une ligne par règlement confirmé. Inclut les avenants payés non encore émis (renouvellements différés), absents du quittancement.
`COASSURANCE`	Bordereau de coassurance	`COINSURANCE`	`issuedAt`	Une ligne par part de compagnie sur un avenant. La répartition fait foi en montants ; la prime nette répétée sur chaque ligne n'est additive qu'au grain de l'avenant.

Gestion

Code	Titre	Source	Basé sur	Règle
`PARC_AUTOMOBILE`	Parc automobile	`FLEET`	`inclusionDate`	Une ligne par séjour d'un véhicule sur un contrat ; un véhicule retiré puis réincorporé apparaît deux fois.
`SOUSCRIPTEURS`	Souscripteurs	`SUBSCRIBERS`	`createdDate`	Répertoire avec agrégats de portefeuille. Données personnelles masquées par défaut. CSV et XLSX seulement.

★ = états marqués popular dans le catalogue.

Quittancement et encaissements : lequel choisir ?

Question	État	Pourquoi
Qu'avons-nous émis sur la période ?	`QUITTANCEMENT`, `RECAP_PROD_*`	Basés sur la date d'émission de l'avenant : chiffre de production, rapprochable des écritures de prime.
Qu'avons-nous encaissé sur la période ?	`ENCAISSEMENTS`, `RECAP_ENCAISSEMENTS_COMPAGNIE`	Basés sur la date de confirmation du règlement : trésorerie. Un paiement confirmé sur un avenant non encore émis y figure, pas au quittancement.
Qu'est-ce qui reste dû ?	`IMPAYES`	Règlements non confirmés par date d'échéance.
Que doit-on reverser à chaque compagnie ?	`COASSURANCE`, `BORDEREAU_CESSION`	Lignes de répartition réelle (apéritrice, coassureurs, Pool).

Un même état peut donner des totaux différents selon l'ancre : le quittancement « basé sur la date d'encaissement » (scope.basedOn: collectedDate) inclut des quittances émises avant la période mais payées dedans. Précisez toujours l'ancre quand vous comparez deux éditions.

On this page