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

OrderPaymentSummary

1 つの OrderSummary に適用される 1 つの支払方法を使用する支払の現在のプロパティと状態を表します。このオブジェクトは、API バージョン 48.0 以降で使用できま���。

可能な場合は、Equality の会社の値に一致するように、含めない用語を変更しました。顧客の実装に対する影響を回避するために、一部の用語は変更されていません。

重要

ほとんどの概要オブジェクトとは異なり、OrderPaymentSummary は類似の名前を持つ注文支払オブジェクトに関連付けられていません。代わりに、同じ支払方法を使用し、同じ OrderSummary に適用される複数の支払オブジェクトから値を組み合わせます。

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

create()delete()describeLayout()describeSObjects()getDeleted()getUpdated()query()retrieve()search()undelete()update()upsert()

特別なアクセスルール

このオブジェクトは、Salesforce Order Management 組織でのみ、または B2B Commerce ライセンスが有効になっている場合にのみ使用できます。

項目

項目 詳細
AuthorizationAmount
currency
プロパティ
Filter、Nillable、Sort
説明
承認された OrderPaymentSummary の金額。
AuthorizationReversal​Amount
currency
プロパティ
Filter、Nillable、Sort
説明
取り消された AuthorizationAmount の金額。
AvailableToCaptureAmount
currency
プロパティ
Filter、Nillable、Sort
説明
収集可能な OrderPaymentSummary の金額。AuthorizationAmount - (CapturedAmount + PendingCaptureAmount + AuthorizationReversalAmount + PendingReverseAuthAmount) と等しくなります。ただし、算出された金額が負の数である場合、この値は 0 になります。
AvailableToRefundAmount
currency
プロパティ
Filter、Nillable、Sort
説明
返金可能な OrderPaymentSummary の金額。CapturedAmount + PendingCaptureAmount - (RefundedAmount + PendingRefundAmount) と等しくなります。ただし、算出された金額が負の数である場合、この値は 0 になります。
BalanceAmount
currency
プロパティ
Filter、Nillable、Sort
説明
この概要オブジェクトに関連付けられたすべての支払の残高合計。
CapturedAmount
currency
プロパティ
Filter、Nillable、Sort
説明
収集された OrderPaymentSummary の金額。
CurrencyIsoCode
picklist
プロパティ
Create、Defaulted on create、Filter、Group、Nillable、Restricted picklist、Sort、Update
説明
マルチ通貨機能を有効化している組織にのみ使用できます。OrderPaymentSummary に関連付けられた OrderSummary の通貨の ISO コードが含まれます。OrderSummary の OrderPaymentSummary を作成する注文管理 API およびアクションによってこの値が設定されます。デフォルト値は、USD です。
可能な値は次のとおりです。
  • DKK — デンマーククローネ
  • EUR — ユーロ
  • GBP — イギリスポンド
  • USD — アメリカドル
この項目は、API バージョン 49.0 以降で使用できます。
FullName
string
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
支払方法のユーザの氏名。
LastPaymentGateway​LogId
reference
プロパティ
Filter、Group、Nillable、Sort
説明
OrderPaymentSummary に関連付けられた最新の支払ゲートウェイの ID。
LastPaymentGateway​Message
string
プロパティ
Create、Filter、Nillable、Sort、Update
説明
OrderPaymentSummary に関連付けられた支払ゲートウェイから受信した最新メッセージ。
LastReferencedDate
dateTime
プロパティ
Filter、Nillable、Sort
説明
現在のユーザがこのレコードに関連するレコードを最後に表示したときのタイムスタンプ。
この項目は、API バージョン 49.0 以降で使用できます。
LastViewedDate
dateTime
プロパティ
Filter、Nillable、Sort
説明
現在のユーザがこのレコードを最後に表示したときのタイムスタンプ。null 値の場合、このレコードは参照 (LastReferencedDate) されただけで、表示はされていない可能性が��ります。
この項目は、API バージョン 49.0 以降で使用できます。
Method
string
プロパティ
Create、Filter、Group、idLookup、Sort、Update
説明
OrderPaymentSummary の名前。
OrderSummaryId
reference
プロパティ
Create、Filter、Group、Sort
説明
OrderPaymentSummary に関連付けられた OrderSummary の ID。
OwnerId
reference
プロパティ
Create、Defaulted on create、Filter、Group、Sort、Update
説明
この OrderPaymentSummary を現在所有するユーザ ID。デフォルト値は、create を実行するために API にログインするユーザです。
PaymentMethodId
reference
プロパティ
Filter、Group、Nillable、Sort
説明
この OrderPaymentSummary に関連付けられた支払方法の ID。
PendingAuthorization​Amount
currency
プロパティ
Filter、Nillable、Sort
説明
承認待機中の OrderPaymentSummary の金額。
PendingCaptureAmount
currency
プロパティ
Filter、Nillable、Sort
説明
収集待機中の OrderPaymentSummary の金額。
PendingRefundAmount
currency
プロパティ
Filter、Nillable、Sort
説明
返金待機中の OrderPaymentSummary の金額。
PendingReverseAuth​Amount
currency
プロパティ
Filter、Nillable、Sort
説明
取消待機中の AuthorizationAmount の金額。
RefundedAmount
currency
プロパティ
Filter、Nillable、Sort
説明
返金された OrderPaymentSummary の金額。
Type
string
プロパティ
Create、Filter、Group、Sort
説明
OrderPaymentSummary に関連付けられた支払方法種別。たとえば、visamastercardcheckgiftcard などです。

関連付けられたオブジェクト

このオブジェクトには次の関連するオブジェクトがあります。特に記載がない限り、これらはこのオブジェクトと同じ API バージョンで使用できます。

OrderPaymentSummaryFeed
このオブジェクトにはフィード追跡を利用できます。
OrderPaymentSummaryOwnerSharingRule
このオブジェクトには共有ルールを利用できます。
OrderPaymentSummaryShare
このオブジェクトには共有を利用できます。