QuoteLineItem

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. Available in API version 18.0 and later.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), 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
BillingFrequency	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The time period that indicates how often the quote line item is billed. This field is available in API version 55.0 and later. This field is available when Subscription Management is enabled. Possible values are: `Monthly`
CurrencyIsoCode	Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description Available only for organizations enabled for multiple 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 isn’t 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, Update Description Editable number from 0 to 100.
Division	Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description A logical segment of your organization's data. For example, if your company is organized into different business units, you could create a division for each business unit, such as “North America,” “Healthcare,” or “Consulting.” Available only if the organization has the Division permission enabled.
EndDate	Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description If the quote line item is sold on subscription, this field indicates the date on which the subscription ends. This field is available in API version 55.0 and later. This field is available if Subscription Management is enabled in your org. You can indicate a subscription’s length using either StartDate and EndDate, or by using StartDate and SubscriptionTerm. If you provide a value for both EndDate and SubscriptionTerm, EndDate is used to determine the subscription’s length.
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.
LastReferencedDate	Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record.
LastViewedDate	Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, the user might have only accessed this record or list view (LastReferencedDate) but not viewed it.
LineNumber	Type string Properties Autonumber, Defaulted on create, Filter, idLookup, 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.
ListPriceTotal	Type currency Properties Filter, Nillable, Sort Description The ListPrice times the Quantity. This is a calculated field.
NetTotalPrice	Type currency Properties Filter, Nillable, Sort Description The price after all adjustments, inclusive of quantity, prorated for the duration of the subscription. This is a calculated field equal to TotalAdjustmentAmount plus TotalLineAmount. This field is available in API version 56.0 and later. This field is available with Subscription Management.
NetUnitPrice	Type currency Properties Filter, Nillable, Sort Description The unit price after all price adjustments are applied.
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.
PeriodBoundary	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The period boundary helps determine the start and end date of the billing periods. This field is available in API version 55.0 and later. This field is available with Subscription Management. Possible values are: `AlignToCalendar`—the period starts on the first day of the term unit; for example, the first day of the month. `Anniversary`—The start date determines the boundary. For example, if a monthly subscription starts on September 13, the subscription starts on the 13th day of each month. `DayOfPeriod`—the period starts on the day indicated by PeriodBoundaryDay. `LastDayOfPeriod`—the period starts on the last day of the pricing term unit.
PeriodBoundaryDay	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Required when PeriodBoundary is `DayOfPeriod`. Indicates day of the week or month that marks the period boundary. Must be an integer from 1 through 31. This field is available in API version 55.0 and later. This field is available with Subscription Management.
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.
PricingTerm	Type int Properties Filter, Group, Nillable, Sort Description The number of terms in the subscription. For example, if a monthly subscription is priced yearly, this field is 12. This field is available in API version 55.0 and later. This field is available with Subscription Management.
PricingTermCount	Type double Properties Filter, Nillable, Sort Description A calculated field indicating the number of pricing terms in the subscription. This field is available in API version 55.0 and later. This field is available with Subscription Management.
PricingTermUnit	Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The unit of time for the pricing term. This field is available in API version 55.0 and later. This field is available with Subscription Management. Possible values are: `Months`
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.
ProductSellingModelId	Type reference Properties Filter, Group, Nillable, Sort Description The ID of the related product selling model. This field is available in API version 55.0 and later. This field is available with Subscription Management. This is a relationship field. Relationship Name ProductSellingModel Relationship Type Lookup Refers To ProductSellingModel
ProrationPolicyId	Type reference Properties Filter, Group, Nillable, Sort Description The ID of the related proration policy. This field is available in API version 55.0 and later. This field is available with Subscription Management. This is a relationship field. Relationship Name ProrationPolicy Relationship Type Lookup Refers To ProrationPolicy
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.
SellingModelType	Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description Indicates whether the quote line item is sold as one-time purchase, an evergreen subscription, or as a termed subscription. This field is available in API version 55.0 and later. This field is available with Subscription Management. Possible values are: `Evergreen` `OneTime` `TermDefined` The default value is `OneTime`.
ServiceDate	Type date Properties Create, Filter, Group, Nillable, Sort, Update Description Date when the product revenue is recognized and the product quantity will be shipped.
SortOrder	Type int Properties Create, Filter, Group, Nillable, Sort, Update 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 Line Items related list and the Quote PDF. Client applications can use this to match the sort order in Salesforce. This field is only available in API versions 21.0 and greater.
StartDate	Type date Properties Create, Filter, Group, Nillable, Sort, Update Description If the quote line item is sold on subscription, this field indicates the date on which the subscription starts. This field is available in API version 55.0 and later. This field is available with Subscription Management.
StartingPriceTotal	Type currency Properties Filter, Nillable, Sort Description The starting unit price times the quantity.
StartingUnitPriceSource	Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Indicates whether the starting unit price was entered manually or calculated. This field is available in API version 55.0 and later. This field is available with Subscription Management. Possible values are: `Manual` `System` `Inherited`
SubscriptionTerm	Type int Properties Filter, Group, Nillable, Restricted picklist, Sort Description The number of terms in the subscription. You can indicate a subscription’s length using either StartDate and EndDate, or by using StartDate and SubscriptionTerm. If you provide a value for both EndDate and SubscriptionTerm, EndDate is used and SubscriptionTerm is ignored.
SubscriptionTermUnit	Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The unit of time used to define the subscription. This field is available in API version 55.0 and later. This field is available with Subscription Management. Possible values are: `Months`
Subtotal	Type currency Properties Filter, Nillable, Sort Description The line item's Quantity multiplied by the UnitPrice.
TotalAdjustmentAmount	Type currency Properties Filter, Nillable, Sort Description The sum of the adjustments applied to the quote line item, inclusive of quantity, prorated for the duration of the subscription. This field is available in API version 56.0 and later. This field is available with Subscription Management.
TotalLineAmount	Type currency Properties Filter, Nillable, Sort Description The total price of the quote line item, before price adjustments, inclusive of quantity, prorated for the duration of the subscription. This is a calculated field equal to TotalPrice times Quantity times PricingTermCount. This field is available in API version 56.0 and later. This field is available with Subscription Management.
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.
TotalPriceWithTax	Type currency Properties Filter, Nillable, Sort Description The sum of TotalPrice and TotalTaxAmount. This field is available in API version 55.0 and later. This field is available with Subscription Management.
TotalTaxAmount	Type currency Properties Filter, Nillable, Sort Description the total amount of tax for the quote line item. his field is available in API version 55.0 and later. This field is available with Subscription Management. This is a calculated field.
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’s 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.

Associated Objects

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 and later.

QuoteLineItemChangeEvent (API version 44.0): Change events are available for the object.
QuoteLineItemHistory (API version 57.0): History is available for tracked fields of the object.

Object Reference for the Salesforce Platform