PriceBooks
Create, update, delete, and query information regarding price books. Not available in free and standard ZohoCRM accounts.
Table-Specific Information
Select
This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.
Insert
INSERT INTO PriceBooks (PriceBookName, Active) VALUES ('pricebook_2018', true)
Required fields: PriceBookName.
Any field which is not read-only (ReadOnly = false in the table below) can be inserted.
Delete
You must specify the Id in the WHERE clause when executing a delete against this table.
DELETE FROM PriceBooks WHERE Id = '3152079000000153079'
Update
You must specify the Id in the WHERE clause when executing an update against this table.
UPDATE PriceBooks SET Description = 'Changed from the API.' WHERE Id = '3152079000000488023'
Required fields: Id.
Any field which is not read-only (ReadOnly = false in the table below) can be updated.
Columns
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
The unique identifier for this record. |
| PriceBookOwner_Id | String | False |
The Id of the owner of the price book. |
| PriceBookOwner_FirstName | String | False |
The First Name of the owner of the price book. |
| PriceBookOwner_LastName | String | False |
The Last Name of the owner of the price book. |
| PriceBookName | String | False |
The name of the price book. |
| Active | Bool | False |
Whether this price book is active or not. |
| CreatedBy_Id | String | False |
The Id of the User who created the record. |
| PricingModel | String | False |
The pricing model of the price book. (Flat or Differential). |
| ModifiedBy_Id | String | False |
The Id of the User who modified the record. |
| ModifiedBy_FirstName | String | False |
The First Name of the User who modified the record. |
| ModifiedBy_LastName | String | False |
The Last Name of the User who modified the record. |
| CreatedTime | Datetime | False |
The time when the record was created. |
| ModifiedTime | Datetime | False |
The time when the record was modified. |
| Tag | String | False |
A list of tags related to this price book. |
| Description | String | False |
The description of the price book. |
| PricingDetails | String | False |
A json aggregate with pricing details. |
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 |
| Word | String |
Used to search for a specific word in records. |
| DuplicateCheckFields | String |
The field/s to be used for checking in an upsert. |
| Converted | Boolean |
Set to true to return only converted records. |
| Approved | Boolean |
Set to true to return only approved records. |
| CustomViewId | String |
The custom view Id to be used for filtering this record. |