この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。
英語に切り替える

CreditMemoProcessedEvent

/commerce/invoicing/credit-memos 要求によって開始されたプロセスが完了したときにサブスクライバーに通知されます。 このオブジェクトは API バージョン 55.0 以降で使用できます。

サポートされているコール

describeSObjects()

サポートされているサブスクライバー

サブスクライバー サポートされているかどうか。
Apex トリガ はい
フロー はい
プロセス はい
Pub/Sub API はい
ストリーミング API (CometD) はい

登録チャネル

/event/CreditMemoProcessedEvent

特別なアクセスルール

このオブジェクトは、サブスクリプション管理が有効な場合に使用できます。

項目

項目 詳細
CorrelationIdentifier
string
プロパティ
Nillable
説明
将来の使用のために予約されています。
CrMemoProcessErrDtlEvents
CreditMemoProcessedErrDtlEvent[]
プロパティ
Nillable
説明
要求が失敗した場合に、エラーメッセージとエラーコードのリストが含まれます。
CreditMemoId
reference
プロパティ
Nillable
説明
成功した要求の結果として作成されるクレジットメモ。
これはリレーション項目です。
リレーション名
CreditMemo
リレーション種別
Lookup
参照先
CreditMemo
EventUuid
string
プロパティ
Nillable
説明
プラットフォームイベントメッセージを識別するユニバーサル一意識別子 (UUID)。
IsSuccess
boolean
プロパティ
Defaulted on create
説明
スタンドアローンクレジットメモの作成アクションが成功したかどうかを示します。
デフォルト値は「false」です。
ReplayId
string
プロパティ
Nillable
説明
システムによって生成された ID 値を表し、イベントストリーム内のイベントの位置を参照します。連続するイベントに対して再生 ID の値に連番が振られるという保証はありません。サブスクライバーは再生 ID の値を保存し、再登録時にその値を使用して、保持ウィンドウ内の欠落したイベントを取得できます。
RequestIdentifier
string
プロパティ
Nillable
説明
/commerce/invoicing/credit-memos 応答で返された一意の ID。特定の要求に対するイベントを特定するには、この ID を使用します。

ユーザが /commerce/invoicing/credit-memos を正常に実行し、クレジットメモを 1 つ作成し、要求が完了するとこのプラットフォームイベントを受信します。
1{
2    RequestId=“2110391bnwsj0938a”,
3    IsSuccess=“true”,
4    CreditMemoId="000115abcde001",
5    CreditMemoErrorDetailEvents=””
6}

ユーザが /commerce/invoicing/invoices/{invoiceId}/actions/credit 要求を実行しましたが、クレジットメモの金額が請求書の残高より大きいため失敗しました。
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}