4D Accounting SDK 2020 .NET Edition

Questions / Feedback?

Vendor Component

Properties   Methods   Events   Configuration Settings   Errors  

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

Syntax

DPayments.DAccountingSDK.Vendor

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

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.
QBRequestAggregateThe request aggregate.
QBRequestIdThe Id of the next message to be sent to QuickBooks.
QBRequestModeDefines whether the request is made online or stored offline.
QBResponseAggregateThe last QBXML 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.
ImportQBXMLImports a QBXML response aggregate.
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.

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.

AppendAfterAppends an XML tag after the specified QBXML element.
AuthFlagsConnection Flags (use for QuickBooks Simple Start).
EditSequenceAn identifier for this copy of the object.
EnforceMaxLengthIndicates whether to enforce max lengths for QB Fields.
FirstNameA first name.
GetHighestVersionHighest QBXMLVersion supported by the installed instance of QuickBooks.
GetRequestProcessorDLLVersionReturns the version of the QB Request Processor that is installed on your system.
GetSupportedVersionsReturns a list of QBXMLVersions that are supported by QuickBooks.
IsActiveIndicates whether the object is currently enabled for use by QuickBooks.
IsReadOnlyThis causes the QuickBooks authorization dialog to display text informing the user that its access will be read-only.
LastNameA last name.
MiddleInitialA middle initial.
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.
PersonalDataPrefWhether the connecting application will require access to personal data such as SSN or credit card information.
QBConnectionModeThe mode of connection to QuickBooks.
QBFileStatusThe status of the company file as it pertains to accepting connections.
QBOpenCompanyFileThe file currently open in QuickBooks.
SalutationA salutation, such as Mr., Mrs., etc.
SendRawXMLSends specified XML to quickbooks without modification.
SeparateContactA contact person other than the person specified by Salutation, FirstName, MiddleInitial, and LastName.
SSLAcceptServerCertThe SSL certificate being used by the Remote Connector.
SSLAcceptServerCertFileThe SSL certificate file being used by the Remote Connector.
StopOnErrorSpecifies how QuickBooks is to proceed if an error occurs in processing of the current request.
TimeCreatedThe time the object was created.
TimeModifiedThe time the object was created.
UnattendedModePrefWhether connecting while QuickBooks is closed is required or optional for the user.
WarningCodesA comma-separated list of QuickBooks warning codes that should not result in an exception.
BuildInfoInformation about the product's build.
GUIAvailableTells the component whether or not a message loop is available for processing events.
LicenseInfoInformation about the current license.
UseInternalSecurityAPITells the component whether or not to use the system security libraries or an internal implementation.

 
 
Copyright (c) 2021 4D Payments Inc. - All rights reserved.
4D Accounting SDK 2020 .NET Edition - Version 20.0 [Build 7887]