ContractStatus

ドラフト、承認中、有効、終了、期限切れなど、Contract の状況を表します。

可能な場合は、Equality の会社の値に一致するように、含めない用語を変更しました。コード内の用語を変更すると、現在の実装が壊れる可能性があるため、このオブジェクトの名前は維持しました。

重要

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

describeSObjects()query()retrieve()

項目

項目 詳細
ApiName
string
プロパティ
Filter、Group、idLookup、Sort
説明
選択リストの値を一意に識別します。これにより ID や主表示ラベルを使用せずに選択リストの値を取得できます。
IsDefault
boolean
プロパティ
Defaulted on create、Filter、Group、Sort
説明
この項目が選択リスト内の契約のデフォルト状況か (true)、否か (false) を示します。
MasterLabel
string
プロパティ
Filter、Group、Nillable、Sort
説明
この契約状況値の表示ラベル。この表示値は、翻訳されない内部ラベルです。
SortOrder
int
プロパティ
Filter、Group、Nillable、Sort
説明
契約の状況の選択リストで値を並べ替えるために使用する番号。以前の契約の状況値が一部削除されている場合があるため、番号が連続していないことがあります。
StatusCode
picklist
プロパティ
Filter、Group、Nillable、Restricted picklist、Sort
説明
契約の状況を示すコード。次のいずれかの値になります。
  • Draft
  • InApproval
  • Activated
他の 2 つの値 (TerminatedExpired) は定義されていますが、API で使用することはできません。

使用方法

このオブジェクトは契約状況の選択リストの値を表します。契約状況の選択リストには、現在の状況 (DraftInApproval、または Activated) など、Contract の状況に関する追加情報が表示されています。これらのレコードを照会して、契約状況の選択リストの値セットを取得します。また、その情報を Contract オブジェクトの処理に使用し、指定された契約のさらに詳細な情報を取得できます。たとえば、アプリケーションは、Status の値、および関連付けられた ContractStatus オブジェクトの StatusCode プロパティの値に基づいて、指定された契約が有効かどうかをテストできます。