Account Component

Properties Methods Events Configuration Settings Errors

The Account component manages QuickBooks accounts.

Syntax

nsoftware.InQB.Account

Remarks

The Account component is used to represent QuickBooks accounts (such as Checking, Accounts Receivable, etc.)

Required Fields (Add): AccountName, AccountType

Supported Methods: Add, Get (Id/Name), Update, Delete

Example (Adding an account to QuickBooks)

Account1.AccountName = "QuickBooks Consulting"
Account1.AccountType = atIncome
Account1.Add()

When adding an account to QuickBooks, the important properties are AccountName and AccountType. If desired, you may specify additional information such as Parent*, IsActive, AccountNumber, BankNumber, and Description. You may also specify an opening balance by setting OpeningBalance and OpeningBalanceDate.

When retrieving account information from QuickBooks you may also retrieve the current Balance. A variety of additional information about the account is available by calling Config.

Property List

The following is the full list of the properties of the component with short descriptions. Click on the links for further details.


AccountName	Account's name.
AccountNumber	Account number for this account.
AccountType	The type of account.
Balance	The balance of this account, including sub-accounts.
BankNumber	Bank account number for this account.
Description	Description for this account.
IsActive	Whether or not entity is active.
OpeningBalance	The opening balance of this account.
OpeningBalanceDate	The opening balance date of this account.
ParentId	Reference to parent Account .
ParentName	Reference to parent Account .
QBConnectionString	An aggregate consisting of various QuickBooks connection properties.
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.

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.
ImportQBXML	Imports a QBXML response aggregate.
OpenQBConnection	Opens a persistent connection to QuickBooks.
Reset	Resets all properties to their defaults.
Update	Updates the account 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.
FullName	The name of the account.
Sublevel	The number of ancestors this Account has.
NonInclusiveBalance	The balance of the Account, not including sub-accounts.
SpecialAccountType	Special account created by QuickBooks.
TaxLineInfo	Tax line information for this account.
CashFlowClassification	Classification of account for cash flow reporting.
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.