La route attend dans le chemin une valeur pour la variable comment_id qui correspond à l'id du commentaire que vous souhaitez modifier. Pour récupérer cet id vous pouvez utiliser l'api MAD et son endpoint GET comments.
Vous devez également fournir un body JSON contenant les propriétés suivantes avec les nouvelles valeurs :
LABEL
TYPE
REQUIS
DESCRIPTION
location
"ENTRIES"
✔️
cible le type parent auquel le commentaire est rattaché
entry_id
number
✔️
L'id de l'écriture auquel le commentaire est rattaché Pour récupérer les écritures d'un dossier comptable vous pouvez utiliser MAD Get entries
comment
string
✔️
Le nouveau commentaire destiné à remplacer l'actuel
La route attend dans le chemin une valeur pour la variable comment_id qui correspond à l'id du commentaire que vous souhaitez modifier. Pour récupérer cet id vous pouvez utiliser l'api MAD et son endpoint GET comments.
Une fois la requête exécutée avec succès, l'API vous retournera en réponse un booléentrue.
Ajouter, modifier, supprimer un commentaire à une écriture comptable
Ajout d'un commentaire à une écriture comptable
Dans MyUnisoft, les écritures comptables sont composées de plusieurs élèments dont les commentaires.
Pour ajouter un commentaire à une écriture comptable, vous pouvez utiliser la route :
https://api.myunisoft.fr/api/v1/entry/comment
.IMPORTANT
Penser à préciser l'en-tête society-id obligatoire.
Paramètres d'ajout d'un commentaire
La route attend un body JSON contenant les propriétés suivantes :
Pour récupérer les écritures d'un dossier comptable vous pouvez utiliser MAD Get entries
Interface TypeScript Commentaire
Une fois la requête exécutée avec succès, l'API vous retournera une réponse au format JSON :
Retour JSON de l'API
Modification d'un commentaire d'une écriture comptable
Pour modifier le commentaire d'une écriture comptable, vous pouvez utiliser la route :
https://api.myunisoft.fr/api/v1/entry/comment/:comment_id
.IMPORTANT
Penser à préciser l'en-tête society-id obligatoire pour les accès cabinet.
Paramètres de mise à jour d'un commentaire
La route attend dans le chemin une valeur pour la variable
comment_id
qui correspond à l'id
du commentaire que vous souhaitez modifier. Pour récupérer cetid
vous pouvez utiliser l'api MAD et son endpoint GET comments.Vous devez également fournir un body JSON contenant les propriétés suivantes avec les nouvelles valeurs :
type parent
auquel le commentaire est rattachéPour récupérer les écritures d'un dossier comptable vous pouvez utiliser MAD Get entries
Interface TypeScript Commentaire
Une fois la requête exécutée avec succès, l'API vous retournera une réponse au format JSON :
Retour JSON de l'API
Suppression d'un commentaire d'une écriture comptable
Pour supprimer le commentaire d'une écriture comptable, vous pouvez utiliser la route :
https://api.myunisoft.fr/api/v1/entry/comment/:comment_id
.IMPORTANT
Penser à préciser l'en-tête society-id obligatoire pour les accès cabinet.
Paramètres de suppression d'un commentaire
La route attend dans le chemin une valeur pour la variable
comment_id
qui correspond à l'id
du commentaire que vous souhaitez modifier. Pour récupérer cetid
vous pouvez utiliser l'api MAD et son endpoint GET comments.Une fois la requête exécutée avec succès, l'API vous retournera en réponse un booléen
true
.