Platform Events Developer Guide
jNewer Version Available
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 |  |
| Flows | |
| Processes | |
| Pub/Sub API | |
| Streaming API (CometD) | |
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 |
|
| CrMemoProcessErrDtlEvents |
|
| CreditMemoId |
|
| EventUuid |
|
| IsSuccess |
|
| ReplayId |
|
| RequestIdentifier |
|
Example
A user successfully runs a /commerce/invoicing/credit-memos, creates one credit memo, and receives
this platform event when the request
completes.
1{
2 RequestId=“2110391bnwsj0938a”,
3 IsSuccess=“true”,
4 CreditMemoId="000115abcde001",
5 CreditMemoErrorDetailEvents=””
6}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.
1{
2 RequestId=“2110391bnwsj0938a”,
3 IsSuccess=“false”,
4 CreditMemoId="",
5 CreditMemoProcessedErrorDetailEvents = [
6 {
7 ErrorSourceId="invoice/invoiceline-id/creditmemoline-id",
8 ErrorCode="INVALID_API_INPUT",
9 ErrorMessage="Credit Memo Invoice Application amount can't be greater than the invoice's balance."
10 }
11 ]
12}