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

OpportunityLineItem

Opportunity に関連付けられた Product2 商品のリストの構成要素である、商談品目名を表します。

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

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

特別なアクセスルール

商談の商談品目を作成または更新するには、Opportunity レコードの「編集」権限が必要です。

項目

項目 詳細
CanUseQuantitySchedule
boolean
プロパティ
Defaulted on create、Filter、Group、Sort
説明
商品に数量のスケジュールが指定されているか (true)、否か (false) を示します。この項目は参照のみです。
CanUseRevenueSchedule
boolean
プロパティ
Defaulted on create、Filter、Group、Sort
説明
商談商品に収益のスケジュールが指定されているか (true)、否か (false) を示します。この項目は参照のみです。
ConnectionReceivedId
reference
プロパティ
Filter、Group、Nillable、Sort
説明
組織とこのレコードを共有した PartnerNetworkConnection の ID。この項目は、Salesforce to Salesforce が有効な場合に使用できます。
ConnectionSentId
reference
プロパティ
Filter、Group、Nillable、Sort
説明
このレコードを共有した PartnerNetworkConnection の ID。この項目は、Salesforce to Salesforce が有効な場合に使用できます。この項目は、API バージョン 15.0 以前を使用する場合にサポートされます。他の API バージョンでは、この項目の値は null です。レコードを接続に転送するには、新しい PartnerNetworkRecordConnection を使用します。
CurrencyIsoCode
picklist
プロパティ
Defaulted on create、Filter、Group、Restricted picklist、Sort
説明
複数の currency 機能を有効化している組織にのみ使用できます。組織で使用できる currency の ISO コードが指定されています。
組織でマルチ通貨を有効にしており、親商談に Pricebook2 が指定されている場合 (このオブジェクトの OpportunityId が参照する商談の Pricebook2Id 項目が空欄でない場合)、この項目の値は、このオブジェクトに関連付けられている PricebookEntry オブジェクトの CurrencyIsoCode 項目の通貨に一致している必要があります。
Description
string
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
商談品目のテキストによる説明。最大 80 文字です。
Discount
percent
プロパティ
Create、Filter、Nillable、Sort、Update
説明
商品の割引率 (%)。
これらのレコードを更新するとき:
  • TotalPrice を指定しないで Discount を指定すると、新しい Discount 値に合わせて TotalPrice が調整され、UnitPrice が一定に保たれます。
  • また、Discount および Quantity の両方を指定する場合、システムがどちらを自動的に調整するかを決定できるように、TotalPrice または UnitPrice のいずれかを指定する必要があります。
