Aller au contenu

GetInvoiceList

Liste les factures, notes de débit et avoirs d’une période, avec leur numéro, leur statut, leur client, leur total et leurs dossiers. Utilisez-le pour récupérer les factures créées, approuvées ou finalisées depuis votre dernier appel, puis lisez chacune en détail avec GetInvoice. Pour la signification de chaque statut, voir Statuts sur la page de la facture.

La liste contient les factures d’une seule société : la Company de l’utilisateur TrakIT qui s’est connecté (voir Champs de l’utilisateur).

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

GET /api/v1/GetInvoiceList?DateType=Approved&FromDate=2026-10-01&ToDate=2026-10-08
Token: your-token
Paramètre Obligatoire Signification
DateType Oui La date à laquelle s’applique la période : InvDate, Created, Approved ou Finalised. Les majuscules n’ont pas d’importance. Voir Période.
FromDate Oui Le début de la période, au format yyyy-MM-dd, ou yyyy-MM-ddTHH:mm:ss pour une heure. 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.

DateType La période s’applique à
InvDate La date de la facture.
Created Le moment où la facture a été créée, en UTC.
Approved Le moment où la facture a été approuvée, en UTC. Les factures pas encore approuvées sont exclues.
Finalised Le moment où la facture a été finalisée, en UTC. Les factures pas encore finalisées sont exclues.

Created, Approved et Finalised sont des dates avec une heure. 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
DateType a une valeur. DateType is required
FromDate a une valeur. FromDate is required
ToDate a une valeur. ToDate is required
DateType est l’une des quatre valeurs. Invalid Date Type. Date Type must be one of the following: InvDate, Created, 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, de la date de facture la plus ancienne à la plus récente, et RowsAffected est le nombre de factures qu’elle contient. Quand aucune facture ne correspond, la liste est vide : Code vaut toujours 1 et RowsAffected vaut 0.

{
"Code": 1,
"Info": "",
"RetInfo": [
{
"ID": 48211,
"InvNum": "INV-2026-0042",
"InvDate": "2026-10-05",
"Type": "I",
"Status": "Approved",
"EntID": 1187,
"EntCode": "EXTRADE",
"Currency": "USD",
"Total": 2360.00,
"JobIDs": [31877],
"DocID": 90412,
"CreatedBy": "jsmith",
"CreatedOn": "2026-10-02T08:41:12.5",
"ApprovedBy": "jsmith",
"ApprovedOn": "2026-10-05T07:15:03.18"
}
],
"RowsAffected": 1,
"Scalar": null,
"Identity": 0
}
Champ Signification
ID L’identifiant de la facture dans TrakIT. Utilisez-le avec GetInvoice.
InvNum Le numéro de la facture. Un brouillon a un numéro pro forma, comme PF00123-1, jusqu’à son approbation.
InvDate La date de la facture, au format yyyy-MM-dd.
Type I pour une facture, D pour une note de débit, C pour un avoir.
Status Draft, Approved, Finalised, Cancelled ou Written Off. Une facture que TrakIT affiche comme Reversed, parce qu’un avoir a été émis contre elle, garde ici son statut Approved ou Finalised.
EntID, EntCode L’identifiant et le code de l’entité facturée, généralement le client. Voir GetEntity.
Currency La devise de la facture.
Total Le total de la facture, taxes comprises.
JobIDs Les identifiants des dossiers facturés : le dossier de la facture ou, pour une facture qui ne concerne pas un seul dossier, les dossiers de ses postes. Voir GetJob.
DocID L’identifiant du PDF de la facture parmi les documents financiers, ou null si elle n’en a pas.
CreatedBy, CreatedOn L’identifiant utilisateur de la personne qui a créé la facture, et le moment, en UTC.
ApprovedBy, ApprovedOn L’identifiant utilisateur de la personne qui a approuvé la facture, et le moment, en UTC. null jusqu’à son approbation.
  • Le numéro et la date d’un brouillon peuvent encore changer : sa date passe à la date du jour à chaque ouverture, et il reçoit son numéro définitif lors de son approbation. Lisez à nouveau la facture une fois qu’elle est approuvée.
  • Les factures annulées sont aussi listées. Filtrez sur Status si vous n’en voulez pas.
  • 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).