Sync-Ereignisse auflisten
Listet auf, was sich seit Ihrem letzten Aufruf geändert hat, älteste zuerst.
GET/v1/workspaces/{regionId}/sync/events
Parameter
afterstringDer nextCursor Ihres letzten Aufrufs (eine Ereignis-ID). Weglassen, um beim ältesten Ereignis zu beginnen.
limitinteger1-500 Ereignisse pro Aufruf. Standardwert 100.
Rückgabe
200 OK mit dem in der Antwort gezeigten Objekt.
Weitere Details
Was sich auf dieser Workspace-Seite geändert hat, älteste zuerst. Ein Ereignis nennt ein Dokument, nie dessen Inhalt: Lesen Sie das Dokument mit der zugehörigen Operation, so erhalten Sie immer seine aktuelle Version. Übergeben Sie nextCursor bei Ihrem nächsten Aufruf als after; solange hasMore true ist, rufen Sie sofort erneut auf. Ereignisse werden 30 Tage aufbewahrt und mindestens einmal zugestellt, dieselbe Änderung kann also zweimal kommen; die neuesten 5 Sekunden warten auf den nächsten Aufruf. Ein Aufrufer mit Lieferantenrolle erhält purchase_order.issued, changed, canceled und rejected, invoice.received, approved, rejected, paid, payment_withdrawn, remittance_sent und credit_applied, invoice.updated (ein Käufer hat die Rechnung zur Prüfung angehalten oder wieder freigegeben: lesen Sie GetInvoiceStatus) sowie credit_note.accepted und rejected. Ein Aufrufer mit Käuferrolle erhält invoice.received und credit_note.received (von einem Lieferanten gesendet); invoice.updated (eine Rechnung wurde freigegeben, von einer Person oder automatisch, oder abgelehnt, oder ihr Lieferant hat Bankdaten bestätigt oder sie gemeldet); invoice.payment (eine Zahlung wurde erfasst oder zurückgezogen, eine Gutschrift hat die Rechnung beglichen, oder eine Zahlung über Pleaxy ist durchgegangen oder fehlgeschlagen: lesen Sie GetInvoiceRemittance); purchase_order.updated (eine Bestellung wurde freigegeben, abgelehnt oder storniert); sowie purchase_order.confirmed und purchase_order.shipped (lesen Sie GetPurchaseOrderFulfillment). Er erhält nur die Dokumenttypen, die seine Einkaufsrolle sehen darf.
Antwortfelder
events[].typestringWas passiert ist, als <document>.<change>, z. B. invoice.paid.
events[].buyerWorkspaceIdstringAufrufer mit Lieferantenrolle: die Workspace-ID des Käufers, die beim Lesen des Dokuments als ?buyer= übergeben wird.
nextCursorstringWo Ihr nächster Aufruf beginnt. Fehlt nur vor dem ersten Ereignis.
hasMorebooleanWeitere Ereignisse warten: Rufen Sie sofort erneut auf.
Fehler
- 400 Bad Request - after ist keine Ereignis-ID, oder limit liegt außerhalb des zulässigen Bereichs.
- 401 Unauthorized - Es wurden keine Zugangsdaten übermittelt, oder der Bearer-Token bzw. der X-Api-Key-Wert fehlt, ist ungültig, abgelaufen oder widerrufen.
- 403 Forbidden - Der Bearer-Token oder API-Schlüssel des Aufrufers gewährt keinen Zugriff auf diesen Workspace (regionId) oder hat nicht die erforderliche Rolle.
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
}