Stock.Collaborateur
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/collaborateur |
Lister les enregistrements |
POST |
/v2/collaborateur |
Créer l'enregistrement |
PUT |
/v2/collaborateur |
Mettre à jour l'enregistrement |
DELETE |
/v2/collaborateur |
Supprimer l'enregistrement |
GET |
/v2/collaborateur/count |
Compter les enregistrements |
POST |
/v2/collaborateur/count |
Compter les enregistrements |
POST |
/v2/collaborateur/recherche |
Rechercher des enregistrements |
POST |
/v2/collaborateur/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/collaborateur
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/collaborateur?sort=<sort>&where=<where>" \
-H "Authorization: Bearer <jeton>" \
-H "Accept: application/json"
POST /v2/collaborateur
Créer l'enregistrement.
Corps de la requête (application/json)
Schéma CollaborateurDto - 32 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/collaborateur" \
-H "Authorization: Bearer <jeton>" \
-H "Content-Type: application/json" \
-d '{"id": 0, "nom": "…", "prenom": "…"}'
PUT /v2/collaborateur
Mettre à jour l'enregistrement.
Corps de la requête (application/json)
Schéma CollaborateurDto - 32 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/collaborateur" \
-H "Authorization: Bearer <jeton>" \
-H "Content-Type: application/json" \
-d '{"id": 0, "nom": "…", "prenom": "…"}'
DELETE /v2/collaborateur
Supprimer l'enregistrement.
Corps de la requête (application/json)
Schéma CollaborateurDto - 32 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/collaborateur" \
-H "Authorization: Bearer <jeton>" \
-H "Content-Type: application/json" \
-d '{"id": 0, "nom": "…", "prenom": "…"}'
GET /v2/collaborateur/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/collaborateur/count?where=<where>" \
-H "Authorization: Bearer <jeton>" \
-H "Accept: application/json"
POST /v2/collaborateur/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/collaborateur/count" \
-H "Authorization: Bearer <jeton>" \
-H "Accept: application/json"
POST /v2/collaborateur/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/collaborateur/recherche" \
-H "Authorization: Bearer <jeton>" \
-H "Accept: application/json"
POST /v2/collaborateur/save
Créer ou mettre à jour l'enregistrement (upsert).
Corps de la requête (application/json)
Schéma CollaborateurDto - 32 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/collaborateur/save" \
-H "Authorization: Bearer <jeton>" \
-H "Content-Type: application/json" \
-d '{"id": 0, "nom": "…", "prenom": "…"}'
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.
CollaborateurDto
CollaborateurDto - 32 propriétés
| Propriété | Type | Notes |
|---|---|---|
id |
integer (int32) |
Identifiant unique du collaborateur (CO_No) |
nom |
string |
nullable, Nom du collaborateur |
prenom |
string |
nullable, Prénom du collaborateur |
adresse |
string |
nullable, Adresse du collaborateur |
complement |
string |
nullable, Complément d'adresse |
codePostal |
string |
nullable, Code postal |
ville |
string |
nullable, Ville |
region |
string |
nullable, Région |
pays |
string |
nullable, Pays |
telephone |
string |
nullable, Téléphone |
portable |
string |
nullable, Portable |
telecopie |
string |
nullable, Télécopie (fax) |
email |
string |
nullable, Email |
estEnSommeil |
boolean |
Indique si le collaborateur est en sommeil (CO_Sommeil). NB : F_COLLABORATEUR ne porte ni site web, ni type unique, ni taux de commission (les rôles Sage sont des booléens séparés CO_Vendeur/CO_Caissier/CO_Acheteur/... - les anciennes propriétés SiteWeb/TypeCollaborateur/TauxCommission mappaient des colonnes inexistantes). |
fonction |
string |
nullable, Fonction (CO_Fonction). |
service |
string |
nullable, Service (CO_Service). |
matricule |
string |
nullable, Matricule (CO_Matricule). |
vendeur |
boolean |
Rôle vendeur (CO_Vendeur). |
caissier |
boolean |
Rôle caissier (CO_Caissier). |
acheteur |
boolean |
Rôle acheteur (CO_Acheteur). |
receptionnaire |
boolean |
Rôle réceptionnaire (CO_Receptionnaire). |
chargeRecouvrement |
boolean |
Rôle chargé de recouvrement (CO_ChargeRecouvr). |
financier |
boolean |
Rôle financier (CO_Financier - Sage v7.2+). |
chefVentes |
boolean |
Rôle chef des ventes (CO_ChefVentes). |
idChefVentes |
integer (int32) |
Chef des ventes de rattachement (CO_NoChefVentes - lecture ; écriture via FactoryVendeurs, différée). |
transmission |
integer (int32) |
Transmission (CO_Transmission - lecture seule, non exposé en COM). |
facebook |
string |
nullable, Compte Facebook (CO_Facebook). |
linkedIn |
string |
nullable, Compte LinkedIn (CO_LinkedIn). |
skype |
string |
nullable, Compte Skype (CO_Skype). |
dateCreation |
string (date-time) |
Date de création |
dateModification |
string (date-time) |
Date de dernière modification |
informationsLibres |
object |
nullable |