Parametres.General.DossierCial
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/dossiercial |
Lister les enregistrements |
POST |
/v2/dossiercial |
Créer l'enregistrement |
PUT |
/v2/dossiercial |
Mettre à jour l'enregistrement |
DELETE |
/v2/dossiercial |
Supprimer l'enregistrement |
GET |
/v2/dossiercial/count |
Compter les enregistrements |
POST |
/v2/dossiercial/count |
Compter les enregistrements |
POST |
/v2/dossiercial/recherche |
Rechercher des enregistrements |
POST |
/v2/dossiercial/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/dossiercial
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/dossiercial?sort=<sort>&where=<where>" \
-H "Authorization: Bearer <jeton>" \
-H "Accept: application/json"
POST /v2/dossiercial
Créer l'enregistrement.
Corps de la requête (application/json)
Schéma DossierCialDto - 11 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/dossiercial" \
-H "Authorization: Bearer <jeton>" \
-H "Content-Type: application/json" \
-d '{"formatQuantite": "…", "formatPrix": "…", "periodeArchivage": "2026-01-01T00:00:00"}'
PUT /v2/dossiercial
Mettre à jour l'enregistrement.
Corps de la requête (application/json)
Schéma DossierCialDto - 11 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/dossiercial" \
-H "Authorization: Bearer <jeton>" \
-H "Content-Type: application/json" \
-d '{"formatQuantite": "…", "formatPrix": "…", "periodeArchivage": "2026-01-01T00:00:00"}'
DELETE /v2/dossiercial
Supprimer l'enregistrement.
Corps de la requête (application/json)
Schéma DossierCialDto - 11 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/dossiercial" \
-H "Authorization: Bearer <jeton>" \
-H "Content-Type: application/json" \
-d '{"formatQuantite": "…", "formatPrix": "…", "periodeArchivage": "2026-01-01T00:00:00"}'
GET /v2/dossiercial/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/dossiercial/count?where=<where>" \
-H "Authorization: Bearer <jeton>" \
-H "Accept: application/json"
POST /v2/dossiercial/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/dossiercial/count" \
-H "Authorization: Bearer <jeton>" \
-H "Accept: application/json"
POST /v2/dossiercial/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/dossiercial/recherche" \
-H "Authorization: Bearer <jeton>" \
-H "Accept: application/json"
POST /v2/dossiercial/save
Créer ou mettre à jour l'enregistrement (upsert).
Corps de la requête (application/json)
Schéma DossierCialDto - 11 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/dossiercial/save" \
-H "Authorization: Bearer <jeton>" \
-H "Content-Type: application/json" \
-d '{"formatQuantite": "…", "formatPrix": "…", "periodeArchivage": "2026-01-01T00:00:00"}'
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.
DossierCialDto
DossierCialDto - 11 propriétés
| Propriété | Type | Notes |
|---|---|---|
formatQuantite |
string |
nullable, Format d'affichage des quantités. |
formatPrix |
string |
nullable, Format d'affichage des prix. |
periodeArchivage |
string (date-time) |
nullable, Période d'archivage. |
periodeValidite |
integer (int32) |
Période de validité. |
derniereCloture |
string (date-time) |
nullable, Date de dernière clôture. |
imprimeFacture |
string |
nullable, Paramètre d'impression des factures. |
imprimeCGV |
string |
nullable, Paramètre d'impression des CGV. |
formatParamCompta |
string |
nullable, Format des paramètres comptables. |
idCalendrier |
integer (int32) |
Identifiant du calendrier (CAL_No). |
imprimeCGVLangue1 |
string |
nullable, Impression CGV langue 1. |
imprimeCGVLangue2 |
string |
nullable, Impression CGV langue 2. |