Document sync

What changed in this workspace side, oldest first. An event names a document, never its content: read the document with the operation for it, so you always get its current version. Pass nextCursor back as after on your next call; while hasMore is true, call again at once. Events are kept 30 days and delivered at least once, so the same change can come twice; the newest 5 seconds wait for the next call. A Supplier caller gets purchase_order.issued, changed, canceled and rejected, invoice.received, approved, rejected, paid, payment_withdrawn, remittance_sent and credit_applied, invoice.updated (a buyer put the invoice on hold for review, or released it: read GetInvoiceStatus), and credit_note.accepted and rejected. A Buyer caller gets invoice.received and credit_note.received (a supplier sent one); invoice.updated (an invoice was approved, by a person or automatically, or rejected, or its supplier confirmed bank details or reported it); invoice.payment (a payment was recorded or withdrawn, credit settled the invoice, or a payment through Pleaxy went through or failed: read GetInvoiceRemittance); purchase_order.updated (an order was approved, rejected or canceled); and purchase_order.confirmed and purchase_order.shipped (read GetPurchaseOrderFulfillment). It gets only the document types its procurement role can view.

An issued purchase order as a document your system takes in. format=cxml (the default) is a cXML OrderRequest: type new, update from version 2, delete once canceled. format=ubl is a UBL 2.1 Order, or an OrderCancellation once canceled. Both parties are named by their Workspace IDs. It is the supplier's copy whoever asks. A supplier whose buyers share a PO id adds ?buyer=<buyer Workspace ID>.

An invoice as a UBL 2.1 Invoice (type 380, or 383 for a debit note), for the buyer's ERP to book or the supplier's archive: its lines, document-level discounts and charges, tax and withholdings, prepayments, the supplier's payment instructions, and the PO and contract it bills. The totals reconcile to the invoice's amount. It is the supplier's view whoever asks: no matching, findings or approvals.

Where an invoice stands, for the system that sent it or the one that pays it, as one status with the codes e-invoicing systems use for it. The same as cXML or UBL is GetInvoiceStatusDocument. It is the supplier's view whoever asks.

GetInvoiceStatus as a document. format=cxml (the default) is a cXML StatusUpdateRequest with an InvoiceStatus; format=ubl is a UBL 2.1 ApplicationResponse with the Peppol Invoice Response codes and, for a rejection, its reason.

The payment signal for an invoice, for the supplier's cash application: how and when the buyer paid, the reference, what was withheld and what reached the supplier, and the remittances the buyer sent (notes and proofs of payment; GetRemittanceFile downloads one). Pleaxy records what the buyer states and moves no money. Never who at the buyer recorded it. The same as cXML or UBL is GetInvoiceRemittanceDocument.

GetInvoiceRemittance as a document. format=cxml (the default) is a cXML PaymentRemittanceRequest; format=ubl is a UBL 2.1 RemittanceAdvice.

Records payments your ERP or bank feed already made outside Pleaxy - wires, checks, ACH, card - so each supplier gets its payment notice, remittance advice and sync event without anyone retyping it. This moves no money. Each payment follows RecordPayment's rules and is answered on its own; repeating one is safe (already_recorded). An invoice approved by an API key is still refused. note becomes a remittance note for the supplier; a proof of payment can only be attached by a person.

Buyer API key with the payments:record scope only, minted with a procurementRole that can edit invoices (administrator or finance). A signed-in person uses RecordPayment.