Énumérations
Toutes les valeurs énumérées utilisées par l'API Pool TPV.
Personnes
PersonType — type de personne (souscripteur, assuré, apporteur)
| Valeur | Description |
|---|---|
PHYSIQUE | Personne physique |
MORALE | Personne morale (entreprise) |
FLOTTE | Flotte (parc de véhicules) |
Civility — MR, MME, MLLE, DR, PR, ME
Contrats
ContractType — MONO (1 véhicule), FLEET (2 véhicules et plus)
ContractStatus
| Valeur | Phase | Description |
|---|---|---|
DRAFT | Proposition | Brouillon modifiable |
PENDING_VALIDATION | Proposition | En attente de validation |
REFUSED | Proposition | Refusée |
CANCELLED | Proposition / contrat | Annulé |
ACTIVE | Contrat | En vigueur |
SUSPENDED | Contrat | Suspendu |
TERMINATED | Contrat | Résilié |
EXPIRED | Contrat | Arrivé à échéance |
RENEWING | Contrat | Renouvellement en cours |
TRANSFERRED | Contrat | Transféré (portefeuille) |
PartnershipStatus — ACTIVE, SUSPENDED, TERMINATED
Avenants et primes
EndorsementStatus
| Valeur | Description |
|---|---|
QUOTE | Devis calculé, non payé ; n'impacte pas le contrat |
PENDING_PAYMENT | Lien de paiement émis |
PAID | Payé, en attente de prise d'effet (renouvellement différé, par exemple) |
ISSUED | Émis : les changements sont appliqués au contrat |
CANCELLED | Annulé |
PremiumImpact — INCREASE (supplément), DECREASE (ristourne), NEUTRAL, RECALCULATE
PremiumStatus — QUOTE, PENDING_PAYMENT, ISSUED, CANCELLED, EXPIRED
PremiumComponentType — composants de la ventilation d'une prime
| Valeur | Description |
|---|---|
PRIME_TECHNIQUE | Prime d'assurance par garantie (RC, DR…), base de la répartition |
RISTOURNE | Ristourne (négative) |
ACCESSOIRE | Frais accessoires |
TAXE_TVA | Taxe unique |
TAXE_FGA | Fonds de garantie automobile |
CEDEAO | Carte brune CEDEAO |
CERTIFICATE | Attestation |
COMMISSION | Commission intermédiaire |
Paiements
PaymentStatus — PENDING, PARTIAL, CONFIRMED, FAILED, REFUNDED
NotificationChannel — EMAIL, SMS, WHATSAPP
États
ReportFileFormat — PDF, CSV, XLSX (EXCEL est accepté comme alias de XLSX)
ReportScopeMode — GLOBAL (un fichier), PER_COMPANY (un fichier par compagnie, comptes Pool uniquement)
ReportVisibility — PRIVATE (visible par son auteur), SHARED (visible par l'organisation)
ReportExecutionType — MANUAL, SCHEDULED
ReportExecutionStatus — SUCCESS, FAILED, SKIPPED_EMPTY
ReportFrequency — DAILY, WEEKLY, MONTHLY, QUARTERLY
EndRecurrenceMode — NEVER, UNTIL_DATE, AFTER_OCCURRENCES
ReportFilterOperator — EQUALS, NOT_EQUALS, IN, NOT_IN, GREATER_THAN, GREATER_OR_EQUAL,
LESS_THAN, LESS_OR_EQUAL, CONTAINS, BETWEEN, IS_EMPTY, IS_NOT_EMPTY
ReportRelativeRange
| Valeur | Période |
|---|---|
TODAY, YESTERDAY | Jour |
CURRENT_WEEK, PREVIOUS_WEEK | Semaine du lundi au dimanche |
CURRENT_MONTH, PREVIOUS_MONTH | Mois civil |
CURRENT_QUARTER, PREVIOUS_QUARTER | Trimestre civil |
CURRENT_YEAR, PREVIOUS_YEAR | Année civile |
LAST_7_DAYS, LAST_30_DAYS, LAST_90_DAYS | Glissant, jour courant inclus |
CUSTOM | Utiliser dateRange |
ReportFieldType — STRING, INTEGER, DECIMAL, MONEY, PERCENT, DATE, DATETIME, BOOLEAN, ENUM
ReportAggregation — NONE, SUM, COUNT, COUNT_DISTINCT, MIN, MAX
ReportColumnRequestType — NATIVE (champ de la source), CALCULATED (formule)