Table of Contents

Paramétrage des établissements

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

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

GET/etablissementComplet

Cette API retourne la liste des établissements.

Lien vers la documentation technique

Cas d'usage

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

Procédure

Il faut appeler un endpoint permettant de lister les établissements :

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

Route Méthode http Description
/etablissementComplet GET Retourne la liste des établissements

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 d'établissement au format suivant :

Champ Type Description
objectId string($uuid) ID (UUID) Code unique
revisionId string($uuid) ID (UUID) de la révision
type Enum Array [ 4 ] {Principal-siège social:1,Secondaire:2,Principal:3,Siège social:4}
nature string Enum Array [ 2 ] {Personne Physique:1,Personne Morale:2}
prenom string maxLength: 35 prénom
name string maxlength 35 Nom
raisonsociale string maxlength 35 Raison Sociale
nomComplement string maxlength 35 Complément de Nom
enseigne string maxlength 100 Enseigne
nic string maxlength 5
legale object
Adresse Légale :
numVoie string maxLength: 10 ,
extension string Enum: Array [ 3 ],
nomVoie string maxLength: 30,
lieuditHameau string maxLength: 35,
complementDistrib string maxLength: 35
codePostal string maxLength: 17 ,
localite string maxLength: 35
pays, objectId string($uuid)
Code unique (UUID}
telephone string maxlength 20 Téléphone
fax string maxlength 20 FAX
email string maxlength 100 Email
autorisationEmail boolean Autorisation de l’utilisation de cette adresse par la DGFip
ics string maxlength 20 Identifiant créancier SEPA
ferme boolean
juridique object
inscriptionRepertoireMetiers boolean,
anneeCdm string($date-time),
numeroCdm string maxLength: 100,
numeroImmatriculation string maxLength: 100,
dateImmatriculation string($date-time),
villeImmatriculation string maxLength: 100,
numeroGestion string maxLength: 100,
debutActivite string ($date-time)}
description string maxlength 100 Enseigne
maitrecolture string enum 3
site string maxlength 100
missionECF boolean
fiscal object
clotureExercice string Enum: Array [ 12 ] ,
nonImposable boolean,
convProfessionMedical string Enum: Array[ 4 ],
rof string maxLength: 100,
activiteFiscale string Enum: Array [ 2 ],
regimeEtranger boolean,
dge boolean,
dgeDateEntree string, ($date-time)
dgeDateSortie string($date-time),
frpDossier string maxLength: 6,
frpCle string maxLength: 2,
codeFRP string maxLength: 15,
oga boolean,
ogaNumero string maxLength: 100 ,
ogaDateDeb string($date-time), ogaDateFin string($date-time) ,
ogaActivite string maxLength: 100
EDI object
raiSocSignataire string maxLength: 35,
compSignataire string maxLength: 35,
lieuSignature string maxLength: 35 }
regimeTva string enum 2 Régime TVA
periodicitePaiement string array 8
datelimiteDepot string array 8 Date limite de dépot
tva object
baseImposition string Enum: Array [ 3 ] {Exonéré:1,Partiel:2,Total:3},
tvaCabinet boolean
assujettiUnique boolean
exigibilite string Enum: Array [ 3 ]
etablissementTVA { objectId string($uuid) Code unique (UUID) },
journalDefault {...},procedureDeclarativeDateDebut string($date-time),
teletransmission boolean,
ompteTvaDec {objectId string($uuid),
Code unique (UUID)},compteDemRemb { objectId strin($uuid),
Code unique (UUID)},compteRepCred { objectId string($uuid),
Code unique (UUID)},
compteAcoSimp { objectId strin($uuid),
Code unique (UUID)},compteReglement {objectId string($uuid),
Code unique (UUID)},
rofTva string maxLength: 100,
secteurDistinct boolean,
procedureDeclarative string Enum:[ 1, 2, 3 ],
optionCA12 boolean,
numeroIntracommunautaire string maxLength: 13,
autresTaxesAnnexesCA boolean,
territorialite string Enum:[ 1, 2, 3 ],
procedureExportateur boolean,
tvaSurLettrageDateDebut string($date-time}