HasQuantitySchedule
boolean
プロパティ
Defaulted on create、Filter、Group、Sort
説明
参照のみ。数量スケジュールがこのオブジェクトに作成されているか (true)、否か (false) を示します。
HasRevenueSchedule
boolean
プロパティ
Defaulted on create、Filter、Group、Sort
説明
収益スケジュールがこのオブジェクトに作成されているか (true)、否か (false) を示します。
このオブジェクトに収益スケジュールが指定されている場合、Quantity 項目と TotalPrice 項目を更新することはできません。また、このオブジェクトに数量スケジュールが指定されている場合、Quantity 項目を更新することはできません。更新要求は却下されませんが、更新された値は無視されます。
HasSchedule
boolean
プロパティ
Defaulted on create、Filter、Group、Sort
説明
HasQuantitySchedule または HasRevenueSchedule のいずれかが true である場合、この項目も true です。
LastReferencedDate
datetime
プロパティ
Filter、Nillable、Sort
説明
現在のユーザがこのレコードに関連するレコードを最後に表示したときのタイムスタンプ。API バージョン 50.0 以降で利用できます。
LastViewedDate
datetime
プロパティ
Filter、Nillable、Sort
説明
現在のユーザがこのレコードを最後に表示したときのタイムスタンプ。この値が null の場合、このレコードは参照 (LastReferencedDate) されただけで、表示はされていない可能性があります。API バージョン 50.0 以降で利用できます。
ListPrice
currency
プロパティ
Filter、Nillable、Sort
説明
この品目名に関連付けられた PricebookEntry の UnitPrice に対応します。標準価格表またはカスタム価格表に記載できます。クライアントアプリケーションはこの情報を使用して、品目名の単価 (または販売価格) が価格表エントリのリスト価格と異なるかどうかを示すことができます。
Name
string
プロパティ
Filter、Nillable、Sort
説明
商談品目名 (ユーザインターフェースでは「商談商品」と呼ばれる)。この項目は参照のみであり、API バージョン 30.0 以降で使用できます。
OpportunityId
reference
プロパティ
Create、Filter、Group、Sort
説明
必須。関連付けられた Opportunity の ID。
これはリレーション項目です。
リレーション名
Opportunity
リレーション種別
Lookup
参照先
Opportunity
PricebookEntryId
reference
プロパティ
Create、Filter、Group、Nillable、Sort
説明
必須。関連付けられた PricebookEntry の ID。商品機能を有効化した組織にのみ定義されます。API バージョン 1.0 および 2.0 では、この項目または ProductId のいずれかの値を指定できます。両方を指定することはできません。このため、両方の項目が nillable を宣言しています。API バージョン 3.0 以降では、ProductId の代わりにこの項目の値を指定する必要があります。
これはリレーション項目です。
リレーション名
PricebookEntry
リレーション種別
Lookup
参照先
PricebookEntry
ProductId
reference
プロパティ
Create、Filter、Nillable
説明
関連する商品レコードの ID。バージョン 3.0 ではこの項目は廃止され、後方互換性の目的でのみ提供されています。このオブジェクトは API バージョン 8.0 以降では使用できません。PricebookEntry レコードの ID を指定して、PricebookEntryId 項目を代わりに使用します。
これはリレーション項目です。
リレーション名
Product2
リレーション種別
Lookup
参照先
Product2
Product2Id
reference
プロパティ
Create、Filter、Group、Nillable、Sort
説明
関連する Product2 レコードの ID。この項目は参照のみであり、API バージョン 30.0 以降で使用できます。

PricebookEntry レコードの ID を指定して、PricebookEntryId 項目を代わりに使用します。

ProductCode
string
プロパティ
Filter、Group、Nillable、Sort
説明
この項目は参照のみであり、API バージョン 30.0 以降で使用できます。関連する Product2 レコードの ProductCode 項目の値を参照します。
Quantity
double
プロパティ
Create、Filter、Sort、Update
説明
レコードに数量スケジュール、収益スケジュールまたはそれらの両方が指定されている場合、参照のみです。
これらのレコードを更新するとき:
  • UnitPrice を指定しないで Quantity を指定する��、新しい Quantity 値に合わせて UnitPrice が調整され、TotalPrice が一定に保たれます。
  • Discount と Quantity の両方を指定する場合は、TotalPrice または UnitPrice のいずれかを指定すると、システムによって自動調整する値が決定されます。
RecalculateTotalPrice
boolean
プロパティ
Defaulted on create、Filter、Group、Sort
説明
品目に Quantity 値の子スケジュール行がある場合、OpportunityLineItem 計算の動作を変更します。この項目が有効な場合、合計数量が変わると、販売価格に合計数量の値を乗じて、合計金額を変更します。Product2 フラグを true にする必要があります。
ServiceDate
date
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
商品の収益が認識され、商品の数量が納入される日付。
  • 商談完了日 — ServiceDate は無視されます。
  • 商品提供日 — ServiceDate は、null でない場合に使用されます。
  • スケジュール日 — ServiceDate は、null でなく、この品目に収益によるスケジュールが指定されていない場合に使用できます。つまり、このオブジェクトの子である Revenue の項目 Type の値が指定された OpportunityLineItemSchedule レコードがない場合に使用されます。
SortOrder
int
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
ユーザが選択した並び替え順を示す番号。クライアントアプリケーションはこれを使用して、Salesforce の並び替え順を一致させることができます。
Subtotal
currency
プロパティ
Filter、Nillable、Sort
説明
標準価格と割引価格の差額。組織の通貨がユーザの通貨と異なる場合、換算された通貨の金額が表示されます。
TotalPrice
currency
プロパティ
Create、Defaulted on create、Filter、Nillable、Sort、Update
説明
この項目は後方互換性確保の目的でのみ使用可能です。OpportunityLineItem の合計金額を表します。

