Guide de migration

Catégorie : Core
Domaine : Comptabilite
Service : EntryAccountBalance
Méthode : GetAccountRangeBalance

Contrat de la V1

Verbe : POST
URL : https://cegid-expert-webapi-core.cegid.com/Comptabilite/EntryAccountBalanceWebService/GetAccountRangeBalance
Paramètres : BODY
Le contrat de la V1 impose la saisie soit d'un code rubrique, soit d'un compte général soit d'un compte auxiliaire.
Il est également nécessaire de préciser des informations permettant de calculer la période sur laquelle on souhaite obtenir le solde et sur quels types d'écritures.. D'autres paramètres sont disponibles comme la possibilité de rechercher ou non sur les écritures d'à-nouveau ou la possibilité de choisir le journal à prendre en compte.
Les types d’écritures à rechercher sont les écritures normales (1), les écritures de simulation (2) et les écritures de situations (4).
Ces valeurs sont des puissances de 2 afin de pouvoir les combiner avec une opération binaire.
Par exemple, la valeur 7 est la combinaison des valeurs 1, 2 et 4.
Ici, seules les écritures normales sont demandées.

{
  "SourceInformationType": 3,
  "ItemCode": "FATTEN",
  "EntryType": 1,
  "PeriodType": 1,
  "FiscalYearDateRangeBoundaryType": 1,
  "NumberInPeriode": 1,
  "CarryForwardKindType": 0,
  "FiscalYearType": 0,
  "Currency": "",
  "Currencytype": 0,
  "Journal": "ACH"
}

Réponse :
Le retour se présente sous la forme d’un objet présentant une unique propriété correspondant au solde.

{
  "AccountReport": -1200.0000
}

Contrat de la V2

Verbe : POST
URL : https://api.cegid.com/cpa-expert-coreComptabilite/AccountingEntriesBalanceWebService/GetAccountRangeBalanceWithFilters
Paramètres : BODY
Le contrat de la V2 est similaire.
La principale différence réside dans le fait que la propriété correspondant au journal n'existe plus.
A la place, il faut utiliser un filtre sur la propriété correspondant au journal.

Les numéros des propriétés sont affichés dans l’APIM :

Le contrat de la V2 diffère dans le choix des types d’écritures à rechercher. Au lieu de combiner les valeurs, on les place dans une collection. Pour cette raison, les valeurs n’ont pas besoin d’être des puissances de 2, elles se suivent.
La valeur 7 de la V1 correspond donc à la collection [1,2,3].
Ici, seules les écritures normales sont demandées.

Filtrer sur la propriété 1 pour le journal avec l’opérateur de comparaison « Egal » (1).

{
    "ItemCode": "FATTEN",
    "ItemSourceKind": 3,
    "EntryTypes": [1],
    "PeriodKind": 1,
    "BoundaryKind": 1,
    "NumberInPeriod": 1,
    "CarryForwardKind": 0,
    "FiscalYearKind": 0,
    "Currency": "",
    "CurrencyKind": 0,
    "Filters": [
        {
            "Property": 1,
            "ConstantValue": "ACH",
            "ComparisonOperateur": 1,
            "Inversion": false,
            "LogicOperator": 1
        }
    ]
}

Réponse :

{
  "balance": -1200
}