Elencare gli eventi di sincronizzazione
Elenca cosa è cambiato dalla tua ultima chiamata, dal meno recente.
GET/v1/workspaces/{regionId}/sync/events
Parametri
afterstringIl nextCursor della tua ultima chiamata (un id evento). Omettilo per partire dall’evento meno recente.
limitinteger1-500 eventi per chiamata. Valore predefinito: 100.
Restituisce
200 OK con l’oggetto mostrato nella risposta.
Più dettagli
Cosa è cambiato in questa parte del workspace, dal meno recente. Un evento indica un documento, mai il suo contenuto: leggi il documento con l’operazione apposita, così ottieni sempre la versione attuale. Ripassa nextCursor come after nella chiamata successiva; finché hasMore è true, richiama subito. Gli eventi sono conservati 30 giorni e consegnati almeno una volta, quindi la stessa modifica può arrivare due volte; gli ultimi 5 secondi attendono la chiamata successiva. Un chiamante Fornitore riceve purchase_order.issued, changed, canceled e rejected, invoice.received, approved, rejected, paid, payment_withdrawn, remittance_sent e credit_applied, invoice.updated (un acquirente ha messo in sospeso la fattura per verificarla, o l’ha sbloccata: leggi GetInvoiceStatus), e credit_note.accepted e rejected. Un chiamante Acquirente riceve invoice.received e credit_note.received (un fornitore ha inviato una fattura o una nota di credito); invoice.updated (una fattura è stata approvata, da una persona o automaticamente, o rifiutata, oppure il suo fornitore ne ha confermato le coordinate bancarie o l’ha segnalata); invoice.payment (un pagamento è stato registrato o ritirato, un credito ha saldato la fattura, oppure un pagamento tramite Pleaxy è andato a buon fine o non è riuscito: leggi GetInvoiceRemittance); purchase_order.updated (un ordine è stato approvato, rifiutato o annullato); e purchase_order.confirmed e purchase_order.shipped (leggi GetPurchaseOrderFulfillment). Riceve solo i tipi di documento che il suo ruolo procurement può vedere.
Campi della risposta
events[].typestringCosa è successo, come <document>.<change>, ad es. invoice.paid.
events[].buyerWorkspaceIdstringChiamanti Fornitore: l’ID del workspace dell’acquirente, da passare come ?buyer= quando leggi il documento.
nextCursorstringDa dove parte la tua prossima chiamata. Assente solo prima del primo evento.
hasMorebooleanCi sono altri eventi in attesa: richiama subito.
Errori
- 400 Bad Request - after non è un id evento, oppure limit è fuori intervallo.
- 401 Unauthorized - Non è stata presentata alcuna credenziale, oppure il token Bearer o il valore di X-Api-Key è mancante, non valido, scaduto o revocato.
- 403 Forbidden - Il token Bearer o la chiave API del chiamante non dà accesso a questo workspace (regionId), oppure non ha il ruolo richiesto.
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
}