astronote/AstronoteCahierDesCharges.md

328 lines
22 KiB
Markdown
Raw Normal View History

2020-07-14 00:23:51 +02:00
# Astronote Cahier des charges
---
### SUJET
- **But**: Développer une application mobile crossplatform pour la gestion des notes de frais d'interface à [**enDI**](https://framagit.org/endi/endi) ("**en**treprendre **DI**fféremment")
- **Note**: Publié sous license libre ([GPLv3 License](https://framagit.org/membres-astrolabe/astronote/-/blob/master/LICENSE.txt)) dans un magasin d'application libre
##### Etapes de travail:
- **Etape 1**:
Première version simplifiée permettant de créer une note de frais et de rentrer à minima la date, le type de dépense et les charges (montants HT, TTC, TVA)
Stocker les informations en local dans une base de donnée simple (objets typés et des binaires)
Envoie sécurisé des informations collectées vers enDI (des contributions à enDI seront peut-être nécessaires)
- **Etape 2**:
Système de pièces jointes de justificatifs et amélioration du design graphique
Inclure la prise de photo de la preuve de dépense et l'attacher en tant que pièce justificative
Reconnaissance de caractères optique (OCR) avec remplissage automatique lors de la prise de photo de la pièce justificative
Utilisation de briques logicielles disponibles en libre ou API standard Android permettant l'OCR
- **Environment**: Android / Lineage OS, F-Droid / Play Store, logiciel libre, progiciel métier
---
## ETAPE 1
[ ] ==**CONNECTION**==
Scénario:
1. Un utilisateur passif veut se connecter : il doit le faire via un URL spécifique et des identifiants crées et envoyés auparavant par un administrateur ou un membre de l'équipe d'appui
2. Lutilisateur rempli le formulaire de connexion avec les informations nécessaires (adresse e-mail et mot de passe) et clique sur le bouton de connexion
3. Lutilisateur peut consulter le site denDI via lURL si nécessaire
4. Lutilisateur peut consulter le site dAstrolabe via lURL si nécessaire
Lutilisateur se connecte automatiquement à son compte enDI via une API Rest
Il est nécessaire de faire perdurer une session avec cookie
[ ] ==**ACCUEIL**==
L'accueil permet dassurer le suivi des notes enregistrées en Brouillon ou en attente de validation
Les notes sont affichées dans un tableau qui permet à lutilisateur de :
- suivre létat de ses notes (enregistrées en Brouillon ou en attente de validation)
- voir les informations globales des notes (la date, les montants HT, TVA, TTC, le nombre de kilomètres)
- voir le total des montants HT, de TVA, TTC, nombre de kilomètres des notes
- consulter des notes spécifiques
Scenario:
1. Une fois lauthentification réussie
Si lutilisateur est enregistré sur une seule enseigne: il est redirigé vers lIHM de lAccueil
Si lutilisateur est enregistré sur plusieurs enseignes: il est redirigé vers lIHM de visualisation de choix de lenseigne sur laquelle il souhaite intervenir puis vers lIHM de lAccueil
2. Les notes de dépenses enregistrées en Brouillon ou en attente de validation sont affichées
3. Lutilisateur peut consulter des notes de dépense spécifiques : si tel est le cas, il est renvoyé sur les IHM des notes quil souhaite consulter
[ ] ==**GESTION DUNE NOTE DE DÉPENSE**==
Les dépenses sont séparées en deux sections : les frais liés au fonctionnement de lenseigne (Frais) et les frais liés directement à lactivité auprès des clients (Achats)
Elles comprennent :
- les dépenses Frais et Achats : la date, le type de dépense, la description, le montant HT, le montant TVA, le total TTC
- les dépenses kilométriques : la date, le type, la prestation, le départ, larrivée, le nombre de kilomètres à indemniser
Seules les dépenses liées au fonctionnement de l'enseigne sont développées/gérées dans cette première étape
Lorsque l'utilisateur sélectionne une note de dépense spécifique il est redirigé vers l'IHM de la note
Cela permet d'assurer le suivi de :
- létat de la note de dépense
- les justificatifs présents ou non
- les commentaires enregistrés (incluant : son contenu, le nom de son auteur et sa date denvoi)
- les dépenses liées à la note
Scénario:
1. Un utilisateur actif veut consulter une note de dépenses spécifique : il se rend sur l'IHM de l'Accueil et sélectionne la note de dépense quil souhaite consulter
2. Le système affiche lensemble des informations de la note de dépense
[ ] ==**CRÉER UNE NOTES DE DÉPENSES**==
Scénario:
1. Un utilisateur actif veut créer une note de dépenses : il se rend sur lIHM de l'Accueil et clique le bouton dajout
2. Lutilisateur doit préciser le mois et lannée (le mois et l'année de la date du jour sont proposés par défaut)
3. Lutilisateur peut choisir dannuler ou valider son action
Une note de dépense (Expense) est rattachée à une feuille de note de dépense (ExpenseSheet) qui est rattachée à un compte utilisateur (User) et une enseigne (Company)
Il faut donc créer une note de dépense dans une feuille de note de dépense qui doit être créée si elle n'existe pas encore
Une fois la note créée, elle est automatiquement enregistrée en tant que Brouillon
[ ] ==**AJOUTER UNE DÉPENSE DE FRAIS (fonctionnement de l'enseigne)**==
Scénario:
1. Un utilisateur actif veut ajouter une dépense de frais : il se rend sur lIHM de l'Accueil, sélectionne la note dans laquelle il souhaite ajouter une dépense -> il est redirigé sur lIHM de la note spécifique puis clique sur le bouton dajout
2. Lutilisateur peut remplir un formulaire de frais généraux avec les informations nécessaires
3. Lutilisateur peut remplir un formulaire de frais téléphoniques avec les informations nécessaires
4. Lutilisateur peut choisir denregistrer ou dannuler les dépenses ajoutées
- les informations pour le formulaire de frais généraux sont : la date*, la catégorie, le type de frais*, la description, le montant HT* et le montant TVA*
- Les informations pour le formulaire de frais téléphoniques sont : la date*, le type de frais*, le montant HT* et le montant TVA*
(* = Les informations obligatoires pour la validation des formulaires)
Si plusieurs taux de TVA doivent être renseignés alors le montant total doit être précisé
Si la TVA nest pas déductible : la valeur TTC doit être renseignée dans le montant HT et mettre 0 dans le montant TVA
Ces dépenses peut être ajoutées seulement si la note est enregistrée en Brouillon
[ ] ==**MODIFIER UNE DÉPENSE DE FRAIS (fonctionnement de l'enseigne)**==
Scénario:
1. Un utilisateur actif veut modifier une dépense de frais : il se rend sur lIHM de l'Accueil, sélectionne la note dans laquelle il souhaite modifier une dépense -> il est redirigé sur lIHM de la note spécifique puis clique sur le bouton de modification
2. Lutilisateur peut remplir un formulaire de frais généraux (prérempli des informations courantes) avec les informations nécessaires
3. Lutilisateur peut remplir un formulaire de frais téléphoniques (prérempli des informations courantes) avec les informations nécessaires
4. Lutilisateur peut choisir denregistrer ou dannuler la dépense modifiée
- les informations pour le formulaire de frais généraux sont : la date*, la catégorie, le type de frais*, la description, le montant HT* et le montant TVA*
- Les informations pour le formulaire de frais téléphoniques sont : la date*, le type de frais*, le montant HT* et le montant TVA*
(* = Les informations obligatoires pour la validation des formulaires)
Si plusieurs taux de TVA doivent être renseignés alors le montant total doit être précisé
Si la TVA nest pas déductible : la valeur TTC doit être renseignée dans le montant HT et mettre 0 dans le montant TVA
Ces dépenses peuvent être modifiées seulement si la note est enregistrée en Brouillon
[ ] ==**AJOUTER UNE DÉPENSE KILOMÉTRIQUE (fonctionnement de l'enseigne)**==
Scénario:
1. Un utilisateur actif veut ajouter une dépense kilométrique : il se rend sur lIHM de l'Accueil, sélectionne la note dans laquelle il souhaite ajouter une dépense -> il est redirigé sur lIHM de la note spécifique puis clique sur le bouton d'ajout
2. Lutilisateur rempli un formulaire de dépense kilométrique avec les informations nécessaires
3. Lutilisateur peut choisir denregistrer ou dannuler la dépense
- les informations pour le formulaire sont : la date*, la catégorie, le type de frais*, le point de départ*, le point darrivée*, la prestation, le nombre de kilomètres*
(* = Les informations obligatoires pour la validation du formulaire)
Cette dépense peut être ajoutée seulement si la note est enregistrée en Brouillon
[ ] ==**MODIFIER UNE DÉPENSE KILOMÉTRIQUE (fonctionnement de l'enseigne)**==
Scénario:
1. Un utilisateur actif veut modifier une dépense kilométrique : il se rend sur lIHM de l'Accueil, sélectionne la note dans laquelle il souhaite modifier la dépense -> il est redirigé sur lIHM de la note spécifique puis clique sur le bouton de modification
2. Lutilisateur peut remplir un formulaire de dépense kilométrique (prérempli des informations courantes) avec les informations nécessaires
3. Lutilisateur peut choisir denregistrer ou dannuler la dépense modifiée.
- les informations pour le formulaire sont : la date*, la catégorie, le type de frais*, le point de départ*, le point darrivée*, la prestation, le nombre de kilomètres*
(* = Les informations obligatoires pour la validation du formulaire)
Cette dépense peut être modifiée seulement si la note est enregistrée en Brouillon
[ ] ==**SUPPRIMER UNE DÉPENSE**==
Scénario:
1. Un utilisateur actif veut supprimer une dépense : il se rend sur lIHM de l'Accueil, sélectionne la note dans laquelle il souhaite supprimer une dépense -> il est redirigé sur lIHM de la note spécifique et clique sur le bouton de suppression
2. Le système ouvre une pop-up pour sassurer que lutilisateur souhaite supprimer la dépense
3. Lutilisateur peut choisir de valider ou dannuler la suppression
Une dépense peut être supprimée seulement si la note de dépenses est enregistrée en Brouillon
[ ] ==**ENREGISTRER UNE NOTE DE DÉPENSE**==
Scénario:
1. Un utilisateur actif souhaite enregistrer une note de dépenses : il se rend sur lIHM de l'Accueil, sélectionne la note sur laquelle il souhaite faire lenregistrement -> il est redirigé sur lIHM de la note spécifique et clique sur le bouton d'enregistrement
2. Lutilisateur remplis un formulaire avec les informations nécessaires (les commentaires ne sont pas obligatoires)
3. Lutilisateur peut choisir de valider ou dannuler son action
Seules les note de dépense à l'état Brouillon peuvent être enregistrées
Les commentaires seront accessibles via l'IHM de l'Accueil une fois enregistrés
[ ] ==**SUPPRIMER UNE NOTE DE DÉPENSE**==
Scénario:
1. Un utilisateur actif veut supprimer une note de dépense : il se rend sur lIHM de l'Accueil, sélectionne la note qu'il souhaite supprimer -> il est redirigé sur lIHM de la note spécifique puis clique sur le bouton de suppression
2. Le système ouvre une pop-up pour sassurer que lutilisateur souhaite bien supprimer la note
3. Lutilisateur peut choisir de valider ou annuler la suppression
Seules les note de dépenses à l'état Brouillon peuvent être supprimées
Si la note est en demande de validation, lutilisateur peut la réenregistrer en tant que Brouillon
Cette action annulera automatiquement la demande de validation et passera la note à létat de Brouillon
[ ] ==**DEMANDER LA VALIDATION DUNE NOTE DE DÉPENSE**==
Scénario:
1. Un utilisateur actif veut demander la validation dune note de dépense : il se rend sur lIHM de l'Accueil, sélectionne la note dans laquelle il souhaite demander la validation -> il est redirigé sur lIHM de la note spécifique puis clique sur le bouton de demande
2. Lutilisateur rempli un formulaire de demande de validation (les commentaires ne sont pas obligatoires)
3. Lutilisateur peut choisir de valider ou dannuler sa demande
Lutilisateur ne peut pas valider ou invalider sa demande : seul ladministrateur applique ces actions
Les notes de dépenses possèdent dautres états mais ils ne sont pas gérés dans lapplication
----------
## ETAPE 2
[ ] ==**JOINDRE UN JUSTIFICATIF A UNE NOTE DE DÉPENSE**==
Scénario:
1. Un utilisateur actif veut ajouter un justificatif à une note de dépense : il se rend sur lIHM de l'Accueil, sélectionne la note dans laquelle il souhaite ajouter un justificatif -> il est redirigé sur lIHM de la note spécifique, va dans la zone des justificatifs puis clique sur le bouton dajout
2. Lutilisateur rempli un formulaire avec les informations nécessaires
3. Lutilisateur peut choisir de valider ou annuler son action
- les informations nécessaires pour le formulaire de justificatif sont : le type du document*, le choix du fichier (en local)* et sa description*
(* = Les informations obligatoires pour la validation du formulaire)
La description par défaut est le nom du fichier
Un justificatif peut être joint peu importe létat de la note de dépense
[ ] ==**SUPPRIMER UN JUSTIFICATIF DUNE NOTE DE DÉPENSE**==
Scénario:
1. Un utilisateur actif veut supprimer un justificatif dune note de dépense : il se rend sur lIHM de l'Accueil, sélectionne la note dans laquelle il souhaite supprimer un justificatif -> il est redirigé sur lIHM de la note spécifique, va dans la zone des justificatifs, sélectionne le fichier et clique sur le bouton de suppression
2. Le système affiche une fenêtre avec les informations du fichier (sa description, son nom, sa taille, la date de son dépôt et la date de sa dernière modification) pour sassurer que lutilisateur souhaite bien supprimer le justificatif
3. Lutilisateur peut choisir de valider ou dannuler la suppression
Un justificatif peut être supprimé peu importe létat de la note de dépense
[ ] ==**MODIFIER UN JUSTIFICATIF DUNE NOTE DE DÉPENSE**==
Scénario:
1. Un utilisateur actif veut modifier un justificatif dune note de dépense : il se rend sur lIHM de l'Accueil, sélectionne la note dans laquelle il souhaite modifier un justificatif -> il est redirigé sur lIHM de la note spécifique, va dans la zone des justificatifs, sélectionne le fichier et clique sur le bouton de modification
2. Le système affiche une fenêtre avec les informations du fichier (sa description, son nom, sa taille, la date de son dépôt et la date de sa dernière modification)
3. Lutilisateur rempli un formulaire (prérempli des informations courantes, dont le fichier) avec les informations nécessaires
4. Lutilisateur peut choisir de valider ou non sa modification
- les informations nécessaires pour le formulaire de justificatif sont : le type du document*, le choix du fichier (en local)* et sa description*
(* = Les informations obligatoires pour la validation du formulaire)
La description par défaut est le nom du fichier
Un justificatif peut être modifié peu importe létat de la note de dépense
[ ] ==**GÉNÉRER UNE DÉPENSE GRÂCE A L'OCR**==
Scénario:
1. Un utilisateur actif veut générer une dépense grâce à l'OCR : il se rend sur lIHM de l'Accueil et selectionne la note dans laquelle il souhaite générer une dépense -> il est redirigé sur lIHM de la note spécifique et clique sur le bouton de génération
2. Lutilisateur peut choisir de générer une dépense à partir dune photo existante ou de prendre une photo directement
3. Le système OCR analyse les données à partir de la photo et calcule automatiquement les taux
4. Le système ouvre un formulaire prérempli des informations courantes
5. Lutilisateur peut choisir de modifier le formulaire, valider ou annuler
[ ] ==**AJOUTER UNE DÉPENSE DACHATS CONCERNANT LACTIVITÉ AUPRÈS DES CLIENTS**==
Scénario:
1. Un utilisateur actif veut ajouter une dépense liées au client : il se rend sur lIHM de l'Accueil, sélectionne la note dans laquelle il souhaite ajouter une dépense -> il est redirigé sur lIHM de la note spécifique puis clique sur le bouton dajout
2. Lutilisateur peut remplir un formulaire de frais généraux avec les informations nécessaires
3. Lutilisateur peut remplir un formulaire de frais téléphoniques avec les informations nécessaires
4. Lutilisateur peut choisir denregistrer ou dannuler la dépense
- les informations pour le formulaire de frais généraux sont : la date*, la catégorie, le type de frais*, la description, le montant HT* et le montant TVA*, le client concerné
- Les informations pour le formulaire de frais téléphoniques sont : la date*, le type de frais*, le montant HT* et le montant TVA*, le client concerné
(* = Les informations obligatoires pour la validation des formulaires)
Si plusieurs taux de TVA doivent être renseignés alors le montant total doit être précisé
Si la TVA nest pas déductible : la valeur TTC doit être renseignée dans le montant HT et mettre 0 dans le montant TVA
Ces dépense peuvent être ajoutées seulement si la note est enregistrée en Brouillon
[ ] ==**MODIFIER UNE DÉPENSE DACHATS CONCERNANT LACTIVITÉ AUPRÈS DES CLIENTS**==
Scénario:
1. Un utilisateur actif veut modifier une dépense liées au client : il se rend sur lIHM de l'Accueil, sélectionne la note dans laquelle il souhaite ajouter une dépense -> il est redirigé sur lIHM de la note spécifique puis clique sur le bouton de modification
2. Lutilisateur peut remplir un formulaire de frais généraux (prérempli des informations courantes) avec les informations nécessaires
3. Lutilisateur peut remplir un formulaire de frais téléphoniques (prérempli des informations courantes) avec les informations nécessaires
4. Lutilisateur peut choisir denregistrer ou dannuler la dépense modifiée
- les informations pour le formulaire de frais généraux sont : la date*, la catégorie, le type de frais*, la description, le montant HT* et le montant TVA*, le client concerné
- Les informations pour le formulaire de frais téléphoniques sont : la date*, le type de frais*, le montant HT* et le montant TVA*, le client concerné
(* = Les informations obligatoires pour la validation des formulaires)
Si plusieurs taux de TVA doivent être renseignés alors le montant total doit être précisé
Si la TVA nest pas déductible : la valeur TTC doit être renseignée dans le montant HT et mettre 0 dans le montant TVA
Ces dépenses peuvent être modifiées seulement si la note est enregistrée en Brouillon
[ ] ==**AJOUTER UNE DÉPENSE KILOMÉTRIQUE CONCERNANT LACTIVITÉ AUPRÈS DES CLIENTS**==
Scénario:
1. Un utilisateur actif veutajouter une dépense kilométrique : il se rend sur lIHM de l'Accueil, sélectionne la note dans laquelle il souhaite modifier une dépense -> il est redirigé sur lIHM de la note spécifique puis clique sur le bouton d'ajout
2. Lutilisateur rempli un formulaire de dépense kilométrique avec les informations nécessaires
3. Lutilisateur peut choisir denregistrer ou dannuler la dépense
- les informations pour le formulaire sont : la date*, la catégorie, le type de frais*, le point de départ*, le point darrivée*, la prestation, le nombre de kilomètres*, le client concernée
(* = Les informations obligatoires pour la validation du formulaire)
Cette dépense peut être ajoutée seulement si la note est enregistrée en Brouillon
[ ] ==**MODIFIER UNE DÉPENSE KILOMÉTRIQUE CONCERNANT LACTIVITÉ AUPRÈS DES CLIENTS**==
Scénario:
1. Un utilisateur actif veut modifier une dépense kilométrique liée au client : il se rend sur lIHM de l'Accueil, sélectionne la note dans laquelle il souhaite modifier une dépense -> il est redirigé sur lIHM de la note spécifique puis clique sur le bouton de modification
2. Lutilisateur peut remplir un formulaire de dépense kilométrique (prérempli des informations courantes) avec les informations nécessaires
3. Lutilisateur peut choisir denregistrer ou dannuler la dépense modifiée.
- les informations pour le formulaire sont : la date*, la catégorie, le type de frais*, le point de départ*, le point darrivée*, la prestation, le nombre de kilomètres*, le client concernée
(* = Les informations obligatoires pour la validation du formulaire)
Cette dépense peut être modifiée seulement si la note est enregistrée en Brouillon
[ ] ==**DUPLIQUER UNE DÉPENSE**==
Scénario:
1. Un utilisateur actif veut dupliquer une dépense : il se rend sur lIHM de l'Accueil, sélectionne la note dans laquelle il souhaite dupliquer une dépense -> il est redirigé sur lIHM de la note spécifique et clique sur le bouton pour dupliquer
2. Lutilisateur précise dans un formulaire dans quelle note de dépenses la dépense doit être dupliquée : seules les notes de dépenses enregistrées en Brouillon peuvent être sélectionnées (la note courante est sélectionnée par défaut)
3. Lutilisateur peut choisir de valider ou dannuler la duplication
Lorsque lutilisateur précise dans quelle note de dépenses la dépense doit être dupliquée, les montants HT et TVA de la dépense sont renseignés
Une dépense peut être dupliquée seulement si la note de dépense est enregistrée en Brouillon
[ ] ==**DUPLIQUER UNE NOTE DE DÉPENSE**==
Scénario:
1. Un utilisateur actif souhaite dupliquer une note de dépense : il se rend sur lIHM de l'Accueil, sélectionne la note qu'il souhaite dupliquer puis clique sur le bouton de duplication
2. Lutilisateur précise le mois et lannée
3. Lutilisateur peut choisir de valider ou dannuler la duplication
Une note de dépense peut être dupliquée peu importe son état et la copie est automatiquement enregistrée en Brouillon