Class PriceBook

Represents a price book.

PropertyDescription
ID: String (read-only)Returns the ID of the price book.
currencyCode: String (read-only)Returns the currency code of the price book.
description: String (read-only)Returns the description of the price book.
displayName: String (read-only)Returns the display name of the price book.
online: Boolean (read-only)Returns the online status of the price book.
onlineFlag: Boolean (read-only)Returns the online status flag of the price book.
onlineFrom: Date (read-only)Returns the date from which the price book is online or valid.
onlineTo: Date (read-only)Returns the date until which the price book is online or valid.
parentPriceBook: PriceBook (read-only)Returns the parent price book.

This class does not have a constructor, so you cannot create it directly.

MethodDescription
getCurrencyCode()Returns the currency code of the price book.
getDescription()Returns the description of the price book.
getDisplayName()Returns the display name of the price book.
getID()Returns the ID of the price book.
getOnlineFlag()Returns the online status flag of the price book.
getOnlineFrom()Returns the date from which the price book is online or valid.
getOnlineTo()Returns the date until which the price book is online or valid.
getParentPriceBook()Returns the parent price book.
isOnline()Returns the online status of the price book.

describe, getCustom

getCreationDate, getLastModified, getUUID

assign, create, create, defineProperties, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toLocaleString, toString, valueOf, values

ID: String (read-only)

Returns the ID of the price book.


currencyCode: String (read-only)

Returns the currency code of the price book.


description: String (read-only)

Returns the description of the price book.


displayName: String (read-only)

Returns the display name of the price book.


online: Boolean (read-only)

Returns the online status of the price book. The online status is calculated from the online status flag and the onlineFrom onlineTo dates defined for the price book.


onlineFlag: Boolean (read-only)

Returns the online status flag of the price book.


onlineFrom: Date (read-only)

Returns the date from which the price book is online or valid.


onlineTo: Date (read-only)

Returns the date until which the price book is online or valid.


parentPriceBook: PriceBook (read-only)

Returns the parent price book.


getCurrencyCode(): String

Returns the currency code of the price book.

Returns:

  • Currency code of the price book

getDescription(): String

Returns the description of the price book.

Returns:

  • Currency code of the price book

getDisplayName(): String

Returns the display name of the price book.

Returns:

  • Display name of the price book

getID(): String

Returns the ID of the price book.

Returns:

  • ID of the price book

getOnlineFlag(): Boolean

Returns the online status flag of the price book.

Returns:

  • the online status flag of the price book.

getOnlineFrom(): Date

Returns the date from which the price book is online or valid.

Returns:

  • the date from which the price book is online or valid.

getOnlineTo(): Date

Returns the date until which the price book is online or valid.

Returns:

  • the date until which the price book is online or valid.

getParentPriceBook(): PriceBook

Returns the parent price book.

Returns:

  • Parent price book

isOnline(): Boolean

Returns the online status of the price book. The online status is calculated from the online status flag and the onlineFrom onlineTo dates defined for the price book.

Returns:

  • The online status of the price book.