QuickBooks Integrator Deposit Component : Deposit OCX, Deposit .NET Component, Deposit Class, Deposit Bean, Deposit Object

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

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

This component is not supported for QuickBooks Online Edition.

Example

Deposit1.DepositToAccountName = "Checking"                  '*
Deposit1.DepositLineCount = 1
Deposit1.DepositLineEntityName(0) = "Baker, Chris"          '*
Deposit1.DepositLineAccountName(0) = "Accounts Receivable"  '*
Deposit1.DepositLineMemo(0) = "Payment for new skylight"
Deposit1.DepositLinePaymentMethodName(0) = "Check"          '*
Deposit1.DepositLineCheckNumber(0) = "12345"
Deposit1.DepositLineAmount(0) = "1200.00"
Deposit1.Add()

'*: 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.


CashBackAccountId	Reference to the bank or credit card company.
CashBackAccountName	Reference to the bank or credit card company.
CashBackAmount	Cash Back Amount.
CashBackId	Id of the cash back transaction.
CashBackMemo	Additional info for the cash back transaction.
DepositLineCount	The number of records in the DepositLine arrays.
DepositLineAccountId	A reference to the account to which funds are to be deposited.
DepositLineAccountName	A reference to the account to which funds are to be deposited.
DepositLineAmount	The total amount of this deposit line item.
DepositLineCheckNumber	Optional check number for this deposit line item.
DepositLineClassId	Specifies the class of the deposit line item ClassName or ClassId may reference to the class of this deposit.
DepositLineClassName	Specifies the class of the deposit line item ClassName or ClassId may reference to the class of this deposit.
DepositLineEntityId	An entity Id for this deposit line item.
DepositLineEntityName	An entity name for this deposit line item.
DepositLineLineId	Identification number of the deposit line, used for Updates.
DepositLineMemo	A memo for this deposit line.
DepositLinePaymentId	The PaymentTxnId for this deposit line item For any given deposit there are many line items properties, such as AccountId , PaymentMethodId , Amount , etc.
DepositLinePaymentLineId	The PaymentTxnLineId for this deposit line item For the PaymentTxnLineID, use a TxnLineID value exactly as it has been returned by the RECEIVEPAYMENT component after a Get.
DepositLinePaymentMethodId	The payment method for this deposit line item.
DepositLinePaymentMethodName	The payment method (funding source) for this deposit line item.
DepositLineRefId	Identification number of the transaction associated with this deposit line.
DepositToAccountId	Account to deposit funds to.
DepositToAccountName	Account to deposit funds to.
Memo	Memo to appear on internal reports only.
QBConnectionString	An aggregate consisting of various QuickBooks connection properties.
QBRequestId	The Id of the next message to be sent to QuickBooks.
QBResponseAggregate	The last XML response aggregate received from QuickBooks.
QBXMLVersion	The version of QBXML used in the outgoing message.
RefId	An alphanumerical identifier generated by the server.
TotalDeposit	The total of the deposit.
TransactionDate	Date 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.


Add	Adds the record into QuickBooks.
Cancel	Cancels (voids) the transaction.
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.
GetCustomField	Gets a custom field value from QuickBooks.
GetQBAddRequestAggregate	Request aggregate for an Add.
GetQBUpdateRequestAggregate	Request aggregate for an Update.
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 bill in QuickBooks.
XMLExport	Exports the object.
XMLImport	Imports the object.

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.
TimeCreated	The time the object was created.
TimeModified	The time the object was created.
EditSequence	An identifier for this copy of the object.
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.
IgnoreQBOEWarnings	Ignores warnings returned from QuickBooks Online.
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.
QBOpenCompanyFile	The file currently open in QuickBooks.
QBConnectionMode	The mode of connection to QuickBooks.
CodePage	The system code page used for Unicode to Multibyte translations.

|

About

|

Privacy Policy

|

Terms of Use

|