Search: 
Available in: QUICKBOOKS
Deposit Component [IBiz Integrator for QuickBooks - V4]

Properties   Methods   Events   Configuration Settings  

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

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) = 120000 '$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 complete descriptions.

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.
DepositLineAccountId Deposit line property: the account for this line.
DepositLineAccountName Deposit line property: the account for this line.
DepositLineAmount Deposit line property: amount of the deposit.
DepositLineCheckNumber Deposit line property: The check number for this deposit.
DepositLineClassId Deposit line property: class of the Deposit.
DepositLineClassName Deposit line property: class of the deposit.
DepositLineCount Deposit line property: number of deposit lines.
DepositLineEntityId Deposit line property: An entity for this deposit line.
DepositLineEntityName Deposit line property: An entity for this deposit line.
DepositLineId Deposit line property: Transaction Id for this line.
DepositLineMemo Deposit line property: Memo for this line.
DepositLinePaymentId Deposit line property: The PaymentTxnId for this deposit.
DepositLinePaymentMethodId Deposit line property: The payment method for this deposit.
DepositLinePaymentMethodName Deposit line property: The payment method for this deposit.
DepositToAccountId Account to deposit funds to.
DepositToAccountName Account to deposit funds to.
Memo Memo to appear on internal reports only.
QBAddRequestAggregate Request aggregate for an Add.
QBConnectionMode The mode of connection to QuickBooks.
QBConnectionString An aggregate consisting of various QuickBooks connection properties.
QBOpenCompanyFile The file currently open in QuickBooks.
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 complete descriptions.

AXMExport Exports the object.
AXMImport Imports the object.
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 component configuration setting.
Delete Deletes the record from QuickBooks.
Get Gets a single record from QuickBooks.
GetCustomField Gets a custom field value from QuickBooks.
OpenQBConnection Opens a persistent connection to QuickBooks.
Reset Resets all properties to their defaults.
SetCustomField Sets a custom field value within QuickBooks.
WebExport Exports the object to a web client.

Event List


The following is the full list of the events fired by the component with short descriptions. Click on the links for complete descriptions.

Error Information about errors during data delivery.
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 complete descriptions.

AppendAfter Appends an xml tag after the specified QBXML element.
AuthFlags Connection Flags (use for QuickBooks Simple Start).
CodePage The system code page used for Unicode to Multibyte translations (Windows/COM only).
EditSequence An identifier for this copy of the object.
EnforceMaxLength Indicates whether to enforce max lengths for QB Fields
GetHighestVersion Highest QBXMLVersion supported by the installed instance of Quickbooks.
IgnoreQBOEWarnings Ignores warnings returned from QuickBooks Online.
SSLAcceptServerCert The SSL certificate being used by the Remote Connector
SSLAcceptServerCertFile The SSL certificate file being used by the Remote Connector
SendRawXML Sends specified XML to quickbooks without modification.
TimeCreated The time the object was created.
TimeModified The time the object was created.

| About | Privacy Policy | Terms of Use |
© Copyright 2008 /n software inc.