Documents.Abonnements.AbonnementLigne
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/abonnementligne |
Lister les enregistrements |
POST |
/v2/abonnementligne |
Créer l'enregistrement |
PUT |
/v2/abonnementligne |
Mettre à jour l'enregistrement |
DELETE |
/v2/abonnementligne |
Supprimer l'enregistrement |
GET |
/v2/abonnementligne/count |
Compter les enregistrements |
POST |
/v2/abonnementligne/count |
Compter les enregistrements |
POST |
/v2/abonnementligne/recherche |
Rechercher des enregistrements |
POST |
/v2/abonnementligne/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/abonnementligne
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/abonnementligne?sort=<sort>&where=<where>" \
-H "Authorization: Bearer <jeton>" \
-H "Accept: application/json"
POST /v2/abonnementligne
Créer l'enregistrement.
Corps de la requête (application/json)
Schéma AbonnementLigneDto - 69 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/abonnementligne" \
-H "Authorization: Bearer <jeton>" \
-H "Content-Type: application/json" \
-d '{"id": 0, "idAbonnement": 0, "numeroLigne": 0}'
PUT /v2/abonnementligne
Mettre à jour l'enregistrement.
Corps de la requête (application/json)
Schéma AbonnementLigneDto - 69 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/abonnementligne" \
-H "Authorization: Bearer <jeton>" \
-H "Content-Type: application/json" \
-d '{"id": 0, "idAbonnement": 0, "numeroLigne": 0}'
DELETE /v2/abonnementligne
Supprimer l'enregistrement.
Corps de la requête (application/json)
Schéma AbonnementLigneDto - 69 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/abonnementligne" \
-H "Authorization: Bearer <jeton>" \
-H "Content-Type: application/json" \
-d '{"id": 0, "idAbonnement": 0, "numeroLigne": 0}'
GET /v2/abonnementligne/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/abonnementligne/count?where=<where>" \
-H "Authorization: Bearer <jeton>" \
-H "Accept: application/json"
POST /v2/abonnementligne/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/abonnementligne/count" \
-H "Authorization: Bearer <jeton>" \
-H "Accept: application/json"
POST /v2/abonnementligne/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/abonnementligne/recherche" \
-H "Authorization: Bearer <jeton>" \
-H "Accept: application/json"
POST /v2/abonnementligne/save
Créer ou mettre à jour l'enregistrement (upsert).
Corps de la requête (application/json)
Schéma AbonnementLigneDto - 69 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/abonnementligne/save" \
-H "Authorization: Bearer <jeton>" \
-H "Content-Type: application/json" \
-d '{"id": 0, "idAbonnement": 0, "numeroLigne": 0}'
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.
AbonnementLigneDto
AbonnementLigneDto - 69 propriétés
| Propriété | Type | Notes |
|---|---|---|
id |
integer (int32) |
- |
idAbonnement |
integer (int32) |
- |
numeroLigne |
integer (int32) |
- |
reference |
string |
nullable |
designation |
string |
nullable |
reconduction |
ReconductionLigne |
- |
texteSupplementaire |
string |
nullable |
referenceExterne |
string |
nullable |
createur |
string |
nullable |
dateModification |
string (date-time) |
- |
dateCreation |
string (date-time) |
- |
utilisateurCreateur |
string |
nullable |
refArticle |
string |
nullable |
refArticleCompose |
string |
nullable |
refArticleClient |
string |
nullable |
refFournisseur |
string |
nullable |
idGamme1 |
integer (int32) |
- |
idGamme2 |
integer (int32) |
- |
quantite |
number (double) |
- |
poidsNet |
number (double) |
- |
poidsBrut |
number (double) |
- |
remiseType1 |
RemiseTypeLigne |
- |
remiseValeur1 |
number (double) |
- |
remiseType2 |
RemiseTypeLigne |
- |
remiseValeur2 |
number (double) |
- |
remiseType3 |
RemiseTypeLigne |
- |
remiseValeur3 |
number (double) |
- |
prixUnitaire |
number (double) |
- |
prixUnitaireTTC |
number (double) |
- |
prixUnitaireDevise |
number (double) |
- |
prixRevientUnitaire |
number (double) |
- |
montantHT |
number (double) |
- |
montantTTC |
number (double) |
- |
cmup |
number (double) |
- |
codeTaxe1 |
string |
nullable |
taxe1 |
number (double) |
- |
typeTaux1 |
TypeTauxTaxe |
- |
typeTaxe1 |
TypeTaxe |
- |
codeTaxe2 |
string |
nullable |
taxe2 |
number (double) |
- |
typeTaux2 |
TypeTauxTaxe |
- |
typeTaxe2 |
TypeTaxe |
- |
codeTaxe3 |
string |
nullable |
taxe3 |
number (double) |
- |
typeTaux3 |
TypeTauxTaxe |
- |
typeTaxe3 |
TypeTaxe |
- |
sectionAnalytique |
string |
nullable |
idDepot |
integer (int32) |
- |
idCollaborateur |
integer (int32) |
- |
conditionnement |
string |
nullable |
quantiteConditionnement |
number (double) |
- |
ligneTTC |
TypePrix |
- |
estValorise |
boolean |
- |
estNomenclature |
boolean |
- |
estTypeRemisePied |
boolean |
- |
estTypeRemiseExceptionnelle |
boolean |
- |
estFactureAuPoids |
boolean |
- |
estSoumisEscompte |
boolean |
- |
periodicite |
PeriodiciteLigne |
- |
dateDebutFacturation |
string (date-time) |
- |
dateFinFacturation |
string (date-time) |
- |
prorata |
AbonnementProrataLigne |
- |
gestionAnnee |
boolean |
- |
nbPeriodes |
integer (int32) |
- |
codeRessource |
string |
nullable |
quantiteRessource |
integer (int32) |
- |
idTexteSupplementaire |
integer (int32) |
- |
idSousTotal |
integer (int32) |
- |
informationsLibres |
object |
nullable |