Documents.Entetes.DocumentInterne

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

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

POST /v2/documentinterne

Créer l'enregistrement.

Corps de la requête (application/json)

Schéma DocumentDto - 122 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/documentinterne" \
  -H "Authorization: Bearer <jeton>" \
  -H "Content-Type: application/json" \
  -d '{"type": {}, "domaine": {}, "numero": "…"}'

PUT /v2/documentinterne

Mettre à jour l'enregistrement.

Corps de la requête (application/json)

Schéma DocumentDto - 122 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/documentinterne" \
  -H "Authorization: Bearer <jeton>" \
  -H "Content-Type: application/json" \
  -d '{"type": {}, "domaine": {}, "numero": "…"}'

DELETE /v2/documentinterne

Supprimer l'enregistrement.

Corps de la requête (application/json)

Schéma DocumentDto - 122 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/documentinterne" \
  -H "Authorization: Bearer <jeton>" \
  -H "Content-Type: application/json" \
  -d '{"type": {}, "domaine": {}, "numero": "…"}'

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

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

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

POST /v2/documentinterne/save

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

Corps de la requête (application/json)

Schéma DocumentDto - 122 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/documentinterne/save" \
  -H "Authorization: Bearer <jeton>" \
  -H "Content-Type: application/json" \
  -d '{"type": {}, "domaine": {}, "numero": "…"}'

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.

DocumentDto

DocumentDto - 122 propriétés

