VoidInvoiceProcessedEvent

Notifies subscribers when the process started by the /commerce/invoicing/invoices/{invoiceId}/actions/void request is complete. The request attempts to void an invoice by crediting an invoice and changing its status to Voided, which prevents further changes. This object is available in API version 55.0 and later. This object is available in API version 55.0 and later.

Supported Calls

describeSObjects()

Supported Subscribers

Subscriber	Supported?
Apex Triggers
Flows
Processes
Pub/Sub API
Streaming API (CometD)

Subscription Channel

/event/VoidInvoiceProcessedEvent

Special Access Rules

This object is available when Subscription Management is enabled.

Fields

Field	Details
CorrelationIdentifier	Type string Properties Nillable Description Reserved for future use.
CrMemoProcessErrDtlEvents	Type CrMemoProcessErrDtlEvent[] Properties Nillable Description Contains a list of error messages and error codes if the request failed
CreditMemoId	Type reference Properties Nillable Description The credit memo created to void the invoice as the result of a successful request. This is a relationship field. Relationship Name CreditMemo Relationship Type Lookup Refers To CreditMemo
EventUuid	Type string Properties Nillable Description A universally unique identifier (UUID) that identifies a platform event message.
InvoiceId	Type reference Properties Nillable Description The invoice that was voided as the result of a successful request. This is a relationship field. Relationship Name Invoice Relationship Type Lookup Refers To Invoice
IsSuccess	Type boolean Properties Defaulted on create Description Indicates whether the request was successful. The default value is 'false'.
ReplayId	Type string Properties Nillable Description Represents an ID value that is populated by the system and refers to the position of the event in the event stream. Replay ID values aren’t guaranteed to be contiguous for consecutive events. A subscriber can store a replay ID value and use it on resubscription to retrieve missed events that are within the retention window.
RequestIdentifier	Type string Properties Nillable Description The unique ID returned in the `/commerce/billing/invoices/{invoiceId}/actions/void` response. Use this ID to identify the event for a specific request.

Platform Events Developer Guide