Documents.Lignes.LigneDocumentInterne
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/lignedocumentinterne |
Lister les enregistrements |
POST |
/v2/lignedocumentinterne |
Créer l'enregistrement |
PUT |
/v2/lignedocumentinterne |
Mettre à jour l'enregistrement |
DELETE |
/v2/lignedocumentinterne |
Supprimer l'enregistrement |
GET |
/v2/lignedocumentinterne/count |
Compter les enregistrements |
POST |
/v2/lignedocumentinterne/count |
Compter les enregistrements |
POST |
/v2/lignedocumentinterne/recherche |
Rechercher des enregistrements |
POST |
/v2/lignedocumentinterne/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/lignedocumentinterne
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/lignedocumentinterne?sort=<sort>&where=<where>" \
-H "Authorization: Bearer <jeton>" \
-H "Accept: application/json"
POST /v2/lignedocumentinterne
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/lignedocumentinterne" \
-H "Authorization: Bearer <jeton>" \
-H "Content-Type: application/json" \
-d '{"domaineDocument": 0, "typeDocument": 0, "numeroDocument": "…"}'
PUT /v2/lignedocumentinterne
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/lignedocumentinterne" \
-H "Authorization: Bearer <jeton>" \
-H "Content-Type: application/json" \
-d '{"domaineDocument": 0, "typeDocument": 0, "numeroDocument": "…"}'
DELETE /v2/lignedocumentinterne
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/lignedocumentinterne" \
-H "Authorization: Bearer <jeton>" \
-H "Content-Type: application/json" \
-d '{"domaineDocument": 0, "typeDocument": 0, "numeroDocument": "…"}'
GET /v2/lignedocumentinterne/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/lignedocumentinterne/count?where=<where>" \
-H "Authorization: Bearer <jeton>" \
-H "Accept: application/json"
POST /v2/lignedocumentinterne/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/lignedocumentinterne/count" \
-H "Authorization: Bearer <jeton>" \
-H "Accept: application/json"
POST /v2/lignedocumentinterne/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/lignedocumentinterne/recherche" \
-H "Authorization: Bearer <jeton>" \
-H "Accept: application/json"
POST /v2/lignedocumentinterne/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/lignedocumentinterne/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) |
Domaine du document (ex : ventes, achats, etc.) |
typeDocument |
integer (int32) |
Type du document (ex : facture, commande, etc.) |
numeroDocument |
string |
nullable, Numéro du document principal |
numeroDocumentBC |
string |
nullable, Numéro du bon de commande lié |
numeroDocumentBL |
string |
nullable, Numéro du bon de livraison lié |
numeroDocumentPL |
string |
nullable, Numéro du bon de préparation lié |
numeroDocumentDE |
string |
nullable, Numéro du devis lié |
date |
string (date-time) |
Date du document principal |
dateBC |
string (date-time) |
Date du bon de commande |
dateBL |
string (date-time) |
Date du bon de livraison |
datePL |
string (date-time) |
Date du bon de préparation |
dateDE |
string (date-time) |
Date du document d'entrée |
numeroLigne |
integer (int32) |
Numéro de la ligne dans le document |
position |
integer (int32) |
Position 1-based de la ligne dans le document (clé de correspondance utilisée par le moteur de traitement des lignes : mise à jour de la ligne existante à cette position, suppression des positions absentes, réordonnancement). Position <= 0 ou hors bornes => nouvelle ligne. |
designation |
string |
nullable, Désignation de la ligne (libellé) |
referenceExterne |
string |
nullable, Référence externe associée à la ligne |
idTexteSupplementaire |
integer (int32) |
Identifiant du texte supplémentaire |
createur |
string |
nullable, Nom du créateur de la ligne |
dateModification |
string (date-time) |
Date de la dernière modification |
dateCreation |
string (date-time) |
Date de création de la ligne |
utilisateurCreateur |
string |
nullable, Utilisateur ayant créé la ligne |
numeroTiers |
string |
nullable, Numéro du tiers (client/fournisseur) |
idGamme1 |
integer (int32) |
Identifiant de la gamme 1 (variation d'article) |
idGamme2 |
integer (int32) |
Identifiant de la gamme 2 (variation d'article) |
dateLivraison |
string (date-time) |
Date de livraison prévue |
prixUnitaire |
number (double) |
Prix unitaire de la ligne |
reference |
string |
nullable, Référence interne de la ligne |
estNomenclature |
boolean |
Indique si la ligne est une nomenclature (article composé) |
estTypeRemisePied |
boolean |
Indique si la ligne est une remise pied |
estTypeRemiseExceptionnelle |
boolean |
Indique si la ligne est une remise exceptionnelle |
referenceArticle |
string |
nullable, Référence de l'article |
quantite |
number (double) |
Quantité de la ligne |
quantiteBC |
number (double) |
Quantité du bon de commande |
quantiteBL |
number (double) |
Quantité du bon de livraison |
quantitePL |
number (double) |
Quantité du bon de préparation |
quantiteDE |
number (double) |
Quantité du document d'entrée |
poidsNet |
number (double) |
Poids net de la ligne |
poidsBrut |
number (double) |
Poids brut de la ligne |
remiseValeur1 |
number (double) |
Valeur de la première remise |
remiseType1 |
RemiseTypeLigne |
- |
remiseValeur2 |
number (double) |
Valeur de la deuxième remise |
remiseType2 |
RemiseTypeLigne |
- |
remiseValeur3 |
number (double) |
Valeur de la troisième remise |
remiseType3 |
RemiseTypeLigne |
- |
prixUnitaireBC |
number (double) |
Prix unitaire du bon de commande |
idCollaborateur |
integer (int32) |
Identifiant du collaborateur associé |
conditionnement |
string |
nullable, Conditionnement de l'article |
quantiteConditionnement |
number (double) |
Quantité par conditionnement |
prixRevientUnitaire |
number (double) |
Prix de revient unitaire |
cmup |
number (double) |
Coût moyen unitaire pondéré |
typeMouvementStock |
integer (int32) |
Type de mouvement de stock |
refFournisseur |
string |
nullable, Référence du fournisseur |
ligneTTC |
TypePrix |
- |
idDepot |
integer (int32) |
Identifiant du dépôt associé |
numeroLigneArticle |
integer (int32) |
Numéro de la ligne d'article |
typePieceLivree |
integer (int32) |
Type de pièce livrée |
prixUnitaireEnDevise |
number (double) |
Prix unitaire en devise |
prixUnitaireTTC |
number (double) |
Prix unitaire TTC |
idLigne |
integer (int32) |
Identifiant de la ligne |
idLigneSuivante |
integer (int32) |
nullable, Ancre de placement - mode lignes partielles uniquement : IdLigne (DL_No) de la ligne devant laquelle cette ligne doit être insérée ou déplacée (WriteBefore). Null ou 0 = pas de déplacement (une ligne créée est ajoutée en fin de document, avant la remise de pied). L'ancre doit exister dans le document et ne pas être supprimée dans le même paquet. |
compteAnalytique |
string |
nullable, Compte analytique associé |
frais |
number (double) |
Frais associés à la ligne |
estValorisee |
boolean |
Indique si la ligne est valorisée |
referenceArticleCompose |
string |
nullable, Référence de l'article composé |
estNonLivree |
boolean |
Indique si la ligne n'est pas livrée |
referenceArticleClient |
string |
nullable, Référence de l'article client |
montantHT |
number (double) |
Montant HT de la ligne |
montantTTC |
number (double) |
Montant TTC de la ligne |
estFactureeAuPoids |
boolean |
Indique si la facturation se fait au poids |
estSoumisAEscompte |
boolean |
Indique si la ligne est soumise à escompte |
numeroColis |
string |
nullable, Numéro du colis associé |
codeRessource |
string |
nullable, Code ressource associé |
numeroLienEmplacementControle |
integer (int32) |
Numéro de lien d'emplacement de contrôle |
quantiteRessource |
integer (int32) |
Quantité de ressource associée |
dateAvancement |
string (date-time) |
Date d'avancement de la ligne |
numeroProjetAffaire |
string |
nullable, Numéro du projet ou de l'affaire associé |
numeroOFGPAO |
integer (int32) |
Numéro d'ordre de fabrication GPAO |
codeOperation |
string |
nullable, Code opération associé |
idSousTotal |
integer (int32) |
Identifiant du sous-total associé |
idCaisse |
integer (int32) |
Identifiant de la caisse associée |
typeDocumentOrigine |
integer (int32) |
Type du document d'origine |
codeTaxe1 |
string |
nullable, Code de la première taxe |
codeTaxe2 |
string |
nullable, Code de la deuxième taxe |
codeTaxe3 |
string |
nullable, Code de la troisième taxe |
taux1 |
number (double) |
Taux de la première taxe |
typeTaux1 |
TypeTauxTaxe |
- |
typeTaxe1 |
TypeTaxe |
- |
taux2 |
number (double) |
Taux de la deuxième taxe |
typeTaux2 |
TypeTauxTaxe |
- |
typeTaxe2 |
TypeTaxe |
- |
taux3 |
number (double) |
Taux de la troisième taxe |
typeTaux3 |
TypeTauxTaxe |
- |
typeTaxe3 |
TypeTaxe |
- |
numerosLignesSousTotal |
tableau de integer (int32) |
nullable, Lignes à cumuler par une ligne de sous-total (TypeLigne 2) : positions 1-based de lignes PRÉCÉDENTES dans les lignes du document écrit (dans Lignes du payload d'un document ; dans le document, hors lignes de remise, pour une ligne créée seule). Au moins une ; un sous-total impossible est refusé sans rien écrire sur les autres lignes. |
quantiteParConditionnement |
number (double) |
nullable, Quantité utilisée pour les conditionnements |
typeLigne |
TypeLigne |
- |
texteComplementaire |
string |
nullable, Texte complémentaire de la ligne de document (Table F_DOCLIGNETEXT) |
informationsLibres |
object |
nullable, Informations libres associées à la ligne (clé/valeur) |
lots |
tableau de LigneLotDto |
nullable, Lots / numéros de série à prélever pour cette ligne (documents de VENTE mouvementant le stock : BL, facture…). Traité après l'écriture de la ligne via le process Sage IPMPreleverLot ; l'article doit être suivi en lot ou en série et les lots doivent exister dans le dépôt de la ligne avec un disponible suffisant. Liste vide = pas de prélèvement explicite (Sage peut réclamer la répartition selon le paramétrage). |
numeroLotSerie |
string |
nullable, Numéro de lot / de série DÉCLARÉ en ENTRÉE de stock (LS_NoSerie) - documents d'ACHAT (réception) et de STOCK (mouvement d'entrée) sur un article suivi en lot/série. Crée un nouveau lot dans le dépôt de la ligne (à distinguer de API100.Base.Models.Dto.Documents.Lignes.LigneDocumentDto.Lots, qui prélève des lots existants en sortie/vente). Une ligne = un lot ; plusieurs lots = plusieurs lignes. |
dateFabricationLot |
string (date-time) |
Date de fabrication du lot déclaré en entrée (LS_Fabrication). |
datePeremptionLot |
string (date-time) |
Date de péremption du lot déclaré en entrée (LS_Peremption). |