4D Accounting SDK 2020 .NET Edition

Questions / Feedback?

QBLists Component

Properties   Methods   Events   Configuration Settings   Errors  

Used to add various List Items.

Syntax

DPayments.DAccountingSDK.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:

ClassClasses 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.
CustomerTypeCustomer 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.
JobTypeJob type can be used to separate jobs into any categories that are meaningful to the business.
PaymentMethodA customer's payment method, for example, cash, check, or Master Card.
PayrollItemWageEach 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.
SalesTaxCodeEach 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.
SalesRepA 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.
VendorTypeVendor 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.

IsActiveWhether or not entity is active.
IsTaxableIndicates whether sales tax is charged.
ListTypeIndicates the type of List Object to add or query.
ParentIdParent Id for this object.
ParentNameParent Name for this object.
PayrollAccountIdExpense account Id.
PayrollAccountNameExpense account Name.
PayrollWageTypeType type of pay.
QBConnectionStringAn aggregate consisting of various QuickBooks connection properties.
QBNameName of the object.
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.
SalesRepEntityIdSales representative's entity Id.
SalesRepEntityNameSales representative's entity name.
TaxCodeDescriptionLonger explanation of QBName .
TermsDiscountDayIf the bill is paid within this period, a discount applies.
TermsDiscountPercentDiscount that applies to a payment.
TermsDueDayIndicates 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.

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).
DueNextMonthDaysDefers payment until next month if bill issued within this many days of the due date.
EditSequenceAn identifier for this copy of the object.
EnforceMaxLengthIndicates whether to enforce max lengths for QB Fields.
FullNameThe name of the account.
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.
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.
SendRawXMLSends specified XML to quickbooks without modification.
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.
SublevelThe number of ancestors this Account has.
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]