Aller au contenu

Documents.Entetes.Document

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

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

POST /v2/document

Créer l'enregistrement.

Corps de la requête (application/json)

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

PUT /v2/document

Mettre à jour l'enregistrement.

Corps de la requête (application/json)

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

DELETE /v2/document

Supprimer l'enregistrement.

Corps de la requête (application/json)

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

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

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

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

POST /v2/document/save

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

Corps de la requête (application/json)

Schéma DocumentDto — 121 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/document/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 — 121 propriétés
Propriété Type Notes
type TypeDocument —
domaine DomaineDocument —
numero string nullable
date string (date-time) —
reference string nullable
numeroTiers string nullable
numeroTiersPayeur string nullable
statut StatutDocument —
provenance ProvenanceDocument —
dateLivraison string (date-time) —
dateLivraisonRealisee string (date-time) —
dateExpedition string (date-time) —
compteAnalytique string nullable
contact string nullable
nbFactures integer (int32) —
nbColis integer (int32) —
tauxEscompte number (double) —
langue LangueSage —
donnee1 string nullable
donnee2 string nullable
donnee3 string nullable
donnee4 string nullable
estImprime boolean —
estTransfere boolean —
estCloture boolean —
estValide boolean —
estReliquat boolean —
idSouche integer (int32) —
idCollaborateur integer (int32) —
idDepot integer (int32) —
idDepotOrigine integer (int32) —
idAdresseLivraison integer (int32) —
idModeExpedition integer (int32) —
idConditionLivraison integer (int32) —
idCategorieComptable integer (int32) —
idCategorieTarifaire integer (int32) —
idModeleReglement integer (int32) —
idDevise integer (int32) —
coursDevise number (double) —
fraisExpedition number (double) nullable
typeFraisExpedition TypeFraisModeExpedition —
typePrixFraisExpedition TypePrix —
francoDePort number (double) nullable
typeFrancoPort TypeFrancoModeExpedition —
typePrixFrancoPort TypePrix —
expeditionCodeTaxe1 string nullable
expeditionCodeTaxe2 string nullable
expeditionCodeTaxe3 string nullable
expeditionTaux1 number (double) —
expeditionTaux2 number (double) —
expeditionTaux3 number (double) —
numeroCentraleAchat string nullable
createur string nullable
dateModification string (date-time) —
montantHT number (double) —
dateCreation string (date-time) —
utilisateurCreateur string nullable
totalHTNet number (double) —
totalTTC number (double) —
netAPayer number (double) —
montantRegle number (double) —
informationsLibres object nullable
periodicite integer (int32) —
blParFacture boolean —
idColisageLivraison integer (int32) —
idTypeColis integer (int32) —
idNatureTransaction integer (int32) —
ecartValorisation number (double) —
idRegime integer (int32) —
estVentile boolean —
idAbonnementLie integer (int32) —
dateDebutAbonnementLie string (date-time) —
dateFinAbonnementLie string (date-time) —
dateDebutPeriodiciteAbonnementLie string (date-time) —
dateFinPeriodiciteAbonnementLie string (date-time) —
numeroCompteGeneral string nullable
numeroCaisse integer (int32) —
idCaissier integer (int32) —
numeroCommandeSiteMarchand string nullable
ticketEnAttente boolean —
ventilationIFRS string nullable
estComptabilise boolean —
motifRectification string nullable
etatGenerationFactureElec integer (int32) —
typeDeTransaction integer (int32) —
numeroFactureFournisseur string nullable
numeroFactureOrigine string nullable
idFactureElectronique string nullable
eStatutDocument integer (int32) —
estDemandeRegularisation boolean —
idTexteComplementaire integer (int32) —
estAuCoffreFort boolean —
idStatutBAP integer (int32) —
estSoumisEscompte boolean —
typeDocumentOrigine integer (int32) —
typeCalculFraisExpedition integer (int32) —
fichierPdfFacture string nullable
idPaiementEnLigne string nullable
adressePaiementEnLigne string nullable
paiementEnLigne boolean —
idMotifDevisPerdu integer (int32) —
conversionEnDevise integer (int32) —
paiementTvaDebit boolean —
idBanque integer (int32) —
idRoutage integer (int32) —
idCadreFacturation integer (int32) —
exclureDeLaTransmission boolean —
codeService string nullable
referenceExterne string nullable
heureDocument string nullable
typeTaux1 TypeTauxTaxe —
typeTaux2 TypeTauxTaxe —
typeTaux3 TypeTauxTaxe —
typeTaxe1 TypeTaxe —
typeTaxe2 TypeTaxe —
typeTaxe3 TypeTaxe —
remisePied string nullable
signature string nullable
lignes tableau de LigneDocumentDto nullable
lignesPartielles boolean nullable
lignesASupprimer tableau de integer (int32) nullable

Voir aussi