Skip to content

Commit

Permalink
#22, improve documentation on invoices, take new development on invoi…
Browse files Browse the repository at this point in the history
…ce section into account
  • Loading branch information
Vincent Doba committed Jan 2, 2015
1 parent 84e6c7a commit dbdcf5c
Show file tree
Hide file tree
Showing 3 changed files with 56 additions and 11 deletions.
67 changes: 56 additions & 11 deletions doc/Documentation-fr.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,26 +30,59 @@ On peut voir les liens suivants dans la barre de menu au-dessus :

### Factures

Sur la page des factures, il existe 4 onglets :
* **Liste des factures**, qui liste toutes les factures
* **Créer une facture**, permettant de créer une facture
* **En retard de paiement**, listant toutes les factures en retard de paiement
* **Numérotation**, permettant d'administrer la numérotation des factures

#### Liste des factures

![Factures](/doc/images/invoice.png?raw=true "liste des factures")

La page factures s'ouvre sur la liste des factures non affectées. On peut voir :
* le nom et le numéro de la facture dans la colonne "project"
La page factures s'ouvre sur la liste des factures. On peut voir :
* le nom, le numéro, le client et les montant Hors Taxe et avec TVA de la facture dans la colonne "project"
* l'historique des status de la facture dans la colonne "status"
* les actions possibles sur la factures dans la colonne "actions"

Les actions disponibles sur la facture sont au nombre de trois :
* Voir la facture : récupérer le fichier PDF de la facture
* Affecter la facture : lier la facture à un membre LT, le status de la facture passera alors soit à "en cours de paiement", soit à "payé"
Il existe des filtres sur les factures :
* Filtre sur l'éditeur, c'est à dire celui qui a créé la facture
* Filtre sur le client, c'est l'entité qui doit payer la facture
* Filtre sur les status de la facture, qui sont détaillés ci-dessous

Les actions disponibles sur la facture sont au nombre de cinq :
* Afficher la facture (PDF) : affiche le fichier PDF de la facture dans un modal
* Affecter la facture : lier la facture à un budget (appartenant à un membre LT), le status de la facture passera alors à "Affectée"
* Réaffecter la facture : lier la facture à un budget (appartenant à un membre LT), le status de la facture ne change pas
* Le paiement a échoué : annule le paiement, le status de la facture passera alors à "Affectée"
* Annuler la facture : Annule la facture. Dans ce cas le PDF de la facture sera barré avec un filigrane "ANNULÉE" et le status de la facture sera annulée.

Pour plus de détail sur les changement de status, voir la section "Status de la facture" ci-dessous

##### Status de la facture

Les factures ont 4 status qui sont les suivants :
* Créée (Created) : la facture est créée, c'est le premier status
* Affectée (Allocated) : la facture a été affectée à un budget
* Payée (Paid) : la facture a été payée
* Annulée (Canceled) : la facture a été annulée

À ces 4 status de base s'ajoute deux metastatus qui sont :
* En cours (In Progress) : la facture est soit créée, soit affectée
* Terminée (Finished) : la facture est soit payée, soit annulée

Les changement de status sont explicités sur le schéma suivant :

![Status](/doc/images/statuses.png?raw=true "Schéma des status")



#### Créer une facture

![Factures](/doc/images/invoice_create.png?raw=true "création d'une facture")

La page de création de facture permet de créer une facture. Pour cela il faut remplir les champs de formulaire :
* Numéro de la facture : le numéro de la facture, par exemple VT201
* Numéro de la facture : le numéro de la facture, par exemple VT201. Ce champ n'est pas modifiable. Pour le modifier, voir la section "Numérotation"
* Titre de la facture : le titre de la facture, par exemple "Jean Dubois Octobre 2014" ou "Formation MongoDB 21-22 avril 2014"
* Avec ou sans taxes : si le client doit payer la TVA (cela dépend de la culture du pays du client).
* Client : la personne physique ou morale qui paiera la facture. Peut-être recherché si le client a déjà été enregistré, sinon il est possible de compléter les informations clients "one shot".
Expand All @@ -60,13 +93,21 @@ Pour les lignes de facturation :
* TJM : le tarif journalier de la prestation en euros hors taxe
* TVA : la TVA, par défaut 20%

On peut également cocher ou décocher la case "Uploader la facture dans le système". Si cette case est décoché, cela veut dire
que la facture ne sera pas enregistrée dans mongo et ne sera pas envoyée sur le drive. Il ne faut décocher la case que si
vous souhaitez faire des tests de génération de facture.
En cliquant sur le bouton "Générer la facture et upload" vous serez redirigé vers la page listant les factures avec un modal ouvert sur le fichier PDF de la facture.

#### En retard de paiement

Page listant toutes les factures en retard de paiement.

En cliquant sur le bouton "Générer la facture et upload" (ou seulement "générer la facture") vous serez redirigé vers
le fichier PDF de la facture.
#### Numérotation

Page permettant d'administrer la numérotation des factures. Sur cette page on peut :
* Voir le numéro actuelle de la facture
* Incrémenter ce numéro
* Réinitialiser ce numéro

Attention, dans le cadre de l'utilisation normal de l'application, il n'est pas nécessaire de réinitialiser les numéros
de factures. Si vous avez raté l'édition d'une facture, il faut l'annuler et recréer une facture avec le numéro suivant

Glossaire
------
Expand All @@ -86,6 +127,10 @@ Une facture est une rentrée d'argent pour LT. Une facture est émise de LT vers
c'est sur son compte que sera versé l'argent gagné lors du paiement de la facture. Une facture peut être non-affectée,
en cours de payment, payée ou annulée.

#### Éditeur

La personne qui a créée la facture

### Activité

Une activité est le compte rendu d'un travail de prestation effectué chez un client. À partir d'une activité on peut générer
Expand Down
Binary file modified doc/images/invoice_create.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/images/statuses.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit dbdcf5c

Please sign in to comment.