PricebookEntry

---

Represents a product entry (an association between a Pricebook2 and Product2) in a pricebook.

Supported API Calls

create, update, delete, query, getDeleted, getUpdated, retrieve, describeSObject

Fields

For a complete list of fields in this object, see the Enterprise WSDL file for your organization and the salesforce.com online help.

PricebookEntry Fields 

Field	Data Type	Description
CurrencyIsoCode	string	Available only for organizations with the multi-currency feature enabled. Contains the ISO code for any currency allowed by the organization.
IsActive	boolean	Indicates whether this PricebookEntry object is active (True) or not (False). Although you can never delete PricebookEntry objects, your client application can set the object's IsActive flag to False. Inactive PricebookEntry objects are hidden in many areas in the salesforce.com user interface. You can change the IsActive flag on a PricebookEntry object as often as necessary.
Name	string	Name of this PricebookEntry object. This read-only field references the value in the Name field of the Product2 object.
Pricebook2Id	ID	ID of the Pricebook2 object with which this PricebookEntry is associated. Required field. This field must be specified in the create call. It cannot be changed in an update call.
Product2Id	ID	ID of the Product2 object with which this PricebookEntry is associated. Required field. This field must be specified in the create call. It cannot be changed in an update call.
ProductCode	string	Product code for this PricebookEntry object. This read-only field references the value in the ProductCode field of the associated Product2 object.
UnitPrice	double	Unit price for this PricebookEntry object. You can specify a UnitPrice only if UseStandardPrice is set to False.
UseStandardPrice	boolean	Indicates whether this PricebookEntry object uses the standard price defined in the standard Pricebook2 object (True) or not (False). If set to True, then this field is read-only and it references the UnitPrice value in the associated Product2 object. For PricebookEntry objects associated with the standard Pricebook2 object, UseStandardPrice must be set to True.

Usage

Use the PricebookEntry object to define the association between your organization's products (Product2 object) and your organization's standard price book or to other, custom-defined price books (Pricebook2 objects). Using PricebookEntry objects allows you to configure the standard price for a product in this price book or to override it with a custom value and, for multi-currency organizations, to specify different currencies as well.

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.

The PricebookEntry 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 via the sforce API.

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

See Also

Concepts