The Net Tools Company - 800.225.4190
Search: 
Available in: QUICKBOOKS
Vendor Component [QuickBooks Integrator V5]

Properties   Methods   Events   Configuration Settings  

A Vendor is anyone from whom the QuickBooks company buys goods or services.

NOTE: What follows is a very short description of the component interfaces. For more information, please consult the help files that come with the respective package.

Remarks

A Vendor is anyone from whom the QuickBooks company buys goods or services.

Required Fields (Add): VendorName

Supported Methods: Add, Update (contact info only), Get (Id/Name), Delete

Online Edition: Leave out IsActive, ContactName, AltContactName, VendorType*, and CreditLimit.

Example (Adding a vendor to QuickBooks)

Vendor1.VendorName = "John Doe"
Vendor1.Add()
The component has a number of optional properties. The contact information is given in CompanyName, ContactName, AltContactName, Address, Fax, and Email. Various other information, such as VendorType and CreditLimit may be specified as well. See below for a complete listing.

If you send 1099-MISC tax forms to the Vendor, the EligibleFor1099 property should be set to true. In this case Address and TaxIdentity are required when calling Add.

Tracking Vendor Balances

The Vendor component may be used to track the outstanding balances of customers. After invoking Get, simply inspect the Balance property;. The OBJSEARCH component can be used to find unpaid and paid BILLs tied to this vendor.

When a vendor is added to QuickBooks, the CreditLimit may be set, and the OpeningBalance (special field) may be set, if there is one. Once a vendor is added to QuickBooks, there is no way to modify Balance directly! Instead, BILLs or VENDORCREDITs should be added referencing this vendor.

Property List


The following is the full list of the properties of the component with short descriptions. Click on the links for further details.

AccountNumberAccount number for this entity.
AddressAddress of vendor.
AltContactNameAlternate contact person for entity.
AltPhoneAlternate phone number of entity.
BalanceBalance with this vendor.
CompanyNameCompany name of customer or vendor.
ContactNameContact person for a customer or vendor.
CreditLimitCredit limit for this entity.
EligibleFor1099Whether vendor is eligible for 1099 tracking.
EmailEmail address of entity.
FaxFax number of entity.
IsActiveWhether or not entity is active.
NameOnCheckName to write on checks to this vendor.
NotesNotes for this transaction.
PhonePhone number of entity.
QBConnectionStringAn aggregate consisting of various QuickBooks connection properties.
QBRequestIdThe Id of the next message to be sent to QuickBooks.
QBResponseAggregateThe last XML response aggregate received from QuickBooks.
QBXMLVersionThe version of QBXML used in the outgoing message.
RefIdAn alphanumerical identifier generated by the server.
TaxIdentityString that identifies a vendor to the IRS.
TermsIdReference to terms of payment.
TermsNameReference to terms of payment.
VendorNameVendor's name.
VendorTypeIdReference to the type of vendor.
VendorTypeNameReference to the type of vendor.

Method List


The following is the full list of the methods of the component with short descriptions. Click on the links for further details.

AddAdds the record into QuickBooks.
CheckRequestStatusChecks whether or not the specified request was processed by QuickBooks.
CloseQBConnectionCloses a persistent connection to QuickBooks.
ConfigSets or retrieves a configuration setting.
DeleteDeletes the record from QuickBooks.
GetGets a single record from QuickBooks.
GetByNameGets a single record from QuickBooks.
GetCustomFieldGets a custom field value from QuickBooks.
GetQBAddRequestAggregateRequest aggregate for an Add.
GetQBUpdateRequestAggregateRequest aggregate for an Update.
OpenQBConnectionOpens a persistent connection to QuickBooks.
ResetResets all properties to their defaults.
SetCustomFieldSets a custom field value within QuickBooks.
UpdateUpdates the entity object in QuickBooks.
XMLExportExports the object.
XMLImportImports the object.

Event List


The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.

ErrorInformation about errors during data delivery.
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusShows the progress of the secure connection.
StatusShows the progress of the QuickBooks connection.
WarningFired when a warning occurs.

Configuration Settings


The following is a list of configuration settings for the component with short descriptions. Click on the links for further details.

SendRawXMLSends specified XML to quickbooks without modification.
AppendAfterAppends an XML tag after the specified QBXML element.
TimeCreatedThe time the object was created.
TimeModifiedThe time the object was created.
EditSequenceAn identifier for this copy of the object.
IsActiveIndicates whether the object is currently enabled for use by QuickBooks.
SalutationA salutation, such as Mr., Mrs., etc.
FirstNameA first name.
MiddleInitialA middle initial.
LastNameA last name.
SeparateContactA contact person other than the person specified by Salutation, FirstName, MiddleInitial, and LastName.
OpeningBalanceThe opening balance for the customer or vendor. Not used in Update operations.
OpeningBalanceDateThe opening balance date for the customer or vendor. Not used in Update operations.
StopOnErrorSpecifies how QuickBooks is to proceed if an error occurs in processing of the current request.
SSLAcceptServerCertThe SSL certificate being used by the Remote Connector.
SSLAcceptServerCertFileThe SSL certificate file being used by the Remote Connector.
EnforceMaxLengthIndicates whether to enforce max lengths for QB Fields.
IgnoreQBOEWarningsIgnores warnings returned from QuickBooks Online.
AuthFlagsConnection Flags (use for QuickBooks Simple Start).
GetHighestVersionHighest QBXMLVersion supported by the installed instance of QuickBooks.
GetSupportedVersionsReturns a list of QBXMLVersions that are supported by QuickBooks.
GetRequestProcessorDLLVersionReturns the version of the QB Request Processor that is installed on your system.
QBOpenCompanyFileThe file currently open in QuickBooks.
QBConnectionModeThe mode of connection to QuickBooks.
CodePageThe system code page used for Unicode to Multibyte translations.
| About | Privacy Policy | Terms of Use |
© Copyright 2012 /n software inc.