Deposit Component
Properties Methods Events Configuration Settings Errors
A Deposit is used to record and query deposits to an account.
Syntax
nsoftware.InQB.Deposit
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
Example
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" 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. |
| DepositLineItems | Collection of line items associated with this deposit. |
| 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. |
| 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. |
| 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. |
| ImportQBXML | Imports a QBXML response aggregate. |
| 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. |
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. |
| 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. |