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

CreditMemoProcessedEvent

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

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

describeSObjects()

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

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

登録チャネル

/event/CreditMemoProcessedEvent

イベント配信割り当ての適用

いいえ

特別なアクセスルール

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

項目

項目	詳細
CorrelationIdentifier	型 string プロパティ Nillable 説明将来の使用のために予約されています。
CrMemoProcessErrDtlEvents	型 CreditMemoProcessedErrDtlEvent[] プロパティ Nillable 説明要求が失敗した場合に、エラーメッセージとエラーコードのリストが含まれます。この項目は、API バージョン 55.0 から 58.0 でのみ使用できます。エラーメッセージとエラーコードについては、ErrorDetails 項目を確認してください。
CreditMemoId	型 reference プロパティ Nillable 説明成功した要求の結果として作成されるクレジットメモ。この項目はリレーション項目です。リレーション名 CreditMemo リレーション種別 Lookup 参照先 CreditMemo
ErrorDetails	型 string プロパティ Nillable 説明要求が失敗した場合、この項目には、エラーメッセージ、エラーコード、およびエラーが発生したレコードの ID が表示されます。この項目は API 58.0 以降で使用できます。
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		"IsSuccess": true,
3		"CrMemoProcessErrDtlEvents": null,
4		"CreatedById": "005RO000000g4LYYAY",
5		"CorrelationIdentifier": "50gRO0000000jxc",
6		"CreatedDate": "2023-03-17T15:09:18Z",
7		"ErrorDetails": "[]",
8		"InvoiceId": "3ttRO0000006839YAA",
9		"CreditMemoId": "50gRO0000000jxcYAA",
10		"RequestIdentifier": "d488e070-0fd8-4cde-a9fd-d7ca38d040f5"
11}

例

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

1{
2		"IsSuccess": false,
3		"CrMemoProcessErrDtlEvents": null,
4		"CreatedById": "005RO000000g4LYYAY",
5		"CorrelationIdentifier": "50gRO0000000jzi",
6		"CreatedDate": "2023-03-17T22:55:11Z",
7		  "ErrorDetails": "[{
8	"ErrorSourceId": "50gRO0000000jzi",
9	"ErrorCode": "RECORD_UPDATE_FAILED",
10	"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"
11}]",
12		"CreditMemoId": "50gRO0000000jziYAA",
13		"RequestIdentifier": "9123a706-4a64-4beb-8942-4eb5abd1e59f"
14	},

プラットフォームイベント開発者ガイド