ronan.quintin/Keryloo
1
0
Fork 0
Code Issues 3 Pull requests Projects Releases Packages Wiki Activity Actions

Création PDF échéance #21

New issue
Closed
opened 2025-12-26 14:38:58 +01:00 by ronan.quintin · 0 comments
ronan.quintin commented 2025-12-26 14:38:58 +01:00
Owner
Copy link

Spécification Fonctionnelle

Génération du PDF d’Échéance (Avis d’Échéance)

1. Contexte

Dans Keryloo, les échéances de loyer sont générées automatiquement par un batch en fonction des baux actifs.
À ce jour, ces échéances ne disposent pas de document PDF, contrairement aux quittances.

Afin de permettre la communication mensuelle aux locataires, la transmission au comptable et la traçabilité documentaire, chaque échéance doit disposer d’un PDF officiel appelé Avis d’échéance.

2. Objectif

Mettre en place un mécanisme permettant :

  • la génération automatique d’un PDF d’échéance
  • immédiatement après la création de l’échéance
  • via un événement métier et un workflow
  • avec stockage du document dans la GED

3. Périmètre

Inclus

  • Déclenchement d’un événement lors de la création d’une échéance
  • Orchestration d’un workflow de génération documentaire
  • Génération d’un PDF d’échéance
  • Stockage du PDF en GED
  • Association du document à l’échéance

Exclu

  • Paiement de l’échéance
  • Génération de quittance
  • Envoi de mails
  • Interface utilisateur de sélection des documents

4. Définitions

  • Échéance : Montant attendu pour une période donnée, avant paiement
  • Avis d’échéance : Document PDF informant le locataire des sommes dues
  • GED : Système de gestion documentaire transverse
  • Workflow : Orchestration d’actions déclenchées par événement

5. Principe général

Toute échéance créée doit produire un PDF d’avis d’échéance, une seule fois.

La génération du PDF :

  • n’est pas déclenchée à la volée
  • n’est pas dépendante du paiement
  • est déclenchée automatiquement après la création de l’échéance

6. Déclenchement par événement

Lorsqu’une échéance est créée, le système émet l’événement métier :

RentDueCreatedEvent

Cet événement contient l’identifiant de l’échéance et le contexte minimal nécessaire à son traitement.

7. Workflow de génération d’avis d’échéance

Étapes du workflow

  1. Réception de l’événement RentDueCreatedEvent
  2. Chargement des données nécessaires (bail, locataire, bailleur, logement)
  3. Génération du PDF d’avis d’échéance
  4. Stockage du PDF dans la GED
  5. Association du document à l’échéance
  6. Fin du workflow

Règles

  • Le workflow est idempotent
  • Le PDF est généré une seule fois par échéance
  • Toute erreur est tracée (audit / logs)

8. Contenu fonctionnel du PDF d’échéance

En-tête

  • Titre : AVIS D’ÉCHÉANCE
  • Période concernée (ex : Novembre 2025)
  • Date d’émission

Informations bailleur

  • Nom / raison sociale
  • Adresse
  • Coordonnées

Informations locataire

  • Nom et prénom
  • Adresse du logement

Informations logement

  • Adresse complète
  • Référence interne éventuelle

Informations bail

  • Date de début du bail
  • Référence du bail

Détail financier

  • Loyer hors charges
  • Charges provisionnelles
  • Autres montants éventuels

Total

  • Total à payer
  • Devise (EUR)

Date d’exigibilité

  • Date à laquelle le paiement est attendu

Mentions

  • « Document non acquitté – avis informatif avant paiement »
  • Modalités de paiement si disponibles

9. Stockage documentaire (GED)

  • Type de document : AVIS_D_ECHEANCE
  • Document rattaché à l’échéance
  • Versionnement possible
  • Accessible pour communication et transmission comptable

10. Contraintes

  • Un PDF d’échéance n’est pas modifiable
  • Toute correction nécessite une nouvelle échéance ou version documentaire
  • Le document reste accessible après paiement

11. Cas d’usage nominal

  1. Le batch génère une échéance
  2. L’événement RentDueCreatedEvent est émis
  3. Le workflow est déclenché
  4. Le PDF est généré
  5. Le PDF est stocké en GED
  6. L’échéance dispose de son document officiel

