Vendor Class
Properties Methods Events Configuration Settings Errors
A Vendor is anyone from whom the QuickBooks company buys goods or services.
Syntax
class inqb.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 class has a number of optional properties. The contact information is given in company_name, contact_name, alt_contact_name, address, fax, and email. Various other information, such as VendorType and credit_limit may be specified as well. See below for a complete listing.
If you send 1099-MISC tax forms to the Vendor, the eligible_for_1099 property should be set to true. In this case address and tax_identity are required when calling Add.
Tracking Vendor Balances
The Vendor class may be used to track the outstanding balances of customers. After invoking get, simply inspect the balance property;. The ObjSearch class can be used to find unpaid and paid Bills tied to this vendor.
When a vendor is added to QuickBooks, the credit_limit 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 class with short descriptions. Click on the links for further details.
| account_number | Account number for this entity. |
| address | Address of vendor. |
| alt_contact_name | Alternate contact person for entity. |
| alt_phone | Alternate phone number of entity. |
| balance | Balance with this vendor. |
| company_name | Company name of customer or vendor. |
| contact_name | Contact person for a customer or vendor. |
| credit_limit | Credit limit for this entity. |
| eligible_for_1099 | Whether vendor is eligible for 1099 tracking. |
| Email address of entity. | |
| fax | Fax number of entity. |
| is_active | Whether or not entity is active. |
| name_on_check | Name to write on checks to this vendor. |
| notes | Notes for this transaction. |
| phone | Phone number of entity. |
| qb_connection_string | An aggregate consisting of various QuickBooks connection properties. |
| qb_request_aggregate | The request aggregate. |
| qb_request_id | The Id of the next message to be sent to QuickBooks. |
| qb_request_mode | Defines whether the request is made online or stored offline. |
| qb_response_aggregate | The last QBXML response aggregate received from QuickBooks. |
| qbxml_version | The version of QBXML used in the outgoing message. |
| ref_id | An alphanumerical identifier generated by the server. |
| tax_identity | String that identifies a vendor to the IRS. |
| terms_id | Reference to terms of payment. |
| terms_name | Reference to terms of payment. |
| vendor_name | Vendor's name. |
| vendor_type_id | Reference to the type of vendor. |
| vendor_type_name | Reference to the type of vendor. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
| add | Adds the record into QuickBooks. |
| check_request_status | Checks whether or not the specified request was processed by QuickBooks. |
| close_qb_connection | Closes a persistent connection to QuickBooks. |
| config | Sets or retrieves a configuration setting. |
| delete | Deletes the record from QuickBooks. |
| get | Gets a single record from QuickBooks. |
| get_by_name | Gets a single record from QuickBooks. |
| get_custom_field | Gets a custom field value from QuickBooks. |
| import_qbxml | Imports a QBXML response aggregate. |
| open_qb_connection | Opens a persistent connection to QuickBooks. |
| reset | Resets all properties to their defaults. |
| set_custom_field | Sets a custom field value within QuickBooks. |
| update | Updates the entity object in QuickBooks. |
Event List
The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.
| on_error | Information about errors during data delivery. |
| on_ssl_server_authentication | Fired after the server presents its certificate to the client. |
| on_ssl_status | Shows the progress of the secure connection. |
| on_status | Shows the progress of the QuickBooks connection. |
| on_warning | Fired when a warning occurs. |
Configuration Settings
The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.
| AppendAfter | Appends an XML tag after the specified QBXML element. |
| AuthFlags | Connection Flags (use for QuickBooks Simple Start). |
| EditSequence | An identifier for this copy of the object. |
| EnforceMaxLength | Indicates whether to enforce max lengths for QB Fields. |
| FirstName | A first name. |
| GetHighestVersion | Highest QBXMLVersion supported by the installed instance of QuickBooks. |
| GetRequestProcessorDLLVersion | Returns the version of the QB Request Processor that is installed on your system. |
| GetSupportedVersions | Returns a list of QBXMLVersions that are supported by QuickBooks. |
| IsActive | Indicates whether the object is currently enabled for use by QuickBooks. |
| IsReadOnly | This causes the QuickBooks authorization dialog to display text informing the user that its access will be read-only. |
| LastName | A last name. |
| MiddleInitial | A middle initial. |
| OpeningBalance | The opening balance for the customer or vendor. Not used in Update operations. |
| OpeningBalanceDate | The opening balance date for the customer or vendor. Not used in Update operations. |
| PersonalDataPref | Whether the connecting application will require access to personal data such as SSN or credit card information. |
| QBConnectionMode | The mode of connection to QuickBooks. |
| QBFileStatus | The status of the company file as it pertains to accepting connections. |
| QBOpenCompanyFile | The file currently open in QuickBooks. |
| Salutation | A salutation, such as Mr., Mrs., etc. |
| SendRawXML | Sends specified XML to quickbooks without modification. |
| SeparateContact | A contact person other than the person specified by Salutation, FirstName, MiddleInitial, and LastName. |
| SSLAcceptServerCert | The SSL certificate being used by the Remote Connector. |
| SSLAcceptServerCertFile | The SSL certificate file being used by the Remote Connector. |
| StopOnError | Specifies how QuickBooks is to proceed if an error occurs in processing of the current request. |
| TimeCreated | The time the object was created. |
| TimeModified | The time the object was created. |
| UnattendedModePref | Whether connecting while QuickBooks is closed is required or optional for the user. |
| WarningCodes | A comma-separated list of QuickBooks warning codes that should not result in an exception. |
| BuildInfo | Information about the product's build. |
| CodePage | The system code page used for Unicode to Multibyte translations. |
| LicenseInfo | Information about the current license. |
| ProcessIdleEvents | Whether the class uses its internal event loop to process events when the main thread is idle. |
| SelectWaitMillis | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. |
| UseInternalSecurityAPI | Tells the class whether or not to use the system security libraries or an internal implementation. |