Supported Calls
create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()
Fields
Description
- Type: string
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Description: Text description of the price book.
IsActive
- Type: boolean
- Properties: Create, Defaulted on create, Filter, Group, Sort, Update
- Description: Indicates whether the price book is active (true) or not (false). Inactive price books are hidden in many areas in the user interface. You can change this field’s value as often as necessary. Label is Active.
IsArchived
- Type: boolean
- Properties: Defaulted on create, Filter, Group, Sort
- Description: Indicates whether the price book has been archived (true) or not (false). This field is read only.
IsDeleted
- Type: boolean
- Properties: Defaulted on create, Filter
- Description: Indicates whether the price book has been moved to the Recycle Bin (true) or not (false). Label is Deleted.
IsStandard
- Type: boolean
- Properties: Defaulted on create, Filter, Group, Sort
- Description: Indicates whether the price book is the standard price book for the org (true) or not (false). Every org has one standard price book—all other price books are custom price books.
Name
- Type: string
- Properties: Create, Filter, Group, Sort, Update
- Description: Required. Name of this object. This field is read-only for the standard price book. Label is Price Book Name.
Associated Objects
This object has the following associated objects. Unless noted, they are available in the same API version as this object.
- Pricebook2History
- History is available for tracked fields of the object.