List Payments

Utilisez ceci pour rattraper tous les paiements qui ont changé depuis votre dernière synchronisation, par exemple après une panne de votre point de terminaison webhook.

The following endpoint can be used to retrieve the details of Payments within the Hyfin application.


Point de terminaison

The following endpoint can be used to retrieve Payments. You must replace the {base_url} , {site_id} and {updated_after} variables with the appropriate values.

GET
{base_url}/api/v4/site/{site_id}/payments?updated_after={updated_after}

Demander les paramètres de la requête
Champ
Type
Description
updated_after
Le début de la plage de temps de la requête (exclusif). Lors des requêtes suivantes, envoyez le nextUpdatedAfter de la réponse précédente. Contrairement aux autres horodatages, il exige exactement trois chiffres de millisecondes et un fuseau horaire, soit Z, soit un décalage tel que +05:00. Dans une chaîne de requête, envoyez + sous la forme %2B. Tout autre format, ou une heure dans le futur, est rejeté. 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. Un moment précis en format ISO 8601, avec un fuseau horaire. 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
La valeur à envoyer comme updated_after lors de la prochaine requête. Lorsque plus d'enregistrements correspondaient que ce que cette page a retourné, il s'agit de 1 milliseconde avant l'heure de mise à jour du dernier enregistrement, de sorte que cet enregistrement revienne sur la page suivante : dédupliquez par id. Lorsque cette page a retourné tous les enregistrements correspondants, il s'agit de l'heure de la requête, et la requête suivante ne retourne que les enregistrements modifiés depuis. Un moment précis en format ISO 8601, avec un fuseau horaire. Format = YYYY-MM-DDTHH:mm:ss.SSSZ
queryTime
L'heure d'exécution de la requête. Lorsque la page a retourné tous les enregistrements correspondants, il s'agit aussi de nextUpdatedAfter. Un moment précis en format ISO 8601, avec un fuseau horaire. 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
Les enregistrements correspondant aux paramètres de la requête, du plus ancien au plus récent selon la mise à jour.
success
Boolean
Indique si la requête s'est terminée avec succès.

Voir aussi