Sources et champs

Les neuf sources de données des états, leurs ancres de date et le dictionnaire complet de leurs champs.

Le dictionnaire par API

Avant de construire un état personnalisé, interrogez le dictionnaire : il fait foi et évolue avec la plateforme.

# les sources
curl -s $API/provider/reports/sources -H "Authorization: Bearer $TOKEN"
# les champs d'une source
curl -s $API/provider/reports/sources/RECEIPTS/fields -H "Authorization: Bearer $TOKEN"

GET /provider/reports/sources/{code}/fields renvoie, pour une source :

CléContenu
families[]Les champs regroupés par famille (Identification, Souscripteur, Véhicule, Financier, Dates, Intermédiaires, Statut, Autres), avec pour chacun key, label, type, required, sensitive, filterable, sortable, groupable, defaultSelected, aggregation, enumValues, description
anchors[]Les ancres de date utilisables dans scope.basedOn, avec l'ancre par défaut
relativeRanges[]Les périodes relatives acceptées dans scope.relativeRange
operators[]Les opérateurs de filtre
summaryMeasures[]Les tuiles de synthèse renvoyées par l'aperçu
defaultSortKey, defaultSortDirectionLe tri par défaut

Lire les tableaux

Pour chaque champ : clé (à utiliser dans columns, filters, grouping, sorting), libellé, famille, type, et des drapeaux :

  • G groupable : utilisable dans grouping
  • S sensible : masqué (••••••) quand options.hideSensitiveData vaut true (défaut)
  • D sélectionné par défaut : présent quand columns est vide
  • R requis : toujours ajouté à l'état
  • Σ totalisable (aggregation = SUM) : sommé dans les totaux et conservé en mode récapitulatif

Les champs de type ENUM se filtrent avec le code (ACTIVE, ISSUED…) ; le dictionnaire donne la correspondance code → libellé dans enumValues. Sauf indication, tous les champs sont filtrables et triables.

CONTRACTS — Contrats

Production contractuelle : mono, flotte, avenants. Grain : une ligne = un contrat. Tri par défaut : effectiveDate.

Ancres de date (scope.basedOn) : effectiveDate (date d'effet) — défaut, subscriptionDate (date de souscription), createdDate (date de création), expiryDate (date d'échéance), validatedAt (date de validation)

CléLibelléFamilleTypeDrapeauxNote
proposalNumberN° PropositionIdentificationSTRINGNuméro de la proposition d'origine ; le N° de police identifie le contrat
policyNumberN° de policeIdentificationSTRINGDR
statusStatutIdentificationENUMGD
contractTypeType de contratIdentificationENUMGD
branchLabelBrancheIdentificationSTRINGG
subscriberNameNom du souscripteurSouscripteurSTRINGD
subscriberClientNumberN° clientSouscripteurSTRING
subscriberTypeType de personneSouscripteurENUMG
subscriberPhoneTéléphoneSouscripteurSTRINGS
subscriberEmailE-mailSouscripteurSTRINGS
subscriberAddressAdresseSouscripteurSTRINGS
registrationImmatriculationVéhiculeSTRINGDnon filtrable
vehicleCountNb véhiculesVéhiculeINTEGERΣ
seatsNb de placesVéhiculeINTEGER
seatCategorySous-catégorie véhiculeVéhiculeSTRINGGnon filtrable ; Tranches TPV : 0-4 · 5-8 · 9-22 · 23-40 · +40 places
durationLabelDurée de couvertureVéhiculeSTRINGG
netPremiumPrime netteFinancierMONEYDΣSomme des primes nettes des avenants émis du contrat
accessoryFeesAccessoiresFinancierMONEYΣ
totalTaxesTaxes & FGAFinancierMONEYΣ
totalTtcPrime TTCFinancierMONEYDΣSomme des primes TTC des avenants émis du contrat
commissionCommissionFinancierMONEYΣSomme des commissions apporteur ventilées (premium_allocation) des avenants émis du contrat
createdDateDate de créationDatesDATETIME
subscriptionDateDate de souscriptionDatesDATETIME
effectiveDateDate d'effetDatesDATETIMED
expiryDateDate d'échéanceDatesDATETIMED
validatedAtDate de validationDatesDATETIME
endorsementCountNb avenantsAutresINTEGERΣ
companyLabelCompagnieIntermédiairesSTRINGGD
brokerNameCourtierIntermédiairesSTRINGG
producteurNameProducteurIntermédiairesSTRINGGUtilisateur qui a créé le contrat
referrerNameApporteurIntermédiairesSTRINGGApporteur rattaché au contrat

