QBLists Component
Properties Methods Events Configuration Settings Errors
Used to add various List Items.
Syntax
nsoftware.InQB.Qblists
Remarks
This component is used to add various List Items into QuickBooks. The QBLists prodtype; can be used to add many different List Items, depending on what the ListType property is set.
Required Fields (Add): QBName. Some ListTypes will have additional required fields.
Supported Methods: Add, Get (Id), Cancel, Delete. Update is supported for SalesRep ItemTypes.
List Items supported:
| Class | Classes can be used to separate transactions into meaningful categories (for example, transactions could be classified according to department, business location, or type of work). In QuickBooks, class tracking is off by default. |
| CustomerType | Customer types allow business owners to categorize customers in ways that are meaningful for their businesses. For example, a customer type might indicate which industry a customer represents, or which part of the country a customer is in. |
| JobType | Job type can be used to separate jobs into any categories that are meaningful to the business. |
| PaymentMethod | A customer's payment method, for example, cash, check, or Master Card. |
| PayrollItemWage | Each payroll wage item describes and names a payment scheme, for example, Regular Pay or Overtime Pay. Additional required fields: PayrollWageType and either PayrollAccountId or PayrollAccountName. |
| SalesTaxCode | Each item on a sales form is assigned a sales-tax code that indicates whether the item is taxable or non-taxable, and why. Additional required field: IsTaxable. |
| SalesRep | A sales representative must be on the Employee, Vendor, or Other Names list within QuickBooks. Sales representative's names and initials appear on the Rep drop-down list on QuickBooks sales forms. A SalesRepEntity refers to a person on the SalesRep list. Additional required field: SalesRepEntityName or SalesRepEntityId. |
| VendorType | Vendor types allow business owners to categorize vendors in ways that are meaningful for their businesses. For example, a vendor type might indicate which industry a vendor represents, or which part of the country a vendor is in. |
Example
QBLists1.ListType = ltVendorType QBLists1.QBName = "Sewage" QBLists1.ParentName = "Utility" '* (optional) QBLists1.Add '*: Item must already exist in QuickBooks.
The QBLists component supports a variety of other operations as well. The component's Get and Delete methods may be used to retrieve and delete the above list items.
Property List
The following is the full list of the properties of the component with short descriptions. Click on the links for further details.
| IsActive | Whether or not entity is active. |
| IsTaxable | Indicates whether sales tax is charged. |
| ListType | Indicates the type of List Object to add or query. |
| ParentId | Parent Id for this object. |
| ParentName | Parent Name for this object. |
| PayrollAccountId | Expense account Id. |
| PayrollAccountName | Expense account Name. |
| PayrollWageType | Type type of pay. |
| QBConnectionString | An aggregate consisting of various QuickBooks connection properties. |
| QBName | Name of the object. |
| QBRequestAggregate | The request aggregate. |
| QBRequestId | The Id of the next message to be sent to QuickBooks. |
| QBRequestMode | Defines whether the request is made online or stored offline. |
| QBResponseAggregate | The last QBXML response aggregate received from QuickBooks. |
| QBXMLVersion | The version of QBXML used in the outgoing message. |
| RefId | An alphanumerical identifier generated by the server. |
| SalesRepEntityId | Sales representative's entity Id. |
| SalesRepEntityName | Sales representative's entity name. |
| TaxCodeDescription | Longer explanation of QBName . |
| TermsDiscountDay | If the bill is paid within this period, a discount applies. |
| TermsDiscountPercent | Discount that applies to a payment. |
| TermsDueDay | Indicates when payment is due. |
Method List
The following is the full list of the methods of the component with short descriptions. Click on the links for further details.
| Add | Adds the record into QuickBooks. |
| CheckRequestStatus | Checks whether or not the specified request was processed by QuickBooks. |
| CloseQBConnection | 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. |
| GetByName | Gets a single record from QuickBooks. |
| GetCustomField | Gets a custom field value from QuickBooks. |
| ImportQBXML | Imports a QBXML response aggregate. |
| OpenQBConnection | Opens a persistent connection to QuickBooks. |
| Reset | Resets all properties to their defaults. |
| SetCustomField | 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 component with short descriptions. Click on the links for further details.
| Error | Information about errors during data delivery. |
| SSLServerAuthentication | Fired after the server presents its certificate to the client. |
| SSLStatus | Shows the progress of the secure connection. |
| Status | Shows the progress of the QuickBooks connection. |
| Warning | Fired 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.
| SendRawXML | Sends specified XML to quickbooks without modification. |
| AppendAfter | Appends an XML tag after the specified QBXML element. |
| TimeCreated | The time the object was created. |
| TimeModified | The time the object was created. |
| EditSequence | An identifier for this copy of the object. |
| FullName | The name of the account. |
| Sublevel | The number of ancestors this Account has. |
| DueNextMonthDays | Defers payment until next month if bill issued within this many days of the due date. |
| IsActive | Indicates whether the object is currently enabled for use by QuickBooks. |
| StopOnError | Specifies how QuickBooks is to proceed if an error occurs in processing of the current request. |
| SSLAcceptServerCert | The SSL certificate being used by the Remote Connector. |
| SSLAcceptServerCertFile | The SSL certificate file being used by the Remote Connector. |
| EnforceMaxLength | Indicates whether to enforce max lengths for QB Fields. |
| AuthFlags | Connection Flags (use for QuickBooks Simple Start). |
| GetHighestVersion | Highest QBXMLVersion supported by the installed instance of QuickBooks. |
| GetSupportedVersions | Returns a list of QBXMLVersions that are supported by QuickBooks. |
| GetRequestProcessorDLLVersion | Returns the version of the QB Request Processor that is installed on your system. |
| IsReadOnly | This causes the QuickBooks authorization dialog to display text informing the user that its access will be read-only. |
| UnattendedModePref | Whether connecting while QuickBooks is closed is required or optional for the user. |
| PersonalDataPref | Whether the connecting application will require access to personal data such as SSN or credit card information. |
| QBOpenCompanyFile | The file currently open in QuickBooks. |
| QBConnectionMode | The mode of connection to QuickBooks. |
| QBFileStatus | The status of the company file as it pertains to accepting connections. |
| WarningCodes | A comma-separated list of QuickBooks warning codes that should not result in an exception. |
| CodePage | The system code page used for Unicode to Multibyte translations. |