Documents.Abonnements.AbonnementEntete¶
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/abonnemententete |
Lister les enregistrements |
POST |
/v2/abonnemententete |
Créer l'enregistrement |
PUT |
/v2/abonnemententete |
Mettre à jour l'enregistrement |
DELETE |
/v2/abonnemententete |
Supprimer l'enregistrement |
GET |
/v2/abonnemententete/count |
Compter les enregistrements |
POST |
/v2/abonnemententete/count |
Compter les enregistrements |
POST |
/v2/abonnemententete/recherche |
Rechercher des enregistrements |
POST |
/v2/abonnemententete/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/abonnemententete¶
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/abonnemententete?sort=<sort>&where=<where>" \
-H "Authorization: Bearer <jeton>" \
-H "Accept: application/json"
POST /v2/abonnemententete¶
Créer l'enregistrement.
Corps de la requête (application/json)
Schéma AbonnementEnteteDto — 56 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/abonnemententete" \
-H "Authorization: Bearer <jeton>" \
-H "Content-Type: application/json" \
-d '{"idAbonnement": 0, "reference": "…", "referenceExterne": "…"}'
PUT /v2/abonnemententete¶
Mettre à jour l'enregistrement.
Corps de la requête (application/json)
Schéma AbonnementEnteteDto — 56 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/abonnemententete" \
-H "Authorization: Bearer <jeton>" \
-H "Content-Type: application/json" \
-d '{"idAbonnement": 0, "reference": "…", "referenceExterne": "…"}'
DELETE /v2/abonnemententete¶
Supprimer l'enregistrement.
Corps de la requête (application/json)
Schéma AbonnementEnteteDto — 56 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/abonnemententete" \
-H "Authorization: Bearer <jeton>" \
-H "Content-Type: application/json" \
-d '{"idAbonnement": 0, "reference": "…", "referenceExterne": "…"}'
GET /v2/abonnemententete/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/abonnemententete/count?where=<where>" \
-H "Authorization: Bearer <jeton>" \
-H "Accept: application/json"
POST /v2/abonnemententete/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/abonnemententete/count" \
-H "Authorization: Bearer <jeton>" \
-H "Accept: application/json"
POST /v2/abonnemententete/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/abonnemententete/recherche" \
-H "Authorization: Bearer <jeton>" \
-H "Accept: application/json"
POST /v2/abonnemententete/save¶
Créer ou mettre à jour l'enregistrement (upsert).
Corps de la requête (application/json)
Schéma AbonnementEnteteDto — 56 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/abonnemententete/save" \
-H "Authorization: Bearer <jeton>" \
-H "Content-Type: application/json" \
-d '{"idAbonnement": 0, "reference": "…", "referenceExterne": "…"}'
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.
AbonnementEnteteDto¶
AbonnementEnteteDto — 56 propriétés
| Propriété | Type | Notes |
|---|---|---|
idAbonnement |
integer (int32) |
— |
reference |
string |
nullable |
referenceExterne |
string |
nullable |
numeroTiers |
string |
nullable |
intitule |
string |
nullable |
modele |
string |
nullable |
contrat |
string |
nullable |
typeAbonnement |
integer (int32) |
— |
typeTiersAbonnement |
integer (int32) |
— |
periodiciteAbonnement |
integer (int32) |
— |
typePeriodicite |
integer (int32) |
— |
duree |
integer (int32) |
— |
typeDuree |
integer (int32) |
— |
dateDebut |
string (date-time) |
— |
dateFin |
string (date-time) |
— |
reconduction |
boolean |
— |
pieceGeneree |
integer (int32) |
— |
soucheGeneration |
integer (int32) |
— |
idCollaborateur |
integer (int32) |
— |
periodicite |
integer (int32) |
— |
idDevise |
integer (int32) |
— |
coursDevise |
number (double) |
— |
idDepot |
integer (int32) |
— |
idAdresseLivraison |
integer (int32) |
— |
numeroTiersPayeur |
string |
nullable |
idModeExpedition |
integer (int32) |
— |
idConditionLivraison |
integer (int32) |
— |
nbFactures |
integer (int32) |
— |
blParFacture |
boolean |
— |
tauxEscompte |
number (double) |
— |
sectionAnalytique |
string |
nullable |
numeroIFRS |
string |
nullable |
donnee1 |
string |
nullable |
donnee2 |
string |
nullable |
donnee3 |
string |
nullable |
donnee4 |
string |
nullable |
idCategorieTarifaire |
integer (int32) |
— |
idCategorieComptable |
integer (int32) |
— |
colisage |
integer (int32) |
— |
typeColisage |
integer (int32) |
— |
transaction |
integer (int32) |
— |
langue |
LangueSage |
— |
regime |
integer (int32) |
— |
baseCalculEcheances |
AbonnementCalculEcheance |
— |
estGenere |
boolean |
— |
compteGeneral |
string |
nullable |
idCentraleAchat |
string |
nullable |
contact |
string |
nullable |
idBanque |
integer (int32) |
— |
idRoutage |
integer (int32) |
— |
createur |
string |
nullable |
dateModification |
string (date-time) |
— |
dateCreation |
string (date-time) |
— |
utilisateurCreateur |
string |
nullable |
lignes |
tableau de AbonnementLigneDto |
nullable |
informationsLibres |
object |
nullable |