EcrituresComptables3
  • 20 Sep 2024
  • 1 Minute à lire
  • Sombre
    Lumière
  • PDF

EcrituresComptables3

  • Sombre
    Lumière
  • PDF

Résumé de l’article

Fonction API

/v1/EcrituresComptables/EcrituresComptables3

Verbe HTTP

Post

Description

Identique au fonctionnement de la fonction EcrituresComptables2 mais permet la récupération de tous les axes analytiques.
Cette même fonction est proposée en mode asynchrone : EcrituresComptablesAsynchrone

Groupe de fonctions API

COMPT01

Paramètres de la requête

ParamètreTypeDescription
avecLibelleParDefautDesEcrituresbooleanPermet de récupérer les libellés par défaut des écritures (true) ou pas (false)
avecToutesLesRepartitionsAnalytiquesbooleanPermet de récupérer les lignes de
- True : tous les axes analytiques (true)
- False : un seul axe analytique
periodeDebutstring(date-time)Date de début de la période à prendre en compte pour les écritures comptables
periodeFinstring(date-time)Date de fin de la période à prendre en compte pour les écritures comptables
numeroDossierstring

Numéro du dossier concerné par la requête

Paramètres de la réponse

ParamètreTypeDescription
numeroDossierstring

Numéro du dossier concerné par la requête

periodeDebutstring(date-time)Date de début de la période pour laquelle sont remontées les écritures comptables
periodeFinstring(date-time)Date de fin de la période pour laquelle sont remontées les écritures comptables
ecrituresEcrituresComptablesLigne[]Liste d'éléments structurés contenant les informations de chaque ligne d'écritures comptables (cf. détail ci-dessous)

EcrituresComptablesLigne

ParamètreTypeDescription
periodestring(date-time)Période de paie à laquelle est rattachée la ligne d'écritures comptables
comptestringNuméro du compte
libellestringLibellé de la ligne d'écriture pour une ligne "normales". Remplacé par la valeur/catégorie de l'axe analytique à laquelle est rattachée la ligne lorsqu'il s'agit d'une ligne liée à une répartition analytique
sensstringIndique s'il s'agit d'un crédit (C) ou d'un débit (D). Sera vide s'il s'agit d'une ligne liée à la répartition analytique
indexRepartitioninteger(int32)Index de l'axe analytique s'il s'agit d'une ligne liée à la répartition analytique. Vaut 0 sinon
valeurnumber(double)Montant de la ligne
pctRepartitionnumber(double)Pourcentage de la répartition affecté à la catégorie de l'axe analytique indiqué par l'index (IndexRepartition), dans le cas d'une ligne liée à la répartition analytique. Vaut 0 sinon

Requête

{
  "avecLibelleParDefautDesEcritures": true,
  "avecToutesLesRepartitionsAnalytiques": true,
  "periodeDebut": "2020-10-14T21:46:24",
  "periodeFin": "2020-10-14T21:46:24",
  "numeroDossier": "string"
}

Réponse

{
  "numeroDossier": "string",
  "periodeDebut": "2020-10-14T21:46:24",
  "periodeFin": "2020-10-14T21:46:24",
  "ecritures": [
    {
      "periode": "2020-10-14T21:46:24",
      "compte": "string",
      "libelle": "string",
      "sens": "string",
      "indexRepartition": 0,
      "valeur": 10.5,
      "pctRepartition": 10.5
    },
    {
      "periode": "2020-10-14T21:46:24",
      "compte": "string",
      "libelle": "string",
      "sens": "string",
      "indexRepartition": 0,
      "valeur": 10.5,
      "pctRepartition": 10.5
    }
  ]
}

Messages d'erreur

ErreurMessageDescription

Cet article vous a-t-il été utile ?

Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.