Catalogue.Famille

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

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

`POST /v2/famille`

Créer l'enregistrement.

Corps de la requête (application/json)

Schéma FamilleDto - 41 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/famille" \
  -H "Authorization: Bearer <jeton>" \
  -H "Content-Type: application/json" \
  -d '{"code": "…", "type": {}, "intitule": "…"}'

`PUT /v2/famille`

Mettre à jour l'enregistrement.

Corps de la requête (application/json)

Schéma FamilleDto - 41 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/famille" \
  -H "Authorization: Bearer <jeton>" \
  -H "Content-Type: application/json" \
  -d '{"code": "…", "type": {}, "intitule": "…"}'

`DELETE /v2/famille`

Supprimer l'enregistrement.

Corps de la requête (application/json)

Schéma FamilleDto - 41 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/famille" \
  -H "Authorization: Bearer <jeton>" \
  -H "Content-Type: application/json" \
  -d '{"code": "…", "type": {}, "intitule": "…"}'

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

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

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

`POST /v2/famille/save`

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

Corps de la requête (application/json)

Schéma FamilleDto - 41 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/famille/save" \
  -H "Authorization: Bearer <jeton>" \
  -H "Content-Type: application/json" \
  -d '{"code": "…", "type": {}, "intitule": "…"}'

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.

FamilleDto

FamilleDto - 41 propriétés

Propriété	Type	Notes
`code`	`string`	nullable, Code de la famille (FA_CodeFamille)
`type`	`TypeFamille`	-
`intitule`	`string`	nullable, Intitulé de la famille
`codeFamilleCentralisatrice`	`string`	nullable, Code famille centralisatrice (parent)
`nature`	`integer` (int32)	Nature de la famille
`idUniteVente`	`integer` (int32)	Unité de vente par défaut
`unitePoids`	`integer` (int32)	Unité de poids par défaut
`coefficient`	`number` (double)	Coefficient de vente
`typeSuiviStock`	`integer` (int32)	Type de suivi de stock par défaut
`fictif`	`boolean`	Famille gérée en tant que fictive (FA_Fictif). NB : il n'existe ni sommeil, ni nomenclature, ni compte général direct sur F_FAMILLE (les anciennes propriétés TypeNomenclature/EstEnSommeil/CompteGeneral mappaient des colonnes inexistantes ; les comptes passent par FamilleParamCompta).
`statistique1`	`string`	nullable, Statistiques (1 à 5)
`statistique2`	`string`	nullable
`statistique3`	`string`	nullable
`statistique4`	`string`	nullable
`statistique5`	`string`	nullable
`dateCreation`	`string` (date-time)	Date de création
`dateModification`	`string` (date-time)	Date de dernière modification
`garantie`	`integer` (int32)	Garantie en mois (FA_Garantie).
`codeFiscal`	`string`	nullable, Code fiscal (FA_CodeFiscal).
`pays`	`string`	nullable, Pays d'origine (FA_Pays).
`escompte`	`boolean`	Soumis à l'escompte (FA_Escompte).
`delai`	`integer` (int32)	Délai de livraison (FA_Delai).
`horsStatistique`	`boolean`	Hors statistiques (FA_HorsStat).
`venteAuDebit`	`boolean`	Vente au débit (FA_VteDebit).
`nonImpression`	`boolean`	Non-impression sur les documents (FA_NotImp).
`contremarque`	`boolean`	Contremarque (FA_Contremarque).
`facturationPoids`	`boolean`	Facturation sur le poids (FA_FactPoids).
`facturationForfait`	`boolean`	Article de charge / facturation forfaitaire (FA_FactForfait).
`publie`	`boolean`	Publiée sur le site marchand (FA_Publie).
`racineReference`	`string`	nullable, Racine de référence article (FA_RacineRef - lecture seule : non exposée en COM).
`racineCodeBarres`	`string`	nullable, Racine de code-barres (FA_RacineCB - lecture seule : non exposée en COM).
`idCatalogue1`	`integer` (int32)	Catalogue niveau 1 (CL_No1).
`idCatalogue2`	`integer` (int32)	Catalogue niveau 2 (CL_No2).
`idCatalogue3`	`integer` (int32)	Catalogue niveau 3 (CL_No3).
`idCatalogue4`	`integer` (int32)	Catalogue niveau 4 (CL_No4).
`nombreColis`	`integer` (int32)	Nombre de colis (FA_NbColis).
`sousTraitance`	`boolean`	Réservée à la sous-traitance (FA_SousTraitance).
`criticite`	`integer` (int32)	Niveau de criticité (FA_Criticite).
`fraisFixe1`	`FraisFixeDto`	-
`fraisFixe2`	`FraisFixeDto`	-
`fraisFixe3`	`FraisFixeDto`	-

Voir aussi

Écrans qui utilisent ce groupe

Articles et familles