ContractStatus

Represents the status of a Contract, such as Draft, InApproval, Activated, Terminated, or Expired.

Supported Calls

query(), retrieve(), describeSObjects()

Fields

Field Field Type Field Properties Description
IsDefault boolean Defaulted on create

Filter

Indicates whether this is the default contract status value (true) or not (false) in the picklist.
MasterLabel string Filter

Nillable

Master label for this contract status value. This display value is the internal label that does not get translated.
SortOrder int Filter

Nillable

Number used to sort this value in the contract status picklist. These numbers are not guaranteed to be sequential, as some previous contract status values might have been deleted.
StatusCode picklist Filter

Nillable

Restricted picklist

Code indicating the status of a contract. One of the following values:
  • Draft
  • InApproval
  • Activated
Two other values (Terminated and Expired) are defined but are not available for use via the API.

Usage

This object represents a value in the contract status picklist. The contract status picklist provides additional information about the status of a Contract, such as its current state (Draft, InApproval, or Activated). Your client application can invoke the query() call on the this object to retrieve the set of values in the contract status picklist, and then use that information while processing Contract objects to determine more information about a given contract. For example, the application could test whether a given contract is activated based on its Status value and the value of the StatusCode property in the associated ContractStatus object.

This object is read-only via the API. With sufficient permissions, your client application can invoke the query() and describeSObjects() calls on it.

See Also:
ContractContactRole
© Copyright 2000-2008 salesforce.com, inc. All rights reserved.
Various trademarks held by their respective owners.