Exemple de retour

[{
    "objectId": "ad69d5bf-daa2-4fa9-9921-06bdf0a1d267",
    "revisionId": "0x0000000000311A52",
    "description": "SOLUTIONS SARL",
    "type": 1,
    "etablissementJuridique": {
        "objectId": "0b02cc56-90c9-447a-ae75-c4c121244b63",
        "nature": 2,
        "prenom": "John            ",
        "nom": "Doe             ",
        "raisonSociale": "SOLUTIONS SARL",
        "nomComplement": "",
        "enseigne": "SOLUTIONS SARL",
        "type": 1,
        "nic": "00017",
        "legale": {
            "numVoie": "3",
            "extension": 0,
            "nomVoie": "52 Quai Paul Sédaillian",
            "lieuditHameau": "",
            "complementDistrib": "ZAC DE MERCIERES ZONE 2",
            "codePostal": "69009",
            "localite": "Lyon    ",
            "pays": {
                "objectId": "2d9c4f9a-9be4-4005-828b-ddf3235e1065",
                "description": ["FRANCE"]
            }
        },
        "telephone": "",
        "fax": "",
        "email": "john.doe@cegid.com",
        "autorisationEmail": false,
        "ics": "",
        "ferme": false,
        "juridique": {
            "inscriptionRepertoireMetiers": false,
            "departementCdm": {
                "objectId": null,
                "description": [""]
            },
            "anneeCdm": null,
            "numeroCdm": "",
            "numeroImmatriculation": "",
            "dateImmatriculation": null,
            "villeImmatriculation": "",
            "numeroGestion": "",
            "debutActivite": null,
            "nafComp": {
                "objectId": null,
                "description": [""]
            }
        }
    },
    "maitreCloture": 1,
    "site": "0004",
    "missionECF": false,
    "fiscal": {
        "clotureExercice": 12,
        "regimeImposition": {
            "objectId": "e457b3e3-78a0-4086-b049-ebdcc73090aa",
            "description": ["BIC"]
        },
        "regimeFiscal": {
            "objectId": "39671ce3-851b-491a-9338-77e62c490790",
            "description": ["Filiale intégrée"]
        },
        "nonImposable": false,
        "convProfessionMedical": 0,
        "rof": "IS1",
        "typeDeclaration": {
            "objectId": "2033c42e-b2c6-4cd5-b54f-95722c5dc8b1",
            "description": ["Réelle"]
        },
        "activiteFiscale": 1,
        "regimeEtranger": false,
        "dge": false,
        "dgeDateEntree": null,
        "dgeDateSortie": null,
        "sie": {
            "objectId": null,
            "description": ["", "", ""]
        },
        "frpDossier": "",
        "frpCle": "",
        "codeFRP": "",
        "oga": false,
        "ogaOrganisme": {
            "objectId": null,
            "description": [""]
        },
        "ogaNumero": "",
        "ogaDateDeb": null,
        "ogaDateFin": null,
        "ogaActivite": ""
    },
    "EDI": {
        "conseil": {
            "objectId": null,
            "description": ["", "", ""]
        },
        "comptable": {
            "objectId": null,
            "description": [""]
        },
        "visa": {
            "objectId": null,
            "description": [""]
        },
        "formeSignataire": {
            "objectId": "db17d361-5aec-4c85-a3b7-dfafe1acbec2",
            "description": ["M"]
        },
        "raiSocSignataire": "Vivet Grégory",
        "compSignataire": "Gérant",
        "lieuSignature": "Compiègne"
    },
    "regimeTva": 1,
    "periodicitePaiement": 2,
    "dateLimiteDepot": 21,
    "tva": {
        "automatique": true,
        "baseImposition": 3,
        "tvaCabinet": true,
        "assujettiUnique": false,
        "assujettiUniqueDateDebut": null,
        "optionDebits": false,
        "optionDebitsDateDebut": null,
        "exigibilite": 1,
        "etablissementTVA": {
            "objectId": "ad69d5bf-daa2-4fa9-9921-06bdf0a1d267",
            "revisionId": "0x0000000000311A52",
            "shortDescription": ["SOLUTIONS SARL"],
            "longDescription": ["SOLUTIONS SARL"]
        },
        "etablissementComplet": {
            "objectId": "ad69d5bf-daa2-4fa9-9921-06bdf0a1d267",
            "description": ["SOLUTIONS SARL"]
        },
        "journalDefault": {
            "objectId": "c0a7d67c-f0cf-4364-a8f7-74f5e1fe607d",
            "description": ["OD"]
        },
        "tauxSpecial": false,
        "regimeAgricole": 0,
        "optionCA12AE": false,
        "procedureDeclarativeDateDebut": "2020-07-01T00:00:00Z",
        "teletransmission": true,
        "compteTvaDec": {
            "objectId": "491d395a-d6e0-412a-a504-d7ec1e6d43df",
            "description": ["44551000"]
        },
        "compteDemRemb": {
            "objectId": "763d3562-82a7-45b3-90c5-ece70e0cf7b3",
            "description": ["44583000"]
        },
        "compteRepCred": {
            "objectId": "4880da84-4ca9-49d2-8b59-00e1c3df500f",
            "description": ["44567000"]
        },
        "compteAcoSimp": {
            "objectId": null,
            "description": [""]
        },
        "compteTvaAnterieure": {
            "objectId": null,
            "description": [""]
        },
        "compteTvaAcompte": {
            "objectId": null,
            "description": [""]
        },
        "compteTvaADeduire": {
            "objectId": null,
            "description": [""]
        },
        "compteRepCredPrec": {
            "objectId": null,
            "description": [""]
        },
        "compteTaxeAssim": {
            "objectId": null,
            "description": [""]
        },
        "compteRembProvOb": {
            "objectId": null,
            "description": [""]
        },
        "compteSomImp": {
            "objectId": null,
            "description": [""]
        },
        "compteCredImpSimp": {
            "objectId": null,
            "description": [""]
        },
        "modePaiement": 1,
        "compteReglement": {
            "objectId": null,
            "description": [""]
        },
        "rofTva": "TVA1",
        "secteurDistinct": false,
        "procedureDeclarative": 1,
        "optionCA12": false,
        "numeroIntracommunautaire": "",
        "autresTaxesAnnexesCA": false,
        "territorialite": 0,
        "procedureExportateur": false,
        "tvaSurLettrageDateDebut": null
    }
}]

