A vendor is a company or person you purchase goods and services from. Vendor records track information about your vendors and enable you to view past transactions and communications with them. For information about working with vendor records in the UI, see Vendor Records Overview.

The vendor record is defined in the listsRel (relationships) XSD.

Supported Operations

The following operations can be used to modify vendor records:

add | addList | attach / detach | delete | deleteList | get | getDeleted | getList | getSavedSearch | getSelectValue | search | searchMoreWithId | update | updateList | upsert | upsertList


You can also use the asynchronous equivalents of SOAP web services list operations. For information about asynchronous operations, see SOAP Web Services Asynchronous Operations. For more information about request processing, see Synchronous Versus Asynchronous Request Processing.

Field Definitions

The SOAP Schema Browser includes definitions for all body fields, sublist fields, search filters, and search joins available to this record. For details, see the SOAP Schema Browser’s vendor reference page.


For information about using the SOAP Schema Browser, see SOAP Schema Browser.


The balance field is only returned when using advanced search. It is not returned when using the <Record>SearchBasic search object. In advanced search, you must set the bodyFieldsOnly preference to false. The balance field is not returned if the bodyFieldsOnly preference is set to true. For more information, see bodyFieldsOnly.

Usage Notes

Working with Vendor Lists

The SOAP Schema Browser includes all lists (sublists) associated with the vendor record. However, see the following information for usage notes regarding specific vendor lists. Note that usage notes are not provided for every list type.


As of the 2011.2 endpoint, the VendorContactList sublist is no longer supported. You can add or update contacts through the attach/detach operations, and you can retrieve contact names and roles for an entity through an advanced search on the entity record and its associated contacts. This advanced search technique is described in Returning a Contact List for a Customer.


This list can only be edited on an update. It defines the quantity pricing schedules to use for the vendor. The Quantity Pricing feature must be enabled to access this list.

Working with the Tax Registration Sublist

The tax registrations sublist is available when the SuiteTax feature is enabled at Setup > Company > Setup Tasks > Enable Features, on the Tax subtab.

Whenever you change the Tax Registration Number value on a sublist line, it triggers the regeneration of the value of a hidden ID field, and the values of ID fields are regenerated on all sublist lines. The ID field is hidden in the UI, but it is visible through SOAP web services. The ID field is searchable, so you can access the updated values through SOAP web services.

For information about working with tax registration in the UI, see Assigning Tax Registrations to an Entity in SuiteTax.

Note about Multiple Currencies and Vendors

When the Multiple Currencies feature is enabled, the label for the Currency field on the vendor record changes to Primary Currency (internal id of the field is still currency) and a Currency sublist is added to the vendor record. Also, the purchasePrice field in ItemVendorList becomes hidden but this field's values can still be saved through SOAP web services.

Related Topics

Entity Search
How to Use the SOAP Web Services Records Help
SOAP Web Services Supported Records
SOAP Schema Browser
SuiteTalk SOAP Web Services Platform Overview

General Notices