Pricebookentry

IsActive

• Type: boolean
• Properties: Create, Defaulted on create, Filter, Group, Sort, Update
• Description: Indicates whether this price book entry is active.

IsArchived

• Type: boolean
• Properties: Defaulted on create, Filter, Group, Sort
• Description: Indicates whether the price book entry has been archived (true) or not (false). This is set to true when the product record it’s associated with is archived, or when the price book record is archived. This field is read only. Available in API version 45.0 and later. Label is Archived.

Name

• Type: string
• Properties: Filter, Group, Nillable, Sort
• Description: Name of this price book entry record. This read-only field references the value in the Name field of the product record. Label is Product Name.

Pricebook2Id

• Type: reference
• Properties: Create, Filter, Group, Sort
• Description: Required. ID of the price book record with which this record is associated. This field must be specified when creating price book records. It can’t be changed in an update.

Product2Id

• Type: reference
• Properties: Create, Filter, Group, Sort
• Description: Required. ID of the product record with which this record is associated. This field must be specified when creating product records. It can’t be changed in an update.

ProductCode

• Type: string
• Properties: Filter, Group, Nillable, Sort
• Description: Product code for this record. This read-only field references the value in the ProductCode field of the associated product record.

UnitPrice

• Type: currency
• Properties: Create, Filter, Sort, Update
• Description: Required. Unit price for this price book entry. You can specify a value only if UseStandardPrice is set to false. Label is List Price.

UseStandardPrice

• Type: boolean
• Properties: Create, Defaulted on create, Filter, Group, Sort, Update
• Description: Indicates whether this price book entry uses the standard price defined in the standard price book record.

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

When creating these records, you must specify the IDs of the associated price book record and product record. Once created, your client application can’t update these IDs.

This object is defined only for those organizations that have products enabled as a feature.

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. Deleted PriceBookEntry records can’t be recovered.

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

This object has the following associated objects. Unless noted, they are available in the same API version as this object.

PricebookEntryHistory

History is available for tracked fields of the object.