Maintains price book records with custom price tiers for products; not accessible in free or standard editions.

Table-Specific Information

The PriceBooks table is only accessible when connected to a ZohoCRM Enterprise Edition account. If using a different edition, this table may not be available.

Select

This table supports the COQL and BULK APIs for filtering, meaning that most filters comparing columns to values are submitted server-side.

Insert

The following example demonstrates a basic insert operation:

-- Insert a new price book with a name and set it to active
INSERT INTO PriceBooks (PriceBookName, Active) VALUES ('pricebook_2018', true)

Required fields: PriceBookName is required. This is the name of the price book and must be provided to create a new record.

Any field which is not read-only (ReadOnly = false in the table schema) can be inserted.

Delete

You must specify the Id column in the WHERE clause to delete a record. The following example demonstrates a delete operation:

-- Delete a price book by its unique ID
DELETE FROM PriceBooks WHERE Id = '3152079000000153079'

Update

You must specify the Id column in the WHERE clause to update a record. The following example demonstrates an update operation:

-- Update the description for a specific price book using its ID
UPDATE PriceBooks SET Description = 'Changed from the API.' WHERE Id = '3152079000000488023'

Required fields: Id is required. The update must target a specific record.

Any field which is not read-only (ReadOnly = false in the table schema) can be updated.

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	True	Unique identifier for the price book record.
Owner_Id	String	False	Unique identifier of the user who owns the price book.
Owner_FirstName	String	True	First name of the user who owns the price book.
Owner_LastName	String	True	Last name of the user who owns the price book.
Owner_Email	String	True	Email address of the user who owns the price book.
Created_By_Id	String	False	Unique identifier of the user who created the price book.
Modified_By_Id	String	False	Unique identifier of the user who last modified the price book.
Modified_By_FirstName	String	True	First name of the user who last modified the price book.
Modified_By_LastName	String	True	Last name of the user who last modified the price book.
Modified_By_Email	String	True	Email address of the user who last modified the price book.
Created_Time	Datetime	False	Date and time when the price book was created.
Modified_Time	Datetime	False	Date and time when the price book was last modified.
Price_Book_Name	String	False	Name of the price book.
Active	Bool	False	Indicates whether the price book is currently active.
Pricing_Model	String	False	Details of the pricing associated with the price book.
Tag	String	False	Tag associated with the price book for categorization or filtering.
Description	String	False	Description of the price book.
Id_CustomModule	Long	True	Internal identifier of the record for internal tracking purposes.
Locked__s	Bool	True	Indicates whether the price book is locked from editing.
Last_Activity_Time	Datetime	False	Timestamp of the most recent activity related to this price book.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.

Name	Type	Description
DuplicateCheckFields	String	The field(s) to be used for checking duplicate records in an upsert. The REST API allows for more than one field in the duplicate check but the BULK API only allows one field.
Trigger	String	To trigger the rule while inserting record into CRM account.