Contract

Supported Calls

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

Fields

Field	Details
AccountId	Type reference Properties Create, Filter, Group, Sort,Update Description Required. ID of the Account associated with this contract.
ActivatedById	Type reference Properties Filter, Group, Nillable, Sort,Update Description ID of the User who activated this contract.
ActivatedDate	Type dateTime Properties Filter, Nillable, Sort, Update Description Date and time when this contract was activated.
BillingCity	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Details for the billing address. Maximum size is 40 characters.
BillingCountry	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Details for the billing address of this account. Maximum size is 40 characters.
BillingPostalCode	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Details for the billing address of this account. Maximum size is 20 characters.
BillingState	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Details for the billing address. Maximum size is 20 characters.
BillingStreet	Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description Street address for the billing address.
CompanySignedDate	Type date Properties Create, Filter, Group, Nillable, Sort, Update Description Date on which the contract was signed by your organization.
CompanySignedId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the User who signed the contract.
ContractNumber	Type string Properties Autonumber, Defaulted on create, Filter, Sort Description Number of the contract.
ContractTerm	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Number of months that the contract is valid.
CustomerSignedDate	Type date Properties Create, Filter, Group, Nillable, Sort, Update Description Date on which the customer signed the contract.
CustomerSignedId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the Contact who signed this contract.
CustomerSignedTitle	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Title of the customer who signed the contract.
Description	Type textarea Properties Create, Nillable, Update Description Description of the contract.
EndDate	Type date Properties Filter, Group, Nillable, Sort, Description Read-only. Calculated end date of the contract. This value is calculated by adding the ContractTerm to the StartDate.
IsDeleted	Type boolean Properties Defaulted on create, Filter Description Indicates whether the object has been moved to the Recycle Bin (true) or not (false). Label is Deleted.
LastActivityDate	Type date Properties Filter, Group, Nillable, Sort Description Value is one of the following, whichever is the most recent: Due date of the most recent event logged against the record. Due date of the most recently closed task associated with the record.
LastApprovedDate	Type dateTime Properties Filter, Nillable, Sort Description Last date the contract was approved.
OwnerExpirationNotice	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Number of days ahead of the contract end date (15, 30, 45, 60, 90, and 120). Used to notify the owner in advance that the contract is ending.
OwnerId	Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the user who owns the contract.
Pricebook2Id	Type reference Properties Create, Filter, Nillable, Update Description ID of the pricebook, if any, associated with this contract.
RecordTypeId	Type reference Properties Create, Filter, Nillable, Update Description ID of the record type assigned to this object.
ShippingCity	Type string Properties Create, Filter, Nillable, Update Description Details of the shipping address. City maximum size is 40 characters.
ShippingCountry	Type string Properties Create, Filter, Nillable, Update Description Details of the shipping address. Country maximum size is 40 characters.
ShippingPostalCode	Type string Properties Create, Filter, Nillable, Update Description Details of the shipping address. Postal code maximum size is 20 characters.
ShippingState	Type string Properties Create, Filter, Nillable, Update Description Details of the shipping address. State maximum size is 20 characters.
ShippingStreet	Type string Properties Create, Filter, Nillable, Update Description The street address of the shipping address. Maximum of 255 characters.
SpecialTerms	Type textarea Properties Create, Filter, Nillable, Sort, Update Description Special terms that apply to the contract.
StartDate	Type date Properties Create, Filter, Group, Nillable, Sort,Update Description Start date for this contract. Label is Contract Start Date.
Status	Type picklist Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The picklist of values that indicate order status. Each value is within one of two status categories defined in StatusCode. For example, the status picklist may contain: Ready to Ship, Shipped, Received as values within the Activated StatusCode.
StatusCode	Type picklist Properties Filter, Group, Restricted picklist, Sort Description The status category for the order. An order can be either Draft, InApproval, or Activated. Label is Status Category.

Usage

The Contract object represents a business agreement.

The Status field specifies the current state of a contract. Status strings (defined in the ContractStatus object) represent its current state (Draft, InApproval, or Activated).

Client applications must initially create a Contract in a non-Activated state. Client applications can subsequently activate a Contract by updating it and setting the value in its Status field to Activated; however, the Status field is the only field you can update when activating the Contract.

Once a Contract has been activated, your client application can't change its status; however, prior to activation, your client application can change the status value from Draft to InApproval via the API. Also, your client application can delete contracts whose status is Draft or InApproval but not when a contract status is Activated.

Client applications can use the API to create, update, delete, and query any Attachment associated with a contract.