ENDORSEMENTS — Avenants

Historique des avenants appliqués sur les contrats. Grain : une ligne = un avenant. Tri par défaut : issuedAt.

Ancres de date (scope.basedOn) : issuedAt (date d'émission (saisie si non émis)) — défaut, effectiveDate (date d'effet), createdDate (date de saisie), cancelledAt (date d'annulation)

CléLibelléFamilleTypeDrapeauxNote
referenceRéférence avenantIdentificationSTRINGDR
sequenceNumberN° d'ordreIdentificationINTEGERD
typeCodeCode acteIdentificationSTRINGG
typeLabelNature de l'acteIdentificationSTRINGGD
officialCodeCode officielIdentificationSTRINGCode réglementaire du type d'avenant (lisible par un tiers)
statusStatutStatutENUMGD
premiumImpactIncidence primeStatutENUMG
proposalNumberN° contrat / propositionIdentificationSTRINGD
policyNumberN° de policeIdentificationSTRING
subscriberNameNom du souscripteurSouscripteurSTRINGD
premiumDeltaDelta de primeFinancierMONEYDΣSigné : une ristourne est négative et se somme (§6.3)
netPremiumPrime netteFinancierMONEYΣ
totalTaxesTaxes & FGAFinancierMONEYΣ
totalTtcPrime TTCFinancierMONEYDΣ
commissionCommissionFinancierMONEYΣCommission apporteur de la ventilation (premium_allocation) ; 0 tant que l'avenant n'est pas ventilé
vehiclesAddedVéhicules ajoutésVéhiculeINTEGERΣ
vehiclesRemovedVéhicules retirésVéhiculeINTEGERΣ
effectiveDateDate d'effetDatesDATETIMED
coverageStartDébut de période couverteDatesDATETIME
coverageEndFin de période couverteDatesDATETIME
issuedAtDate d'émissionDatesDATETIMED
cancelledAtDate d'annulationDatesDATETIME
createdDateDate de saisieDatesDATETIME
companyLabelCompagnieIntermédiairesSTRINGGD
brokerNameCourtierIntermédiairesSTRINGG
reasonCommentMotif / commentaireAutresSTRINGnon triable
paymentReferenceRéférence paiement (pi_…)AutresSTRING
orderNumberN° de commandeAutresSTRING
paymentLinkLien de paiementAutresSTRINGSnon filtrable ; non triable

CERTIFICATES — Attestations

Attestations éditées par période. Grain : une ligne = une attestation. Tri par défaut : issuedDate.

Ancres de date (scope.basedOn) : issuedDate (date d'édition) — défaut, cancelledDate (date d'annulation), expiryDate (date d'expiration), createdDate (date de création)

CléLibelléFamilleTypeDrapeauxNote
attestationNumberN° d'attestationIdentificationSTRINGDR
attestationTypeTypeIdentificationENUMGD
statusStatutStatutENUMGD
serialNumberN° de sérieIdentificationSTRING
registrationImmatriculationVéhiculeSTRINGD
chassisNumberN° de châssisVéhiculeSTRING
proposalNumberN° contrat / propositionIdentificationSTRINGD
policyNumberN° de policeIdentificationSTRING
subscriberNameNom du souscripteurSouscripteurSTRINGD
issuedDateDate d'éditionDatesDATETIMED
expiryDateDate d'expirationDatesDATETIME
cancelledDateDate d'annulationDatesDATETIME
cancellationReasonMotif d'annulationAutresSTRINGnon triable
issuingEndorsementRefAvenant émetteurAutresSTRINGActe qui a émis l'attestation (rattachement S1)
companyLabelCompagnieIntermédiairesSTRINGGD
brokerNameCourtier / apporteurIntermédiairesSTRINGG

RECEIPTS — Quittancement

Primes et taxes émises par compagnie. Grain : une ligne = un avenant émis (une quittance). Tri par défaut : issuedAt.

Ancres de date (scope.basedOn) : issuedAt (date d'émission) — défaut, collectedDate (date d'encaissement), effectiveDate (date d'effet)

CléLibelléFamilleTypeDrapeauxNote
receiptRefN° quittance (avenant)IdentificationSTRINGDRRéférence de l'avenant émis — la numérotation de quittance dédiée (S7) n'existe pas encore
typeLabelNature de l'acteIdentificationSTRINGGD
sequenceNumberN° d'ordreIdentificationINTEGER
proposalNumberN° contrat / propositionIdentificationSTRINGD
policyNumberN° de policeIdentificationSTRING
branchLabelBrancheIdentificationSTRINGG
subscriberNameNom du souscripteurSouscripteurSTRINGD
registrationImmatriculationVéhiculeSTRINGnon filtrable
seatsNb de placesVéhiculeINTEGER
seatCategorySous-catégorie véhiculeVéhiculeSTRINGGnon filtrable ; Tranches TPV : 0-4 · 5-8 · 9-22 · 23-40 · +40 places
durationLabelDurée de couvertureVéhiculeSTRINGG
technicalPremiumPrime techniqueFinancierMONEYΣComposants PRIME_TECHNIQUE — la prime d'assurance stricto sensu (§6.4)
netPremiumPrime netteFinancierMONEYDΣ
accessoriesAccessoiresFinancierMONEYΣ
tvaTaxe unique (TVA)FinancierMONEYΣ
fgaFGAFinancierMONEYΣ
cedeaoCarte brune CEDEAOFinancierMONEYΣ
refundsRistournesFinancierMONEYΣ
totalTaxesTotal taxesFinancierMONEYΣ
totalTtcPrime totaleFinancierMONEYDΣ
commissionCommission intermédiaireFinancierMONEYΣCommission apporteur de la ventilation (premium_allocation), en unités ; 0 tant que l'avenant n'est pas ventilé
billedAmountMontant facturéFinancierMONEYΣMontant du lien de paiement émis pour l'avenant (peut différer de la prime totale)
amountPaidMontant encaisséFinancierMONEYDΣSomme des règlements confirmés rattachés à l'avenant
leadSharePart apériteurFinancierMONEYΣMontants réels de la ventilation (premium_allocation)
coassSharePart coassuranceFinancierMONEYΣ
poolSharePart PoolFinancierMONEYΣ
fraisGestionFrais de gestion PoolFinancierMONEYΣLigne Pool de la ventilation (10 % de l'assiette) ; ce que le Pool perçoit sur l'avenant
fraisGestionParCompagnieFrais de gestion retenus par compagnieFinancierMONEYΣSomme des frais de gestion retenus sur chaque part (apéritrice et coassureurs)
fraisAperitionFrais d'apéritionFinancierMONEYΣ
leadNetDueNet dû apéritriceFinancierMONEYΣNet à reverser à l'apéritrice selon la ventilation (part − commission − frais + taxes et accessoires encaissés)
coassNetDueNet dû coassureursFinancierMONEYΣ
poolNetDueNet dû PoolFinancierMONEYΣ
allocatedNetPremiumAssiette ventiléeFinancierMONEYΣPrime nette retenue par la ventilation ; doit égaler la prime nette de la quittance
allocatedTtcPrime totale ventiléeFinancierMONEYΣDoit égaler la prime totale et la somme des nets dus
coInsurerCountNb coassureursAutresINTEGER
allocationStatusStatut ventilation apéritriceStatutSTRINGG
allocationTransferStatusReversement apéritriceStatutSTRINGG
allocationTransferredAtDate de reversementDatesDATETIME
chiffreAffairesC.A.FinancierMONEYΣPrime nette + accessoires − part coassurance
partCniePart CnieFinancierMONEYΣPrime totale − part coassurance (TTC conservé par la compagnie)
attestationNumberN° attestationAutresSTRING
paymentStatusÉtat quittanceStatutENUMGD
collectedDateDate d'encaissementDatesDATETIME
paymentDateDate de règlementDatesDATETIME
paymentDueDateÉchéance de paiementDatesDATETIMEDate limite du dernier lien de paiement de l'avenant
paymentReferenceRéférence paiement (pi_…)AutresSTRINGnon triable ; Référence du règlement confirmé, sinon du dernier lien émis
paymentReferencesToutes les références de paiementAutresSTRINGnon filtrable ; non triable
externalTransactionIdIdentifiant de la transaction de paiementAutresSTRINGnon triable
paymentMethodMode de règlementAutresSTRINGG
paymentCountNb règlementsAutresINTEGERΣ
orderNumberN° de commandeAutresSTRING
issuedAtDate d'émissionDatesDATETIMED
effectiveDateDate d'effetDatesDATETIME
coverageEndÉchéanceDatesDATETIME
emissionMonthMois d'émissionDatesSTRINGGnon filtrable
companyLabelCompagnieIntermédiairesSTRINGGD
brokerNameIntermédiaireIntermédiairesSTRINGG
producteurNameProducteur (saisie)IntermédiairesSTRINGG

UNPAID — Impayés

Quittances en souffrance et relances. Grain : une ligne = un règlement non confirmé. Tri par défaut : dueDate.

Ancres de date (scope.basedOn) : dueDate (date d'échéance) — défaut, createdDate (date de création)

CléLibelléFamilleTypeDrapeauxNote
paymentReferenceRéférence paiement (pi_…)IdentificationSTRINGDR
statusStatutStatutENUMGD
proposalNumberN° contrat / propositionIdentificationSTRINGD
policyNumberN° de policeIdentificationSTRING
endorsementRefAvenantIdentificationSTRING
endorsementTypeNature de l'acteIdentificationSTRINGGD
endorsementStatusStatut de l'avenantStatutENUMG
contractStatusStatut du contratStatutENUMGDBrouillon = proposition jamais souscrite, pas une créance
subscriberNameNom du souscripteurSouscripteurSTRINGD
subscriberPhoneTéléphoneSouscripteurSTRINGS
subscriberEmailE-mailSouscripteurSTRINGS
amountDueMontant dûFinancierMONEYDΣ
amountPaidMontant payéFinancierMONEYΣ
amountRemainingRestant dûFinancierMONEYDΣ
dueDateÉchéance de paiementDatesDATETIMED
daysOverdueJours de retardDatesINTEGERDnon filtrable
agingBucketAntérioritéDatesSTRINGGnon filtrable ; non triable
createdDateDate de créationDatesDATETIME
lastModifiedDateDernière mise à jourDatesDATETIME
paymentDateDate de règlementDatesDATETIME
paymentMethodMode de règlementAutresSTRINGG
externalTransactionIdIdentifiant de la transaction de paiementAutresSTRING
endorsementPaymentReferenceRéférence paiement de l'avenantAutresSTRING
paymentLinkLien de paiementAutresSTRINGSnon filtrable ; non triable
notesNotesAutresSTRINGnon triable
companyLabelCompagnieIntermédiairesSTRINGGD
brokerNameCourtierIntermédiairesSTRINGG
failureReasonMotif d'échecAutresSTRINGnon triable

FLEET — Parc automobile

Véhicules couverts par période. Grain : une ligne = un séjour d'un véhicule sur un contrat (période de garantie). Tri par défaut : inclusionDate.

Ancres de date (scope.basedOn) : inclusionDate (date d'inclusion) — défaut, withdrawalDate (date de retrait), createdDate (date de création)

CléLibelléFamilleTypeDrapeauxNote
registrationImmatriculationVéhiculeSTRINGDR
chassisNumberN° de châssisVéhiculeSTRING
brandLabelMarqueVéhiculeSTRINGGD
modelLabelModèleVéhiculeSTRINGD
usageLabelUsageVéhiculeSTRINGG
energyLabelÉnergieVéhiculeSTRINGG
seatsNb de placesVéhiculeINTEGER
horsepowerPuissance fiscaleVéhiculeINTEGER
vehicleStatusStatut au contratStatutENUMGD
proposalNumberN° contrat / propositionIdentificationSTRINGD
policyNumberN° de policeIdentificationSTRING
contractTypeType de contratIdentificationENUMG
contractStatusStatut du contratStatutENUMG
subscriberNameNom du souscripteurSouscripteurSTRINGD
inclusionDateDate d'inclusionDatesDATED
withdrawalDateDate de retraitDatesDATETIME
withdrawalReasonMotif de retraitAutresSTRINGnon triable
inclusionEndorsementRefAvenant d'inclusionAutresSTRINGActe qui a fait entrer le véhicule au contrat (S2)
withdrawalEndorsementRefAvenant de retraitAutresSTRING
companyLabelCompagnieIntermédiairesSTRINGGD
brokerNameCourtierIntermédiairesSTRINGG

SUBSCRIBERS — Souscripteurs

Clients particuliers, entreprises, flottes. Grain : une ligne = un souscripteur. Tri par défaut : createdDate.

Ancres de date (scope.basedOn) : createdDate (date de création) — défaut

CléLibelléFamilleTypeDrapeauxNote
clientNumberN° clientIdentificationSTRINGDR
personTypeType de personneIdentificationENUMGD
displayNameNom / raison socialeSouscripteurSTRINGD
civilityCivilitéSouscripteurSTRING
phoneTéléphoneSouscripteurSTRINGSD
emailE-mailSouscripteurSTRINGS
addressAdresseSouscripteurSTRINGS
nationalIdNumberPièce d'identitéSouscripteurSTRINGS
drivingLicenseNumberN° de permisSouscripteurSTRINGS
isActiveActifStatutBOOLEANG
contractCountNb contratsFinancierINTEGERDΣ
activeContractCountNb contrats actifsFinancierINTEGERΣ
netPremiumPrime nette totaleFinancierMONEYΣ
totalTtcPrime TTC totaleFinancierMONEYDΣ
createdDateDate de créationDatesDATETIME
companyLabelCompagnieIntermédiairesSTRINGG
brokerNameCourtierIntermédiairesSTRINGG

COINSURANCE — Coassurance

Ventilation des primes entre apéritrice, coassureurs et Pool. Grain : une ligne = la part d'une compagnie sur un avenant (ventilation). Tri par défaut : createdDate.

Ancres de date (scope.basedOn) : issuedAt (date d'émission de l'avenant) — défaut, createdDate (date de création de la ventilation)

CléLibelléFamilleTypeDrapeauxNote
companyLabelCompagnieIntermédiairesSTRINGGDR
poolRoleRôle poolIntermédiairesENUMGD
sharePercentageQuote-part (%)FinancierPERCENTDValeur d'affichage — la répartition fait foi en montants (A6)
proposalNumberN° contrat / propositionIdentificationSTRINGD
endorsementRefAvenantIdentificationSTRINGD
sequenceNumberN° avenantIdentificationINTEGER
effectiveDateDate d'effetDatesDATETIME
coverageEndDate d'échéanceDatesDATETIME
leadShareOfActPart apériteur de l'avenantFinancierMONEYRépétée sur chaque ligne de l'avenant : non totalisable
subscriberNameNom du souscripteurSouscripteurSTRING
netPremiumPrime nette ventiléeFinancierMONEYAssiette de l'avenant, répétée sur chaque ligne : non totalisable
primeTtcPrime totaleFinancierMONEYPrime totale de l'avenant, répétée sur chaque ligne : non totalisable
fgaFGAFinancierMONEYΣ
cedeaoCarte brune CEDEAOFinancierMONEYΣ
companySharePart compagnieFinancierMONEYDΣPart de prime de l'apéritrice ou du coassureur ; la ligne Pool porte ses frais dans « Frais Pool »
poolFeesFrais PoolFinancierMONEYΣFrais de gestion perçus par le Pool (10 % de l'assiette), portés par la ligne Pool
managementFeesFrais de gestion PoolFinancierMONEYΣ
leadInsurerFeesFrais d'apéritionFinancierMONEYΣ
commissionCommission apporteurFinancierMONEYΣ
collectedCommissionCommission reverséeFinancierMONEYΣ
netAmountDueNet à reverserFinancierMONEYDΣ
primeRcPrime RCFinancierMONEYRépétée sur chaque ligne de l'avenant : non totalisable
primeDrPrime DRFinancierMONEYRépétée sur chaque ligne de l'avenant : non totalisable
taxAmountTaxe uniqueFinancierMONEYRépétée sur chaque ligne de l'avenant : non totalisable
collectedLeadInsurerFeesFrais d'apérition reversésFinancierMONEYΣ
commercialDiscountPctRéduction commerciale (%)FinancierPERCENT
allocationKindNature de la ligneStatutSTRINGGPRIME : part de prime ; FRAIS : frais d'un avenant sans assiette
statusStatutStatutSTRINGGCALCULATED : ventilée ; REVERSED : reversée
transferStatusStatut du reversementStatutSTRINGG
transferModeMode de reversementStatutSTRINGG
transferRefRéférence de reversementAutresSTRING
transferredAtDate de reversementDatesDATETIME
transferMessageMessage de reversementAutresSTRINGnon filtrable ; non triable
settlementStatementIdRelevé de règlementAutresSTRING
installmentIdÉchéance (fractionnement)AutresSTRING
createdDateDate de créationDatesDATETIMED
issuedAtDate d'émission de l'avenantDatesDATETIME

COLLECTIONS — Encaissements

Règlements confirmés, par date d'encaissement. Grain : une ligne = un règlement confirmé. Tri par défaut : confirmedDate.

Ancres de date (scope.basedOn) : confirmedDate (date d'encaissement) — défaut, paymentDate (date de règlement), createdDate (date de création)

CléLibelléFamilleTypeDrapeauxNote
paymentReferenceRéférence paiement (pi_…)IdentificationSTRINGDR
paymentMethodMode de règlementIdentificationSTRINGGD
externalTransactionIdIdentifiant de la transaction de paiementIdentificationSTRING
endorsementPaymentReferenceRéférence paiement de l'avenantIdentificationSTRING
orderNumberN° de commandeIdentificationSTRING
proposalNumberN° contrat / propositionIdentificationSTRINGD
policyNumberN° de policeIdentificationSTRING
endorsementRefAvenantIdentificationSTRINGD
endorsementTypeNature de l'acteIdentificationSTRINGGD
endorsementStatusStatut de l'avenantStatutENUMGDUn règlement confirmé sur un avenant non émis n'apparaît pas encore au quittancement
contractStatusStatut du contratStatutENUMG
subscriberNameNom du souscripteurSouscripteurSTRINGD
amountDueMontant dûFinancierMONEYΣ
amountPaidMontant encaisséFinancierMONEYDΣ
premiumTtcPrime totale de l'avenantFinancierMONEYΣ
confirmedDateDate d'encaissementDatesDATETIMED
paymentDateDate de règlementDatesDATETIME
dueDateÉchéance de paiementDatesDATETIME
createdDateDate de création du lienDatesDATETIME
lastModifiedDateDernière mise à jourDatesDATETIME
paymentLinkLien de paiementAutresSTRINGSnon filtrable ; non triable
notesNotesAutresSTRINGnon triable
collectionMonthMois d'encaissementDatesSTRINGGnon filtrable
companyLabelCompagnieIntermédiairesSTRINGGD
brokerNameIntermédiaireIntermédiairesSTRINGG

Champs communs à retenir

BesoinChampSources
Regrouper par compagniecompanyLabeltoutes
Regrouper par intermédiairebrokerNametoutes sauf COINSURANCE
Identifier la quittancereceiptRef (= reference de l'avenant)RECEIPTS
Identifier le contratpolicyNumber, proposalNumberCONTRACTS, RECEIPTS, ENDORSEMENTS…
Montants de productionnetPremium, totalTtc, tva, fga, cedeao, commissionRECEIPTS, CONTRACTS, ENDORSEMENTS
Montants de répartitionleadShare, coassShare, poolShare, fraisGestion, fraisAperition, leadNetDueRECEIPTS, COINSURANCE
EncaissementamountPaid, paymentStatus, collectedDate, paymentReferenceRECEIPTS, COLLECTIONS, UNPAID

On this page