Ventilation Analytique

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

Cette API permet de modifier l’affection ou la ventilation analytique d’une écriture comptable

• Modification

PUT/VentilationAnalytique

Description

Lien vers la documentation technique

Cas d'usage

• Modifier l'affection analytique d'une écriture comptable qui est affectée à une section par défaut par exemple.
• Modifier la ventilation existante d'une écriture comptable

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.

• Vérifier l'existence de l'Axe Analytique en utilisant l'API "GET /axe?codeDossier={codeDossier}"
  https://developers.cegid.com/docreference/BusinessUnits/Loop-Api-Management-Docs/AxeParameter.html

• Vérifier l'existence de la Section Analytique en utilisant l'API "GET /section?codeDossier={codeDossier}"
  https://developers.cegid.com/docreference/BusinessUnits/Loop-Api-Management-Docs/ParametreAnalytique.html

Procédure

Il faut appeler un endpoint :

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

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
ligneId	string($uuid)	ID (UUID) Code unique	Oui
codeAxe	string	code l'Axe	Oui
codeSection	string	code de la Section	Oui
debit / credit	string	montant à ventiller	Oui

Exemple de body

[
    {
        "idLigne": "56218e10-5952-4dd2-902e-da1c5a06b4ea",
        "ventilation": [
            {
                "codeAxe": "Axe",
                "ventilationSection": [
                    {
                        "codeSection": "00001",
                        "debit": 900,
                        "credit": 0
                    }
                ]
            }
        ]
    }
]

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

Example response

{
    "message": "Mise à jour effectuée avec succès"
}