Lister les événements de synchronisation
Liste ce qui a changé depuis votre dernier appel, du plus ancien au plus récent.
GET/v1/workspaces/{regionId}/sync/events
Paramètres
afterstringLe nextCursor de votre dernier appel (un id d’événement). Omettez-le pour partir de l’événement le plus ancien.
limitinteger1-500 événements par appel. 100 par défaut.
Retour
200 OK avec l’objet présenté dans la réponse.
Plus de détails
Ce qui a changé de ce côté de l’espace de travail, du plus ancien au plus récent. Un événement nomme un document, jamais son contenu : lisez le document avec l’opération correspondante, pour toujours obtenir sa version actuelle. Renvoyez nextCursor comme after lors de votre prochain appel ; tant que hasMore vaut true, rappelez immédiatement. Les événements sont conservés 30 jours et livrés au moins une fois, si bien qu’un même changement peut arriver deux fois ; les 5 dernières secondes attendent l’appel suivant. Un appelant fournisseur reçoit purchase_order.issued, changed, canceled et rejected, invoice.received, approved, rejected, paid, payment_withdrawn, remittance_sent et credit_applied, invoice.updated (un acheteur a mis la facture en attente de vérification, ou l’a libérée : lisez GetInvoiceStatus), ainsi que credit_note.accepted et rejected. Un appelant acheteur reçoit invoice.received et credit_note.received (un fournisseur a envoyé une facture ou un avoir) ; invoice.updated (une facture a été validée, par une personne ou automatiquement, ou refusée, ou son fournisseur a confirmé les coordonnées bancaires ou l’a signalée) ; invoice.payment (un paiement a été enregistré ou retiré, un avoir a soldé la facture, ou un paiement via Pleaxy a abouti ou échoué : lisez GetInvoiceRemittance) ; purchase_order.updated (une commande a été validée, refusée ou annulée) ; et purchase_order.confirmed et purchase_order.shipped (lisez GetPurchaseOrderFulfillment). Il ne reçoit que les types de documents que son rôle achats peut consulter.
Champs de la réponse
events[].typestringCe qui s’est passé, sous la forme <document>.<change>, par exemple invoice.paid.
events[].buyerWorkspaceIdstringAppelants fournisseurs : l’ID d’espace de travail de l’acheteur, à passer en ?buyer= pour lire le document.
nextCursorstringLe point de départ de votre prochain appel. Absent uniquement avant le premier événement.
hasMorebooleanD’autres événements attendent : rappelez immédiatement.
Erreurs
- 400 Bad Request - after n’est pas un id d’événement, ou limit est hors limites.
- 401 Unauthorized - Aucun identifiant n’a été fourni, ou la valeur du jeton Bearer / de X-Api-Key est manquante, invalide, expirée ou révoquée.
- 403 Forbidden - Le jeton Bearer ou la clé API de l’appelant ne donne pas accès à cet espace de travail (regionId), ou n’a pas le rôle requis.
curl "$PLEAXY_API_BASE_URL/v1/workspaces/reg_01k5x8p9j3q7vn2mhb4tzc6rde.supplier/sync/events?after=EV-mgx2k9a1-0c4f81d2" \
-H "X-Api-Key: $PLEAXY_API_KEY"{
"events": [
{ "id": "EV-mgx2kb7e-91a2c3d4", "at": "2026-10-23T10:02:11.402Z", "type": "invoice.paid", "documentType": "invoice", "documentId": "INV-3C9E71B2", "buyerWorkspaceId": "reg_01k5x8n2a7c4bq9wze0tkv3fjm.buyer" }
],
"nextCursor": "EV-mgx2kb7e-91a2c3d4",
"hasMore": false
}