Get Factures
The following endpoint can be used to retrieve the details of Factures within the The Invoice Path application.
Point de terminaison
The following endpoint can be used to retrieve Factures. You must replace the {base_url} , {site_id} and {updated_after} variables with the appropriate values.
GET
{base_url}/api/v4/site/{site_id}/invoices?updated_after={updated_after}
Demander les paramètres de la requête
Champ
Type
Description
updated_after
Date
Un horodatage à utiliser comme début de la plage de dates (exclusif) de la requête. Pour les requêtes suivantes, vous devez transmettre la valeur nextUpdatedAfter qui était dans la réponse de la requête précédente. Les requêtes remontent au maximum à 7 jours. Un horodatage plus ancien est avancé jusqu'à la limite plutôt que rejeté; les enregistrements modifiés pour la dernière fois avant cette limite ne sont donc pas retournés. Si ce paramètre est omis, les 7 derniers jours sont retournés. Une intégration qui renvoie le nextUpdatedAfter de chaque réponse n'atteint jamais la limite. Format = YYYY-MM-DDTHH:mm:ss.SSSZ
Réponse
Champ
Type
Description
recordsMatched
Number
Le nombre d'enregistrements qui correspondent aux paramètres de la requête.
recordsReturned
Number
Le nombre d'enregistrements qui ont été retournés.
nextUpdatedAfter
Date
Un horodatage à utiliser comme début de la plage de dates (exclusif) de la prochaine requête pour le même point de terminaison. Cela est utilisé pour la pagination lors de la requête avec un paramètre updated_after. Format = YYYY-MM-DDTHH:mm:ss.SSSZ
queryTime
Date
L'heure à laquelle la requête a été exécutée. nextUpdatedAfter en est dérivé; il s'agit donc de la même valeur chaque fois qu'une page complète a été retournée. Format = YYYY-MM-DDTHH:mm:ss.SSSZ
limit
Number
Le nombre maximal d'enregistrements qu'une seule réponse peut retourner. Lorsque recordsReturned est égal à ce nombre, il est probable que d'autres enregistrements soient en attente et qu'une autre requête doive être effectuée avec le nextUpdatedAfter retourné.
records
La liste des contacts qui correspondent aux paramètres de la requête.
success
Boolean
Indique si la requête s'est terminée avec succès.