CreditInvoiceProcessedEvent
Notifies subscribers when the process started by the /commerce/invoicing/invoices/{invoiceId}/actions/credit request is complete. This object is available in API version 55.0 and later.
describeSObjects()
| Subscriber | Supported? |
|---|---|
| Apex Triggers |  |
| Flows | |
| Processes | |
| Pub/Sub API | |
| Streaming API (CometD) | |
/event/CreditInvoiceProcessedEvent
No
This object is available when Subscription Management is enabled.
Type: string
Properties: Nillable
Description: Reserved for future use.
Type: CreditMemoProcessedErrDtlEvent[]
Properties: Nillable
Description: Contains a list of error messages and error codes if the request failed. This field is available only in API versions 55.0–58.0. See the ErrorDetails field for error messages and error codes.
Type: reference
Properties: Nillable
Description: The credit memo created as the result of a successful request. This field is a relationship field.
Relationship Name: CreditMemo
Relationship Type: Lookup
Refers To: CreditMemo
Type: string
Properties: Nillable
Description: If the request fails, this field shows error messages, error codes, and the ID of the record on which the errors occurred. This field is available in API 58.0 and later.
Type: string
Properties: Nillable
Description: A universally unique identifier (UUID) that identifies a platform event message.
Type: reference
Properties: Nillable
Description: The invoice credited as the result of a successful request. This field is a relationship field.
Relationship Name: Invoice
Relationship Type: Lookup
Refers To: Invoice
Type: boolean
Properties: Defaulted on create
Description: Indicates whether the request was successful. The default value is ‘false’.
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.
Type: string
Properties: Nillable
Description: The unique ID returned in the response. Use this ID to identify the event for a specific request.