Vendors

Stores vendor contact information, used in purchase orders and inventory workflows.

Table-Specific Information

The Vendors 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 vendor with a name, email address, and website
INSERT INTO Vendors (VendorName, Email, Website) VALUES ('XYZVendor', '[email protected]', 'vendeverything.xyz')

Required fields: VendorName is required. This identifies the vendor record being created.

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 vendor by its unique ID
DELETE FROM Vendors 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 vendor using its ID
UPDATE Vendors SET Description = 'Changed from the API' WHERE Id = '3152079000000492032'

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	A unique identifier (Id) for the vendor.
VendorName	String	False	The name of the vendor.
Phone	String	False	The vendor's phone number.
Email	String	False	The vendor's email address.
Website	String	False	The vendor's website URL.
GLAccount	String	False	The general ledger account associated with the vendor.
Category	String	False	The category to which the vendor belongs.
VendorOwner_Id	String	False	The Id of the user who owns the vendor record.
VendorOwner_FirstName	String	True	The first name of the user who owns the vendor record.
VendorOwner_LastName	String	True	The last name of the user who owns the vendor record.
VendorOwner_Email	String	True	The email address of the user who owns the vendor record.
VendorOwner_Name	String	True	The full name of the user who owns the vendor record.
CreatedBy_Id	String	False	The Id of the user who created the vendor record.
CreatedBy_FirstName	String	True	The first name of the user who created the vendor record.
CreatedBy_LastName	String	True	The last name of the user who created the vendor record.
CreatedBy_Email	String	True	The email address of the user who created the vendor record.
CreatedBy_Name	String	True	The full name of the user who created the vendor record.
ModifiedBy_Id	String	False	The Id of the user who last modified the vendor record.
ModifiedBy_FirstName	String	True	The first name of the user who last modified the vendor record.
ModifiedBy_LastName	String	True	The last name of the user who last modified the vendor record.
ModifiedBy_Email	String	True	The email address of the user who last modified the vendor record.
ModifiedBy_Name	String	True	The full name of the user who last modified the vendor record.
CreatedTime	Datetime	False	The date and time when the vendor record was created.
ModifiedTime	Datetime	False	The date and time when the vendor record was last modified.
Tag	String	False	A tag or label associated with the vendor.
Street	String	False	The street address of the vendor.
City	String	False	The city where the vendor is located.
State	String	False	The state where the vendor is located.
ZipCode	String	False	The postal code where the vendor is located.
Country	String	False	The country where the vendor is located.
Description	String	False	A description or notes related to the vendor.
VendorImage	String	False	The image or logo of the vendor.
Locked	Bool	True	Indicates whether the vendor record is locked from editing.
EmailOptOut	Bool	False	Indicates whether the vendor has opted out of email communications.
UnsubscribedMode	String	True	The method by which the vendor unsubscribed.
UnsubscribedTime	Datetime	True	The date and time when the vendor unsubscribed.
LastActivityTime	Datetime	False	The date and time of the last activity related to the vendor.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。


Name	Type	Description
DuplicateCheckFields	String	The field or fields used to identify duplicate records during an upsert operation. The REST API supports multiple fields; the BULK API supports only one.
Trigger	String	Used to trigger automation rules when a record is inserted into the CRM.
CustomViewId	Long	The custom view Id used to filter this vendor record. Works only when the useCOQL parameter is set to false.

CData Python Connector for Zoho CRM