/n software QuickBooks qblists Component : qblists OCX, qblists .NET Component, qblists Class, qblists Bean, qblists Object

Available in: QUICKBOOKS

QBLists Component [IBiz Integrator for QuickBooks - V4]

Properties Methods Events Configuration Settings

Used to add various List Items.

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

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.

This component is not supported for QuickBooks Online Edition.

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 complete descriptions.


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.
QBAddRequestAggregate	Request aggregate for an Add.
QBConnectionMode	The mode of connection to QuickBooks.
QBConnectionString	An aggregate consisting of various QuickBooks connection properties.
QBName	Name of the object.
QBOpenCompanyFile	The file currently open in QuickBooks.
QBRequestId	The Id of the next message to be sent to QuickBooks.
QBResponseAggregate	The last XML response aggregate received from QuickBooks.
QBUpdateRequestAggregate	Request aggregate for an Update.
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

Method List

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


AXMExport	Exports the object.
AXMImport	Imports the object.
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 component 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.
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.
WebExport	Exports the object to a web client.

Event List

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


Error	Information about errors during data delivery.
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 complete descriptions.


AppendAfter	Appends an xml tag after the specified QBXML element.
AuthFlags	Connection Flags (use for QuickBooks Simple Start).
CodePage	The system code page used for Unicode to Multibyte translations (Windows/COM only).
EditSequence	An identifier for this copy of the object.
EnforceMaxLength	Indicates whether to enforce max lengths for QB Fields
FullName	The name of the account.
GetHighestVersion	Highest QBXMLVersion supported by the installed instance of Quickbooks.
IgnoreQBOEWarnings	Ignores warnings returned from QuickBooks Online.
IsActive	Indicates whether the object is currently enabled for use by QuickBooks.
SSLAcceptServerCert	The SSL certificate being used by the Remote Connector
SSLAcceptServerCertFile	The SSL certificate file being used by the Remote Connector
SendRawXML	Sends specified XML to quickbooks without modification.
Sublevel	The number of ancestors this Account has.
TimeCreated	The time the object was created.
TimeModified	The time the object was created.