UnitPrice を指定しない場合、この項目は必須です。Discount および Quantity を指定する場合は、この項目または UnitPrice が必要です。これらのレコードを更新するとき、この値または UnitPrice のいずれかを変更できますが、両方を同時に変更することはできません。

この項目は Nillable ですが、同じ更新要求で、TotalPriceUnitPrice を null に設定することはできません。API を使用して TotalPrice を挿入するには (単価と数量のみがある場合)、単価に数量を乗じてこの項目を計算します。商談品目に収益スケジュールが指定されている場合、この項目は参照のみです。この商談品目にスケジュールが指定されていないまたは数量スケジュールのみが指定されている場合、この項目を更新できます。
UnitPrice
currency
プロパティ
Create、Defaulted on create、Filter、Nillable、Sort、Update
説明
商談品目の単価。Salesforce ユーザインターフェースでは、この項目の値は、商談品目の合計金額をその品目の数量で除算して計算されます。表示ラベルは [販売価格] です。

この項目または TotalPrice のいずれかが必要です。両方を指定することはできません。

Discount および Quantity を指定する場合は、この項目または TotalPrice が必要です。

使用方法

Opportunity には、Opportunity に Pricebook2 がある場合にのみ、関連付けられた OpportunityLineItem レコードを含めることができます。OpportunityLineItem は、商談の Pricebook2 に記載された Product2 に対応する必要があります。関連する Pricebook2 または既存の品目がない商談への OpportunityLineItem の挿入については、「商談への影響」を参照してください。

このオブジェクトは、商品機能を有効化している組織にのみ定義されます。商品機能が有効化されていない場合、このオブジェクトは describeGlobal() コールに表示されないため、describeSObjects() と共に使用したり、OpportunityLineItem オブジェクトを照会したりできません。

OpportunityLineItem とその他のオブジェクトの関係を示すダイアグラムについては、「商品オブジェクトとスケジュールオブジェクト」を参照してください。

  • マルチ通貨のオプションが有効化されている場合、CurrencyIsoCode 項目が存在します。変更することはできず、必ず親 Opportunity の CurrencyIsoCode の値に設定されます。
  • カスタマイズ可能な商品スケジュールが有効化されている場合、デフォルトのスケジュールでカスタム項目を使用し、そのレイアウトをカスタマイズできます。ただし、最初の挿入時は、適用している入力規則または Apex トリガでスキップされます。

メモ

商談への影響

関連付けられた OpportunityLineItem レコードを持つ商談は、次のように影響を受けます。
  • OpportunityLineItem を作成すると、OpportunityLineItem の TotalPrice によって Opportunity の Amount の値が増加します。また、OpportunityLineItem を挿入すると、TotalPrice を商談の Probability と乗算することによって ExpectedRevenue が増加します。
  • 商談に品目がある場合、Opportunity の Amount は参照のみの項目となります。API は、品目を持つ商談のこの項目を更新しようとしても無視します。更新要求は却下されませんが、更新された値は無視されます。
  • 品目がある場合、商談の PricebookId 項目または CurrencyIsoCode 項目を更新することはできません。API は、品目を持つ商談のこれらの項目を更新しようとしても却下します。
  • OpportunityLineItem を作成または更新すると、商談に関連付けられた Pricebook2 の PricebookEntry に品目名が対応しているかどうかが API によって検証されます。商談に関連付けられた Pricebook2 が存在しない状態で、有効な Pricebook2 の PricebookEntry に品目が対応しており、かつ PricebookEntry が商談の CurrencyIsoCode 項目に一致する CurrencyIsoCode 項目を持つ場合、API は自動的に商談の価格表を設定します。Pricebook2 が有効でない場合、または CurrencyIsoCode 項目が一致しない場合、エラーが返されます。
  • Opportunity に OpportunityLineItem が挿入されると、その Opportunity の HasOpportunityLineItem 項目が true に設定されます。
  • OpportunityLineItem レコードを直接削除した場合、ごみ箱に入れられないため、削除を取り消すことができません。getDeleted() コールは、削除された OpportunityLineItem レコードが消去されるまで表示します。通常は、当日または翌日中に消去されます。
  • Lightning では、ListPriceName、および ProductCode 項目の値は OpportunityLineItem.Product2Id 値の保存後に計算されるため、挿入前に入力されることはありません。これらの項目の値にアクセスするには、After Insert トリガを使用します。