Vendors

Stores vendor records used in purchase-related transactions such as purchase orders or stock replenishment.

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	Unique identifier for the vendor record.
VendorName	String	False	Name of the vendor.
Phone	String	False	Phone number of the vendor.
Email	String	False	Email address of the vendor.
Website	String	False	Website URL of the vendor.
GLAccount	String	False	General ledger account associated with the vendor.
Category	String	False	Category to which the vendor belongs.
VendorOwner_Id	String	False	Unique identifier of the user who owns the vendor record.
VendorOwner_FirstName	String	True	First name of the vendor owner.
VendorOwner_LastName	String	True	Last name of the vendor owner.
VendorOwner_Email	String	True	Email address of the vendor owner.
VendorOwner_Name	String	True	Full name of the vendor owner.
CreatedBy_Id	String	False	Unique identifier of the user who created the vendor record.
CreatedBy_FirstName	String	True	First name of the user who created the vendor record.
CreatedBy_LastName	String	True	Last name of the user who created the vendor record.
CreatedBy_Email	String	True	Email address of the user who created the vendor record.
CreatedBy_Name	String	True	Full name of the user who created the vendor record.
ModifiedBy_Id	String	False	Unique identifier of the user who last modified the vendor record.
ModifiedBy_FirstName	String	True	First name of the user who last modified the vendor record.
ModifiedBy_LastName	String	True	Last name of the user who last modified the vendor record.
ModifiedBy_Email	String	True	Email address of the user who last modified the vendor record.
ModifiedBy_Name	String	True	Full name of the user who last modified the vendor record.
CreatedTime	Datetime	False	Timestamp when the vendor record was created.
ModifiedTime	Datetime	False	Timestamp when the vendor record was last modified.
Tag	String	False	Comma-separated tags associated with the vendor record.
Street	String	False	Street address of the vendor.
City	String	False	City where the vendor is located.
State	String	False	State where the vendor is located.
ZipCode	String	False	Postal code of the vendor.
Country	String	False	Country where the vendor is located.
Description	String	False	Textual description of the vendor.
VendorImage	String	False	Path or identifier for the image associated with 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 receiving emails.
UnsubscribedMode	String	True	Method through which the vendor unsubscribed from email communication.
UnsubscribedTime	Datetime	True	Timestamp when the vendor unsubscribed from email communication.
LastActivityTime	Datetime	False	Timestamp of the most recent activity on this vendor record.

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 check for duplicate vendor records during upsert. Only one field is supported for bulk upserts.
Trigger	String	Specifies whether to trigger workflow rules when inserting the vendor record.
CustomViewId	Long	Custom view identifier used to filter the vendor record. Only applies when the useCOQL parameter is false.

Cmdlets for Zoho CRM