PriceBooks

Manages price book records for assigning specific product pricing tiers. Not supported in free or standard accounts.

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 COQL 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.
PriceBookOwner_Id	String	False	Identifier of the user who owns the price book.
PriceBookOwner_FirstName	String	True	First name of the price book owner.
PriceBookOwner_LastName	String	True	Last name of the price book owner.
PriceBookOwner_Email	String	True	Email address of the price book owner.
PriceBookOwner_Name	String	True	Full name of the price book owner.
CreatedBy_Id	String	False	Identifier of the user who created the price book.
CreatedBy_FirstName	String	True	First name of the user who created the price book.
CreatedBy_LastName	String	True	Last name of the user who created the price book.
CreatedBy_Email	String	True	Email address of the user who created the price book.
CreatedBy_Name	String	True	Full name of the user who created the price book.
ModifiedBy_Id	String	False	Identifier of the user who last modified the price book.
ModifiedBy_FirstName	String	True	First name of the user who last modified the price book.
ModifiedBy_LastName	String	True	Last name of the user who last modified the price book.
ModifiedBy_Email	String	True	Email address of the user who last modified the price book.
ModifiedBy_Name	String	True	Full name of the user who last modified the price book.
CreatedTime	Datetime	False	Timestamp indicating when the price book was created.
ModifiedTime	Datetime	False	Timestamp indicating when the price book was last modified.
PriceBookName	String	False	Name of the price book.
Active	Bool	False	Indicates whether the price book is active.
PricingModel	String	False	Pricing model applied to the price book, such as flat or volume-based.
Tag	String	False	Comma-separated list of tags associated with the price book.
PricingDetails	String	False	Details of the pricing structure associated with the price book.
Description	String	False	Description or additional notes about the price book.
Locked	Bool	True	Indicates whether the price book is locked from editing.
LastActivityTime	Datetime	False	Timestamp of the most recent activity related to the price book.

Pseudo-Columns

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


Name	Type	Description
DuplicateCheckFields	String	Field or fields used to identify duplicate records during an upsert. Multiple fields are supported in the REST API, but only one is allowed in the BULK API.
Trigger	String	Specifies whether to trigger automation or workflow rules when inserting the record.
CustomViewId	Long	Identifier of the custom view used to filter this record. Applies only when the useCOQL parameter is set to false.

CData Python Connector for Zoho CRM