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) |
Base de calcul de l'encours (1=factures, 2=+BL, 3=+PL, 4=+BC). |
periodeEncours |
integer (int32) |
Périodicité de l'encours. |
gestionAnalytique |
integer (int32) |
Gestion analytique active. |
gestionDevise |
integer (int32) |
Gestion des devises active. |
gestionQuantite |
integer (int32) |
Gestion des quantités. |
contremarque |
integer (int32) |
Gestion de la contremarque. |
tauxEscompte |
number (double) |
Taux d'escompte par défaut. |
exonerationTVA |
string |
nullable, Code d'exonération de TVA. |
creerRdvOutlook |
boolean |
Créer un rendez-vous dans le calendrier Outlook (P_Calendrier - flag, PAS un id calendrier ; l'id calendrier CAL_No est dans DossierCialDto.IdCalendrier). |
formatFacture |
integer (int32) |
Format de facture. |
gestionMulti |
integer (int32) |
Gestion multi-dépôts. |
referenceStructuree |
integer (int32) |
Référence structurée active. |
libelleEntete1 |
string |
nullable, Libellé personnalisé d'en-tête 1. |
libelleEntete2 |
string |
nullable, Libellé personnalisé d'en-tête 2. |
libelleEntete3 |
string |
nullable, Libellé personnalisé d'en-tête 3. |
libelleEntete4 |
string |
nullable, Libellé personnalisé d'en-tête 4. |
libellePoidsNet |
string |
nullable, Libellé du poids net. |
libellePoidsBrut |
string |
nullable, Libellé du poids brut. |
journalTransfert1 |
string |
nullable, Journal de transfert comptable 1 (P_Journal01 - ventes). |
journalTransfert2 |
string |
nullable, Journal de transfert comptable 2 (P_Journal02 - achats). |
journalTransfert3 |
string |
nullable, Journal de transfert comptable 3 (P_Journal03). |
journalTransfert4 |
string |
nullable, Journal de transfert comptable 4 (P_Journal04). |
journalTransfert5 |
string |
nullable, Journal de transfert comptable 5 (P_Journal05). |
journalTransfert6 |
string |
nullable, Journal de transfert comptable 6 (P_Journal06). |
pieceTransfert1 |
integer (int32) |
Numérotation de pièce du transfert 1 (P_Piece01). |
pieceTransfert2 |
integer (int32) |
Numérotation de pièce du transfert 2 (P_Piece02). |
pieceTransfert3 |
integer (int32) |
Numérotation de pièce du transfert 3 (P_Piece03). |
pieceTransfert4 |
integer (int32) |
Numérotation de pièce du transfert 4 (P_Piece04). |
libelleTransfert1 |
integer (int32) |
Libellé d'écriture du transfert 1 (P_Libelle01). |
libelleTransfert2 |
integer (int32) |
Libellé d'écriture du transfert 2 (P_Libelle02). |
libelleTransfert3 |
integer (int32) |
Libellé d'écriture du transfert 3 (P_Libelle03). |
libelleTransfert4 |
integer (int32) |
Libellé d'écriture du transfert 4 (P_Libelle04). |
transfertCaisse |
integer (int32) |
Transfert des règlements de caisse (P_TransfertCaisse). |
journalCaisse |
string |
nullable, Journal de caisse (P_JournalCaisse). |
pieceEcritureReglement |
integer (int32) |
Numérotation de pièce des écritures de règlement (P_PieceEcrReg). |
conversionDevise |
integer (int32) |
Conversion en devise (P_Conversion). |
transfertDevise |
integer (int32) |
Transfert en devise (P_TransfertDevise). |
stockIndisponible |
integer (int32) |
Stock indisponible géré (P_Indispo). |
stockSaisie |
integer (int32) |
Contrôle du stock en saisie (P_StockSaisie). |
uniciteLot |
boolean |
Unicité des numéros de lot (P_UniciteLot). |
prioriteDestockage |
integer (int32) |
Priorité de déstockage (P_Priorite). |
gestionControle |
boolean |
Gestion du contrôle qualité (P_GestionControle). |
alerteStockNegatif |
boolean |
Alerte de stock négatif (P_AlerteNegatif). |
echeances |
integer (int32) |
Gestion des échéances (P_Echeances). |
arrondi |
integer (int32) |
Arrondi (P_Arrondi). |
refArticleFraisPort |
string |
nullable, Article de frais de port (AR_Ref). |
refArticleAcompte |
string |
nullable, Article d'acompte (AR_RefAcompte). |
idRibBanque |
integer (int32) |
RIB bancaire par défaut (EB_No). |