PricebookEntry

Supported Calls

create(), update(), delete(), query(), retrieve(), getDeleted(), getUpdated(), describeSObjects()

Fields

Field	Field Type	Field Properties	Description
CurrencyIsoCode	picklist	Filter Restricted picklist	Available only for organizations with the multicurrency feature enabled. Contains the ISO code for any currency allowed by the organization.
IsActive	boolean	Create Defaulted on create Filter Update	Indicates whether this object is active (true) or not (false). Although you can never delete()PricebookEntry objects, your client application can set this flag to false. Inactive PricebookEntry objects are hidden in many areas in the Salesforce.com user interface. You can change this flag on a PricebookEntry object as often as necessary.
IsDeleted	boolean	Defaulted on create Filter	Indicates whether the record has been moved to the Recycle Bin (true) or not (false). Label is Deleted.
Name	string	Filter Nillable	Name of this PricebookEntry object. This read-only field references the value in the Name field of the Product2 object. Label is Product Name.
Pricebook2Id	reference	Create Filter	Required. ID of the Pricebook2 object with which this object is associated. Required field. This field must be specified in the create() call. It cannot be changed in an update() call. For information on IDs, see ID Field Type.
Product2Id	reference	Create Filter	ID of the Product2 object with which this object is associated. Required field. This field must be specified in the create() call. It cannot be changed in an update() call. For information on IDs, see ID Field Type.
ProductCode	string	Filter Nillable	Product code for this object. This read-only field references the value in the ProductCode field of the associated Product2 object.
UnitPrice	currency	Create Filter Update	Required. Unit price for this object. You can specify a value only if UseStandardPrice is set to false. Label is List Price.
UseStandardPrice	boolean	Create Defaulted on create Filter Update	Indicates whether this object uses the standard price defined in the standard Pricebook2 object (true) or not (false). If set to true, then the UnitPrice field is read-only, and the value will be the same as the UnitPricevalue in the corresponding PricebookEntry in the standard price book (that is, the PricebookEntry object whose Pricebook2Id refers to the standard price book and whose Product2Id and CurrencyIsoCode are the same as this object). For PricebookEntry objects associated with the standard Pricebook2 object, this field must be set to true.

Usage

Use this object to define the association between your organization’s products (Product2) and your organization’s standard price book or to other, custom-defined price books ( Pricebook2). Create one PricebookEntry record for each standard or custom price and currency combination for a product in a Pricebook2.

When your client application calls create(), it must specify the IDs of the associated Pricebook2 object and Product2 object. Once created, your client application cannot update these IDs.

This object is defined only for those organizations that have products enabled as a feature. If the organization does not have the products feature enabled, then the PricebookEntry object does not appear in the describeGlobal() call, and you cannot access it.

If you delete a PricebookEntry while a line item references it, the line item is unaffected, but the PricebookEntry will be archived and unavailable from the API.

You must load the standard price for a product before you are permitted to load its custom price(s).

For a visual diagram of the relationships between PricebookEntry and other objects, see Product and Schedule Objects and PriceBook2, Product2, and PricebookEntry Relationships.