Aller au contenu

Articles

Les articles correspondent aux prestations, fournitures ou services proposés par la société (BU).
Chaque article est identifié de manière unique par son codeArticle.

Exemples d’articles :

  • Fourniture et pose d'une cavurne
  • Nettoyage d'un monument
  • Plaque personnalisée
  • Travaux de marbrerie

Un article contient notamment :

  • son identifiant (codeArticle)
  • son libellé (libelle)
  • sa catégorie (famille et sous-famille)
  • sa TVA
  • son état (actif, supprimé)
  • ses informations d’ordonnancement

Structure d’un article

Champ Description
codeArticle Identifiant unique de l’article
libelle Nom de l’article
libelleTechnique Libellé technique interne
commentaire Commentaire associé
isActive Indique si l’article est actif
isDeleted Indique si l’article est supprimé
creationDate Date de création
updateDate Date de dernière modification
sfArticle Sous-famille de l’article
sfArticle.codeSf Code sous-famille
sfArticle.libelle Libellé sous-famille
sfArticle.familleArticle Famille de l’article
tva Informations de TVA
tva.codeTva Code TVA
tva.taux Taux de TVA
ordonnancementHaut2025 Ordonnancement haut
ordonnancementBas2025 Ordonnancement bas

Pagination

Certains endpoints retournent une liste paginée d’articles.

Structure :

Champ Description
content Liste des articles
totalPages Nombre total de pages
totalElements Nombre total d’articles
pageable.pageNumber Numéro de la page courante
pageable.pageSize Nombre d’éléments par page

Exemple de réponse :

{
  "content": [
    {
      "codeArticle": "CAVURNE",
      "libelle": "Fourniture et pose d'une cavurne",
      "isActive": true,
      "isDeleted": false,
      "creationDate": "2026-01-31T23:00:00.000+00:00",
      "updateDate": "2026-02-08T23:00:00.000+00:00",
      "sfArticle": {
        "codeSf": "TRAV",
        "libelle": "Travaux",
        "familleArticle": {
          "codeFamille": "MARB",
          "libelle": "Marbrerie"
        }
      },
      "tva": {
        "codeTva": "2",
        "libelle": "TVA 20%",
        "taux": 20.0
      }
    }
  ],
  "totalPages": 25,
  "totalElements": 246,
  "pageable": {
    "pageNumber": 0,
    "pageSize": 10
  }
}

Récupération d’un article par code

Cet endpoint retourne un seul article.

Le paramètre codeArticle correspond à l’identifiant unique de l’article.

Exemple :

GET /v1/article/CAVURNE?codeBu=FUN

Réponse :

{
  "codeArticle": "CAVURNE",
  "libelle": "Fourniture et pose d'une cavurne",
  "isActive": true,
  "isDeleted": false,
  "creationDate": "2026-01-31T23:00:00.000+00:00",
  "updateDate": "2026-02-08T23:00:00.000+00:00"
}

Liste des endpoints disponibles

GET /v1/article/all

Retourne la liste paginée de tous les articles actifs et non supprimés.

Paramètres :

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

Exemple :

GET /v1/article/all?codeBu={{codeBu}}&page=0

GET /v1/article/{codeArticle}

Retourne un article unique.

Paramètres :

Path :

Paramètre Type Obligatoire Description
codeArticle string oui Code unique de l’article

Query :

Paramètre Type Obligatoire Description
codeBu string oui Code de la BU (société)

Exemple :

GET /v1/article/CAVURNE?codeBu={{codeBu}}

GET /v1/article/latest

Retourne la liste paginée des articles créés ou modifiés depuis une date.

Paramètres :

Paramètre Type Obligatoire Description
codeBu string oui Code de la BU (société)
depuis string oui Date de début de synchronisation
page integer oui Numéro de page (commence à 0)

Format de la date :

dd/MM/yyyy HH:mm:ss

Exemple :

GET /v1/article/latest?codeBu={{codeBu}}&depuis=01/01/2026 00:00:00&page=0

GET /v1/article/delete/latest

Retourne la liste paginée des articles supprimés depuis une date.

Paramètres :

Paramètre Type Obligatoire Description
codeBu string oui Code de la BU (société)
depuis string oui Date de début de synchronisation
page integer oui Numéro de page (commence à 0)

Format de la date :

dd/MM/yyyy HH:mm:ss

Exemple :

GET /v1/article/delete/latest?codeBu={{codeBu}}&depuis=01/01/2026 00:00:00&page=0