Aller au contenu

GetPaymentsByStatusDate

Liste les paiements d’une société, l’argent qu’elle a versé à des fournisseurs et à d’autres entités en règlement de leurs factures fournisseurs, par statut : les brouillons créés, les paiements approuvés ou les paiements finalisés sur une période. Utilisez-le pour récupérer les paiements approuvés ou finalisés depuis votre dernier appel, puis lisez chacun d’eux, avec les factures fournisseurs qu’il règle, avec GetTransaction. Les encaissements, l’argent reçu en règlement des factures, ne sont pas listés. Les paiements sont décrits sur la page Encaissement ou paiement.

Comment se connecter et lire la réponse : Authentification, Réponses.

GET /api/v1/GetPaymentsByStatusDate?CompID=3&Status=Approved&FromDate=2026-10-01&ToDate=2026-10-08
Token: your-token
Paramètre Obligatoire Signification
CompID Oui L’identifiant de la société qui a effectué les paiements, un nombre entier.
Status Oui Draft, Approved ou Finalised. Les majuscules n’ont pas d’importance. Voir Statut et dates.
FromDate Oui Le début de la période, au format yyyy-MM-dd, ou yyyy-MM-ddTHH:mm:ss pour une heure, en UTC. Inclus.
ToDate Oui La fin de la période, sous la même forme. Incluse. 365 jours au plus après FromDate.

Envoyez les dates au format yyyy-MM-dd ou yyyy-MM-ddTHH:mm:ss : les autres formes dépendent des paramètres régionaux du serveur. Voir Dates.

Status choisit à la fois les paiements et la date à laquelle s’applique la période (pour les statuts, voir Les étapes d’un encaissement) :

Status Liste les paiements qui sont La période s’applique à
Draft Pas encore approuvés. Le moment où le paiement a été créé.
Approved Approuvés, et pas encore finalisés. Le moment où le paiement a été approuvé.
Finalised Finalisés. Le moment où le paiement a été finalisé.

Un paiement n’est donc listé que sous un seul statut à la fois : un paiement approuvé n’apparaît plus sous Draft, et un paiement finalisé n’apparaît plus sous Approved. Un paiement ramené à l’état de brouillon apparaît de nouveau sous Draft.

Les dates sont des dates avec une heure, en UTC. Une date sans heure correspond au début de ce jour : ToDate=2026-10-08 s’arrête donc à minuit, au début du 8 octobre. Pour inclure toute la journée, envoyez ToDate=2026-10-08T23:59:59 ou le jour suivant.

Règle Info en cas d’échec
L’en-tête Token contient un jeton valide. Token missing in header, Token invalid or expired, ou une autre réponse listée dans Jeton de connexion
L’utilisateur est un administrateur système avec l’accès à l’API. API User must be SysAdmin with API Access
Status a une valeur. Status is required
FromDate a une valeur. FromDate is required
ToDate a une valeur. ToDate is required
CompID est supérieur à 0. CompID is invalid
Status est l’une des trois valeurs. Invalid Status. Status must be one of the following: Draft, Approved, Finalised
FromDate est une date. FromDate is not valid
ToDate est une date. ToDate is not valid
ToDate n’est pas antérieure à FromDate. ToDate must be later than FromDate
Les dates sont espacées de 365 jours au plus. Days between FromDate and ToDate cannot exceed 365

TrakIT supprime les espaces des dates avant de les lire ; écrivez donc une heure avec le T : 2026-10-08 23:59:59 est refusé.

En cas de succès, Code vaut 1, RetInfo est la liste, dans l’ordre des identifiants, et RowsAffected est le nombre de paiements qu’elle contient. Quand aucun paiement ne correspond, y compris quand aucune société n’a ce CompID, la liste est vide : Code vaut toujours 1 et RowsAffected vaut 0.

{
"Code": 1,
"Info": "",
"RetInfo": [
{ "ID": 60218, "Date": "2026-10-06T00:00:00", "Curr": "USD", "Amount": 1150.00, "Seq": "HQ20260012" },
{ "ID": 60231, "Date": "2026-10-07T00:00:00", "Curr": "EUR", "Amount": 420.00, "Seq": "HQ20260013" }
],
"RowsAffected": 2,
"Scalar": null,
"Identity": 0
}
Champ Signification
ID L’identifiant du paiement. Utilisez-le avec GetTransaction.
Date La Transaction Date du paiement, sous forme de date et heure à minuit.
Curr La devise du paiement.
Amount Le montant payé.
Seq Le Sequence Number du paiement, attribué lors de l’approbation : le code de la société, l’année et un numéro d’ordre. null pour un brouillon.
  • Envoyez tous les paramètres : sans l’un d’eux, la requête n’atteint pas le point de terminaison, et TrakIT répond avec le statut HTTP 404 (voir Erreurs).