ContractLineItem

Represents a product covered by a service contract (customer support agreement).

Introduced in API version 18.0.

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

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Required. ID of the Asset associated with the contract line item. Must be a valid asset ID.
  • Relationship name: Asset
  • Relationship type: relationship
  • Refers to: Asset
  • Type: textarea
  • Properties: Create, Nillable, Update
  • Description: Description of the contract line item.

  • Type: percent

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

  • Description:

    The discount for the product as a percentage.

    When updating, if you specify Discount without specifying TotalPrice, the TotalPrice will be adjusted to accommodate the new Discount value, and the UnitPrice will be held constant.

    If you specify both Discount and Quantity, you must also specify either TotalPrice or UnitPrice so the system can determine which one to automatically adjust.

  • Type: date
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The last day the contract line item is in effect.
  • Type: string
  • Properties: Autonumber, Defaulted on create, Filter, idLookup, Sort
  • Description: Automatically-generated number that identifies the contract line item.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Description: Corresponds to the UnitPrice on the PricebookEntry that is associated with this line item, which can be in the standard pricebook or a custom pricebook. A client application can use this information to show whether the unit price (or sales price) of the line item differs from the pricebook entry list price.

  • Type: reference

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

  • Introduced: API version 51.0

  • Description:

    The location associated with the contract line item.

    If you have access to the location entity, it doesn’t necessarily mean you can access the location id field. To access the location, you must have userHasLocation user access.

  • Relationship name: Location

  • Relationship type: relationship

  • Refers to: Location

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 37.0
  • Description: The line item’s parent line item, if it has one.
  • Relationship name: ParentContractLineItem
  • Relationship type: relationship
  • Refers to: ContractLineItem

  • Type: reference

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

  • Description:

    Required. ID of the associated PricebookEntry.

    Only exists if Product2 is enabled.

  • Relationship name: PricebookEntry

  • Relationship type: relationship

  • Refers to: PricebookEntry

  • Type: reference
  • Properties: Filter, Group, Nillable, Sort
  • Introduced: API version 41.0
  • Description: The product related to the contract line item.
  • Relationship name: Product2
  • Relationship type: relationship
  • Refers to: Product2
  • Type: double
  • Properties: Create, Filter, Sort, Update
  • Description: Number of units of the contract line item (product) included in the associated service contract.
  • Type: reference
  • Properties: Filter, Group, Nillable, Sort
  • Introduced: API version 37.0
  • Description: (Read only) The top-level line item in a contract line item hierarchy. Depending on where a line item lies in the hierarchy, its root could be the same as its parent.
  • Relationship name: RootContractLineItem
  • Relationship type: relationship
  • Refers to: ContractLineItem
  • Type: reference
  • Properties: Create, Filter, Group, Sort
  • Description: Required. ID of the ServiceContract associated with the contract line item. Must be a valid service contract ID.
  • Relationship name: ServiceContract
  • Relationship type: masterdetail
  • Refers to: ServiceContract
  • Type: date
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The first day the contract line item is in effect.
  • Type: picklist
  • Properties: Filter, Group, Nillable, Restricted picklist, Sort
  • Description: Status of the contract line item.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Description: Contract line item’s sales price multiplied by the Quantity.

  • Type: currency

  • Properties: Filter, Nillable, Sort

  • Description:

    This field is available only for backward compatibility. It represents the total price of the ContractLineItem

    If you specify Discount and Quantity, this field or UnitPrice is required.

    This field is nillable, but you can’t set both TotalPrice and UnitPrice to null in the same update request. To insert the TotalPrice for a contract line item via the API (given only a unit price and the quantity), calculate this field as the unit price multiplied by the quantity.

  • Type: currency

  • Properties: Create, Filter, Sort, Update

  • Description:

    The unit price for the contract line item. In the user interface, this field’s value is calculated by dividing the total price of the contract line item by the quantity listed for that line item. Label is Sales Price.

    This field or TotalPrice is required. You can’t specify both.

    If you specify Discount and Quantity, this field or TotalPrice is required.

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.