Vendor API

This topic describes the vendor APIs for the Integration Framework.

API

Name Description
void Delete(LogonInfo, RecordIdentifier)

Delete a vendor.

Parameters:

  • logonInfo: Login information for the database
  • vendorID: The ID of the vendor to delete
void Get(LogonInfo, RecordIdentifier)

Get a vendor.

Parameters:

  • logonInfo: Login information for the database
  • vendorID: The ID of the vendor to get
void Save(LogonInfo, Vendor)

Save a vendor.

Parameters:

  • logonInfo: Login information for the database
  • vendor: The vendor to save
VendorSaveResult SaveList(LogonInfo, List<Vendor>)

Save multiple vendors.

Parameters:

  • logonInfo: Login information for the database
  • vendors: The vendors to save

 

Business objects

The following business objects are used by the vendor API.

Name Description
Address The full address object of the vendor. To set the address use the SetAddress(Address) method.
Address1 First address information of the vendor.
Address2 Second address information of the vendor.
AddressFormat Address format of the vendor's address.
City The city of the vendor.
CurrencyID The default currency ID of the vendor.
DefaultContactID The default contact ID of the vendor.
DefaultDeliveryTime The default delivery time in number of days.
DeliveryDaysType Set if the default delivery time is represented in normal or business days.
Email The email address of the vendor
Fax The fax number of the vendor
ID The ID of the vendor.
LanguageID The language ID of the vendor.
LongDescription A long description about the vendor.
Phone The phone number of the vendor.
State The state of the vendor.
TaxCalculationMethod Set if the tax should be added, included or not used.
TaxGroup The tax group ID to which the vendor belongs to.
Text The name the vendor.
ZipCode The zip code of the vendor.

For a vendor object to be valid the ID and Text properties must be set.

Name Description
VendorErrorInfo A list of objects containing the vendors that failed the saving process along with the error message.
EndTime The time at which the saving process finished.
StartTime The time at which the saving process started.
Success True if the saving process finished successfully.

 

Examples

To update vendors you must use the optimized update feature.

Updating a vendor


	Vendor vendor = wcfVendorService.Get(CreateLogonInfo(dataModel), "0000001");
	vendor.Text += "-Updated";

	((IOptimizedUpdate) vendor).CloneUpdateListToTransportList();
	wcfVendorService.Save(CreateLogonInfo(dataModel), vendor);

In the above example, firstly we get an existing vendor through the Integration Framework, update it, then we clone the update list using the optimized update functionality. After we update all properties accordingly we save the vendor through the Integration Framework.

Deleting a vendor


	wcfVendorService.Delete(CreateLogonInfo(dataModel), "0000001");

See also