Contract

Represents a contract (a business agreement) associated with an Account.

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

  • Type: reference

  • Properties: Create, Filter, Group, Sort, Update

  • Description:

    Required. ID of the Account associated with this contract.

    This field is a relationship field.

  • Relationship name: Account

  • Relationship type: relationship

  • Refers to: Account

  • Type: reference

  • Properties: Filter, Group, Nillable, Sort, Update

  • Description:

    ID of the User who activated this contract.

    This field is a relationship field.

  • Relationship name: ActivatedBy

  • Relationship type: relationship

  • Refers to: User

  • Type: datetime
  • Properties: Filter, Nillable, Sort, Update
  • Description: Date and time when this contract was activated.

  • Type: reference

  • Properties: Filter, Group, Nillable, Sort

  • Description:

    When Einstein Activity Capture with Activity Metrics is enabled, the ID of the related activity metric.

    This field is a relationship field.

  • Relationship name: ActivityMetric

  • Relationship type: relationship

  • Refers to: ActivityMetric

  • Type: reference

  • Properties: Filter, Group, Nillable, Sort

  • Description:

    When Einstein Activity Capture with Activity Metrics is enabled, the ID of the related activity metric rollup.

    This field is a relationship field.

  • Relationship name: ActivityMetricRollup

  • Relationship type: relationship

  • Refers to: ActivityMetricRollup

  • Type: picklist

  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update

  • Introduced: API version 64.0

  • Description:

    The aggregation strategy when creating a pricing contract.

    Valid value is Cumulative. This field is available with Revenue Cloud in API version 64.0 and later.

  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Introduced: API version 54.0

  • Relationship name: AmendedContract

  • Relationship type: relationship

  • Refers to: Contract

  • Type: picklist
  • Properties: Create, Filter, Group, Restricted picklist, Sort, Update
  • Type: currency
  • Properties: Filter, Sort
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Type: address
  • Properties: Filter, Nillable
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Type: double
  • Properties: Create, Filter, Nillable, Sort, Update
  • Type: double
  • Properties: Create, Filter, Nillable, Sort, Update
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Type: textarea
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Type: address
  • Properties: Filter, Nillable
  • Description: The compound form of the billing address. Read-only. See Address Compound Fields for details on compound address fields.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Details for the billing address. The maximum size is 40 characters.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Details for the billing address of this account. The maximum size is 80 characters.
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The ISO country code for the contract’s billing address.
  • Type: email
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Type: phone
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Description: The accuracy of the geocode for the billing address.
  • Possible values:
    • Address — Address
    • Block — Block
    • City — City
    • County — County
    • ExtendedZip — ExtendedZip
    • NearAddress — NearAddress
    • Neighborhood — Neighborhood
    • State — State
    • Street — Street
    • Unknown — Unknown
    • Zip — Zip
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Type: picklist
  • Properties: Create, Filter, Group, Restricted picklist, Sort, Update
  • Type: string
  • Properties: Create, Filter, Group, Sort, Update
  • Type: double
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: Used with BillingLongitude to specify the precise geolocation of a billing address. Acceptable values are numbers between –90 and 90 with up to 15 decimal places.
  • Type: double
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: Used with BillingLatitude to specify the precise geolocation of a billing address. Acceptable values are numbers between –180 and 180 with up to 15 decimal places.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Type: string
  • Properties: Filter, Group, Nillable, Sort
  • Type: phone
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Details for the billing address of this account. The maximum size is 20 characters.
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Details for the billing address. The maximum size is 80 characters.
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The ISO state code for the contract’s billing address.
  • Type: textarea
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Street address for the billing address.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Type: date
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The date your organization signed the contract.

  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Description:

    ID of the user who signed the contract.

    This field is a relationship field.

  • Relationship name: CompanySigned

  • Relationship type: relationship

  • Refers to: User

  • Type: int
  • Properties: Filter, Group, Nillable, Sort
  • Introduced: API version 54.0

  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Introduced: API version 54.0

  • Relationship name: ContractDocumentVersion

  • Relationship type: relationship

  • Refers to: ContractDocumentVersion

  • Type: string
  • Properties: Autonumber, Defaulted on create, Filter, idLookup, Sort
  • Description: Number of the contract.
  • Type: int
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Number of months that the contract is valid.
  • Type: string
  • Properties: Filter, Group, Nillable, Sort, Update
  • Introduced: API version 56.0
  • Type: date
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Type: date
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The date when the customer signed the contract.

  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Description:

    ID of the Contact who signed this contract.

    This field is a relationship field.

  • Relationship name: CustomerSigned

  • Relationship type: relationship

  • Refers to: Contact

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Title of the customer who signed the contract.
  • Type: textarea
  • Properties: Create, Nillable, Update
  • Description: Description of the contract.
  • Type: date
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Read-only. Calculated end date of the contract. This value is calculated by adding the ContractTerm to the StartDate. If the Auto-calculate Contract End Date setting is disabled, the contract end date is editable.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 54.0

  • Type: boolean

  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update

  • Introduced: API version 65.0

  • Description:

    Indicates whether the contract can be coterminated (true) or not (false).

    The default value is false. This field is available with Revenue Cloud in API version 65.0 and later.

  • Default value: false

  • Type: boolean

  • Properties: Defaulted on create, Filter, Group, Sort

  • Default value: false

  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update

  • Type: boolean

  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update

  • Introduced: API version 56.0

  • Default value: false

  • Type: boolean

  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update

  • Default value: false

  • Type: boolean
  • Properties: Defaulted on create, Filter, Group, Sort
  • Introduced: API version 63.0
  • Description: Indicates whether the contract has related contract item prices (true) or if there are no contract item prices for the contract (false). This field is available with Revenue Cloud in API version 63.0 and later.
  • Default value: false

  • Type: boolean

  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update

  • Introduced: API version 54.0

  • Default value: false

  • Type: boolean

  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update

  • Introduced: API version 54.0

  • Default value: false

  • Type: date

  • Properties: Filter, Group, Nillable, Sort

  • Description:

    Value is the most recent:

    • The due date of the most recent event is logged against the record.
    • The due date of the most recently closed task associated with the record.
  • Type: datetime
  • Properties: Filter, Nillable, Sort
  • Description: Last date the contract was approved.
  • Type: datetime
  • Properties: Filter, Nillable, Sort, Update
  • Type: currency
  • Properties: Filter, Sort
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Introduced: API version 54.0
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The name of the Contract.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Type: boolean

  • Properties: Defaulted on create, Filter, Group, Sort, Update

  • Introduced: API version 10.0

  • Default value: false

  • Type: date
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Type: int
  • Properties: Create, Filter, Group, Sort, Update
  • 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.

  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Introduced: API version 54.0

  • Relationship name: ParentContract

  • Relationship type: relationship

  • Refers to: Contract

  • Type: picklist
  • Properties: Create, Filter, Group, Restricted picklist, Sort, Update
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update

  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Introduced: API version 54.0

  • Relationship name: PreviousContract

  • Relationship type: relationship

  • Refers to: Contract

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 2.0
  • Description: ID of the pricebook, if any, associated with this contract.
  • Relationship name: Pricebook2
  • Relationship type: relationship
  • Refers to: Pricebook2
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Introduced: API version 60.0
  • Description: Source of the pricing for the contract.
  • Possible values:
    • LastTransaction — LastTransaction
    • PriceBookListPrice — PriceBookListPrice — Price Book or List Price

  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Introduced: API version 68.0

  • Relationship name: Program

  • Relationship type: relationship

  • Refers to: Program

  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Introduced: API version 68.0
  • Type: int
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Type: date
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 54.0
  • Type: int
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 54.0
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Introduced: API version 54.0
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Introduced: API version 54.0
  • Type: int
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Type: double
  • Properties: Create, Filter, Nillable, Sort, Update
  • Introduced: API version 58.0
  • Description: The default subscription term for renewals. For example, if the Renewal Term Unit is months and you want a 6-month term, set the Renewal Term to 6.
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Introduced: API version 58.0
  • Description: The unit of time for a subscription term.
  • Possible values:
    • Annual — Annual — UI label is Years
    • Months — Months
    • Quarterly — Quarterly — Available in API version 61.0 and later.
    • Semi-Annual — Semi-Annual — Available in API version 61.0 and later.

  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Relationship name: Salesrep1

  • Relationship type: relationship

  • Refers to: User

  • Type: percent
  • Properties: Create, Filter, Nillable, Sort, Update

  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Relationship name: Salesrep2

  • Relationship type: relationship

  • Refers to: User

  • Type: percent
  • Properties: Create, Filter, Nillable, Sort, Update

  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Relationship name: Salesrep3

  • Relationship type: relationship

  • Refers to: User

  • Type: percent
  • Properties: Create, Filter, Nillable, Sort, Update
  • Type: address
  • Properties: Filter, Nillable
  • Description: The compound form of the shipping address. Read-only. See Address Compound Fields for details on compound address fields.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Details of the shipping address. City maximum size is 40 characters.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Details of the shipping address. Country maximum size is 80 characters.
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The ISO country code for the contract’s shipping address.
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Introduced: API version 60.0
  • Description: The accuracy of the geocode for the shipping address.
  • Possible values:
    • Address — Address
    • Block — Block
    • City — City
    • County — County
    • ExtendedZip — ExtendedZip
    • NearAddress — NearAddress
    • Neighborhood — Neighborhood
    • State — State
    • Street — Street
    • Unknown — Unknown
    • Zip — Zip
  • Type: double
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: Used with ShippingLongitude to specify the precise geolocation of a shipping address. Acceptable values are numbers between –90 and 90 with up to 15 decimal places.
  • Type: double
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: Used with ShippingLatitude to specify the precise geolocation of an address. Acceptable values are numbers between –180 and 180 with up to 15 decimal places.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Details of the shipping address. The postal code maximum size is 20 characters.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Details of the shipping address. The maximum size for the state is 80 characters.
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The ISO state code for the contract’s shipping address.
  • Type: textarea
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The street address of the shipping address. The maximum size is 255 characters.

  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Introduced: API version 54.0

  • Relationship name: SourceOpportunity

  • Relationship type: relationship

  • Refers to: Opportunity

  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Introduced: API version 54.0

  • Relationship name: SourceOrder

  • Relationship type: relationship

  • Refers to: Order

  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Introduced: API version 54.0

  • Description:

    ID of the source quote associated with this contract. This field is available with Revenue Cloud in API version 64.0 and later.

    This field is a relationship field.

  • Relationship name: SourceQuote

  • Relationship type: relationship

  • Refers to: Quote

  • Type: textarea
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: Special terms that apply to the contract.
  • Type: date
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Start date for this contract. The label is Contract Start Date.
  • Type: picklist
  • Properties: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update
  • Introduced: API version 60.0
  • 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.
  • Possible values:
    • Activated — Activated
    • Draft — Draft
    • In Approval Process — In Approval Process
  • Type: picklist
  • Properties: Filter, Group, Restricted picklist, Sort
  • Introduced: API version 60.0
  • Description: The status category for the contract. A contract can be Draft, InApproval, or Activated. Label is Status Category.
  • Possible values:
    • Activated — Activated
    • Draft — Draft
    • InApproval — InApproval
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Type: datetime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Introduced: API version 54.0
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 54.0
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 54.0
  • Type: currency
  • Properties: Filter, Sort
  • Type: currency
  • Properties: Filter, Sort
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Type: currency
  • Properties: Filter, Sort
  • Type: percent
  • Properties: Create, Filter, Nillable, Sort, Update
  • Introduced: API version 64.0
  • Description: Indicates the percentage increase of a line item’s unit price. This field is available with Revenue Cloud in API version 64.0 and later.

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.

After a Contract has been activated, your client application can’t change its status; however, before 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.

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version.