Recettes prêtes à l'emploi

Des corps de requête à copier pour les besoins les plus courants.

Chaque recette est un corps pour POST /provider/reports/preview (ajoutez page/size) ou POST /provider/reports/generate (ajoutez format). $API et $TOKEN comme dans le reste du guide.

Production

Récapitulatif de production par compagnie, mois clos

{ "definitionCode": "RECAP_PROD_COMPAGNIE", "scope": { "relativeRange": "PREVIOUS_MONTH" }, "format": "XLSX" }

Même récapitulatif, arrêté à une date précise

{
  "definitionCode": "RECAP_PROD_COMPAGNIE",
  "scope": { "basedOn": "issuedAt", "dateRange": { "from": "2026-10-01T00:00:00", "to": "2026-10-28T23:59:59" } },
  "format": "XLSX", "title": "État récapitulatif au 28/10/2026"
}

Production par sous-catégorie de véhicule et par intermédiaire

{
  "definitionCode": "RECAP_PROD_SOUS_CATEGORIE",
  "grouping": ["brokerName", "seatCategory"],
  "scope": { "relativeRange": "CURRENT_QUARTER" },
  "format": "XLSX"
}

Détail des quittances d'un seul intermédiaire

{
  "definitionCode": "PRODUCTION_EMISSIONS",
  "filters": [ { "fieldName": "brokerName", "operator": "CONTAINS", "values": ["ASSUR PLUS"] } ],
  "scope": { "relativeRange": "CURRENT_MONTH" },
  "format": "PDF"
}

Trésorerie

Encaissements du jour

{ "definitionCode": "ENCAISSEMENTS", "scope": { "relativeRange": "TODAY" }, "format": "CSV" }

Encaissements par mode de paiement et par compagnie

{
  "sourceCode": "COLLECTIONS",
  "columns": [ { "fieldName": "amountPaid" } ],
  "grouping": ["companyLabel", "paymentMethod"],
  "scope": { "basedOn": "confirmedDate", "relativeRange": "PREVIOUS_MONTH" },
  "format": "XLSX"
}

Quittances émises mais non encaissées

{
  "sourceCode": "RECEIPTS",
  "columns": [
    { "fieldName": "receiptRef" }, { "fieldName": "companyLabel" }, { "fieldName": "subscriberName" },
    { "fieldName": "totalTtc" }, { "fieldName": "amountPaid" },
    { "type": "CALCULATED", "name": "resteDu", "label": "Reste dû", "definition": "totalTtc - amountPaid" },
    { "fieldName": "paymentDueDate" }
  ],
  "filters": [ { "fieldName": "paymentStatus", "operator": "NOT_EQUALS", "values": ["CONFIRMED"] } ],
  "scope": { "basedOn": "issuedAt", "relativeRange": "LAST_90_DAYS" },
  "sorting": { "fieldName": "issuedAt", "direction": "ASC" },
  "format": "XLSX"
}

Impayés de plus de 60 jours

{
  "definitionCode": "IMPAYES",
  "filters": [ { "fieldName": "daysOverdue", "operator": "GREATER_OR_EQUAL", "values": ["60"] } ],
  "scope": { "basedOn": "dueDate", "relativeRange": "CURRENT_YEAR" },
  "format": "XLSX"
}

Répartition et coassurance

Bordereau de cession du mois clos, un fichier par compagnie (Pool)

{ "definitionCode": "BORDEREAU_CESSION", "scope": { "relativeRange": "PREVIOUS_MONTH" }, "scopeMode": "PER_COMPANY", "format": "PDF" }

Parts et frais de gestion par compagnie, avec contrôle du 10 %

{
  "sourceCode": "RECEIPTS",
  "columns": [
    { "fieldName": "netPremium" }, { "fieldName": "leadShare" }, { "fieldName": "coassShare" },
    { "fieldName": "fraisGestion" }, { "fieldName": "fraisAperition" },
    { "type": "CALCULATED", "name": "ecartFG", "label": "Écart FG vs 10 %", "definition": "fraisGestion - netPremium * 0.10" },
    { "type": "CALCULATED", "name": "ecartLead", "label": "Écart apériteur vs 60 %", "definition": "leadShare - netPremium * 0.60" }
  ],
  "grouping": ["companyLabel"],
  "options": { "aggregated": true },
  "scope": { "basedOn": "issuedAt", "relativeRange": "PREVIOUS_MONTH" },
  "format": "XLSX"
}

Lignes de répartition reversées à une compagnie

{
  "sourceCode": "COINSURANCE",
  "filters": [
    { "fieldName": "companyLabel", "operator": "CONTAINS", "values": ["COMAR"] },
    { "fieldName": "transferStatus", "operator": "EQUALS", "values": ["PAID"] }
  ],
  "scope": { "basedOn": "createdDate", "relativeRange": "PREVIOUS_MONTH" },
  "format": "CSV"
}

Portefeuille

Contrats arrivant à échéance dans les 30 prochains jours

{
  "definitionCode": "CONTRATS_A_RENOUVELER",
  "scope": { "basedOn": "expiryDate", "dateRange": { "from": "2026-11-02T00:00:00", "to": "2026-12-02T23:59:59" } },
  "format": "XLSX"
}

Véhicules assurés par marque

{
  "sourceCode": "FLEET",
  "grouping": ["brandLabel"],
  "options": { "aggregated": true },
  "scope": { "basedOn": "inclusionDate", "relativeRange": "CURRENT_YEAR" },
  "format": "XLSX"
}

Attestations éditées la semaine dernière

{ "definitionCode": "ATTESTATIONS_EDITEES", "scope": { "relativeRange": "PREVIOUS_WEEK" }, "format": "PDF" }

Automatiser

  1. Créez le modèle avec POST /provider/reports/models (reprenez le corps d'une recette, ajoutez name, allowedFormats, visibility).
  2. Planifiez-le avec PUT /provider/reports/models/{id}/schedule.
  3. Retrouvez les envois dans GET /provider/reports/models/{id}/executions?type=SCHEDULED.

On this page