Propriété	Type	Notes
type	TypeDocument	-
domaine	DomaineDocument	-
numero	string	nullable, Numéro unique du document.
date	string (date-time)	Date du document.
reference	string	nullable, Référence du document (libre ou issue du client/fournisseur).
numeroTiers	string	nullable, Numéro du tiers (client, fournisseur, etc.).
numeroTiersPayeur	string	nullable, Numéro du tiers payeur (si différent du tiers principal).
statut	StatutDocument	-
provenance	ProvenanceDocument	-
dateLivraison	string (date-time)	Date prévue de livraison.
dateLivraisonRealisee	string (date-time)	Date réelle de livraison.
dateExpedition	string (date-time)	Date d’expédition.
compteAnalytique	string	nullable, Compte analytique associé au document.
contact	string	nullable, Contact principal pour ce document.
nbFactures	integer (int32)	Nombre de factures générées à partir de ce document.
nbColis	integer (int32)	Nombre de colis associés à la livraison.
tauxEscompte	number (double)	Taux d’escompte appliqué.
langue	LangueSage	-
donnee1	string	nullable, Données libres 1 à 4 (champs personnalisables).
donnee2	string	nullable
donnee3	string	nullable
donnee4	string	nullable
estImprime	boolean	Indique si le document a été imprimé.
estTransfere	boolean	Indique si le document a été transféré (ex : vers la compta).
estCloture	boolean	Indique si le document est clôturé.
estValide	boolean	Indique si le document est validé.
estReliquat	boolean	Indique si le document est en reliquat (reste à livrer ou à facturer).
idSouche	integer (int32)	Identifiant de la souche (numérotation).
idCollaborateur	integer (int32)	Identifiant du collaborateur associé.
idDepot	integer (int32)	Identifiant du dépôt (magasin) concerné. Pour un document de stock, c'est le dépôt de stockage ; pour un virement inter-dépôts, c'est le dépôt de destination.
idDepotOrigine	integer (int32)	Identifiant du dépôt d'origine d'un virement inter-dépôts (document de stock de type virement). Non utilisé pour les autres documents.
idAdresseLivraison	integer (int32)	Identifiant de l’adresse de livraison.
idModeExpedition	integer (int32)	Identifiant du mode d’expédition.
idConditionLivraison	integer (int32)	Identifiant de la condition de livraison.
idCategorieComptable	integer (int32)	Identifiant de la catégorie comptable.
idCategorieTarifaire	integer (int32)	Identifiant de la catégorie tarifaire.
idModeleReglement	integer (int32)	Identifiant du modèle de règlement.
idDevise	integer (int32)	Identifiant de la devise.
coursDevise	number (double)	Cours de la devise au moment du document.
fraisExpedition	number (double)	nullable, Frais d’expédition appliqués.
typeFraisExpedition	TypeFraisModeExpedition	-
typePrixFraisExpedition	TypePrix	-
francoDePort	number (double)	nullable, Seuil de franco de port (livraison gratuite).
typeFrancoPort	TypeFrancoModeExpedition	-
typePrixFrancoPort	TypePrix	-
expeditionCodeTaxe1	string	nullable, Codes taxes d’expédition (jusqu’à 3).
expeditionCodeTaxe2	string	nullable
expeditionCodeTaxe3	string	nullable
expeditionTaux1	number (double)	Taux de taxes d’expédition (jusqu’à 3).
expeditionTaux2	number (double)	-
expeditionTaux3	number (double)	-
numeroCentraleAchat	string	nullable, Numéro de centrale d’achat (si concerné).
createur	string	nullable, Nom du créateur du document.
dateModification	string (date-time)	Date de dernière modification.
montantHT	number (double)	Montant HT du document.
dateCreation	string (date-time)	Date de création du document.
utilisateurCreateur	string	nullable, Utilisateur ayant créé le document.
totalHTNet	number (double)	Total HT net (après remises).
totalTTC	number (double)	Total TTC du document.
netAPayer	number (double)	Net à payer (après remises et taxes).
montantRegle	number (double)	Montant déjà réglé.
informationsLibres	object	nullable, Informations libres (champs personnalisés).
periodicite	integer (int32)	Périodicité (abonnement, facturation récurrente, etc.).
blParFacture	boolean	Indique si le BL est généré par facture.
idColisageLivraison	integer (int32)	Identifiant du colisage de livraison.
idTypeColis	integer (int32)	Identifiant du type de colis.
idNatureTransaction	integer (int32)	Identifiant de la nature de transaction.
ecartValorisation	number (double)	Ecart de valorisation constaté.
idRegime	integer (int32)	Identifiant du régime fiscal ou douanier.
estVentile	boolean	Indique si le document est ventilé (analytique, IFRS, etc.).
idAbonnementLie	integer (int32)	Identifiant de l’abonnement lié.
dateDebutAbonnementLie	string (date-time)	Dates de début et fin de l’abonnement lié.
dateFinAbonnementLie	string (date-time)	-
dateDebutPeriodiciteAbonnementLie	string (date-time)	-
dateFinPeriodiciteAbonnementLie	string (date-time)	-
numeroCompteGeneral	string	nullable, Numéro du compte général associé.
numeroCaisse	integer (int32)	Numéro de caisse (point de vente).
idCaissier	integer (int32)	Identifiant du caissier.
numeroCommandeSiteMarchand	string	nullable, Numéro de commande sur site marchand.
ticketEnAttente	boolean	Indique si le ticket est en attente (point de vente).
ventilationIFRS	string	nullable, Ventilation IFRS (comptabilité internationale).
estComptabilise	boolean	Indique si le document est comptabilisé.
motifRectification	string	nullable, Motif de rectification (modification, annulation, etc.).
etatGenerationFactureElec	integer (int32)	Etat de génération de la facture électronique.
typeDeTransaction	integer (int32)	Type de transaction (code interne).
numeroFactureFournisseur	string	nullable, Numéro de facture fournisseur (si achat).
numeroFactureOrigine	string	nullable, Numéro de facture d’origine (cas de transformation).
idFactureElectronique	string	nullable, Identifiant de la facture électronique (optionnel).
eStatutDocument	integer (int32)	Statut électronique du document (code interne).
estDemandeRegularisation	boolean	Indique si une demande de régularisation est en cours.
idTexteComplementaire	integer (int32)	Identifiant du texte complémentaire associé.
estAuCoffreFort	boolean	Indique si le document est au coffre-fort électronique.
idStatutBAP	integer (int32)	Statut BAP (Bon à Payer).
estSoumisEscompte	boolean	Indique si le document est soumis à l’escompte.
typeDocumentOrigine	integer (int32)	Type du document d’origine (code interne).
typeCalculFraisExpedition	integer (int32)	Type de calcul des frais d’expédition.
fichierPdfFacture	string	nullable, Fichier PDF de la facture (optionnel).
idPaiementEnLigne	string	nullable, Identifiant du paiement en ligne (optionnel).
adressePaiementEnLigne	string	nullable, Adresse du paiement en ligne.
paiementEnLigne	boolean	Indique si le paiement en ligne est activé.
idMotifDevisPerdu	integer (int32)	Identifiant du motif de devis perdu.
conversionEnDevise	integer (int32)	Indicateur de conversion en devise.
paiementTvaDebit	boolean	Indique si la TVA est payée au débit.
idBanque	integer (int32)	Identifiant de la banque associée.
idRoutage	integer (int32)	Identifiant du routage (logistique).
idCadreFacturation	integer (int32)	Identifiant du cadre de facturation.
exclureDeLaTransmission	boolean	Indique si le document est exclu de la transmission.
codeService	string	nullable, Code du service concerné.
referenceExterne	string	nullable, Référence externe du document.
clauseReserve	boolean	Clause de réserve (DO_ClauseReserve, Objets métiers 12.20 / v12.2). Lecture : colonne absente (false) sur une base non convertie en 12.20. Écriture : documents de VENTE uniquement (IBODocumentVente3.DO_ClauseReserve), ignorée sur les achats et avant la 12.20.
heureDocument	string	nullable, Heure du document (format HHss).
typeTaux1	TypeTauxTaxe	-
typeTaux2	TypeTauxTaxe	-
typeTaux3	TypeTauxTaxe	-
typeTaxe1	TypeTaxe	-
typeTaxe2	TypeTaxe	-
typeTaxe3	TypeTaxe	-
remisePied	string	nullable, Remise de pied du document (écriture seule, alias v1 ZREMISE) : chaîne au format des remises Sage - jusqu'à trois niveaux séparés par +, chacun en pourcentage (%), en unités (u) ou en montant (f), ex. "10%+5u". Portée par une ligne de remise exceptionnelle sur l'article de remise du dossier (P_PARAMETRECIAL). Vide ou nulle ("0%") = suppression de la remise de pied existante.
signature	string	nullable, Signature du document au format image (base64).
lignes	tableau de LigneDocumentDto	nullable, Liste des lignes du document (articles, prestations, etc.).
lignesPartielles	boolean	nullable, Mode lignes partielles (traitement des gros documents par paquets) : les API100.Base.Models.Dto.Documents.Entetes.DocumentDto.Lignes du payload sont des opérations CIBLÉES - modification de la ligne désignée par API100.Base.Models.Dto.Documents.Lignes.LigneDocumentDto.IdLigne (repli sur API100.Base.Models.Dto.Documents.Lignes.LigneDocumentDto.Position), création sinon - sans synchronisation complète : les autres lignes du document ne sont pas touchées et aucun réordonnancement global n'est appliqué. Requis pour API100.Base.Models.Dto.Documents.Entetes.DocumentDto.LignesASupprimer et API100.Base.Models.Dto.Documents.Lignes.LigneDocumentDto.IdLigneSuivante. L'écriture renvoie alors un ResultatLignesPartiellesDto (IdLigne de chaque ligne traitée = référence stable pour le paquet suivant). Nécessite Sage 100 v9+ (DL_No / WriteBefore).
lignesASupprimer	tableau de integer (int32)	nullable, IdLigne (DL_No) des lignes à supprimer - mode lignes partielles uniquement, traitées avant les modifications/créations du même paquet. La ligne de remise de pied n'y est pas admise.

Voir aussi

• Démarrer avec l'API v2
• Conventions de payload
• Tous les groupes