Modification du Lettrage

Présentation générale de l'API et finalité fonctionnelle

Cette API permet de lettrer un paquet d’écritures non lettrées ou d’ajouter des écritures à un paquet existant dans Cegid Loop :

• Modification

PUT/Lettrage

Description

Lien vers la documentation technique

Cas d'usage

• Lettrer un paquet d'écritures dont le solde total est à Zéro
• ajouter de nouvelles écritures à un paquet d'écritures déja lettré afin que l'ensemble ait le même code lettrage

Points d'attention

Avant d'appeler cette API, utilisez l'API "GET/EcrituresComptables" afin de recupérer le champs "ligneId" et "revisionId".

Exemple : codeLettrage == null && reference== "94122" && tiersCode== "00086200"

Assurez-vous d'avoir la dernière version de la valeur de revisionId.
En effet, la valeur de ce champ est incrémentée à chaque mise à jour.

Procédure

Il faut appeler un endpoint :

https://api.cegid.com/loop-api-publiques/Lettrage?codeDossier={codeDossier}

Route	Méthode http	Description
/API	PUT	Lettre/Modifie le lettrage de la ligne

Paramétrage de l’appel

Méthode http pour la demande : PUT

Header(s) attendu(s) obligatoire(s) de la demande

Champ	Description
Ocp-Apim-Subscription-Key	Subscription key
x-apikey	API Key & Secret

Paramètres de la demande

Champ	Description	obligatoire
codeDossier	Nom du dossier	Oui

Champ	Type	Description	Obligatoire
objectId	string($uuid)	ID (UUID) Code unique	Oui
revisionId	string($uuid)	ID (UUID) de la révision	Oui
codeLettrage	string($uuid)	ID (UUID) Code unique	Non => pour un lettrage / Oui => pour mis à jour d'un paquet déja lettré)
lignes	string($uuid)	ID (UUID) Code unique	Oui => au moins 2 UUID

Exemple de body

[
  {
    "objectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "revisionId": "string",
    "codeLettrage": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "lignes":  ["4c95abb0-a818-46dc-9627-b4e2c4517e9f","8edb4de7-d3e5-4360-8015-ae05a38246c0"]
  }
]

Code retour

En cas de succès

Code retour http de la réponse : 200

En cas de d'échec

Lien vers la liste des codes d'erreur

Exemple de message d'erreur :

• PUT request rejected: Ligne lettrée
• PUT request rejected: L'identifiant des Lignes ne sont pas des UUID
• PUT request rejected: Ligne non trouvée

Structure du retour

Format du retour

Champ	Type	Description
message	string	exemple : Mise à jour effectué avec succès
codeLettrage	string($uuid)	UUID du code lettrage

| Exemple de retour

{
   "message": "Mise à jour effectuée avec succès",
    "codeLettrage": [
        "7f1a0b18-55ca-4d6d-a077-ce937daf904b"
    ]
}