Créer une pièce comptable

API Reference : journaux

Description

Création d’une pièce comptable en respectant les règles métier de l’application.

L’action POST /{datasetId}/journaux('{id}')/creerPieceComptable ajoute une collection d’écritures équilibrées dans un journal :

L’action creerPieceComptable dépend de la ressource journal.
La structure du body à passer à l’action est composée :
- d’une entête contenant des éléments communs à l’ensemble des lignes de la pièce ou à affecter par défaut pour chaque ligne.
- d’un ensemble de lignes d’écritures au format Ecritures.

Remarque :

Cette action accepte un paramètre facultatif booléen controle qui permet de déclencher les tests de cohérence sans enregistrement de la pièce.
Ne pas préciser ce paramètre équivaut à lui affecter sa valeur par défaut qui est false.
Sans ce paramètre, si aucune erreur n’a été détectée, la pièce sera créée.

Ce paramètre permet par exemple de vérifier successivement toutes les pièces à importer pour refuser l’import si au moins une des pièces est en erreur :

Appel pour chaque pièce de /{datasetId}/journaux('{id}')/creerPieceComptable?controle=true pour vérifier s’il y a des pièces en erreur.
Si aucune erreur, appel pour chaque pièce de /{datasetId}/journaux('{id}')/creerPieceComptable pour procéder réellement à l’import des pièces.

</div>

L’application d’exemple Exemples / Projet d’application en C# .NET + JavaScript intègre une fonctionnalité d’import d’écritures utilisant creerPieceComptable.

Paramètres

Nom	Type	Description	Valeur
controle	booléen	Permet de déclencher les tests de cohérence de la pièce sans l’enregistrer	false

Propriétés

Propriétés	Type	Description
date *	datetime	Date de la pièce comptable
extProvenance	ecritures[..]	Origine de l’écriture Ecritures Plus d'infos
extSequence	Integer	Numéro de séquence de l’origine de la pièce
ecritures	ecritures[..]	Liste des Ecritures de la pièce comptable Plus d'infos

Route

Verbe	Route	Description
POST	`/{datasetId}/journaux('{id}')`/creerPieceComptable	création d’une pièce comptable
POST	`/{datasetId}/journaux('{id}')`/creerPieceComptable?controle=true	Contrôle d’une pièce comptable

Informations

origine écriture :Permet d’indiquer si l’écriture est générée par une fonction d’automatisation de l’application (Banque,Achats ou Ventes)ou par l’Api Publique.
Ecritures, équilibre de la pièce : Pour tous les types de journaux, il faut impérativement passer une collection d’écritures équilibrées.

Exemples d’affectation des propriétés pour POST

Création d’une pièce.

       {

         "date": "2020-11-05T00:00:00Z",
         "ecritures": [
       {
         "reference": "",
         "ExtProvenance": "ImportAPI",
         "numeroFacture": "",
         "[email protected]": "{url API}/{datasetId}/comptes('{id Compte}')",
         "[email protected]":"{url API}/{datasetId}/tiers('{id Tiers}')",
         "intitule": "Fact Bague's en or",
         "[email protected]":"{url API}/{datasetId}/modesReglement('{id Mode reglement}')",
         "echeance": "2020-07-31T00:00:00Z",
         "sens": "Debit",
         "montant": 306.0
      },
      {
          "reference": "",
          "ExtProvenance": "ImportAPI",
          "numeroFacture": "",
          "[email protected]": "{url API}/{datasetId}/comptes('{id Compte}')",
          "tiers": null,
          "intitule": "Fact Bague's en or",
          "modeReglement": null,
          "echeance": null,
          "sens": "Credit",
          "montant": 51.0
      },
      {
          "reference": "",
          "ExtProvenance": "ImportAPI",
          "numeroFacture": "",
          "[email protected]": "{url API}/{datasetId}/comptes('{id Compte}')",
          "tiers": null,
          "intitule": "Fact Bague's en or",
          "modeReglement": null,
          "echeance": null,
          "sens": "Credit",
          "montant": 240.0
      },
      {
          "reference": "",
          "ExtProvenance": "ImportAPI",
          "numeroFacture": "",
          "[email protected]": "{url API}/{datasetId}/comptes('{id Compte}')",
          "tiers": null,
          "intitule": "Fact Bague's en or",
          "modeReglement": null,
          "echeance": null,
          "sens": "Credit",
          "montant": 15.0
      }
  ]
}
}