QuickBooks Integrator 2020 .NET Edition

Questions / Feedback?

Deposit Component

Properties   Methods   Events   Configuration Settings   Errors  

A Deposit is used to record and query deposits to an account.




The Deposit component is used to deposit a payment into an existing account. The Deposit component corresponds to a standard Deposit in QuickBooks, and allows the QuickBooks user to record the deposit of funds from any existing payment.

Required Fields (Add): DepositTo*, and at least one DepositLinePaymentId*, or one DepsoitLineAccount* and a DepositLineAmount.

Supported Methods: Add, Get (Id), Cancel, Delete


Deposit1.DepositToAccountName = "Checking"                  '*
Deposit1.DepositLines.Add(New DepositLine())
Deposit1.DepositLines(0).EntityName = "Baker, Chris"          '*
Deposit1.DepositLines(0).AccountName = "Accounts Receivable"  '*
Deposit1.DepositLines(0).Memo = "Payment for new skylight"
Deposit1.DepositLines(0).PaymentMethodName = "Check"          '*
Deposit1.DepositLines(0).CheckNumber = "12345"
Deposit1.DepositLines(0).Amount = "1200.00"

'*: Item must already exist in QuickBooks.

The Deposit component supports a variety of other operations as well. The component's Get, Cancel, and Delete methods may be used to retrieve, cancel, and delete Deposits, respectively. The ObjSearch Component may be used to search for Deposits in the QuickBooks database.

Property List

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

CashBackAccountIdReference to the bank or credit card company.
CashBackAccountNameReference to the bank or credit card company.
CashBackAmountCash Back Amount.
CashBackIdId of the cash back transaction.
CashBackMemoAdditional info for the cash back transaction.
DepositLineItemsCollection of line items associated with this deposit.
DepositToAccountIdAccount to deposit funds to.
DepositToAccountNameAccount to deposit funds to.
MemoMemo to appear on internal reports only.
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.
TotalDepositThe total of the deposit.
TransactionDateDate of transaction.

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.
CancelCancels (voids) the transaction.
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.
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 bill 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).
EditSequenceAn identifier for this copy of the object.
EnforceMaxLengthIndicates whether to enforce max lengths for QB Fields.
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.
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 QuickBooks Gateway (aka Remote Connector).
SSLAcceptServerCertFileThe SSL certificate file being used by the QuickBooks Gateway (aka Remote Connector).
StopOnErrorSpecifies how QuickBooks is to proceed if an error occurs in processing of the current request.
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) 2022 4D Payments Inc. - All rights reserved.
QuickBooks Integrator 2020 .NET Edition - Version 20.0 [Build 8076]