QuoteLineItem

The QuoteLineItem object represents a quote line item, which is a member of the list of Product2 products associated with a Quote, along with other information about those line items on that quote.

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
Filter, Group, Nillable, Sort
Description
Text description of the line item. Limit: 225 characters.
Discount
Type
percent
Properties
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.
PricebookEntryId
Type
reference
Properties
Create, Filter, Group, Sort
Description
Required. ID of the associated PricebookEntry. Exists only for those organizations that have Products enabled as a feature.
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
Filter, Group, Nillable, Sort
Description
Date when the product revenue will be recognized and the product quantity will be shipped.
Subtotal
Type
currency
Properties
Filter, Nillable
Description
The line item's Quantity multiplied by the UnitPrice.
TotalPrice
Type
currency
Properties
Filter, Nillable
Description
Read-only. Calculated by applying the Discount to the Subtotal. If you don't specify a UnitPrice, this field is required. 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. If it doesn't have a revenue schedule or only has a quantity schedule, this field can be updated.
UnitPrice
Type
currency
Properties
Create, Filter, 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.

Note
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.

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.
© Copyright 2000–2012 salesforce.com, inc. All rights reserved.
Various trademarks held by their respective owners.