ContractLineItem

Represents a Product2 in a ServiceContract (customer support agreement).

Supported Calls

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

Fields

Field Details
AssetId
Type
reference
Properties
Create, Filter, Nillable, Update
Description
Required. ID of the Asset associated with the contract line item. Must be a valid asset ID.
Description
Type
textarea
Properties
Create, Nillable, Update
Description
Description of the contract line item.
Discount
Type
percent
Properties
Create, Filter, Nillable, 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.
EndDate
Type
date
Properties
Create, Filter, Nillable, Update
Description
The last day the contract line item is in effect.
LastReferencedDate
Type
date
Properties
Filter, Nillable, Sort, Update
Description
The timestamp for when the current user last viewed a record related to this record.
LastViewedDate
Type
date
Properties
Filter, Nillable, Sort, Update
Description
The timestamp for when the current user last viewed this record. If this value is null, this record might only have been referenced (LastReferencedDate) and not viewed.
LineItemNumber
Type
string
Properties
Autonumber, Defaulted on create, Filter, idLookup, Update
Description
Automatically-generated number that identifies the contract line item.
ListPrice
Type
currency
Properties
Filter, Nillable
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.
PricebookEntryId
Type
reference
Properties
Create, Filter
Description
Required. ID of the associated PricebookEntry.
Only exists if Product2 is enabled.
Quantity
Type
double
Properties
Create, Filter, Update
Description
Number of units of the contract line item (product) included in the associated service contract.
ServiceContractId
Type
reference
Properties
Create, Filter
Description
Required. ID of the ServiceContract associated with the contract line item. Must be a valid asset ID.
StartDate
Type
date
Properties
Create, Filter, Nillable, Update
Description
The first day the contract line item is in effect.
Status
Type
picklist
Properties
Filter, Nillable
Description
Status of the contract line item.
Subtotal
Type
currency
Properties
Filter, Nillable
Description
Contract line item's sales price multiplied by the Quantity.
TotalPrice
Type
currency
Properties
Filter, Nillable
Description
This field is available only for backward compatibility. It represents the total price of the ContractLineItem
If you do not specify UnitPrice, this field is required. If you specify Discount and Quantity, this field or UnitPrice is required. When updating, you can change either this value or the UnitPrice, but not both at the same time.
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.
UnitPrice
Type
currency
Properties
Create, Filter, 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.

Usage

Use this object to query and manage contract line items.

© Copyright 2000–2014 salesforce.com, inc. All rights reserved.
Various trademarks held by their respective owners.