Parametres.General.DossierParamCial¶
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/dossierparamcial |
Lister les enregistrements |
POST |
/v2/dossierparamcial |
Créer l'enregistrement |
PUT |
/v2/dossierparamcial |
Mettre à jour l'enregistrement |
DELETE |
/v2/dossierparamcial |
Supprimer l'enregistrement |
GET |
/v2/dossierparamcial/count |
Compter les enregistrements |
POST |
/v2/dossierparamcial/count |
Compter les enregistrements |
POST |
/v2/dossierparamcial/recherche |
Rechercher des enregistrements |
POST |
/v2/dossierparamcial/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/dossierparamcial¶
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/dossierparamcial?sort=<sort>&where=<where>" \
-H "Authorization: Bearer <jeton>" \
-H "Accept: application/json"
POST /v2/dossierparamcial¶
Créer l'enregistrement.
Corps de la requête (application/json)
Schéma DossierParamCialDto — 48 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/dossierparamcial" \
-H "Authorization: Bearer <jeton>" \
-H "Content-Type: application/json" \
-d '{"baseEncours": 0, "periodeEncours": 0, "gestionAnalytique": 0}'
PUT /v2/dossierparamcial¶
Mettre à jour l'enregistrement.
Corps de la requête (application/json)
Schéma DossierParamCialDto — 48 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/dossierparamcial" \
-H "Authorization: Bearer <jeton>" \
-H "Content-Type: application/json" \
-d '{"baseEncours": 0, "periodeEncours": 0, "gestionAnalytique": 0}'
DELETE /v2/dossierparamcial¶
Supprimer l'enregistrement.
Corps de la requête (application/json)
Schéma DossierParamCialDto — 48 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/dossierparamcial" \
-H "Authorization: Bearer <jeton>" \
-H "Content-Type: application/json" \
-d '{"baseEncours": 0, "periodeEncours": 0, "gestionAnalytique": 0}'
GET /v2/dossierparamcial/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/dossierparamcial/count?where=<where>" \
-H "Authorization: Bearer <jeton>" \
-H "Accept: application/json"
POST /v2/dossierparamcial/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/dossierparamcial/count" \
-H "Authorization: Bearer <jeton>" \
-H "Accept: application/json"
POST /v2/dossierparamcial/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/dossierparamcial/recherche" \
-H "Authorization: Bearer <jeton>" \
-H "Accept: application/json"
POST /v2/dossierparamcial/save¶
Créer ou mettre à jour l'enregistrement (upsert).
Corps de la requête (application/json)
Schéma DossierParamCialDto — 48 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/dossierparamcial/save" \
-H "Authorization: Bearer <jeton>" \
-H "Content-Type: application/json" \
-d '{"baseEncours": 0, "periodeEncours": 0, "gestionAnalytique": 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.
DossierParamCialDto¶
DossierParamCialDto — 48 propriétés
| Propriété | Type | Notes |
|---|---|---|
baseEncours |
integer (int32) |
— |
periodeEncours |
integer (int32) |
— |
gestionAnalytique |
integer (int32) |
— |
gestionDevise |
integer (int32) |
— |
gestionQuantite |
integer (int32) |
— |
contremarque |
integer (int32) |
— |
tauxEscompte |
number (double) |
— |
exonerationTVA |
string |
nullable |
creerRdvOutlook |
boolean |
— |
formatFacture |
integer (int32) |
— |
gestionMulti |
integer (int32) |
— |
referenceStructuree |
integer (int32) |
— |
libelleEntete1 |
string |
nullable |
libelleEntete2 |
string |
nullable |
libelleEntete3 |
string |
nullable |
libelleEntete4 |
string |
nullable |
libellePoidsNet |
string |
nullable |
libellePoidsBrut |
string |
nullable |
journalTransfert1 |
string |
nullable |
journalTransfert2 |
string |
nullable |
journalTransfert3 |
string |
nullable |
journalTransfert4 |
string |
nullable |
journalTransfert5 |
string |
nullable |
journalTransfert6 |
string |
nullable |
pieceTransfert1 |
integer (int32) |
— |
pieceTransfert2 |
integer (int32) |
— |
pieceTransfert3 |
integer (int32) |
— |
pieceTransfert4 |
integer (int32) |
— |
libelleTransfert1 |
integer (int32) |
— |
libelleTransfert2 |
integer (int32) |
— |
libelleTransfert3 |
integer (int32) |
— |
libelleTransfert4 |
integer (int32) |
— |
transfertCaisse |
integer (int32) |
— |
journalCaisse |
string |
nullable |
pieceEcritureReglement |
integer (int32) |
— |
conversionDevise |
integer (int32) |
— |
transfertDevise |
integer (int32) |
— |
stockIndisponible |
integer (int32) |
— |
stockSaisie |
integer (int32) |
— |
uniciteLot |
boolean |
— |
prioriteDestockage |
integer (int32) |
— |
gestionControle |
boolean |
— |
alerteStockNegatif |
boolean |
— |
echeances |
integer (int32) |
— |
arrondi |
integer (int32) |
— |
refArticleFraisPort |
string |
nullable |
refArticleAcompte |
string |
nullable |
idRibBanque |
integer (int32) |
— |