Paramétrage des codes TVA

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

Ces API permettent d'interagir sur le paramétrage des codes TVA de Cegid Loop :

GET/tva

Cette API retourne la liste du plan des codes TVA.

Lien vers la documentation technique

Cas d'usage

Cette API permet de retourner toute la liste des codes TVA d'un dossier client au sein du cabinet.
Elle permet également de retourner un échantillon de codes TVA grâce à ses paramètres (Cf. § Paramètres de la demande).

Procédure

Il faut appeler un endpoint permettant de lister les codes TVA :

https://api.cegid.com/loop-api-publiques/tva?codeDossier={codeDossier}[&filter][&sort][&skip][&take]

Route	Méthode http	Description
/tva	GET	Retourne la liste des codes TVA

Paramétrage de l’appel

Méthode http pour la demande : GET

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	Valeur à renseigner : Code dossier	Oui
filter	Permet de filtrer le resultat	Non
sort	Trie le résultat	Non
skip	Saute X dossiers	Non
take	Retourne X dossiers	Non
select	Retourne seulement les champs mentionnés	Non

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

Structure du retour

Format du retour

L'API retourne une liste d'objet TVA au format suivant :

Champ	Type	Description
objectId	string($uuid)	ID (UUID) Code unique
revisionId	string($uuid)	ID (UUID) de la révision
code	string	code du tva
description	string	Libelllé du tva
regime	string	{Normal:1,Exonéré:2,Autoliquidation biens Intra-communautaire:3, Autoliquidation prestations Intra-communautaire:8,Export:4,Corse:5,DOM:6,Auto-liquidation sous traitance:7}
collecte	object	{Vente:7, assuranceDeb:61, transportDeb:62, client:411, douteux:416, societe:512, discountC: 665, remissionC:709, collecte:4452, acompteC:4191, emballageDeb:4196}
deductible	object	"{Vente:7, assuranceDeb:61, transportDeb:62, client:411, douteux:416, societe:512, discountC: 665, remissionC:709, collecte:4452, acompteC:4191, emballageDeb:4196}
deductibleImmo	object
taux	float	Taux de tva
encaissement	boolean	TVA sur Encaissements
ferme	boolean	fermé
racine	string	Racine

Exemple de retour

	
Response body
Download
[
  {
    "objectId": "45e8de4e-7d02-46ab-941d-da9afb04aac6",
    "revisionId": "0x0000000000071D73",
    "description": "TVA 19,6",
    "code": "001",
    "regime": 1,
    "collecte": {
      "objectId": "7b09ffc9-e91a-4607-a53e-c2e3c9796dfb",
      "description": [
        "44571000"
      ]
    },
    "deductible": {
      "objectId": "1d8fc9f2-8879-4da3-bc86-acb9557608b2",
      "description": [
        "44562000"
      ]
    },
    "deductibleImmo": {
      "objectId": "1d8fc9f2-8879-4da3-bc86-acb9557608b2",
      "description": [
        "44562000"
      ]
    },
    "taux": 19.6,
    "encaissement": true,
    "ferme": false,
    "racine": ""
  }
]

POST/tva

Cette API crée un tva.

Lien vers la documentation technique

Cas d'usage

Cette API permet la création de tva au niveau des dossiers du cabinet par une application externe.

Procédure

Il faut appeler un endpoint permettant d'ajouter les codes TVA :

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

Route	Méthode http	Description
/tva	POST	Ajoute des codes TVA

Paramétrage de l’appel

Méthode http pour la demande : POST

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	Valeur à renseigner : Code du dossier	Oui

Body de la demande

Champ	Type	Description	Obligatoire
code	string	code du tva	Oui
description	string	Libelllé du tva	Oui
regime	string	{Normal:1,Exonéré:2,Autoliquidation biens Intra-communautaire:3, Autoliquidation prestations Intra-communautaire:8,Export:4,Corse:5,DOM:6,Auto-liquidation sous traitance:7}
collecte	object	{Vente:7, assuranceDeb:61, transportDeb:62, client:411, douteux:416, societe:512, discountC: 665, remissionC:709, collecte:4452, acompteC:4191, emballageDeb:4196}
deductible	object	"{Vente:7, assuranceDeb:61, transportDeb:62, client:411, douteux:416, societe:512, discountC: 665, remissionC:709, collecte:4452, acompteC:4191, emballageDeb:4196}
deductibleImmo	object
taux	float	Taux de tva
encaissement	boolean	TVA sur Encaissements
ferme	boolean	fermé
racine	string	Racine

Exemple de body

