Platform Events Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Platform Events Developer Guide
Delivering Custom Notifications with Platform Events
Defining Your Custom Platform Event
Publishing Platform Events
Subscribing to Platform Events
Testing Your Platform Event in Apex
Encrypting Platform Event Messages at Rest in the Event Bus
Monitor Platform Event Publishing and Delivery Usage
Considerations
Examples
Reference
Platform Event Allocations
Platform Event Error Status Codes
Standard Platform Event Objects
Change Data Capture Events
Standard Platform Event Object List
AcademicTermGpaCalcEvent
AIPredictionEvent
AIUpdateRecordEvent
AppointmentSchedulingEvent
AssetCancelInitiatedEvent
AssetAmendInitiatedEvent
AssetRenewInitiatedEvent
AssetTokenEvent
BatchApexErrorEvent
BillingScheduleCreatedEvent
BulkApi2JobEvent (Beta)
CommerceDiagnosticEvent
ConsentEvent
ConsentUnsubscribeAllEvent
ConversationInsightEvent
CreateAssetOrderEvent
CreditInvoiceProcessedEvent
CreditMemoProcessedEvent
DataObjectDataChgEvent
DataObjectMetadataChgEvent
DatasetExportEvent
DiscoveryPredictionEvent
EmailCapturedMatchEvent
ExtlRecShrEvent
ExtlRecShrResultEvent
FirstBillPaymentSetupEvent
FlowExecutionErrorEvent
FlowOrchestrationEvent
FOStatusChangedEvent
FulfillOrdItemQtyChgEvent
InsPolicyRnwlQuoteStatusEvent
InsPolicyRnwlStatusEvent
InteropTopicSubcrEvent
InvoiceProcessedEvent
InvoiceProcPymtExclEvent
NegInvcLineProcessedEvent
OmniTrackingEvent
OrderStatusChangedEvent
OrderSummaryCreatedEvent
OrderSumStatusChangedEvent
PaymentCreationEvent
PendingOrdSumProcEvent
PlaceOrderCompletedEvent
PlatformStatusAlertEvent
ProcessExceptionEvent
QuoteSaveEvent
QuoteToOrderCompletedEvent
RealtimeAlertEvent
RemoteKeyCalloutEvent
SrcPredJobStatusChgEvent
SearchIndexJobStatusEvent
ServiceAppointmentEvent
VoidInvoiceProcessedEvent
WebCartAbandonedEvent
WebStoreUserCreatedEvent
Real-Time Event Monitoring Objects
ApiAnomalyEvent
ApiAnomalyEventStore
ApiEvent
ApiEventStream
BulkApiResultEvent
BulkApiResultEventStore
ConcurLongRunApexErrEvent
CredentialStuffingEvent
CredentialStuffingEventStore
CreditInvoiceProcessedEvent
CreditMemoProcessedEvent
CrMemoProcessErrDtlEvent
GuestUserAnomalyEvent
GuestUserAnomalyEventStore
PaymentCreationEvent
VoidInvoiceProcessedEvent
FileEvent
FileEventStore
IdentityProviderEventStore
IdentityVerificationEvent
LightningUriEvent
LightningUriEventStream
ListViewEvent
ListViewEventStream
LoginAnomalyEvent
LoginAnomalyEventStore
LoginAsEvent
LoginAsEventStream
LoginEvent
LoginEventStream
LogoutEvent
LogoutEventStream
MobileEmailEvent
MobileEnforcedPolicyEvent
MobileScreenshotEvent
MobileTelephonyEvent
PermissionSetEvent
PermissionSetEventStore
ReportAnomalyEvent
ReportAnomalyEventStore
ReportEvent
ReportEventStream
SessionHijackingEvent
SessionHijackingEventStore
UriEvent
UriEventStream
PDF

CreditMemoProcessedEvent

Notifies subscribers when the process started by the /commerce/invoicing/credit-memos request is complete. This object is available in API version 55.0 and later.

Supported Calls

describeSObjects()

Supported Subscribers

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

Subscription Channel

/event/CreditMemoProcessedEvent

Event Delivery Allocation Enforced

No

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
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.
CreditMemoId
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
ErrorDetails
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.
EventUuid
Type
string
Properties
Nillable
Description
A universally unique identifier (UUID) that identifies a platform event message.
IsSuccess
Type
boolean
Properties
Defaulted on create
Description
Indicates whether the Create Standalone Credit Memo action 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/invoicing/credit-memos response. Use this ID to identify the event for a specific request.

Example

A user successfully runs a /commerce/invoicing/credit-memos, creates one credit memo, and receives this platform event when the request completes.
{
		"IsSuccess": true,
		"CrMemoProcessErrDtlEvents": null,
		"CreatedById": "005RO000000g4LYYAY",
		"CorrelationIdentifier": "50gRO0000000jxc",
		"CreatedDate": "2023-03-17T15:09:18Z",
		"ErrorDetails": "[]",
		"InvoiceId": "3ttRO0000006839YAA",
		"CreditMemoId": "50gRO0000000jxcYAA",
		"RequestIdentifier": "d488e070-0fd8-4cde-a9fd-d7ca38d040f5"
}

Example

A user runs a /commerce/invoicing/invoices/{invoiceId}/actions/credit request, which fails because the credit memo’s amount is greater than the invoice’s balance. 
{
		"IsSuccess": false,
		"CrMemoProcessErrDtlEvents": null,
		"CreatedById": "005RO000000g4LYYAY",
		"CorrelationIdentifier": "50gRO0000000jzi",
		"CreatedDate": "2023-03-17T22:55:11Z",
		  "ErrorDetails": "[{
	"ErrorSourceId": "50gRO0000000jzi",
	"ErrorCode": "RECORD_UPDATE_FAILED",
	"ErrorMessage": "An error occurred while updating the credit memo status to POSTED: Child events testing - fail updating credit memo status to posted Failed object Ids : 50gRO0000000jzi"
}]",
		"CreditMemoId": "50gRO0000000jziYAA",
		"RequestIdentifier": "9123a706-4a64-4beb-8942-4eb5abd1e59f"
	},