QuoteLineItem

Supported Calls

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

Special Access Rules

The user must have “Edit” permissions on Quote records in order to create or update quote line items on a quote. The user must have “Edit” permissions on Quote records to delete a quote line item.

Fields

Field	Details
CurrencyIsoCode	Type picklist Properties Filter, Restricted picklist Description Available only for organizations enabled for multiples currencies. Contains the ISO code for any currency allowed by the organization. If the organization has multicurrency and a Pricebook2 is specified on the quote (the Pricebook2Id field is not blank), then the currency value of this field must match the currency of the PricebookEntry objects for any associated quote line items. This value is copied from the related Quote and can't be changed.
Description	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Text description of the line item. Limit: 225 characters.
Discount	Type percent Properties Create, Filter, Nillable, Sort Description Editable number from 0 to 100.
HasQuantitySchedule	Type boolean Properties Defaulted on create, Filter, Group, Sort Description Read-only. Indicates whether the opportunity line item that the quote line item is synced with has a quantity schedule.
HasRevenueSchedule	Type boolean Properties Defaulted on create, Filter, Group, Sort Description Read-only. Indicates whether the opportunity line item that the quote line item is synced with has a revenue schedule. If this object has a revenue schedule, the GrandTotal and TotalPrice fields can't be updated. In addition, the Quantity field can't be updated if this object has a quantity schedule. The system ignores any attempt to update this field. The update isn't rejected but the updated value is ignored.
HasSchedule	Type boolean Properties Defaulted on create, Filter, Group, Sort Description Read-only. Indicates whether the line item uses schedules.
LineNumber	Type string Properties Autonumber, Defaulted on create, Filter, Sort Description Read-only. Automatically generated number identifying the quote line item. In the form of `QL-XXXXX`.
ListPrice	Type currency Properties Filter, Nillable, Sort Description Read-only. Corresponds to the UnitPrice on the PricebookEntry that is associated with this line item, which can be in the standard price book or a custom price book. A client application can use this information to show whether the unit price (or sales price) of the line item differs from the price book entry list price.
OpportunityLineItemId	Type reference Properties Create, Filter, Group, Nillable, Sort Description ID of the related opportunity line item. This field is populated by the API during creation of the quote line item. Not editable. Available in API version 40.0 and later.
PricebookEntryId	Type reference Properties Create, Filter, Group, Sort Description Required. ID of the associated PricebookEntry. Exists only for orgs with Products enabled. In API 38.0 and earlier, if Product2Id is populated with PricebookEntryId data, you receive an error message. In API 39.0 and later, Product2Id is made null, and PricebookEntryId is populated with the PricebookEntryId data.
Product2Id	Type reference Properties Create, Filter, Group, Sort Description Required. ID of the Product2 associated with this QuoteLineItem. In API 38.0 and earlier, if Product2Id is populated with PricebookEntryId data, you receive an error message. In API 39.0 and later, Product2Id is made null, and PricebookEntryId is populated with the PricebookEntryId data.
Quantity	Type double Properties Create, Filter, Sort, Update Description The number of units for the line item.
QuoteId	Type reference Properties Create, Filter, Group, Sort Description Required. ID of the associated Quote.
ServiceDate	Type date Properties Create, Filter, Group, Nillable, Sort, Update Description Date when the product revenue will be recognized and the product quantity will be shipped.
SortOrder	Type int Properties Filter, Group, Nillable, Sort Description The value of where the line item is in the sorted order, such as 1, 2, and so on. The SortOrder value determines the order in which a quote line item displays in the Quote Detail page. Client applications can use this to match the sort order in Salesforce. This field is only available in API versions 21.0 and greater.
Subtotal	Type currency Properties Filter, Nillable, Sort Description The line item's Quantity multiplied by the UnitPrice.
TotalPrice	Type currency Properties Filter, Nillable, Sort Description Read-only. Calculated by applying the Discount to the Subtotal. This field is nillable, but you can't set both TotalPrice and UnitPrice to null in the same update. To insert the TotalPrice for a quote line item via the API (given only a unit price and the quantity), calculate this field as the unit price multiplied by the quantity. This field is read-only if the quote line item has a revenue schedule.
UnitPrice	Type currency Properties Create, Filter, Sort, Update Description The price per unit for the quote line item.

Usage

A Quote record can have QuoteLineItem records only if the Quote has a Pricebook2. A QuoteLineItem must correspond to a Product2 that is listed in the quote's Pricebook2.

If the multicurrency option has been enabled, the CurrencyIsoCode field is present. It can't be modified, it is always set to the value of the CurrencyIsoCode of the parent Quote.

Note

Effects on Quotes

Quotes that have associated QuoteLineItem objects are affected in the following ways:

Creating a QuoteLineItem increments the Quote value by the TotalPrice of the QuoteLineItem.
When you create or update a QuoteLineItem, the API verifies that the line item corresponds to a PricebookEntry in the Pricebook2 that is associated with the quote.

Object Reference for Salesforce and Lightning Platform

Supported Calls

Special Access Rules

Fields

Usage

Effects on Quotes

See Also