GET/DossierComplet

Cette API retourne la liste des Siren et forme juridique des dossiers

Lien vers la documentation technique

Cas d'usage

  • Cette API permet de retourner Siren et forme juridique d'un dossier client au sein du cabinet.

Procédure

Il faut appeler un endpoint permettant de lister les dossiers :

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

Route Méthode http Description
/DossierComplet GET Retourne la liste Siren et forme juridique des dossiers

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 Siren et forme juridique au format suivant :

Champ Type Description
objectId string($uuid) ID (UUID) Code unique
revisionId string($uuid) ID (UUID) de la révision
siren string Siren
formeJuridique string forme juridique

Exemple de retour

{
    "objectId": "933dc04b-eb0c-40d5-83ac-1df4d1d54b46",
    "revisionId": "0x00000000000F2AEB",
    "siren": "",
    "formeJuridique": "SA"
}

GET/etablissementJuridique

Cette API retourne la liste d'établissement juridique d'un dossier

Lien vers la documentation technique

Cas d'usage

  • Cette API permet de retourner toute la liste des établissement juridique au sein du cabinet.
  • Elle permet également de retourner un échantillon de établissements grâce à ses paramètres (Cf. § Paramètres de la demande).

Procédure

Il faut appeler un endpoint permettant de lister les dossiers :

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

