Catalogue.Tarif
En bref
8 opérations sur 4 chemins. Préfixe /v2. Authentification JWT (voir Démarrer).
Opérations
| Méthode | Chemin | Rôle |
|---|---|---|
GET |
/v2/tarif |
Lister les enregistrements |
POST |
/v2/tarif |
Créer l'enregistrement |
PUT |
/v2/tarif |
Mettre à jour l'enregistrement |
DELETE |
/v2/tarif |
Supprimer l'enregistrement |
GET |
/v2/tarif/count |
Compter les enregistrements |
POST |
/v2/tarif/count |
Compter les enregistrements |
POST |
/v2/tarif/recherche |
Rechercher des enregistrements |
POST |
/v2/tarif/save |
Créer ou mettre à jour l'enregistrement (upsert) |
Rôle déduit
La spécification ne porte ni summary ni description d'opération : la colonne Rôle est déduite mécaniquement de la méthode HTTP et du chemin.
Détail
GET /v2/tarif
Lister les enregistrements.
Paramètres
| Nom | Emplacement | Type | Obligatoire | Description |
|---|---|---|---|---|
sort |
query | string |
non | - |
where |
query | string |
non | - |
Réponses
| Code | Description | Schéma de data |
|---|---|---|
200 |
OK | - |
401 |
Unauthorized | - |
403 |
Forbidden | - |
Exemple
curl -s -X GET "https://<votre-connecteur>/v2/tarif?sort=<sort>&where=<where>" \
-H "Authorization: Bearer <jeton>" \
-H "Accept: application/json"
POST /v2/tarif
Créer l'enregistrement.
Corps de la requête (application/json)
Schéma TarifDto - 39 propriétés (détail : Schémas).
Écriture partielle : seules les propriétés présentes dans le corps sont écrites (voir Conventions).
Réponses
| Code | Description | Schéma de data |
|---|---|---|
200 |
OK | - |
401 |
Unauthorized | - |
403 |
Forbidden | - |
Exemple
curl -s -X POST "https://<votre-connecteur>/v2/tarif" \
-H "Authorization: Bearer <jeton>" \
-H "Content-Type: application/json" \
-d '{"numeroTiers": "…", "numeroCentraleAchat": "…", "referenceArticle": "…"}'
PUT /v2/tarif
Mettre à jour l'enregistrement.
Corps de la requête (application/json)
Schéma TarifDto - 39 propriétés (détail : Schémas).
Écriture partielle : seules les propriétés présentes dans le corps sont écrites (voir Conventions).
Réponses
| Code | Description | Schéma de data |
|---|---|---|
200 |
OK | - |
401 |
Unauthorized | - |
403 |
Forbidden | - |
Exemple
curl -s -X PUT "https://<votre-connecteur>/v2/tarif" \
-H "Authorization: Bearer <jeton>" \
-H "Content-Type: application/json" \
-d '{"numeroTiers": "…", "numeroCentraleAchat": "…", "referenceArticle": "…"}'
DELETE /v2/tarif
Supprimer l'enregistrement.
Corps de la requête (application/json)
Schéma TarifDto - 39 propriétés (détail : Schémas).
Écriture partielle : seules les propriétés présentes dans le corps sont écrites (voir Conventions).
Réponses
| Code | Description | Schéma de data |
|---|---|---|
200 |
OK | - |
401 |
Unauthorized | - |
403 |
Forbidden | - |
Exemple
curl -s -X DELETE "https://<votre-connecteur>/v2/tarif" \
-H "Authorization: Bearer <jeton>" \
-H "Content-Type: application/json" \
-d '{"numeroTiers": "…", "numeroCentraleAchat": "…", "referenceArticle": "…"}'
GET /v2/tarif/count
Compter les enregistrements.
Paramètres
| Nom | Emplacement | Type | Obligatoire | Description |
|---|---|---|---|---|
where |
query | string |
non | - |
Réponses
| Code | Description | Schéma de data |
|---|---|---|
200 |
OK | - |
401 |
Unauthorized | - |
403 |
Forbidden | - |
Exemple
curl -s -X GET "https://<votre-connecteur>/v2/tarif/count?where=<where>" \
-H "Authorization: Bearer <jeton>" \
-H "Accept: application/json"
POST /v2/tarif/count
Compter les enregistrements.
Réponses
| Code | Description | Schéma de data |
|---|---|---|
200 |
OK | - |
401 |
Unauthorized | - |
403 |
Forbidden | - |
Exemple
curl -s -X POST "https://<votre-connecteur>/v2/tarif/count" \
-H "Authorization: Bearer <jeton>" \
-H "Accept: application/json"
POST /v2/tarif/recherche
Rechercher des enregistrements.
Réponses
| Code | Description | Schéma de data |
|---|---|---|
200 |
OK | - |
401 |
Unauthorized | - |
403 |
Forbidden | - |
Exemple
curl -s -X POST "https://<votre-connecteur>/v2/tarif/recherche" \
-H "Authorization: Bearer <jeton>" \
-H "Accept: application/json"
POST /v2/tarif/save
Créer ou mettre à jour l'enregistrement (upsert).
Corps de la requête (application/json)
Schéma TarifDto - 39 propriétés (détail : Schémas).
Écriture partielle : seules les propriétés présentes dans le corps sont écrites (voir Conventions).
Réponses
| Code | Description | Schéma de data |
|---|---|---|
200 |
OK | - |
401 |
Unauthorized | - |
403 |
Forbidden | - |
Exemple
curl -s -X POST "https://<votre-connecteur>/v2/tarif/save" \
-H "Authorization: Bearer <jeton>" \
-H "Content-Type: application/json" \
-d '{"numeroTiers": "…", "numeroCentraleAchat": "…", "referenceArticle": "…"}'
Schémas
Schémas résolus à un niveau : les propriétés qui référencent un autre schéma sont citées par leur nom, sans être dépliées.
TarifDto
TarifDto - 39 propriétés
| Propriété | Type | Notes |
|---|---|---|
numeroTiers |
string |
nullable, Numéro du client qui profite du tarif. |
numeroCentraleAchat |
string |
nullable, Numéro de la centrale d'achat associée au client. |
referenceArticle |
string |
nullable, Référence de l'article sur lequel s'applique le tarif. |
referenceFournisseur |
string |
nullable, Référence fournisseur de l'article. |
codeBarre |
string |
nullable, Code barre de l'article. |
photo |
string |
nullable, URL ou chemin de la photo de l'article. |
designation |
string |
nullable, Désignation de l'article. |
referenceEnumere |
string |
nullable, Référence énumérée de l'article. |
codeBarreEnumere |
string |
nullable, Code barre énuméré de l'article. |
idGamme1 |
integer (int32) |
Identifiant de la première gamme de l'article. |
idGamme2 |
integer (int32) |
Identifiant de la seconde gamme de l'article. |
designationGamme1 |
string |
nullable, Désignation de la première gamme. |
designationGamme2 |
string |
nullable, Désignation de la seconde gamme. |
cO_No |
integer (int32) |
Numéro de conditionnement (CO_No) du tarif, le cas échéant. |
conditionnement |
string |
nullable, Libellé du conditionnement (énuméré), le cas échéant. |
borneInferieure |
number (double) |
Borne inférieure du tarif (quantité ou valeur minimale). |
borneSuperieure |
number (double) |
Borne supérieure du tarif (quantité ou valeur maximale). |
borneType |
integer (int32) |
Type de borne (quantité, montant, etc.). |
quantiteStockReelle |
number (double) |
Quantité réelle en stock de l'article. |
quantiteStockATerme |
number (double) |
Quantité en stock à terme de l'article. |
poidsNet |
number (double) |
Poids net de l'article. |
poidsBrut |
number (double) |
Poids brut de l'article. |
facturationPoids |
boolean |
Indique si la facturation se fait au poids. |
prixVente |
number (double) |
Prix de vente de l'article. |
prixAchat |
number (double) |
Prix d'achat de l'article. |
isTTC |
boolean |
Indique si le prix courant (PrixVente / PrixRemise) est exprimé TTC. |
remiseArticle |
Remise |
- |
remiseFamille |
Remise |
- |
remiseTiers |
Remise |
- |
remiseTiersFiche |
Remise |
- |
remiseArtTiersException |
Remise |
- |
remiseArtTiersCategorie |
Remise |
- |
remiseFamTiersException |
Remise |
- |
remiseFamTiersCategorie |
Remise |
- |
typeRemise |
integer (int32) |
Type de remise appliqué (montant, pourcentage, etc.). |
tauxRemise |
number (double) |
Taux de remise appliqué. |
texteRemise |
string |
nullable, Texte explicatif de la remise. |
prixRemise |
number (double) |
Prix après application de la remise. |
taxes |
tableau de TaxeArticle |
nullable, Taxes calculées (TVA, taxes parafiscales, taxe au poids, TP) sur le prix remisé. |