Documents.DocumentEcheance

En bref

9 opérations sur 5 chemins. Préfixe /v2. Authentification JWT (voir Démarrer).

Opérations

Méthode	Chemin	Rôle
GET	/v2/documentecheance	Lister les enregistrements
POST	/v2/documentecheance	Créer l'enregistrement
PUT	/v2/documentecheance	Mettre à jour l'enregistrement
DELETE	/v2/documentecheance	Supprimer l'enregistrement
GET	/v2/documentecheance/count	Compter les enregistrements
POST	/v2/documentecheance/count	Compter les enregistrements
POST	/v2/documentecheance/recherche	Rechercher des enregistrements
POST	/v2/documentecheance/save	Créer ou mettre à jour l'enregistrement (upsert)
PUT	/v2/documents/{doType}/{doPiece}/echeances	Appel PUT sur documents/echeances

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/documentecheance

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

POST /v2/documentecheance

Créer l'enregistrement.

Corps de la requête (application/json)

Schéma DocumentEcheanceDto - 16 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/documentecheance" \
  -H "Authorization: Bearer <jeton>" \
  -H "Content-Type: application/json" \
  -d '{"id": 0, "domaine": 0, "typeDocument": 0}'

PUT /v2/documentecheance

Mettre à jour l'enregistrement.

Corps de la requête (application/json)

Schéma DocumentEcheanceDto - 16 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/documentecheance" \
  -H "Authorization: Bearer <jeton>" \
  -H "Content-Type: application/json" \
  -d '{"id": 0, "domaine": 0, "typeDocument": 0}'

DELETE /v2/documentecheance

Supprimer l'enregistrement.

Corps de la requête (application/json)

Schéma DocumentEcheanceDto - 16 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/documentecheance" \
  -H "Authorization: Bearer <jeton>" \
  -H "Content-Type: application/json" \
  -d '{"id": 0, "domaine": 0, "typeDocument": 0}'

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

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

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

POST /v2/documentecheance/save

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

Corps de la requête (application/json)

Schéma DocumentEcheanceDto - 16 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/documentecheance/save" \
  -H "Authorization: Bearer <jeton>" \
  -H "Content-Type: application/json" \
  -d '{"id": 0, "domaine": 0, "typeDocument": 0}'

PUT /v2/documents/{doType}/{doPiece}/echeances

Appel PUT sur documents/echeances.

Paramètres

Nom	Emplacement	Type	Obligatoire	Description
doType	path	integer (int32)	oui	-
doPiece	path	string	oui	-

Corps de la requête (application/json)

Schéma CorpsEcheancierV2 - 2 propriétés (détail : Schémas).

Réponses

Code	Description	Schéma de data
200	OK	ResultatEcriture
400	Bad Request	ProblemDetails
401	Unauthorized	-
403	Forbidden	-
404	Not Found	ProblemDetails
422	Unprocessable Content	ProblemDetails
503	Service Unavailable	ProblemDetails

Exemple

curl -s -X PUT "https://<votre-connecteur>/v2/documents/<doType>/<doPiece>/echeances" \
  -H "Authorization: Bearer <jeton>" \
  -H "Content-Type: application/json" \
  -d '{"modeleReglement": 0, "echeances": []}'

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.

CorpsEcheancierV2

CorpsEcheancierV2 - 2 propriétés

Propriété	Type	Notes
modeleReglement	integer (int32)	nullable
echeances	tableau de DocumentEcheanceDto	nullable

DocumentEcheanceDto

DocumentEcheanceDto - 16 propriétés

Propriété	Type	Notes
id	integer (int32)	Numéro interne de l'échéance (DR_No). Lecture seule (non exposé COM).
domaine	integer (int32)	Domaine du document porteur (DO_Domaine : 0=Vente, 1=Achat).
typeDocument	integer (int32)	Type du document porteur (DO_Type SQL).
numeroPiece	string	nullable, Numéro de pièce du document porteur (DO_Piece - non paddé dans F_DOCREGL).
typeReglement	integer (int32)	Type de règlement (DR_TypeRegl : 0=échéance, 1=acompte). Lecture seule.
date	string (date-time)	Date de l'échéance (DR_Date).
libelle	string	nullable, Libellé (DR_Libelle - porté par les acomptes, non exposé COM sur l'échéance).
pourcent	number (double)	Pourcentage du règlement (DR_Pourcent).
montant	number (double)	Montant du règlement (DR_Montant).
montantDevise	number (double)	Montant en devise (DR_MontantDev).
equilibrage	boolean	Ligne d'équilibrage générée par Sage (DR_Equil). Lecture seule.
idEcriture	integer (int32)	Écriture comptable liée (EC_No). Lecture seule.
regle	integer (int32)	Statut de règlement de l'échéance (DR_Regle). Lecture seule.
numeroReglement	integer (int32)	Mode de règlement (N_Reglement, cbIndice de P_REGLEMENT).
referencePaiement	string	nullable, Référence de paiement (DR_RefPaiement). Lecture seule (non exposé COM).
numeroPieceAcompte	string	nullable, Pièce d'acompte liée (DO_PieceAcompte). Lecture seule.

ProblemDetails

ProblemDetails - 5 propriétés

Propriété	Type	Notes
type	string	nullable
title	string	nullable
status	integer (int32)	nullable
detail	string	nullable
instance	string	nullable

ResultatEcriture

ResultatEcriture - 4 propriétés

Propriété	Type	Notes
cle	string	nullable
proprieteCle	string	nullable
resultat	quelconque	nullable
entite	quelconque	nullable

Voir aussi

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

Écrans qui utilisent ce groupe

• Abonnements
• Filtres et accès