[
  {
    "code": "002",
    "description": "TVA 20%",
    "regime": 1,
    "collecte": {
      "objectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    },
    "deductible": {
      "objectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    },
    "deductibleImmo": {
      "objectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    },
    "taux": 20,
    "encaissement": true,
    "ferme": true,
    "racine": ""
  }
]

Points d'attention sur la structure du JSON

Vous ne pouvez pas modifier les propriétés d'un élément 'enfant'.
Vous pouvez ajouter, modifier ou supprimer des éléments 'enfant' en incluant leur 'objectId', toutes les autres propriétés seront ignorées.
Cela s'applique également aux éléments « enfants » dans un tableau.

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

Structure du retour

Format du retour

Champ	Type	Description
numero	string	Numéro de tva	Oui
description	string	Libelllé du tva	Oui
regime	string	{Normal:1,Exonéré:2,Autoliquidation biens Intra-communautaire:3, Autoliquidation prestations Intra-communautaire:8,Export:4,Corse:5,DOM:6,Auto-liquidation sous traitance:7}
collecte	object	{Vente:7, assuranceDeb:61, transportDeb:62, client:411, douteux:416, societe:512, discountC: 665, remissionC:709, collecte:4452, acompteC:4191, emballageDeb:4196}
deductible	object	"{Vente:7, assuranceDeb:61, transportDeb:62, client:411, douteux:416, societe:512, discountC: 665, remissionC:709, collecte:4452, acompteC:4191, emballageDeb:4196}
deductibleImmo	object
taux	float	Taux de tva
encaissement	boolean	TVA sur Encaissements
ferme	boolean	fermé
racine	string	Racine

Exemple de retour


[
  {
    "revisionId": "0x0000000000092386",
    "objectId": "63f68512-f902-4a1a-9223-97a501342fc6",
    "code": "002",
    "description": "TVA 20%",
    "regime": 1,
    "collecte": {
      "objectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    },
    "deductible": {
      "objectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    },
    "deductibleImmo": {
      "objectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    },
    "taux": 20,
    "encaissement": true,
    "ferme": true,
    "racine": "",
    "created": "2022-07-13T09:49:54Z",
    "updated": "2022-07-13T09:49:54Z"
  }
]

PUT/tva

Cette API modifie les codes TVA d'un dossier client

Lien vers la documentation technique

Cas d'usage

Cette API permet de modifier les informations des codes TVA dans Cegid Loop depuis une application externe.

Points d'attention

Avant d'appeler cette API, utilisez l'API GET/tva afin de recupérer les champs obligatoires objectId et revisionId.

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.

Cette API permet de modifier la valeur d'un champ et pas de la supprimer. Envoyer une valeur à vide ne supprimera pas la valeur précedente.

Procédure

Il faut appeler un endpoint permettant de modifier les codes TVA :

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

Route	Méthode http	Description
/tva	PUT	Modifie des codes TVA

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	Valeur à renseigner : code dossier	Oui

Body de la demande

Exemple de body

[[
{
    "objectId": "37f8728f-af7a-46e7-b690-668e810208ae",
    "revisionId": "0x0000000000033A12",
    "description": "tva D'ATTENTE AXEANAAXE",
    "code": "SECA@AXE",
    "ferme": false,
    "axe": {
      "objectId": "352ebf42-ba97-43bb-a786-649ef1d4ba28",
      "description": [
        "Axe numéro 1"
      ]
    }
  }
]

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

Structure du retour

Format du retour

Champ	Type	Description
numero	string	Numéro de tva	Oui
description	string	Libelllé du tva	Oui
regime	string	{Normal:1,Exonéré:2,Autoliquidation biens Intra-communautaire:3, Autoliquidation prestations Intra-communautaire:8,Export:4,Corse:5,DOM:6,Auto-liquidation sous traitance:7}
collecte	object	{Vente:7, assuranceDeb:61, transportDeb:62, client:411, douteux:416, societe:512, discountC: 665, remissionC:709, collecte:4452, acompteC:4191, emballageDeb:4196}
deductible	object	"{Vente:7, assuranceDeb:61, transportDeb:62, client:411, douteux:416, societe:512, discountC: 665, remissionC:709, collecte:4452, acompteC:4191, emballageDeb:4196}
deductibleImmo	object
taux	float	Taux de tva
encaissement	boolean	TVA sur Encaissements
ferme	boolean	fermé
racine	string	Racine

Exemple de retour


[
  {
    "objectId": "37f8728f-af7a-46e7-b690-668e810208ae",
    "revisionId": "0x000000000006DE0E",
    "description": "tva D'ATTENTE AXEANAAXE",
    "code": "SECA@AXE",
    "ferme": false,
    "axe": {
      "objectId": "352ebf42-ba97-43bb-a786-649ef1d4ba28"
    },
    "updated": "2022-05-16T07:24:21Z"
  }
]

DEL/tva

Cette API supprime un tva

Lien vers la documentation technique

Cas d'usage

Cette API permet de supprimer des codes TVA dans Cegid Loop depuis une application externe

Points d'attention

Avant d'appeler cette API, utilisez l'API GET/tva afin de recupérer les champs obligatoires objectId et revisionId.

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 permettant de supprimer les codes TVA :

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

Route	Méthode http	Description
/tva	DEL	Suppression des codes TVA

Paramétrage de l’appel

Méthode http pour la demande : DEL

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	Valeur à renseigner : code du dossier	Oui

Body de la demande

Champ	Type	Description	Obligatoire
objectId	string($uuid)	ID (UUID) Code unique	Oui
revisionId	string($uuid)	ID (UUID) de la révision	Oui

Exemple de body

[
  {
    "revisionId": "0x000000000006DE0F",
    "objectId": "95e17efe-bb83-4d19-9424-7d5d2383982a"
  }
]

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

Structure du retour

Format du retour

Champ	Type	Description
objectId	string($uuid)	ID (UUID) Code unique
revisionId	string($uuid)	ID (UUID) de la révision

Example de retour

	
Response body
Download
[
  {
    "revisionId": "0x000000000006DE0F",
    "objectId": "95e17efe-bb83-4d19-9424-7d5d2383982a"
  }
]
```

Welcome to the Cegid APIs documentation

Paramétrage des codes TVA

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

GET/tva

Cas d'usage

Procédure

Paramétrage de l’appel

Code retour

Structure du retour

POST/tva

Cas d'usage

Procédure

Paramétrage de l’appel

Code retour

Structure du retour

PUT/tva

Cas d'usage

Points d'attention

Procédure

Paramétrage de l’appel

Code retour

Structure du retour

DEL/tva

Cas d'usage

Points d'attention

Procédure

Paramétrage de l’appel

Code retour

Structure du retour