Parametres.General.Dossier

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/dossier`	Lister les enregistrements
`POST`	`/v2/dossier`	Créer l'enregistrement
`PUT`	`/v2/dossier`	Mettre à jour l'enregistrement
`DELETE`	`/v2/dossier`	Supprimer l'enregistrement
`GET`	`/v2/dossier/count`	Compter les enregistrements
`POST`	`/v2/dossier/count`	Compter les enregistrements
`POST`	`/v2/dossier/recherche`	Rechercher des enregistrements
`POST`	`/v2/dossier/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/dossier`

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/dossier?sort=<sort>&where=<where>" \
  -H "Authorization: Bearer <jeton>" \
  -H "Accept: application/json"

`POST /v2/dossier`

Créer l'enregistrement.

Corps de la requête (application/json)

Schéma DossierDto - 40 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/dossier" \
  -H "Authorization: Bearer <jeton>" \
  -H "Content-Type: application/json" \
  -d '{"raisonSociale": "…", "profession": "…", "adresse": "…"}'

`PUT /v2/dossier`

Mettre à jour l'enregistrement.

Corps de la requête (application/json)

Schéma DossierDto - 40 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/dossier" \
  -H "Authorization: Bearer <jeton>" \
  -H "Content-Type: application/json" \
  -d '{"raisonSociale": "…", "profession": "…", "adresse": "…"}'

`DELETE /v2/dossier`

Supprimer l'enregistrement.

Corps de la requête (application/json)

Schéma DossierDto - 40 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/dossier" \
  -H "Authorization: Bearer <jeton>" \
  -H "Content-Type: application/json" \
  -d '{"raisonSociale": "…", "profession": "…", "adresse": "…"}'

`GET /v2/dossier/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/dossier/count?where=<where>" \
  -H "Authorization: Bearer <jeton>" \
  -H "Accept: application/json"

`POST /v2/dossier/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/dossier/count" \
  -H "Authorization: Bearer <jeton>" \
  -H "Accept: application/json"

`POST /v2/dossier/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/dossier/recherche" \
  -H "Authorization: Bearer <jeton>" \
  -H "Accept: application/json"

`POST /v2/dossier/save`

Créer ou mettre à jour l'enregistrement (upsert).

Corps de la requête (application/json)

Schéma DossierDto - 40 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/dossier/save" \
  -H "Authorization: Bearer <jeton>" \
  -H "Content-Type: application/json" \
  -d '{"raisonSociale": "…", "profession": "…", "adresse": "…"}'

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.

DossierDto

DossierDto - 40 propriétés

Propriété	Type	Notes
`raisonSociale`	`string`	nullable, Raison sociale.
`profession`	`string`	nullable, Profession / activité.
`adresse`	`string`	nullable, Adresse.
`complement`	`string`	nullable, Complément d'adresse.
`codePostal`	`string`	nullable, Code postal.
`ville`	`string`	nullable, Ville.
`pays`	`string`	nullable, Pays.
`siret`	`string`	nullable, SIRET.
`ape`	`string`	nullable, Code APE / NAF.
`identifiant`	`string`	nullable, Identifiant (n° TVA intracommunautaire).
`telephone`	`string`	nullable, Téléphone.
`email`	`string`	nullable, Email.
`longueurCompteGeneral`	`integer` (int32)	Longueur des comptes généraux.
`longueurSectionAnalytique`	`integer` (int32)	Longueur des sections analytiques.
`formatQuantites`	`string`	nullable, Format d'affichage des quantités.
`dateDebutExercice`	`string` (date-time)	Date de début de l'exercice courant (N). 1753-01-01 = non défini. (R12)
`dateFinExercice`	`string` (date-time)	Date de fin de l'exercice courant (N). (R12)
`dateDebutExercicePrecedent`	`string` (date-time)	Date de début de l'exercice précédent (N-1). 1753-01-01 = non défini. (R12)
`dateFinExercicePrecedent`	`string` (date-time)	Date de fin de l'exercice précédent (N-1). (R12)
`dateCloture`	`string` (date-time)	Date de clôture comptable (D_DateClot - synchro comptable ; ≠ D_CloturePeriod). (R12)
`commentaire`	`string`	nullable, Commentaire (D_Commentaire).
`codeRegion`	`string`	nullable, Code région (D_CodeRegion).
`telecopie`	`string`	nullable, Télécopie (D_Telecopie).
`emailSociete`	`string`	nullable, E-mail société (D_EMailSoc - distinct de D_EMail).
`site`	`string`	nullable, Site internet (D_Site).
`expert`	`string`	nullable, Intitulé de l'expert-comptable (D_Expert).
`emailExpert`	`string`	nullable, E-mail de l'expert (D_EMailExpert).
`numeroDossier`	`string`	nullable, Numéro de dossier (D_NumDoss).
`capital`	`string`	nullable, Capital (D_Capital).
`formeJuridique`	`string`	nullable, Forme juridique (D_FormeJuridique).
`facebook`	`string`	nullable, Compte Facebook (D_Facebook).
`linkedIn`	`string`	nullable, Compte LinkedIn (D_LinkedIn).
`derniereCloturePeriode`	`string` (date-time)	nullable, Dernière période clôturée (D_CloturePeriod).
`idDeviseCompte`	`integer` (int32)	Devise de tenue de compte (N_DeviseCompte).
`idDeviseEquivalence`	`integer` (int32)	Devise d'équivalence (N_DeviseEquival).
`codeJournalAN`	`string`	nullable, Journal des à-nouveaux (JO_NumAN).
`compteANOuverture`	`string`	nullable, Compte d'à-nouveaux d'ouverture (CG_NumANOuv).
`compteANBenefice`	`string`	nullable, Compte de résultat bénéfice (CG_NumANBenef).
`compteANPerte`	`string`	nullable, Compte de résultat perte (CG_NumANPerte).
`idPlanAnalytiqueDefaut`	`integer` (int32)	Plan analytique par défaut (N_Analytique).

Voir aussi

Écrans qui utilisent ce groupe

Dossiers Sage