12. Évolutions futures (hors périmètre)

  • Envoi automatique par mail
  • Communication mensuelle automatisée
  • Transmission comptable
# Spécification Fonctionnelle ## Génération du PDF d’Échéance (Avis d’Échéance) --- ## 1. Contexte Dans Keryloo, les échéances de loyer sont générées automatiquement par un batch en fonction des baux actifs. À ce jour, ces échéances ne disposent pas de document PDF, contrairement aux quittances. Afin de permettre la communication mensuelle aux locataires, la transmission au comptable et la traçabilité documentaire, chaque échéance doit disposer d’un PDF officiel appelé **Avis d’échéance**. --- ## 2. Objectif Mettre en place un mécanisme permettant : - la génération automatique d’un PDF d’échéance - immédiatement après la création de l’échéance - via un événement métier et un workflow - avec stockage du document dans la GED --- ## 3. Périmètre ### Inclus - Déclenchement d’un événement lors de la création d’une échéance - Orchestration d’un workflow de génération documentaire - Génération d’un PDF d’échéance - Stockage du PDF en GED - Association du document à l’échéance ### Exclu - Paiement de l’échéance - Génération de quittance - Envoi de mails - Interface utilisateur de sélection des documents --- ## 4. Définitions - **Échéance** : Montant attendu pour une période donnée, avant paiement - **Avis d’échéance** : Document PDF informant le locataire des sommes dues - **GED** : Système de gestion documentaire transverse - **Workflow** : Orchestration d’actions déclenchées par événement --- ## 5. Principe général Toute échéance créée doit produire un PDF d’avis d’échéance, une seule fois. La génération du PDF : - n’est pas déclenchée à la volée - n’est pas dépendante du paiement - est déclenchée automatiquement après la création de l’échéance --- ## 6. Déclenchement par événement Lorsqu’une échéance est créée, le système émet l’événement métier : **RentDueCreatedEvent** Cet événement contient l’identifiant de l’échéance et le contexte minimal nécessaire à son traitement. --- ## 7. Workflow de génération d’avis d’échéance ### Étapes du workflow 1. Réception de l’événement RentDueCreatedEvent 2. Chargement des données nécessaires (bail, locataire, bailleur, logement) 3. Génération du PDF d’avis d’échéance 4. Stockage du PDF dans la GED 5. Association du document à l’échéance 6. Fin du workflow ### Règles - Le workflow est idempotent - Le PDF est généré une seule fois par échéance - Toute erreur est tracée (audit / logs) --- ## 8. Contenu fonctionnel du PDF d’échéance ### En-tête - Titre : **AVIS D’ÉCHÉANCE** - Période concernée (ex : Novembre 2025) - Date d’émission ### Informations bailleur - Nom / raison sociale - Adresse - Coordonnées ### Informations locataire - Nom et prénom - Adresse du logement ### Informations logement - Adresse complète - Référence interne éventuelle ### Informations bail - Date de début du bail - Référence du bail ### Détail financier - Loyer hors charges - Charges provisionnelles - Autres montants éventuels ### Total - Total à payer - Devise (EUR) ### Date d’exigibilité - Date à laquelle le paiement est attendu ### Mentions - « Document non acquitté – avis informatif avant paiement » - Modalités de paiement si disponibles --- ## 9. Stockage documentaire (GED) - Type de document : AVIS_D_ECHEANCE - Document rattaché à l’échéance - Versionnement possible - Accessible pour communication et transmission comptable --- ## 10. Contraintes - Un PDF d’échéance n’est pas modifiable - Toute correction nécessite une nouvelle échéance ou version documentaire - Le document reste accessible après paiement --- ## 11. Cas d’usage nominal 1. Le batch génère une échéance 2. L’événement RentDueCreatedEvent est émis 3. Le workflow est déclenché 4. Le PDF est généré 5. Le PDF est stocké en GED 6. L’échéance dispose de son document officiel --- ## 12. Évolutions futures (hors périmètre) - Envoi automatique par mail - Communication mensuelle automatisée - Transmission comptable
ronan.quintin referenced this issue from a commit 2025-12-28 10:33:29 +01:00
#21 test ok
Sign in to join this conversation.
No Branch/Tag specified
Branches Tags
main
No results found.
Labels
Clear labels
No items
No labels
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference: ronan.quintin/Keryloo#21
No description provided.
Delete branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?