4D Accounting SDK 2020 .NET Edition

Questions / Feedback?

Account Component

Properties   Methods   Events   Configuration Settings   Errors  

The Account component manages QuickBooks accounts.

Syntax

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

AccountNameAccount's name.
AccountNumberAccount number for this account.
AccountTypeThe type of account.
BalanceThe balance of this account, including sub-accounts.
BankNumberBank account number for this account.
DescriptionDescription for this account.
IsActiveWhether or not entity is active.
OpeningBalanceThe opening balance of this account.
OpeningBalanceDateThe opening balance date of this account.
ParentIdReference to parent Account .
ParentNameReference to parent Account .
QBConnectionStringAn aggregate consisting of various QuickBooks connection properties.
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.

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.
ImportQBXMLImports a QBXML response aggregate.
OpenQBConnectionOpens a persistent connection to QuickBooks.
ResetResets all properties to their defaults.
UpdateUpdates 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.

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).
CashFlowClassificationClassification of account for cash flow reporting.
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.
NonInclusiveBalanceThe balance of the Account, not including sub-accounts.
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.
SpecialAccountTypeSpecial account created by QuickBooks.
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.
TaxLineInfoTax line information for this account.
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]