Route Méthode http Description
/etablissementJuridique GET Retourne la liste des établissements

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 établissements juridiques au format suivant :

Champ Type Description
objectId string($uuid) ID (UUID) Code unique
revisionId string($uuid) ID (UUID) de la révision
nature Enum Array [ 2 ] Nature
prenom string maxLength: 35 prénom
nom string maxlength 35 Nom
raisonsociale string maxlength 35 Raison sociale
enseigne string maxlength 100 Enseigne
type string enum Array [ 4 ]
nic string maxlength 5
legale Object
numVoie string, maxLength: 10
extension string, Enum: Array [ 3 ],
nomVoie string maxLength: 30,
lieuditHameau string maxLength: 35,
complementDistrib string maxLength: 35,
codePostal string maxLength: 17,
localite string maxLength: 35, pays {...}
telephone string maxlength 20 Téléphone
fax string maxlength 20 FAX
email string maxlength 100 EMAIL
autorisationEmail boolean
ferme boolean Fermer
juridique object {
inscriptionRepertoireMetiers boolean,
anneeCdm string,($date-time),
numeroCdm string maxLength: 100 ,
numeroImmatriculation string maxLength: 100 , dateImmatriculation string ($date-time) ,
villeImmatriculation string maxLength: 100,
numeroGestion string maxLength: 100,
debutActivite string($date-time)}

Exemple de retour

[{
    "objectId": "31fb7658-9743-4e83-b2f9-884efb5cc8bc",
    "revisionId": "0x00000000000EADD3",
    "description": ["CEGID003"],
    "nature": 2,
    "prenom": "",
    "nom": "",
    "raisonSociale": "CEGID003",
    "nomComplement": "",
    "enseigne": "CEGID003",
    "type": 1,
    "nic": "",
    "legale": {
        "numVoie": "15",
        "extension": 0,
        "nomVoie": "Av. des Alouette",
        "lieuditHameau": "",
        "complementDistrib": "",
        "codePostal": "",
        "localite": "",
        "pays": {
            "objectId": null,
            "description": [""]
        }
    },
    "telephone": "0102030405",
    "fax": "",
    "email": "mentressangle@cegid.com",
    "autorisationEmail": true,
    "ics": "",
    "ferme": true,
    "juridique": {
        "inscriptionRepertoireMetiers": false,
        "departementCdm": {
            "objectId": null,
            "description": [""]
        },
        "anneeCdm": null,
        "numeroCdm": "",
        "numeroImmatriculation": "",
        "dateImmatriculation": null,
        "villeImmatriculation": "",
        "numeroGestion": "",
        "debutActivite": null,
        "nafComp": {
            "objectId": null,
            "description": [""]
        }
    }
}]

PUT/DossierComplet

Cette API modifie la siren et la forme juridique d'un dossier client

Lien vers la documentation technique

Cas d'usage

  • Cette API permet de modifier les informations siren et la forme juridique dans Cegid Loop depuis une application externe.

Points d'attention

Avant d'appeler cette API, utilisez l'API GET/etablissementComplet 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 établissements :

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

Route Méthode http Description
/DossierComplet PUT Modifie la siren et la forme juridique

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": "933dc04b-eb0c-40d5-83ac-1df4d1d54b46",
    "revisionId": "0x00000000000F2AEB",
    "siren": "23119098712315",
    "formeJuridique": "SARL"
}]

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 Obligatoire
objectId string($uuid) ID (UUID) Code unique Oui
revisionId string($uuid) ID (UUID) de la révision Oui
siren string Numéro de etablissementComplet
formeJuridique string Forme juridique

Exemple de retour

{
    "success": [{
        "objectId": "dab59efe-c743-4f5c-a95c-ff08b6748536",
        "revisionId": "0x00000000000FE651",
        "siren": "23119098712315",
        "formeJuridique": "SARL"
    }],
    "errors": []
}

