Aller au contenu

Documents.Lignes.LigneDocument

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

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

POST /v2/lignedocument

Créer l'enregistrement.

Corps de la requête (application/json)

Schéma LigneDocumentDto — 102 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/lignedocument" \
  -H "Authorization: Bearer <jeton>" \
  -H "Content-Type: application/json" \
  -d '{"domaineDocument": 0, "typeDocument": 0, "numeroDocument": "…"}'

PUT /v2/lignedocument

Mettre à jour l'enregistrement.

Corps de la requête (application/json)

Schéma LigneDocumentDto — 102 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/lignedocument" \
  -H "Authorization: Bearer <jeton>" \
  -H "Content-Type: application/json" \
  -d '{"domaineDocument": 0, "typeDocument": 0, "numeroDocument": "…"}'

DELETE /v2/lignedocument

Supprimer l'enregistrement.

Corps de la requête (application/json)

Schéma LigneDocumentDto — 102 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/lignedocument" \
  -H "Authorization: Bearer <jeton>" \
  -H "Content-Type: application/json" \
  -d '{"domaineDocument": 0, "typeDocument": 0, "numeroDocument": "…"}'

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

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

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

POST /v2/lignedocument/save

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

Corps de la requête (application/json)

Schéma LigneDocumentDto — 102 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/lignedocument/save" \
  -H "Authorization: Bearer <jeton>" \
  -H "Content-Type: application/json" \
  -d '{"domaineDocument": 0, "typeDocument": 0, "numeroDocument": "…"}'

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.

LigneDocumentDto

LigneDocumentDto — 102 propriétés
Propriété Type Notes
domaineDocument integer (int32)
typeDocument integer (int32)
numeroDocument string nullable
numeroDocumentBC string nullable
numeroDocumentBL string nullable
numeroDocumentPL string nullable
numeroDocumentDE string nullable
date string (date-time)
dateBC string (date-time)
dateBL string (date-time)
datePL string (date-time)
dateDE string (date-time)
numeroLigne integer (int32)
position integer (int32)
designation string nullable
referenceExterne string nullable
idTexteSupplementaire integer (int32)
createur string nullable
dateModification string (date-time)
dateCreation string (date-time)
utilisateurCreateur string nullable
numeroTiers string nullable
idGamme1 integer (int32)
idGamme2 integer (int32)
dateLivraison string (date-time)
prixUnitaire number (double)
reference string nullable
estNomenclature boolean
estTypeRemisePied boolean
estTypeRemiseExceptionnelle boolean
referenceArticle string nullable
quantite number (double)
quantiteBC number (double)
quantiteBL number (double)
quantitePL number (double)
quantiteDE number (double)
poidsNet number (double)
poidsBrut number (double)
remiseValeur1 number (double)
remiseType1 RemiseTypeLigne
remiseValeur2 number (double)
remiseType2 RemiseTypeLigne
remiseValeur3 number (double)
remiseType3 RemiseTypeLigne
prixUnitaireBC number (double)
idCollaborateur integer (int32)
conditionnement string nullable
quantiteConditionnement number (double)
prixRevientUnitaire number (double)
cmup number (double)
typeMouvementStock integer (int32)
refFournisseur string nullable
ligneTTC TypePrix
idDepot integer (int32)
numeroLigneArticle integer (int32)
typePieceLivree integer (int32)
prixUnitaireEnDevise number (double)
prixUnitaireTTC number (double)
idLigne integer (int32)
idLigneSuivante integer (int32) nullable
compteAnalytique string nullable
frais number (double)
estValorisee boolean
referenceArticleCompose string nullable
estNonLivree boolean
referenceArticleClient string nullable
montantHT number (double)
montantTTC number (double)
estFactureeAuPoids boolean
estSoumisAEscompte boolean
numeroColis string nullable
codeRessource string nullable
numeroLienEmplacementControle integer (int32)
quantiteRessource integer (int32)
dateAvancement string (date-time)
numeroProjetAffaire string nullable
numeroOFGPAO integer (int32)
codeOperation string nullable
idSousTotal integer (int32)
idCaisse integer (int32)
typeDocumentOrigine integer (int32)
codeTaxe1 string nullable
codeTaxe2 string nullable
codeTaxe3 string nullable
taux1 number (double)
typeTaux1 TypeTauxTaxe
typeTaxe1 TypeTaxe
taux2 number (double)
typeTaux2 TypeTauxTaxe
typeTaxe2 TypeTaxe
taux3 number (double)
typeTaux3 TypeTauxTaxe
typeTaxe3 TypeTaxe
numerosLignesSousTotal tableau de integer (int32) nullable
quantiteParConditionnement number (double) nullable
typeLigne TypeLigne
texteComplementaire string nullable
informationsLibres object nullable
lots tableau de LigneLotDto nullable
numeroLotSerie string nullable
dateFabricationLot string (date-time)
datePeremptionLot string (date-time)

Voir aussi