QuickBooks Integrator 2020 Python Edition

Questions / Feedback?

Deposit Class

Properties   Methods   Events   Configuration Settings   Errors  

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

Syntax

class inqb.Deposit

Remarks

The Deposit class is used to deposit a payment into an existing account. The Deposit class 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.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 class supports a variety of other operations as well. The class's get, cancel, and delete methods may be used to retrieve, cancel, and delete Deposits, respectively. The ObjSearch Class may be used to search for Deposits in the QuickBooks database.

Property List


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

cash_back_account_idReference to the bank or credit card company.
cash_back_account_nameReference to the bank or credit card company.
cash_back_amountCash Back Amount.
cash_back_idId of the cash back transaction.
cash_back_memoAdditional info for the cash back transaction.
deposit_line_countThe number of records in the DepositLine arrays.
deposit_line_account_idA reference to the account to which funds are to be deposited.
deposit_line_account_nameA reference to the account to which funds are to be deposited.
deposit_line_amountThe total amount of this deposit line item.
deposit_line_check_numberOptional check number for this deposit line item.
deposit_line_class_idSpecifies the class of the deposit line item ClassName or ClassId may reference to the class of this deposit.
deposit_line_class_nameSpecifies the class of the deposit line item ClassName or ClassId may reference to the class of this deposit.
deposit_line_entity_idAn entity Id for this deposit line item.
deposit_line_entity_nameAn entity name for this deposit line item.
deposit_line_line_idIdentification number of the deposit line, used for Updates.
deposit_line_memoA memo for this deposit line.
deposit_line_payment_idThe PaymentTxnId for this deposit line item For any given deposit there are many line items properties, such as AccountId , PaymentMethodId , Amount , etc.
deposit_line_payment_line_idThe PaymentTxnLineId for this deposit line item For the PaymentTxnLineID, use a TxnLineID value exactly as it has been returned by the RECEIVEPAYMENT class after a Get.
deposit_line_payment_method_idThe payment method for this deposit line item.
deposit_line_payment_method_nameThe payment method (funding source) for this deposit line item.
deposit_line_ref_idIdentification number of the transaction associated with this deposit line.
deposit_to_account_idAccount to deposit funds to.
deposit_to_account_nameAccount to deposit funds to.
memoMemo to appear on internal reports only.
qb_connection_stringAn aggregate consisting of various QuickBooks connection properties.
qb_request_aggregateThe request aggregate.
qb_request_idThe Id of the next message to be sent to QuickBooks.
qb_request_modeDefines whether the request is made online or stored offline.
qb_response_aggregateThe last QBXML response aggregate received from QuickBooks.
qbxml_versionThe version of QBXML used in the outgoing message.
ref_idAn alphanumerical identifier generated by the server.
total_depositThe total of the deposit.
transaction_dateDate of transaction.

Method List


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

addAdds the record into QuickBooks.
cancelCancels (voids) the transaction.
check_request_statusChecks whether or not the specified request was processed by QuickBooks.
close_qb_connectionCloses a persistent connection to QuickBooks.
configSets or retrieves a configuration setting.
deleteDeletes the record from QuickBooks.
getGets a single record from QuickBooks.
get_custom_fieldGets a custom field value from QuickBooks.
import_qbxmlImports a QBXML response aggregate.
open_qb_connectionOpens a persistent connection to QuickBooks.
resetResets all properties to their defaults.
set_custom_fieldSets 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 class with short descriptions. Click on the links for further details.

on_errorInformation about errors during data delivery.
on_ssl_server_authenticationFired after the server presents its certificate to the client.
on_ssl_statusShows the progress of the secure connection.
on_statusShows the progress of the QuickBooks connection.
on_warningFired when a warning occurs.

Configuration Settings


The following is a list of configuration settings for the class 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 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.
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.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
ProcessIdleEventsWhether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillisThe length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseInternalSecurityAPITells the class whether or not to use the system security libraries or an internal implementation.

Copyright (c) 2021 /n software inc. - All rights reserved.
QuickBooks Integrator 2020 Python Edition - Version 20.0 [Build 7941]