Generation de Balances Comptables
Présentation générale de l'API et finalité fonctionnelle
Ces API permettent de récupérer différents types balances comptables de Cegid Loop :
GET/getBalanceGeneral
Cette API récupère la balance comptables des comptes généraux d'une période Bilan "N" d'un dossier au sein d'un cabinet.
Lien vers la documentation technique
Cas d'usage
- Cette API permet de récupérer la balance générale des comptes généraux de l'année N ou N-1 ou N-2 d'un dossier client.
- Elle permet également de retourner un échantillon de comptes généraux grâce à ses paramètres (Cf. § Paramètres de la demande).
Procédure
Il faut appeler un endpoint permettant de recupérer la balance générale :
GET https://api.cegid.com/loop-api-publiques/getBalanceGeneral
Attached the video : https://app.arcade.software/share/049i9cVPvz85XhwcyR80
Route | Méthode http | Description |
---|---|---|
/BalanceGenerale | GET | Retourne la balance générale |
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
Description du body :
Champ | Type | Description | Exemple | Obligatoire | |
---|---|---|---|---|---|
codeDossier | String | Code du dossier | CEGID003 | Oui | |
period | String | Période Bilan | "N" ou "N1" ou "N2" | Oui si aucune date début et fin ne sont renseignées | |
dateStart | String | Date de début au format (YYYY-MM-DDTHH:mm:ssZ) | Oui si aucune période bilan n'est renseignée | ||
dateEnd | String | Date de fin au format (YYYY-MM-DDTHH:mm:ssZ) | Oui si aucune période bilan n'est renseignée | ||
accountStart | String | Premier compte retourné par l'API | Non | ||
accountEnd | String | Dernier compte retourné par l'API | Non | ||
etablissement | UUID | Sous-dossier / ObjectId de l'établissement obtenu par GET/etablissementComplet | Non |
Point d'attention
- N (blian en cours), N1 (bilan N-1), N2 (bilan N-2)
- Vous pouvez préciser soit la période bilan, soit les dates de debut/fin
Exemple de body
- Exemple 1 : période bilan N , avec un focus sur le mois de 01/2021 et sur les comptes génraux de 12000000 à 40100000 :
{
"codeDossier": "CEGID003",
"period": "N",
"dateStart": "2021-01-01THH:mm:ssZ",
"dateEnd": "2021-31-01THH:mm:ssZ",
"accountStart": "12000000",
"accountEnd": "40100000",
"etablissement": ""
}
- Exemple 2 : uniquement avec un focus sur la date du 01/01/2023 (même date de début et de fin):
{
"codeDossier": "CEGID003",
"dateStart": "2023-01-01T00:00:00.000Z",
"dateEnd": "2023-01-01T00:00:00.000Z"
}
- Exemple 3 : uniquement avec un focus sur la période bilan:
{
"codeDossier": "CEGID002",
"period": "N"
}
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 dossier au format suivant :
Champ | Sous-champ1 | Sous-champ2 | Sous-champ4 | Type | Description |
---|---|---|---|---|---|
data | |||||
result | |||||
data | |||||
numero | String | Numéro du compte | |||
libelle | String | Libellé du compte | |||
debit | String | Total du débit du compte | |||
credit | String | Total du crédit du compte | |||
solde | String | Solde du compte |
Exemple de réponse
{
"data": {
"result": {
"data": [
{
"numero": "12000000",
"libelle": "Bénéfice",
"debit": 0,
"credit": 14603774.68,
"solde": -14603774.68,
"objectId": "7ad984b3-124d-45af-81f9-749993d646eb"
},
{
"numero": "18100000",
"libelle": "Comptes de liaison établissements",
"debit": 0,
"credit": 8725908,
"solde": -8725908,
"objectId": "3221b66e-8fa4-44e1-904c-db87c89f2a28"
},
{
"numero": "21830000",
"libelle": "Matériel de bureau et informatique",
"debit": 16000,
"credit": 0,
"solde": 16000,
"objectId": "55c4a506-0354-45ef-a6fe-af5116946477"
},
{
"numero": "40100000",
"libelle": "Fournisseurs collectifs",
"debit": 13931.47,
"credit": 2338828.38,
"solde": -2324896.91,
"objectId": "49e41478-b3ce-475a-bc79-373a36ddb431"
}
]
}
}
}
Balance de situation par période (mensuel, trimestrielle ou semestrielle).
Cette API récupère la balance comptable d'une période de Situation "S" des comptes généraux d'un dossier au sein d'un cabinet.
Paramètres de la demande
Description du body :
Champ | Type | Description | Exemple | Obligatoire | |
---|---|---|---|---|---|
codeDossier | String | Code du dossier | CEGID003 | Oui | |
period | String | Période Situation | "S" | Oui | |
dateEnd | String | Date de fin au format (YYYY-MM-DDTHH:mm:ssZ) | Oui | ||
accountStart | String | Premier compte retourné par l'API | Non | ||
accountEnd | String | Dernier compte retourné par l'API | Non | ||
etablissement | UUID | Sous-dossier / ObjectId de l'établissement obtenu par GET/etablissementComplet | Non |
Point d'attention
La période doit être spécifiée en "S"
Exemple de body
Exemple 1 : Avec uniquement une date de fin de situation:
{
"codeDossier": "MANON004",
"period": "S",
"dateEnd": "2021-06-30T00:00:00.000Z"
}
Exemple 2 : Avec une précision du sou-dossier:
{
"codeDossier": "MANON004",
"period": "S",
"dateEnd": "2021-06-30T00:00:00.000Z",
"etablissement":"843dab45-5933-4983-a13e-d5446e29d9f7"
}
Exemple 3 : Avec une précision d'un échantillon de comptes:
{
"codeDossier": "UNCLEPHIL",
"period": "S",
"dateEnd": "2023-06-30",
"accountStart": "40110000",
"accountEnd": "41110000"
}
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 dossier au format suivant :
Champ | Sous-champ1 | Sous-champ2 | Sous-champ4 | Type | Description |
---|---|---|---|---|---|
data | |||||
result | |||||
data | |||||
numero | String | Numéro du compte | |||
libelle | String | Libellé du compte | |||
debit | String | Total du débit du compte | |||
credit | String | Total du crédit du compte | |||
solde | String | Solde du compte |
Exemple de réponse
{
"data": {
"result": {
"data": [
{
"numero": "40110000",
"libelle": "FOURNISSEURS",
"debit": 354600.4,
"credit": 309161.49,
"solde": 45438.91,
"objectId": "58aee0bd-9ba2-4386-88e8-d8c9c64208fd"
},
{
"numero": "41110000",
"libelle": "CLIENTS",
"debit": 95100,
"credit": 99800,
"solde": -4700,
"objectId": "b2b446be-06cc-4909-94a3-4e5396ede1cc"
}
]
}
}
}
GET/getBalanceThirdParty
Cette API récupère la balance comptable des comptes auxiliaires d'une période bilan ou situation d'un dossier au sein d'un cabinet.
Lien vers la documentation technique
Cas d'usage
- Cette API permet de récupérer la balance comptable des comptes auxiliaires de l'année N ou N-1 ou N-2 d'un dossier client.
- Elle permet également de retourner un échantillon de comptes auxiliaires grâce à ses paramètres (Cf. § Paramètres de la demande).
Procédure
Il faut appeler un endpoint permettant de recupérer la balance des comptes auxiliaires :
GET https://api.cegid.com/loop-api-publiques/getBalanceThirdParty
Route | Méthode http | Description |
---|---|---|
/BalanceThirdParty | GET | Retourne la balance auxiliaire |
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
Name | Type | Description | Exemple | Obligatoire | |
---|---|---|---|---|---|
codeDossier | String | Code du dossier | CEGID003 | Oui | |
period | String | Période Bilan ou période Situation | "N", "N1", "N2" ou "S" | Oui si il n'y a pas de date renseignée | |
accountType | string | Nature de compte (fournisseur, client, salarié, prospect, divers) | provider, customer, employee, prospect, other | Oui | |
dateStart | String | Date de début au format (YYYY-MM-DDTHH:mm:ssZ) | Oui si aucune période bilan n'est renseignée | ||
dateEnd | String | Date de fin au format (YYYY-MM-DDTHH:mm:ssZ) | Oui si aucune période bilan n'est renseignée ou si la période Situation est renseignée | ||
accountStart | String | Premier compte retourné par l'API | Non | ||
accountEnd | String | Dernier compte retourné par l'API | Non | ||
etablissement | UUID | Sous-dossier / ObjectId de l'établissement obtenu par GET/etablissementComplet | Non |
Exemple de body
{
"codeDossier": "CEGID003",
"accountType": "customer",
"period": "N",
"dateStart": "2022-01-01THH:mm:ssZ",
"dateEnd": "2022-31-01THH:mm:ssZ",
"accountStart": "",
"accountEnd": "",
"etablissement": ""
}
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 dossier au format suivant :
Champ | Sous-champ1 | Sous-champ2 | Sous-champ4 | Type | Description |
---|---|---|---|---|---|
data | |||||
result | |||||
data | |||||
code | String | Code du compte auxiliaire | |||
nomUsuel | String | Libellé du compte auxiliaire | |||
debit_0 | String | Total du débit du compte auxiliaire | |||
credit_0 | String | Total du crédit du compte auxiliaire | |||
solde_0 | String | Solde du compte auxiliaire |
Exemple de réponse
{
"data": {
"result": {
"data": [
{
"code": "401BPS",
"nomUsuel": "BPS AVOCAT ",
"debit_0": "0",
"credit_0": "307.2",
"solde_0": "-307.2"
},
{
"code": "401CFE",
"nomUsuel": "COTIS FONCIERE ENTREPRISE ",
"debit_0": "0",
"credit_0": "1014",
"solde_0": "-1014"
},
{
"code": "CATTEN",
"nomUsuel": "Client attente ",
"debit_0": "4792.04",
"credit_0": "0",
"solde_0": "4792.04"
},
{
"code": "CDIVER",
"nomUsuel": "CLIENT DIVER ",
"debit_0": "22642497.48",
"credit_0": "179275.16",
"solde_0": "22463222.32"
},
{
"code": "DELL",
"nomUsuel": "DELL FRANCE SA ",
"debit_0": "0",
"credit_0": "67393.55",
"solde_0": "-67393.55"
},
{
"code": "FOURNISSEUR$ATTENTE",
"nomUsuel": " ",
"debit_0": "0",
"credit_0": "1200",
"solde_0": "-1200"
},
{
"code": "LDLC",
"nomUsuel": "LDLC ",
"debit_0": "13931.47",
"credit_0": "2285713.63",
"solde_0": "-2271782.16"
}
]
}
}
}
GET/getBalanceGeneralDeveloped
Cette API récupère la balance comptable développée des comptes généraux d'une période bilan ou situation d'un dossier au sein d'un cabinet.
Lien vers la documentation technique
Cas d'usage
- Cette API permet de récupérer la balance comptable développée des comptes généraux de l'année N ou N-1 ou N-2 d'un dossier client.
- Elle permet également de retourner un échantillon de comptes grâce à ses paramètres (Cf. § Paramètres de la demande).
Procédure
Il faut appeler un endpoint permettant de recupérer la balance générale développée :
GET https://api.cegid.com/loop-api-publiques/getBalanceGeneralDeveloped
Route | Méthode http | Description |
---|---|---|
/BalanceGeneralDeveloped | GET | Retourne la balance developpée |
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
Name | Type | Description | Exemple | Obligatoire | |
---|---|---|---|---|---|
codeDossier | String | Code du dossier | CEGID003 | Oui | |
period | String | Période Bilan ou période Situation | "N", "N1", "N2" ou "S" | Oui si il n'y a pas de date renseignée | |
dateStart | String | Date de début au format (YYYY-MM-DDTHH:mm:ssZ) | Oui si aucune période bilan n'est renseignée | ||
dateEnd | String | Date de fin au format (YYYY-MM-DDTHH:mm:ssZ) | Oui si aucune période bilan n'est renseignée ou si la période Situation est renseignée | ||
accountStart | String | Premier compte retourné par l'API | Non | ||
accountEnd | String | Dernier compte retourné par l'API | Non | ||
etablissement | UUID | Sous-dossier / ObjectId de l'établissement obtenu par GET/etablissementComplet | Non |
Exemple de body
{
"codeDossier": "CEGID003",
"period": "N",
"dateStart": "2022-01-01THH:mm:ssZ",
"dateEnd": "2022-31-01THH:mm:ssZ",
"accountStart": "",
"accountEnd": "",
"etablissement": ""
}
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 dossier au format suivant :
Champ | Sous-champ1 | Sous-champ2 | Sous-champ4 | Type | Description |
---|---|---|---|---|---|
data | |||||
result | |||||
data | |||||
andebit | String | Solde débiteur début de période | |||
ancredit | String | Solde créditeur début de période | |||
mvtdebit | String | Solde débiteur des mouvements de la période | |||
mvtcredit | String | Solde créditeur des mouvements de la période | |||
sfdebit | String | Solde débiteur fin de période | |||
sfcredit | String | Solde créditeur fin de période | |||
compte | String | Numéro du compte | |||
libelle | String | libellé du compte |
Exemple de réponse
{
"data": {
"result": {
"data": [
{
"andebit": 0,
"ancredit": 0,
"mvtdebit": 354600.4,
"mvtcredit": 309161.49,
"sfdebit": 93600,
"sfcredit": 48161.09,
"compte": "40110000",
"libelle": "FOURNISSEURS"
},
{
"andebit": 0,
"ancredit": 0,
"mvtdebit": 95100,
"mvtcredit": 99800,
"sfdebit": 1300,
"sfcredit": 6000,
"compte": "41110000",
"libelle": "CLIENTS"
},
{
"andebit": 0,
"ancredit": 0,
"mvtdebit": 0,
"mvtcredit": 20000,
"sfdebit": 0,
"sfcredit": 20000,
"compte": "47100000",
"libelle": "Compte d'attente"
}
]
}
}
}
GET/getBalanceRevision
Cette API récupère la balance révision des comptes généraux d'une période bilan d'un dossier au sein d'un cabinet.
Lien vers la documentation technique
Cas d'usage
- Cette API permet de récupérer la balance révision des comptes généraux des années N et N-1 d'un dossier client.
Procédure
Il faut appeler un endpoint permettant de recupérer la balance révision :
GET https://api.cegid.com/loop-api-publiques/getBalanceRevision
Route | Méthode http | Description |
---|---|---|
/BalanceRevision | GET | Retourne la balance révision |
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
Name | Type | Description | Exemple | Obligatoire | |
---|---|---|---|---|---|
codeDossier | String | Code du dossier | CEGID003 | Oui | |
etablissement | UUID | Sous-dossier / ObjectId de l'établissement obtenu par GET/etablissementComplet | Non |
Exemple de body
{
"codeDossier": "CEGID003",
"etablissement": ""
}
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 dossier au format suivant :
Champ | Sous-champ1 | Sous-champ2 | Sous-champ4 | Type | Description |
---|---|---|---|---|---|
data | |||||
result | |||||
data | |||||
compte | String | Numéro du compte | |||
libelle | String | libellé du compte | |||
libelle de période courante | String | solde du compte de la période courante | |||
libelle de la période précédente | String | solde du compte de la période précédente |
Exemple de réponse
{
"data": {
"result": {
"data": [
{
"compte": "12000000",
"libelle": "Bénéfice",
"Exercice_2020": -14603774.68,
"Exercice_2019": 0
},
{
"compte": "18100000",
"libelle": "Comptes de liaison établissements",
"Exercice_2020": -8725908,
"Exercice_2019": 0
}
]
}
}
}
GET/getAnalyticalBalance
Cette API récupère la balance analytique des comptes généraux d'une période bilan ou situation d'un dossier au sein d'un cabinet.
Lien vers la documentation technique
Cas d'usage
- Cette API permet de récupérer la balance analytique des comptes généraux de l'année N ou N-1 ou N-2 ou S d'un dossier client.
- Elle permet également de retourner un échantillon d'axes analytiques grâce à ses paramètres (Cf. § Paramètres de la demande).
Procédure
Il faut appeler un endpoint permettant de recupérer la balance révision :
GET https://api.cegid.com/loop-api-publiques/getAnalyticalBalance
Route | Méthode http | Description |
---|---|---|
/AnalyticalBalance | GET | Retourne la balance analytique |
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
Name | Type | Description | Exemple | Obligatoire | |
---|---|---|---|---|---|
codeDossier | String | Code du dossier | DOS001 | Oui | |
period | String | Période Bilan ou période Situation | "N", "N1", "N2" ou "S" | Oui si il n'y a pas de date renseignée | |
dateStart | String | Date de début au format (YYYY-MM-DDTHH:mm:ssZ) | Oui si aucune période bilan n'est renseignée | ||
dateEnd | String | Date de fin au format (YYYY-MM-DDTHH:mm:ssZ) | Oui si aucune période bilan n'est renseignée ou si la période Situation est renseignée | ||
axe | String | Code de l'axe | Non | ||
section | String | Code de la section | Non | ||
etablissement | UUID | Sous-dossier / ObjectId de l'établissement obtenu par GET/etablissementComplet | Non |
Exemple de body
{
"codeDossier": "DOS001",
"period": "N",
"dateStart": "",
"dateEnd": "",
"axe": "",
"section": "",
"etablissement": ""
}
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 dossier au format suivant :
Champ | Sous-champ1 | Sous-champ2 | Sous-champ4 | Type | Description |
---|---|---|---|---|---|
data | |||||
message | |||||
result | |||||
data | |||||
axe | String | code de l'axe | |||
section | String | code de la section | |||
numero | String | Numéro du compte | |||
libelle | String | libellé du compte | |||
debit_0 | String | solde débiteur du compte | |||
credit_0 | String | solde créditeur du compte | |||
solde_0 | String | solde du compte |
Exemple de réponse
{
"data": {
"message": {},
"result": {
"data": [{
"axe": "ATELIER",
"section": "SECA@ATELIER",
"numero": "60313000",
"libelle": "Variat stocks",
"debit_0": "5936.94",
"credit_0": "0",
"solde_0": "5936.94"
}, {
"axe": "ATELIER",
"section": "SECA@ATALIER",
"numero": "60321000",
"libelle": "Variat stocks",
"debit_0": "8882.9",
"credit_0": "0",
"solde_0": "8882.9"
}]
}
}
}
GET/getBalanceCompared
Returns a accounting comparative balance
Cette API récupère la balance comparée des comptes généraux de 2 périodes bilan ou de 2 périodes situation d'un dossier au sein d'un cabinet.
Lien vers la documentation technique
Cas d'usage
- Cette API permet de récupérer la balance analytique des comptes généraux de l'année N ou N-1 ou N-2 ou S d'un dossier client.
Procédure
Il faut appeler un endpoint permettant de recupérer la balance révision :
GET https://api.cegid.com/loop-api-publiques/getBalanceCompared
Route | Méthode http | Description |
---|---|---|
/BalanceCompared | GET | Retourne la balance comparée |
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
Name | Type | Description | Exemple | Obligatoire | |
---|---|---|---|---|---|
codeDossier | String | Code du dossier | DOS001 | Oui | |
period | String | Période Bilan ou période Situation | "N", "N1", "N2" ou "S" | Oui si il n'y a pas de date renseignée | |
idJeuPeriode | UUID | UUID du jeu de prériode | Non | ||
etablissement | UUID | Sous-dossier / ObjectId de l'établissement obtenu par GET/etablissementComplet | Non |
Point d'attention
Le nombre de périodes comparatives doit être différent de 0. Dans le cas contraire, les éléments du solde1 (pour N-1) ne seront pas restitués.
périodes comparatives :
Exemple de body
Exemple 1 : balance comparée sur des périodes bilan "N"
{
"codeDossier": "DOS001",
"period": "N",
"idJeuPeriode": "",
"etablissement": ""
}
Exemple 2 : balance comparée sur des périodes situation "S"
{
"codeDossier": "DOS001",
"period": "S",
"dateEnd" :"2023-06-30",
"idJeuPeriode": "",
"etablissement": ""
}
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 dossier au format suivant :
Field | Description |
---|---|
numero string | code of general account |
libelle string | description |
debit_0 string | debit |
credit_0 string | credit |
debit_1 string | debit-1 |
credit_1 string | credit-1 |
solde_0 string | debit balance |
solde_1 string | credit balance |
variation string | variation |
axe string | axis |
section string | section |
Champ | Sous-champ1 | Sous-champ2 | Sous-champ4 | Type | Description |
---|---|---|---|---|---|
data | |||||
message | |||||
result | |||||
data | |||||
numero | String | Numéro du compte | |||
libelle | String | libellé du compte | |||
debit_0 | String | solde débiteur période en cours N du compte | |||
credit_0 | String | solde créditeur période N du compte | |||
debit_1 | String | solde débiteur période précedente N-1 du compte | |||
credit_1 | String | solde créditeur période précédente N-1 du comptee | |||
solde_0 | String | solde du compte de la période N | |||
solde_1 | String | solde du compte de la période N-1 | |||
variation | String | variation du solde entre N-1 et N en % |
Exemple de réponse
{
"data": {
"message": {},
"result": {
"data": [
{
"numero": "70100000",
"libelle": "Ventes de produits finis",
"debit0": 1600,
"credit0": 95100,
"debit1": 0,
"credit1": 108000,
"solde0": -93500,
"solde1": -108000,
"variation": 13.43
},
{
"numero": "60100000",
"libelle": "Achats de matières premières et fournitures",
"debit0": 309161.49,
"credit0": 1200,
"debit1": 194927.8,
"credit1": 0,
"solde0": 307961.49,
"solde1": 194927.8,
"variation": 57.99
}
]
}
}
}