Aller au contenu

Pièces commerciales

Les pièces commerciales représentent les documents de vente rattachés à un dossier (ex. obsèques, crémation, etc.).
Elles sont typées, comme pour les tiers.

Types possibles :

typePieceCommerciale Description
devis Devis
commande Commande
facture Facture

Chaque pièce est identifiée principalement par son numeroPiece (ex: F162600022).

Structure d’une pièce commerciale

Une pièce commerciale est composée de :

  • un contexte (dossier, site)
  • une entête (numéro, date, type)
  • un statut
  • un client (tiers)
  • des lignes (articles facturés)

Champs principaux :

Champ Description
dossier.idDossier Identifiant technique du dossier
dossier.numeroDossier Numéro du dossier
dossier.typeActivite Type d’activité du dossier
site.codeSite Code du site
site.nomSite Nom du site
entete.datePiece Date de la pièce
entete.numeroPiece Numéro de la pièce (identifiant principal)
entete.referencePiece Référence (souvent identique au numéro)
entete.typeFacture Libellé du type (ex: Facture)
statut.libelle Statut métier (ex: Imprimée)
client.codeTiers Code du client
lignes Liste des lignes de la pièce

Lignes de pièce

Chaque ligne correspond à un article (avec éventuellement une sous-référence).

Champ Description
codeArticle Code article
codeSousReference Sous-référence (optionnel)
position Position dans la pièce
quantite Quantité
puHt / puTtc Prix unitaire HT / TTC
totalHt / totalTtc Total HT / TTC
codeTva Code TVA
tva Taux TVA
remise Remise (en %) ou valeur selon configuration
totalRemise Montant total de remise
totalTva Montant total TVA
commentaire Commentaire de la ligne (peut contenir du HTML)

Notes :

  • codeSousReference est présent uniquement pour certains articles gérés en sous-références.
  • commentaire peut contenir du HTML (ex: <div>...</div>, &nbsp;).

Pagination

Les endpoints de liste retournent une structure paginée.

Champ Description
content Liste des pièces
totalPages Nombre total de pages
totalElements Nombre total de pièces
pageable.pageNumber Numéro de la page
pageable.pageSize Taille de la page

Liste des endpoints disponibles

Le paramètre typePieceCommerciale est une path variable.

GET /v1/piece-commerciale/{typePieceCommerciale}/all

Retourne la liste paginée des pièces commerciales pour un type donné.

Path variables :

Paramètre Type Obligatoire Description
typePieceCommerciale string oui devis, commande, facture

Query parameters :

Paramètre Type Obligatoire Description
codeBu string oui Code de la BU
page integer oui Numéro de page (commence à 0)

Exemples :

GET /v1/piece-commerciale/facture/all?codeBu={{ codeBu }}&page=0
````

```http
GET /v1/piece-commerciale/devis/all?codeBu={{ codeBu }}&page=0

GET /v1/piece-commerciale/{typePieceCommerciale}/{numeroPiece}

Retourne une pièce commerciale (avec ses lignes) à partir de son numéro.

Path variables :

Paramètre Type Obligatoire Description
typePieceCommerciale string oui devis, commande, facture
numeroPiece string oui Numéro de pièce (ex: F162600022)

Query parameters :

Paramètre Type Obligatoire Description
codeBu string oui Code de la BU

Exemple :

GET /v1/piece-commerciale/facture/F162600022?codeBu={{ codeBu }}

GET /v1/piece-commerciale/{typePieceCommerciale}/latest

Retourne les pièces créées ou modifiées depuis une date (synchronisation).

Path variables :

Paramètre Type Obligatoire Description
typePieceCommerciale string oui devis, commande, facture

Query parameters :

Paramètre Type Obligatoire Description
codeBu string oui Code de la BU
depuis string oui Date de synchronisation
page integer oui Numéro de page

Format :

dd/MM/yyyy HH:mm:ss

Exemple :

GET /v1/piece-commerciale/facture/latest?codeBu={{ codeBu }}&depuis=01/01/2026 00:00:00&page=0

GET /v1/piece-commerciale/{typePieceCommerciale}/delete/latest

Retourne les pièces supprimées depuis une date.

Path variables :

Paramètre Type Obligatoire Description
typePieceCommerciale string oui devis, commande, facture

Query parameters :

Paramètre Type Obligatoire Description
codeBu string oui Code de la BU
depuis string oui Date de synchronisation
page integer oui Numéro de page

Format :

dd/MM/yyyy HH:mm:ss

Exemple :

GET /v1/piece-commerciale/facture/delete/latest?codeBu={{ codeBu }}&depuis=01/01/2026 00:00:00&page=0