Docs lettering (#129)

* docs(lettering): add lettering page - WIP * docs(lettering): ajout des pages 'lettering' et 'next lettering value'
MyUnisoft · Feb 14, 2025 · 173c7a0 · 173c7a0
1 parent a4d8b57
commit 173c7a0
Show file tree

Hide file tree

Showing 5 changed files with 112 additions and 0 deletions.
diff --git a/docs/accounting/folder/account/lettering.md b/docs/accounting/folder/account/lettering.md
@@ -0,0 +1,64 @@
+---
+prev:
+  text: 🐤 Introduction
+  link: documentation.md
+next: false
+---
+
+# Lettrer les mouvements d'un compte
+
+Ce guide va acompagner dans l'opération de lettrage des mouvements d'un compte.
+
+Dans MyUnisoft, vous pouvez lettrer les mouvements d'un compte afin de déterminer l'origine de son solde depuis : `Tenue` > `Saisie/Consultation` >`Consultation`.
+
+![](../../../images/tenue_consultation_menu.png)
+
+Vous obtenez la page de consultation du compte avec les boutons d'actions permettant de lettrer ou délettrer des écritures.
+
+![](../../../images/consultation_lettrage.png)
+
+## API
+
+La route https://api.myunisoft.fr/api/v1/entry/lettering permet de lettrer des mouvements avec l'API partenaires.
+
+```bash
+curl --location --request PUT 'https://api.myunisoft.fr/api/v1/entry/lettering' \
+--header 'X-Third-Party-Secret: nompartenaire-L8vlKfjJ5y7zwFj2J49xo53V' \
+--header 'Society-id: 1' \
+--header 'Content-Type: application/json' \
+--header 'Authorization: Bearer {{API_TOKEN}}' \
+--data '{
+    "lettering": "AAA",
+    "line_entry_list": [
+        {
+            "line_entry_id": 123456789
+        },
+        {
+            "line_entry_id": 987654321
+        }
+    ]
+}'
+```
+
+> [!IMPORTANT]
+> Penser à préciser l'en-tête **society-id** si vous utilisez un 🔹 Accès cabinet.
+
+Il sera nécessaire de renseigner dans le body les paramètres de requête suivants :
+
+| paramètre | decription |
+| --- | --- |
+| `lettering` | le code lettrage à appliquer aux lignes que vous souhaiter lettrer.<br> Pour déterminer la valeur, vous devez utiliser le endpoint  vous pouvez consulter [Récupérer la prochaine valeur de lettrage](./next_lettering_value.md) |
+| `line_entry_list` | Un tableau composé des `entry_line_id` des écritures que vous souhaitez lettrer<br> Pour récupérer les id des écritures vous pouvez consulter [Récupérer les mouvements comptables](../../../MAD/api/movements.md) |
+
+<details class="details custom-block"><summary>Retour JSON de l'API</summary>
+
+```json
+{
+    "code": "Success",
+    "message": ""
+}
+```
+
+</details>
+
+<p align="right">(<a href="#readme-top">retour en haut de page</a>)</p>
diff --git a/docs/accounting/folder/account/next_lettering_value.md b/docs/accounting/folder/account/next_lettering_value.md
@@ -0,0 +1,46 @@
+---
+prev:
+  text: 🐤 Introduction
+  link: documentation.md
+next: false
+---
+
+# Récupérer la prochaine valeur de lettrage d'un compte
+
+Dans MyUnisoft, pour vous permettre de lettrer des mouvements comptables par le biais de l'API, vous devrez renseigner entre autres la propriété **lettering**.
+La valeur de cette propriété est automatiquement calculée via le endpoint `/next_lettering`.
+
+Ce guide va vous accompagner pour vous peremettre de récupérer la prochaine valeur de lettrage d'un compte en exploitant ce endpoint.
+
+## API
+
+La route https://api.myunisoft.fr/api/v1/account/next_lettering permet d'obtenir la prochaine valeur de lettrage d'un compte avec l'API partenaires.
+
+```bash
+curl --location 'https://api.myunisoft.fr/api/v1/account/next_lettering?account_id=24208754&partial=false' \
+--header 'X-Third-Party-Secret: nompartenaire-L8vlKfjJ5y7zwFj2J49xo53V' \
+--header 'Society-id: 1' \
+--header 'Authorization: Bearer {{API_TOKEN}}'
+```
+
+> [!IMPORTANT]
+> Penser à préciser l'en-tête **society-id** si vous utilisez un 🔹 Accès cabinet.
+
+Il sera nécessaire de renseigner les paramères de requête suivants : 
+
+| paramètre | decription |
+| --- | --- |
+| `account_id` | l'identifiant du compte relatif aux lignes d'écritures que vous souhaitez lettrer.<br> Pour récupérer le liste des comptes du dossier [Récupérer la liste des comptes du dossier](../../../MAD/api/account.md) |
+| `partial` | ce paramètre permet de spécifier si vous souhaitez un lettrage complet `partial = false` (lorsque la balance "débit/crédit" des écritures est soldée), ou un lettrage partiel `partial = true` (lorsque la balance "débit/crédit" des écritures n'est pas soldée. Exemple : une facture réglée par échéancier) |
+
+<details class="details custom-block"><summary>Retour JSON de l'API</summary>
+
+```json
+{
+    "next_lettering": "AAA"
+}
+```
+
+</details>
+
+<p align="right">(<a href="#readme-top">retour en haut de page</a>)</p>
diff --git a/docs/documentation.md b/docs/documentation.md
@@ -138,6 +138,8 @@ Une liste de guides qui pourront certainement vous aider dans la réalisation de
   - [Mise à jour de la liste de contacts d'un compte client ou fournisseur](./accounting/folder/account/update_contact.md)
   - [Mise à jour complète d'un compte client ou fournisseur](./accounting/folder/account/update.md)
 - [Récupération et/ou création d'un compte](./accounting/folder/account/create.md)
+- [Lettrer les mouvements d'un compte](./accounting/folder/account/lettering.md)
+  - [Récupérer la prochaine valeur de lettrage d'un compte](./accounting/folder/account/next_lettering_value.md)
 - [Gérer l'analytique d'une société (dossier)](./accounting/folder/analytique.md)
 - [Récupération des données liées aux widgets et dashboards](./accounting/folder/dashboard.md)
 - [Récupération des dossiers de révision et des modèles de dossier](./accounting/folder/dossiers_de_révision.md)

diff --git a/docs/images/consultation_lettrage.png b/docs/images/consultation_lettrage.png
diff --git a/docs/images/tenue_consultation_menu.png b/docs/images/tenue_consultation_menu.png