PUT/etablissementJuridique

Cette API modifie les établissements d'un dossier client

Lien vers la documentation technique

Cas d'usage

  • Cette API permet de modifier les informations des établissements juridique dans Cegid Loop depuis une application externe.

Points d'attention

Avant d'appeler cette API, utilisez l'API GET/etablissementJuridique 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 établissements :

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

Route Méthode http Description

|/https://developers.cegid.com/api-details#api=loop-api-publiques&operation=updateetablissementjuridique|PUT|Modifie des établissements|

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": "31fb7658-9743-4e83-b2f9-884efb5cc8bc",
    "revisionId": "0x00000000000EADD3",
    "description": ["CEGID003"],
    "nature": 2,
    "prenom": "",
    "nom": "",
    "raisonSociale": "CEGID003",
    "nomComplement": "",
    "enseigne": "CEGID003",
    "type": 1,
    "nic": "",
    "legale": {
        "numVoie": "1",
        "extension": 1,
        "nomVoie": "AV. des anciens ",
        "lieuditHameau": "",
        "complementDistrib": "",
        "codePostal": "",
        "localite": "",
        "pays": {
            "objectId": null,
            "description": [""]
        }
    },
    "telephone": "",
    "fax": "",
    "email": "",
    "autorisationEmail": false,
    "ics": "",
    "ferme": false,
    "juridique": {
        "inscriptionRepertoireMetiers": false,
        "departementCdm": {
            "objectId": null,
            "description": [""]
        },
        "debutActivite": "2011-01-12T00:00:00Z",
        "nafComp": {
            "objectId": null,
            "description": [""]
        }
    }
}]

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 Obligatoire
objectId string($uuid) ID (UUID) Code unique Oui
revisionId string($uuid) ID (UUID) de la révision Oui
nature Enum Array [ 2 ] Nature
prenom string maxLength: 35 prénom
nom string maxlength 35 Nom
raisonsociale string maxlength 35 Raison sociale
enseigne string maxlength 100
type string enum Array [ 4 ]
nic string maxlength 5
legale Object
numVoie string, maxLength: 10
extension string, Enum: Array [ 3 ],
nomVoie string maxLength: 30,
lieuditHameau string maxLength: 35,
complementDistrib string maxLength: 35,
codePostal string maxLength: 17,
localite string maxLength: 35, pays {...}
telephone string maxlength 20
fax string maxlength 20 FAX
email string maxlength 100 EMAIL
autorisationEmail boolean
ferme boolean
juridique object {
inscriptionRepertoireMetiers boolean,
anneeCdm string,($date-time),
numeroCdm string maxLength: 100 ,
numeroImmatriculation string maxLength: 100 ,
dateImmatriculation string ($date-time) ,
villeImmatriculation string maxLength: 100,
numeroGestion string maxLength: 100,
debutActivite string($date-time)}

Exemple de retour

[{
    "objectId": "31fb7658-9743-4e83-b2f9-884efb5cc8bc",
    "revisionId": "0x00000000000FE652",
    "nature": 2,
    "prenom": "",
    "nom": "",
    "raisonSociale": "CEGID003",
    "nomComplement": "",
    "enseigne": "CEGID003",
    "type": 1,
    "nic": "",
    "legale": {
        "numVoie": "1",
        "extension": 1,
        "nomVoie": "AV. des anciens ",
        "lieuditHameau": "",
        "complementDistrib": "",
        "codePostal": "",
        "localite": "",
        "pays": {
            "objectId": null
        }
    },
    "telephone": "",
    "fax": "",
    "email": "",
    "autorisationEmail": false,
    "ics": "",
    "ferme": false,
    "juridique": {
        "inscriptionRepertoireMetiers": false,
        "departementCdm": {
            "objectId": null
        },
        "debutActivite": "2011-01-12T00:00:00Z",
        "nafComp": {
            "objectId": null
        }
    },
    "updated": "2024-06-18T13:50:44Z"
}]