Newer Version Available

This content describes an older version of this product. View Latest

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.

This guide only lists certain information for each object. For more information, including descriptions of the fields, see VoidInvoiceProcessedEvent in the Billing Guide and Platform Events Developer Guide.

Fields

Field Name Field Label Type Digits Length Precision Scale
CorrelationIdentifier Correlation Identifier string 80
CrMemoProcessErrDtlEvents Credit Memo Processed Error Detail Event ID complexvalue
CreatedById Created By ID reference 18
CreatedDate Created Date datetime
ErrorDetails Error Details string 2000
EventUuid Event UUID string 36
InvoiceId Invoice ID reference 18
IsSuccess Success boolean
ReplayId Replay ID string 1000
RequestIdentifier Request Identifier string 80