Deposit Class

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

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.

Method List

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

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.

Config Settings

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

CashBackAccountId Property (Deposit Class)

Reference to the bank or credit card company.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCashBackAccountId();
int SetCashBackAccountId(const char* lpszCashBackAccountId);

Unicode (Windows)
LPWSTR GetCashBackAccountId();
INT SetCashBackAccountId(LPCWSTR lpszCashBackAccountId);

char* inqb_deposit_getcashbackaccountid(void* lpObj);
int inqb_deposit_setcashbackaccountid(void* lpObj, const char* lpszCashBackAccountId);

QString GetCashBackAccountId();
int SetCashBackAccountId(QString qsCashBackAccountId);

Default Value

""

Remarks

Id of the account into which the CashBackAmount is deposited. Id/Name Reference Properties

This property is used to reference an object that is already done within QuickBooks. This may be done with its Id (this property) or its full Name, for which a corresponding property is defined.

Using the Id is recommended when feasible, as the Id is guaranteed to never change once defined.

Setting the value of this property will set the corresponding Name property to an empty string.

Data Type

String

CashBackAccountName Property (Deposit Class)

Reference to the bank or credit card company.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCashBackAccountName();
int SetCashBackAccountName(const char* lpszCashBackAccountName);

Unicode (Windows)
LPWSTR GetCashBackAccountName();
INT SetCashBackAccountName(LPCWSTR lpszCashBackAccountName);

char* inqb_deposit_getcashbackaccountname(void* lpObj);
int inqb_deposit_setcashbackaccountname(void* lpObj, const char* lpszCashBackAccountName);

QString GetCashBackAccountName();
int SetCashBackAccountName(QString qsCashBackAccountName);

Default Value

""

Remarks

Name of the account into which the CashBackAmount is deposited. Name/Id Reference Properties

This property is used to reference an object that is already done within QuickBooks. This may be done with its full Name (this property) or its Id, for which a corresponding property is defined. If Name is used, it must contain the full name of the object referred to, as generated by QuickBooks. For hierarchically defined objects, such as Customers, this includes the names of parent objects, and the full name can be determined by reading the FullName special field.

Setting the value of this property will set the corresponding Id property to an empty string.

Data Type

String

CashBackAmount Property (Deposit Class)

Cash Back Amount.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCashBackAmount();
int SetCashBackAmount(const char* lpszCashBackAmount);

Unicode (Windows)
LPWSTR GetCashBackAmount();
INT SetCashBackAmount(LPCWSTR lpszCashBackAmount);

char* inqb_deposit_getcashbackamount(void* lpObj);
int inqb_deposit_setcashbackamount(void* lpObj, const char* lpszCashBackAmount);

QString GetCashBackAmount();
int SetCashBackAmount(QString qsCashBackAmount);

Default Value

""

Remarks

Amount of cash received (if any) for this deposit. The amount should be formatted as a string in dollars.

Data Type

String

CashBackId Property (Deposit Class)

Id of the cash back transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCashBackId();

Unicode (Windows)
LPWSTR GetCashBackId();

char* inqb_deposit_getcashbackid(void* lpObj);

QString GetCashBackId();

Default Value

""

Remarks

Identification number of the cash back transaction.

This property is read-only.

Data Type

String

CashBackMemo Property (Deposit Class)

Additional info for the cash back transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCashBackMemo();
int SetCashBackMemo(const char* lpszCashBackMemo);

Unicode (Windows)
LPWSTR GetCashBackMemo();
INT SetCashBackMemo(LPCWSTR lpszCashBackMemo);

char* inqb_deposit_getcashbackmemo(void* lpObj);
int inqb_deposit_setcashbackmemo(void* lpObj, const char* lpszCashBackMemo);

QString GetCashBackMemo();
int SetCashBackMemo(QString qsCashBackMemo);

Default Value

""

Remarks

This property may contain any additional information describing the cash back portion of this transaction.

Data Type

String

DepositLineCount Property (Deposit Class)

The number of records in the DepositLine arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetDepositLineCount();
int SetDepositLineCount(int iDepositLineCount);

Unicode (Windows)
INT GetDepositLineCount();
INT SetDepositLineCount(INT iDepositLineCount);

int inqb_deposit_getdepositlinecount(void* lpObj);
int inqb_deposit_setdepositlinecount(void* lpObj, int iDepositLineCount);

int GetDepositLineCount();
int SetDepositLineCount(int iDepositLineCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• DepositLineAccountId
• DepositLineAccountName
• DepositLineAmount
• DepositLineCheckNumber
• DepositLineClassId
• DepositLineClassName
• DepositLineEntityId
• DepositLineEntityName
• DepositLineLineId
• DepositLineMemo
• DepositLinePaymentId
• DepositLinePaymentLineId
• DepositLinePaymentMethodId
• DepositLinePaymentMethodName
• DepositLineRefId

The array indices start at 0 and end at DepositLineCount - 1.

This property is not available at design time.

Data Type

Integer

DepositLineAccountId Property (Deposit Class)

A reference to the account to which funds are to be deposited.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDepositLineAccountId(int iDepositLineIndex);
int SetDepositLineAccountId(int iDepositLineIndex, const char* lpszDepositLineAccountId);

Unicode (Windows)
LPWSTR GetDepositLineAccountId(INT iDepositLineIndex);
INT SetDepositLineAccountId(INT iDepositLineIndex, LPCWSTR lpszDepositLineAccountId);

char* inqb_deposit_getdepositlineaccountid(void* lpObj, int depositlineindex);
int inqb_deposit_setdepositlineaccountid(void* lpObj, int depositlineindex, const char* lpszDepositLineAccountId);

QString GetDepositLineAccountId(int iDepositLineIndex);
int SetDepositLineAccountId(int iDepositLineIndex, QString qsDepositLineAccountId);

Default Value

""

Remarks

A reference to the account to which funds are to be deposited. Either DepositLineAccountName or DepositLineAccountId (but not both) may be used to reference the account. For example, DepositLineAccountName might be "Checking".

Id/Name Reference Properties

This property is used to reference an object that is already done within QuickBooks. This may be done with its Id (this property) or its full Name, for which a corresponding property is defined.

Using the Id is recommended when feasible, as the Id is guaranteed to never change once defined.

Setting the value of this property will set the corresponding Name property to an empty string.

The DepositLineIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DepositLineCount property.

This property is not available at design time.

Data Type

String

DepositLineAccountName Property (Deposit Class)

A reference to the account to which funds are to be deposited.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDepositLineAccountName(int iDepositLineIndex);
int SetDepositLineAccountName(int iDepositLineIndex, const char* lpszDepositLineAccountName);

Unicode (Windows)
LPWSTR GetDepositLineAccountName(INT iDepositLineIndex);
INT SetDepositLineAccountName(INT iDepositLineIndex, LPCWSTR lpszDepositLineAccountName);

char* inqb_deposit_getdepositlineaccountname(void* lpObj, int depositlineindex);
int inqb_deposit_setdepositlineaccountname(void* lpObj, int depositlineindex, const char* lpszDepositLineAccountName);

QString GetDepositLineAccountName(int iDepositLineIndex);
int SetDepositLineAccountName(int iDepositLineIndex, QString qsDepositLineAccountName);

Default Value

""

Remarks

A reference to the account to which funds are to be deposited. Either DepositLineAccountName or DepositLineAccountId (but not both) may be used to reference the account. For example, DepositLineAccountName might be "Checking".

Id/Name Reference Properties

This property is used to reference an object that is already done within QuickBooks. This may be done with its Id (this property) or its full Name, for which a corresponding property is defined.

Using the Id is recommended when feasible, as the Id is guaranteed to never change once defined.

Setting the value of this property will set the corresponding Name property to an empty string.

The DepositLineIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DepositLineCount property.

This property is not available at design time.

Data Type

String

DepositLineAmount Property (Deposit Class)

The total amount of this deposit line item.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDepositLineAmount(int iDepositLineIndex);
int SetDepositLineAmount(int iDepositLineIndex, const char* lpszDepositLineAmount);

Unicode (Windows)
LPWSTR GetDepositLineAmount(INT iDepositLineIndex);
INT SetDepositLineAmount(INT iDepositLineIndex, LPCWSTR lpszDepositLineAmount);

char* inqb_deposit_getdepositlineamount(void* lpObj, int depositlineindex);
int inqb_deposit_setdepositlineamount(void* lpObj, int depositlineindex, const char* lpszDepositLineAmount);

QString GetDepositLineAmount(int iDepositLineIndex);
int SetDepositLineAmount(int iDepositLineIndex, QString qsDepositLineAmount);

Default Value

""

Remarks

The total amount of this deposit line item. This should be a positive number.

The amount should be formatted as a string in dollars.

The DepositLineIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DepositLineCount property.

This property is not available at design time.

Data Type

String

DepositLineCheckNumber Property (Deposit Class)

Optional check number for this deposit line item.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDepositLineCheckNumber(int iDepositLineIndex);
int SetDepositLineCheckNumber(int iDepositLineIndex, const char* lpszDepositLineCheckNumber);

Unicode (Windows)
LPWSTR GetDepositLineCheckNumber(INT iDepositLineIndex);
INT SetDepositLineCheckNumber(INT iDepositLineIndex, LPCWSTR lpszDepositLineCheckNumber);

char* inqb_deposit_getdepositlinechecknumber(void* lpObj, int depositlineindex);
int inqb_deposit_setdepositlinechecknumber(void* lpObj, int depositlineindex, const char* lpszDepositLineCheckNumber);

QString GetDepositLineCheckNumber(int iDepositLineIndex);
int SetDepositLineCheckNumber(int iDepositLineIndex, QString qsDepositLineCheckNumber);

Default Value

""

Remarks

Optional check number for this deposit line item.

If the source of funds for this deposit line item is a check, this property should contain the check number. Otherwise it should be left blank.

The DepositLineIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DepositLineCount property.

This property is not available at design time.

Data Type

String

DepositLineClassId Property (Deposit Class)

Specifies the class of the deposit line item ClassName or ClassId may reference to the class of this deposit.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDepositLineClassId(int iDepositLineIndex);
int SetDepositLineClassId(int iDepositLineIndex, const char* lpszDepositLineClassId);

Unicode (Windows)
LPWSTR GetDepositLineClassId(INT iDepositLineIndex);
INT SetDepositLineClassId(INT iDepositLineIndex, LPCWSTR lpszDepositLineClassId);

char* inqb_deposit_getdepositlineclassid(void* lpObj, int depositlineindex);
int inqb_deposit_setdepositlineclassid(void* lpObj, int depositlineindex, const char* lpszDepositLineClassId);

QString GetDepositLineClassId(int iDepositLineIndex);
int SetDepositLineClassId(int iDepositLineIndex, QString qsDepositLineClassId);

Default Value

""

Remarks

Specifies the class of the deposit line item

DepositLineClassName or DepositLineClassId may reference to the class of this deposit. This is only used if class tracking is being done with the QuickBooks company.

Name/Id Reference Properties

This property is used to reference an object that is already done within QuickBooks. This may be done with its full Name (this property) or its Id, for which a corresponding property is defined. If Name is used, it must contain the full name of the object referred to, as generated by QuickBooks. For hierarchically defined objects, such as Customers, this includes the names of parent objects, and the full name can be determined by reading the FullName special field.

Setting the value of this property will set the corresponding Id property to an empty string.

The DepositLineIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DepositLineCount property.

This property is not available at design time.

Data Type

String

DepositLineClassName Property (Deposit Class)

Specifies the class of the deposit line item ClassName or ClassId may reference to the class of this deposit.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDepositLineClassName(int iDepositLineIndex);
int SetDepositLineClassName(int iDepositLineIndex, const char* lpszDepositLineClassName);

Unicode (Windows)
LPWSTR GetDepositLineClassName(INT iDepositLineIndex);
INT SetDepositLineClassName(INT iDepositLineIndex, LPCWSTR lpszDepositLineClassName);

char* inqb_deposit_getdepositlineclassname(void* lpObj, int depositlineindex);
int inqb_deposit_setdepositlineclassname(void* lpObj, int depositlineindex, const char* lpszDepositLineClassName);

QString GetDepositLineClassName(int iDepositLineIndex);
int SetDepositLineClassName(int iDepositLineIndex, QString qsDepositLineClassName);

Default Value

""

Remarks

Specifies the class of the deposit line item

DepositLineClassName or DepositLineClassId may reference to the class of this deposit. This is only used if class tracking is being done with the QuickBooks company.

Name/Id Reference Properties

This property is used to reference an object that is already done within QuickBooks. This may be done with its full Name (this property) or its Id, for which a corresponding property is defined. If Name is used, it must contain the full name of the object referred to, as generated by QuickBooks. For hierarchically defined objects, such as Customers, this includes the names of parent objects, and the full name can be determined by reading the FullName special field.

Setting the value of this property will set the corresponding Id property to an empty string.

The DepositLineIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DepositLineCount property.

This property is not available at design time.

Data Type

String

DepositLineEntityId Property (Deposit Class)

An entity Id for this deposit line item.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDepositLineEntityId(int iDepositLineIndex);
int SetDepositLineEntityId(int iDepositLineIndex, const char* lpszDepositLineEntityId);

Unicode (Windows)
LPWSTR GetDepositLineEntityId(INT iDepositLineIndex);
INT SetDepositLineEntityId(INT iDepositLineIndex, LPCWSTR lpszDepositLineEntityId);

char* inqb_deposit_getdepositlineentityid(void* lpObj, int depositlineindex);
int inqb_deposit_setdepositlineentityid(void* lpObj, int depositlineindex, const char* lpszDepositLineEntityId);

QString GetDepositLineEntityId(int iDepositLineIndex);
int SetDepositLineEntityId(int iDepositLineIndex, QString qsDepositLineEntityId);

Default Value

""

Remarks

An entity Id for this deposit line item.

A Deposit Line Entity refers to a Customer, Vendor, Employee, or "Other Name" associated with this deposit line. If a Deposit Line Account is an accounts receivable account, the Entity should refer to a customer. If the Account is an accounts payable account, the Entity should refer to a vendor. Either DepositLineEntityName or DepositLineEntityId (but not both) may be used to specify the Entity.

Id/Name Reference Properties

This property is used to reference an object that is already done within QuickBooks. This may be done with its Id (this property) or its full Name, for which a corresponding property is defined.

Using the Id is recommended when feasible, as the Id is guaranteed to never change once defined.

Setting the value of this property will set the corresponding Name property to an empty string.

The DepositLineIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DepositLineCount property.

This property is not available at design time.

Data Type

String

DepositLineEntityName Property (Deposit Class)

An entity name for this deposit line item.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDepositLineEntityName(int iDepositLineIndex);
int SetDepositLineEntityName(int iDepositLineIndex, const char* lpszDepositLineEntityName);

Unicode (Windows)
LPWSTR GetDepositLineEntityName(INT iDepositLineIndex);
INT SetDepositLineEntityName(INT iDepositLineIndex, LPCWSTR lpszDepositLineEntityName);

char* inqb_deposit_getdepositlineentityname(void* lpObj, int depositlineindex);
int inqb_deposit_setdepositlineentityname(void* lpObj, int depositlineindex, const char* lpszDepositLineEntityName);

QString GetDepositLineEntityName(int iDepositLineIndex);
int SetDepositLineEntityName(int iDepositLineIndex, QString qsDepositLineEntityName);

Default Value

""

Remarks

An entity name for this deposit line item.

A Deposit Line Entity refers to a Customer, Vendor, Employee, or "Other Name" associated with this deposit line. If a Deposit Line Account is an accounts receivable account, the Entity should refer to a customer. If the Account is an accounts payable account, the Entity should refer to a vendor. Either DepositLineEntityName or DepositLineEntityId (but not both) may be used to specify the Entity.

Id/Name Reference Properties

This property is used to reference an object that is already done within QuickBooks. This may be done with its Id (this property) or its full Name, for which a corresponding property is defined.

Using the Id is recommended when feasible, as the Id is guaranteed to never change once defined.

Setting the value of this property will set the corresponding Name property to an empty string.

The DepositLineIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DepositLineCount property.

This property is not available at design time.

Data Type

String

DepositLineLineId Property (Deposit Class)

Identification number of the deposit line, used for Updates.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDepositLineLineId(int iDepositLineIndex);
int SetDepositLineLineId(int iDepositLineIndex, const char* lpszDepositLineLineId);

Unicode (Windows)
LPWSTR GetDepositLineLineId(INT iDepositLineIndex);
INT SetDepositLineLineId(INT iDepositLineIndex, LPCWSTR lpszDepositLineLineId);

char* inqb_deposit_getdepositlinelineid(void* lpObj, int depositlineindex);
int inqb_deposit_setdepositlinelineid(void* lpObj, int depositlineindex, const char* lpszDepositLineLineId);

QString GetDepositLineLineId(int iDepositLineIndex);
int SetDepositLineLineId(int iDepositLineIndex, QString qsDepositLineLineId);

Default Value

""

Remarks

Identification number of the deposit line, used for Updates.

If you need to add a new deposit line in a transaction Update request, you can do so by setting the DepositLineLineId to -1.

The DepositLineIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DepositLineCount property.

This property is not available at design time.

Data Type

String

DepositLineMemo Property (Deposit Class)

A memo for this deposit line.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDepositLineMemo(int iDepositLineIndex);
int SetDepositLineMemo(int iDepositLineIndex, const char* lpszDepositLineMemo);

Unicode (Windows)
LPWSTR GetDepositLineMemo(INT iDepositLineIndex);
INT SetDepositLineMemo(INT iDepositLineIndex, LPCWSTR lpszDepositLineMemo);

char* inqb_deposit_getdepositlinememo(void* lpObj, int depositlineindex);
int inqb_deposit_setdepositlinememo(void* lpObj, int depositlineindex, const char* lpszDepositLineMemo);

QString GetDepositLineMemo(int iDepositLineIndex);
int SetDepositLineMemo(int iDepositLineIndex, QString qsDepositLineMemo);

Default Value

""

Remarks

A memo for this deposit line.

The DepositLineIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DepositLineCount property.

This property is not available at design time.

Data Type

String

DepositLinePaymentId Property (Deposit Class)

The PaymentTxnId for this deposit line item For any given deposit there are many line items properties, such as AccountId , PaymentMethodId , Amount , etc.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDepositLinePaymentId(int iDepositLineIndex);
int SetDepositLinePaymentId(int iDepositLineIndex, const char* lpszDepositLinePaymentId);

Unicode (Windows)
LPWSTR GetDepositLinePaymentId(INT iDepositLineIndex);
INT SetDepositLinePaymentId(INT iDepositLineIndex, LPCWSTR lpszDepositLinePaymentId);

char* inqb_deposit_getdepositlinepaymentid(void* lpObj, int depositlineindex);
int inqb_deposit_setdepositlinepaymentid(void* lpObj, int depositlineindex, const char* lpszDepositLinePaymentId);

QString GetDepositLinePaymentId(int iDepositLineIndex);
int SetDepositLinePaymentId(int iDepositLineIndex, QString qsDepositLinePaymentId);

Default Value

""

Remarks

The PaymentTxnId for this deposit line item

For any given deposit there are many line items properties, such as DepositLineAccountId, DepositLinePaymentMethodId, DepositLineAmount, etc. All of these properties may be replaced by referencing a transaction already stored in quickbooks. Just set the DepositLinePaymentId property, and no other Deposit Line Item properties need be set.

When this property is set, you may also specify a DepositLinePaymentLineId to indicate which payment line in the transaction referenced by DepositLinePaymentId is to be added. If specified, the DepositLineMemo, DepositLineCheckNumber, and DepositLineClassName/DepositLineClassId properties will override those from the original transaction. All other properties are ignored when DepositLinePaymentId has a value.

The DepositLineIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DepositLineCount property.

This property is not available at design time.

Data Type

String

DepositLinePaymentLineId Property (Deposit Class)

The 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.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDepositLinePaymentLineId(int iDepositLineIndex);
int SetDepositLinePaymentLineId(int iDepositLineIndex, const char* lpszDepositLinePaymentLineId);

Unicode (Windows)
LPWSTR GetDepositLinePaymentLineId(INT iDepositLineIndex);
INT SetDepositLinePaymentLineId(INT iDepositLineIndex, LPCWSTR lpszDepositLinePaymentLineId);

char* inqb_deposit_getdepositlinepaymentlineid(void* lpObj, int depositlineindex);
int inqb_deposit_setdepositlinepaymentlineid(void* lpObj, int depositlineindex, const char* lpszDepositLinePaymentLineId);

QString GetDepositLinePaymentLineId(int iDepositLineIndex);
int SetDepositLinePaymentLineId(int iDepositLineIndex, QString qsDepositLinePaymentLineId);

Default Value

""

Remarks

The 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. If you do not include a DepositLinePaymentLineId but do include a DepositLinePaymentId for a transaction that includes payment lines, only the first payment line from that transaction will be deposited.

The DepositLineIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DepositLineCount property.

This property is not available at design time.

Data Type

String

DepositLinePaymentMethodId Property (Deposit Class)

The payment method for this deposit line item.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDepositLinePaymentMethodId(int iDepositLineIndex);
int SetDepositLinePaymentMethodId(int iDepositLineIndex, const char* lpszDepositLinePaymentMethodId);

Unicode (Windows)
LPWSTR GetDepositLinePaymentMethodId(INT iDepositLineIndex);
INT SetDepositLinePaymentMethodId(INT iDepositLineIndex, LPCWSTR lpszDepositLinePaymentMethodId);

char* inqb_deposit_getdepositlinepaymentmethodid(void* lpObj, int depositlineindex);
int inqb_deposit_setdepositlinepaymentmethodid(void* lpObj, int depositlineindex, const char* lpszDepositLinePaymentMethodId);

QString GetDepositLinePaymentMethodId(int iDepositLineIndex);
int SetDepositLinePaymentMethodId(int iDepositLineIndex, QString qsDepositLinePaymentMethodId);

Default Value

""

Remarks

The payment method for this deposit line item.

The funding source for this deposit. For example: "cash", "check", or "Master Card". Id/Name Reference Properties

This property is used to reference an object that is already done within QuickBooks. This may be done with its Id (this property) or its full Name, for which a corresponding property is defined.

Using the Id is recommended when feasible, as the Id is guaranteed to never change once defined.

Setting the value of this property will set the corresponding Name property to an empty string.

The DepositLineIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DepositLineCount property.

This property is not available at design time.

Data Type

String

DepositLinePaymentMethodName Property (Deposit Class)

The payment method (funding source) for this deposit line item.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDepositLinePaymentMethodName(int iDepositLineIndex);
int SetDepositLinePaymentMethodName(int iDepositLineIndex, const char* lpszDepositLinePaymentMethodName);

Unicode (Windows)
LPWSTR GetDepositLinePaymentMethodName(INT iDepositLineIndex);
INT SetDepositLinePaymentMethodName(INT iDepositLineIndex, LPCWSTR lpszDepositLinePaymentMethodName);

char* inqb_deposit_getdepositlinepaymentmethodname(void* lpObj, int depositlineindex);
int inqb_deposit_setdepositlinepaymentmethodname(void* lpObj, int depositlineindex, const char* lpszDepositLinePaymentMethodName);

QString GetDepositLinePaymentMethodName(int iDepositLineIndex);
int SetDepositLinePaymentMethodName(int iDepositLineIndex, QString qsDepositLinePaymentMethodName);

Default Value

""

Remarks

The payment method (funding source) for this deposit line item. For example: "cash", "check", or "Master Card". Name/Id Reference Properties

This property is used to reference an object that is already done within QuickBooks. This may be done with its full Name (this property) or its Id, for which a corresponding property is defined. If Name is used, it must contain the full name of the object referred to, as generated by QuickBooks. For hierarchically defined objects, such as Customers, this includes the names of parent objects, and the full name can be determined by reading the FullName special field.

Setting the value of this property will set the corresponding Id property to an empty string.

The DepositLineIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DepositLineCount property.

This property is not available at design time.

Data Type

String

DepositLineRefId Property (Deposit Class)

Identification number of the transaction associated with this deposit line.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDepositLineRefId(int iDepositLineIndex);

Unicode (Windows)
LPWSTR GetDepositLineRefId(INT iDepositLineIndex);

char* inqb_deposit_getdepositlinerefid(void* lpObj, int depositlineindex);

QString GetDepositLineRefId(int iDepositLineIndex);

Default Value

""

Remarks

Identification number of the transaction associated with this deposit line.

The DepositLineIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DepositLineCount property.

This property is read-only and not available at design time.

Data Type

String

DepositToAccountId Property (Deposit Class)

Account to deposit funds to.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDepositToAccountId();
int SetDepositToAccountId(const char* lpszDepositToAccountId);

Unicode (Windows)
LPWSTR GetDepositToAccountId();
INT SetDepositToAccountId(LPCWSTR lpszDepositToAccountId);

char* inqb_deposit_getdeposittoaccountid(void* lpObj);
int inqb_deposit_setdeposittoaccountid(void* lpObj, const char* lpszDepositToAccountId);

QString GetDepositToAccountId();
int SetDepositToAccountId(QString qsDepositToAccountId);

Default Value

""

Remarks

Refers to the account where these funds will be (or have been) deposited. Id/Name Reference Properties

This property is used to reference an object that is already done within QuickBooks. This may be done with its Id (this property) or its full Name, for which a corresponding property is defined.

Using the Id is recommended when feasible, as the Id is guaranteed to never change once defined.

Setting the value of this property will set the corresponding Name property to an empty string.

Data Type

String

DepositToAccountName Property (Deposit Class)

Account to deposit funds to.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDepositToAccountName();
int SetDepositToAccountName(const char* lpszDepositToAccountName);

Unicode (Windows)
LPWSTR GetDepositToAccountName();
INT SetDepositToAccountName(LPCWSTR lpszDepositToAccountName);

char* inqb_deposit_getdeposittoaccountname(void* lpObj);
int inqb_deposit_setdeposittoaccountname(void* lpObj, const char* lpszDepositToAccountName);

QString GetDepositToAccountName();
int SetDepositToAccountName(QString qsDepositToAccountName);

Default Value

""

Remarks

Refers to the account where these funds will be (or have been) deposited. Name/Id Reference Properties

This property is used to reference an object that is already done within QuickBooks. This may be done with its full Name (this property) or its Id, for which a corresponding property is defined. If Name is used, it must contain the full name of the object referred to, as generated by QuickBooks. For hierarchically defined objects, such as Customers, this includes the names of parent objects, and the full name can be determined by reading the FullName special field.

Setting the value of this property will set the corresponding Id property to an empty string.

Data Type

String

Memo Property (Deposit Class)

Memo to appear on internal reports only.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMemo();
int SetMemo(const char* lpszMemo);

Unicode (Windows)
LPWSTR GetMemo();
INT SetMemo(LPCWSTR lpszMemo);

char* inqb_deposit_getmemo(void* lpObj);
int inqb_deposit_setmemo(void* lpObj, const char* lpszMemo);

QString GetMemo();
int SetMemo(QString qsMemo);

Default Value

""

Remarks

A memo to appear on internal reports. Will not appear to customers, vendors, etc.

Data Type

String

QBConnectionString Property (Deposit Class)

An aggregate consisting of various QuickBooks connection properties.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetQBConnectionString();
int SetQBConnectionString(const char* lpszQBConnectionString);

Unicode (Windows)
LPWSTR GetQBConnectionString();
INT SetQBConnectionString(LPCWSTR lpszQBConnectionString);

char* inqb_deposit_getqbconnectionstring(void* lpObj);
int inqb_deposit_setqbconnectionstring(void* lpObj, const char* lpszQBConnectionString);

QString GetQBConnectionString();
int SetQBConnectionString(QString qsQBConnectionString);

Default Value

""

Remarks

QBConnectionString allows the user to customize the application's interaction with QuickBooks.

The connection properties should be formatted in a sequence as follows:

propertyname = "propertyvalue" propertyname = "propertyvalue" ...

The order is irrelevant, and the whitespace around the equal sign is optional.

The following properties are currently supported:

Data Type

String

QBRequestAggregate Property (Deposit Class)

The request aggregate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetQBRequestAggregate();
int SetQBRequestAggregate(const char* lpszQBRequestAggregate);

Unicode (Windows)
LPWSTR GetQBRequestAggregate();
INT SetQBRequestAggregate(LPCWSTR lpszQBRequestAggregate);

char* inqb_deposit_getqbrequestaggregate(void* lpObj);
int inqb_deposit_setqbrequestaggregate(void* lpObj, const char* lpszQBRequestAggregate);

QString GetQBRequestAggregate();
int SetQBRequestAggregate(QString qsQBRequestAggregate);

Default Value

""

Remarks

This property will be populated when QBRequestMode is set to rmOffline and a method is called. This is used when working with the QBWCServer class to generate requests to be sent to QuickBooks Web Connector.

This property is not available at design time.

Data Type

String

QBRequestId Property (Deposit Class)

The Id of the next message to be sent to QuickBooks.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetQBRequestId();
int SetQBRequestId(const char* lpszQBRequestId);

Unicode (Windows)
LPWSTR GetQBRequestId();
INT SetQBRequestId(LPCWSTR lpszQBRequestId);

char* inqb_deposit_getqbrequestid(void* lpObj);
int inqb_deposit_setqbrequestid(void* lpObj, const char* lpszQBRequestId);

QString GetQBRequestId();
int SetQBRequestId(QString qsQBRequestId);

Default Value

""

Remarks

The next message Id to be sent to QuickBooks. Message Id's are used by CheckRequestStatus to check on the status of previously made requests.

This property allows the user to determine whether a previous request was successfully processed by QuickBooks. Ordinarily QuickBooks either processes requests successfully or returns an error, but in the event of a power outage or other system failure, QuickBooks might or might not have time to process a request before issuing a response.

QuickBooks stores internally a list of QBRequestIds for which it has processed a request, and updated its internal state accordingly. Use of this property in conjunction with CheckRequestStatus allows the user to query this internal list.

To enable error recovery, the user application should store the value of QBRequestId before submitting a request to QuickBooks. If a system failure occurs, CheckRequestStatus should be called with this value of QBRequestId to find whether the request was processed before the system failed.

Unique values for QBRequestId will be generated on startup and after each request to QuickBooks. The automatically generated value may be overwritten by the user. Error checking may be turned off by setting QBRequestId equal to the empty string. See CheckRequestStatus for more information on error recovery.

This property is not available at design time.

Data Type

String

QBRequestMode Property (Deposit Class)

Defines whether the request is made online or stored offline.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetQBRequestMode();
int SetQBRequestMode(int iQBRequestMode);

Unicode (Windows)
INT GetQBRequestMode();
INT SetQBRequestMode(INT iQBRequestMode);

RM_ONLINE(0), 
RM_OFFLINE(1)

int inqb_deposit_getqbrequestmode(void* lpObj);
int inqb_deposit_setqbrequestmode(void* lpObj, int iQBRequestMode);

int GetQBRequestMode();
int SetQBRequestMode(int iQBRequestMode);

Default Value

0

Remarks

This property defines the behavior of the class when calling a method. Possible values are:

The use of offline mode is required when using the QBWCServer class. This allows requests to be generated and passed to QuickBooks Web Connector through the QBWCServer class.

For normal communication to QuickBooks either directly or through the QBConnector application use the default online mode.

Data Type

Integer

QBResponseAggregate Property (Deposit Class)

The last QBXML response aggregate received from QuickBooks.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetQBResponseAggregate();
int SetQBResponseAggregate(const char* lpszQBResponseAggregate);

Unicode (Windows)
LPWSTR GetQBResponseAggregate();
INT SetQBResponseAggregate(LPCWSTR lpszQBResponseAggregate);

char* inqb_deposit_getqbresponseaggregate(void* lpObj);
int inqb_deposit_setqbresponseaggregate(void* lpObj, const char* lpszQBResponseAggregate);

QString GetQBResponseAggregate();
int SetQBResponseAggregate(QString qsQBResponseAggregate);

Default Value

""

Remarks

The last QBXML response aggregate received from QuickBooks. This property is set whenever a response is received from QuickBooks.

This property may also be set to a response aggregate. When set to a QBXML aggregate, such as a response from ObjSearch or QBWCServer the class will parse the response as if it had been received directly from QuickBooks and the applicable properties will be updated.

This property is not available at design time.

Data Type

String

QBXMLVersion Property (Deposit Class)

The version of QBXML used in the outgoing message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetQBXMLVersion();
int SetQBXMLVersion(const char* lpszQBXMLVersion);

Unicode (Windows)
LPWSTR GetQBXMLVersion();
INT SetQBXMLVersion(LPCWSTR lpszQBXMLVersion);

char* inqb_deposit_getqbxmlversion(void* lpObj);
int inqb_deposit_setqbxmlversion(void* lpObj, const char* lpszQBXMLVersion);

QString GetQBXMLVersion();
int SetQBXMLVersion(QString qsQBXMLVersion);

Default Value

"3.0"

Remarks

The version of QBXML used in the outgoing message. Except as noted in the documentation, a value of "1.1" will suffice for all requests, and for all versions of QuickBooks which support integrated applications.

With each release of QuickBooks since 2002, a corresponding version of the QuickBooks SDK has also been released: 1.0 for QuickBooks 2002, 2.0 for QuickBooks 2003, 3.0 for QuickBooks 2004, etc., up to 8.0 for QuickBooks 2009. In addition, each release of QuickBooks continues to support all earlier versions of the SDK, meaning that requests using version 1.1 of the QuickBooks SDK are supported by all versions of QuickBooks. However, new requests and newer fields in existing requests are only supported in later versions of the QuickBooks SDK. As such, it is recommended that you set the QBXMLVersion property to correspond to the version of QuickBooks you are interacting with. These values are:

In addition, versions of QuickBooks outside of the U.S. released before Quickbooks 2008 adhere to a different version of the QuickBooks SDK. These versions were updated with less frequency than the U.S. SDK, and may omit features introduced in later releases:

With the exception of Province in Address (set State) or EligibleForT4A in Vendor (set EligibleFor1099), Canadian-only fields are read-only and may be accessed with Config.

This property is not available at design time.

Data Type

String

RefId Property (Deposit Class)

An alphanumerical identifier generated by the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRefId();

Unicode (Windows)
LPWSTR GetRefId();

char* inqb_deposit_getrefid(void* lpObj);

QString GetRefId();

Default Value

""

Remarks

An Id is an alphanumerical identifier assigned by the server whenever an object is added to QuickBooks. It is guaranteed to be unique across all objects of the same type.

This property is read-only and not available at design time.

Data Type

String

TotalDeposit Property (Deposit Class)

The total of the deposit.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTotalDeposit();

Unicode (Windows)
LPWSTR GetTotalDeposit();

char* inqb_deposit_gettotaldeposit(void* lpObj);

QString GetTotalDeposit();

Default Value

""

Remarks

The total amount of the Deposit, as calculated by QuickBooks and returned. It will be equal to the sum of all the DepositLineAmounts.

The amount should be formatted as a string in dollars.

This property is read-only.

Data Type

String

TransactionDate Property (Deposit Class)

Date of transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTransactionDate();
int SetTransactionDate(const char* lpszTransactionDate);

Unicode (Windows)
LPWSTR GetTransactionDate();
INT SetTransactionDate(LPCWSTR lpszTransactionDate);

char* inqb_deposit_gettransactiondate(void* lpObj);
int inqb_deposit_settransactiondate(void* lpObj, const char* lpszTransactionDate);

QString GetTransactionDate();
int SetTransactionDate(QString qsTransactionDate);

Default Value

""

Remarks

The date of the transaction.

The standard formatting for dates is YYYY-MM-DD; i.e., September 2, 2002 is formatted as 2002-09-02. When getting the value of a date property, the date will always be in this format.

When setting the value of a date property, the formats MM-DD-YY, MM-DD-YYYY, MM/DD/YY, and MM/DD/YYYY are also acceptable. Dates in these formats will be automatically parsed and stored in YYYY-MM-DD format.

This property is required in Accounts Payable (Bill and VendorCredit) transactions. In other kinds of transactions this property is optional.

Data Type

String

Add Method (Deposit Class)

Adds the record into QuickBooks.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Add();

Unicode (Windows)
INT Add();

int inqb_deposit_add(void* lpObj);

int Add();

Remarks

Add is used to add the object to QuickBooks.

If QuickBooks is able to add the object, it will return a copy of the object, and the values of all properties will be reset from the QuickBooks response. The QBResponseAggregate property will also be set to the entire QBXML aggregate received from QuickBooks.

For example, read-only properties such as RefIds will be assigned. In transaction objects, line item information will be filled out, and ItemGroups will be broken up into their respective Items. Also, a total will be calculated.

If QuickBooks is not able to add the object, a trappable error will occur.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Cancel Method (Deposit Class)

Cancels (voids) the transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Cancel();

Unicode (Windows)
INT Cancel();

int inqb_deposit_cancel(void* lpObj);

int Cancel();

Remarks

Cancel causes the transaction to be voided in QuickBooks. The amount of the transaction and all line item quantities are changed to zero, and the memo is changed to "VOID:". The transaction will not, however, be deleted.

The transaction canceled in QuickBooks is the one specified by RefId. If the value of RefId is known then Get should first be called to retrieve the transaction. Otherwise the ObjSearch class should be used to search for the desired transaction in the QuickBooks database.

As the QuickBooks response to Cancel does not include the updated transaction, the values of all properties are instead set to their defaults. To get a copy of the updated transaction, the value of RefId should first be stored, and then Get should be called.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

CheckRequestStatus Method (Deposit Class)

Checks whether or not the specified request was processed by QuickBooks.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* CheckRequestStatus(const char* lpszRequestId);

Unicode (Windows)
LPWSTR CheckRequestStatus(LPCWSTR lpszRequestId);

char* inqb_deposit_checkrequeststatus(void* lpObj, const char* lpszRequestId);

QString CheckRequestStatus(const QString& qsRequestId);

Remarks

This method allows the user to determine whether a previous request was successfully processed by QuickBooks. Ordinarily QuickBooks either processes requests successfully or returns an error, but in the event of a power outage or other system failure, QuickBooks might or might not have time to process a request before issuing a response.

QuickBooks stores internally a list of QBRequestIds for which it has processed a request, and updated its internal state accordingly. Use of this method allows the user to query the list for any RequestId whose value is known.

The method returns a string corresponding to the result of the query. If the request was processed successfully, an empty string ("") will be returned. If the request was not processed, the string "Request not processed." will be returned. If the request was processed but an error occurred, a string containing the error code and a description will be returned; for example, "801: A QuickBooks internal error has occurred."

See QBRequestId for more information on error recovery.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

CloseQBConnection Method (Deposit Class)

Closes a persistent connection to QuickBooks.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int CloseQBConnection();

Unicode (Windows)
INT CloseQBConnection();

int inqb_deposit_closeqbconnection(void* lpObj);

int CloseQBConnection();

Remarks

Invoking CloseQBConnection closes the QuickBooks connection specified in QBConnectionString. After the connection has been closed, the class will revert to its default behavior, and a new connection will be established for each request until QBConnectionString is invoked again.

In case the connection is already closed invoking CloseQBConnection will have no effect. Moreover, if multiple connections are open CloseQBConnection will only close the connection specified in QBConnectionString.

Be sure to always invoke this method after calling OpenQBConnection.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Config Method (Deposit Class)

Sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* inqb_deposit_config(void* lpObj, const char* lpszConfigurationString);

QString Config(const QString& qsConfigurationString);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

Delete Method (Deposit Class)

Deletes the record from QuickBooks.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Delete();

Unicode (Windows)
INT Delete();

int inqb_deposit_delete(void* lpObj);

int Delete();

Remarks

Delete causes the object to be deleted in QuickBooks. After this method is called, the values of all fields will be reset to their defaults.

The object deleted in QuickBooks is the one specified by RefId. This read-only property may be assigned either by calling Get or by assigning the value of QBResponseAggregate.

A typical example: Customer.GetByName("John Smith") 'this will assign the RefId Customer.Delete() Deleting entity objects (Customer, Employee, and Vendor) requires that QuickBooks be open in single-user mode. Transaction objects, however, may be deleted while QuickBooks is in any mode.

Use this method with caution, as there is no way to recover deleted objects.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Get Method (Deposit Class)

Gets a single record from QuickBooks.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Get(const char* lpszId);

Unicode (Windows)
INT Get(LPCWSTR lpszId);

int inqb_deposit_get(void* lpObj, const char* lpszId);

int Get(const QString& qsId);

Remarks

Get may be used to retrieve a single object from QuickBooks, based on its RefId. When the method is called, a search will be initiated for the requested object. If it is found, all properties of the class will be set to the information retrieved from QuickBooks. The QBResponseAggregate property will also be set to the entire QBXML aggregate received from QuickBooks.

The RefId of any class, or the Id of any reference property, may be used for the parameter. So for example, the following pseudocode would get customer information for a Customer listed on an Invoice:

Customer.Get( Invoice.CustomerId )

The GetByName method, present only in entity objects (Customer, Vendor, and Employee) and QBObject, may be used to get an object based on its Name. To retrieve multiple objects, to retrieve transaction objects whose RefId is not known, or to perform more advanced searches the ObjSearch class may be used.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

GetCustomField Method (Deposit Class)

Gets a custom field value from QuickBooks.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCustomField(const char* lpszFieldName);

Unicode (Windows)
LPWSTR GetCustomField(LPCWSTR lpszFieldName);

char* inqb_deposit_getcustomfield(void* lpObj, const char* lpszFieldName);

QString GetCustomField(const QString& qsFieldName);

Remarks

This method will get the value of a custom field, which has been defined by the user from within the QuickBooks UI.

To read the values of custom fields, be sure to set QBXMLVersion to at least "2.0" when retrieving data from QuickBooks. Then, QuickBooks will return custom field information, and it will be accessible through this method.

You may also invoke Config to read the value of custom fields. However, to set the value of custom fields you must set QBXMLVersion to at least "3.0" and invoke SetCustomField.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

ImportQBXML Method (Deposit Class)

Imports a QBXML response aggregate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ImportQBXML(const char* lpszXMLData);

Unicode (Windows)
INT ImportQBXML(LPCWSTR lpszXMLData);

int inqb_deposit_importqbxml(void* lpObj, const char* lpszXMLData);

int ImportQBXML(const QString& qsXMLData);

Remarks

This method imports a QBXML response aggregate. When called with a QBXML aggregate, such as a response from ObjSearch or QBWCServer the class will parse the response as if it had been received directly from QuickBooks and the applicable properties will be updated.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

OpenQBConnection Method (Deposit Class)

Opens a persistent connection to QuickBooks.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int OpenQBConnection();

Unicode (Windows)
INT OpenQBConnection();

int inqb_deposit_openqbconnection(void* lpObj);

int OpenQBConnection();

Remarks

Invoking OpenQBConnection will open a persistent connection to QuickBooks. After invoking OpenQBConnection, all requests such as Get, Add, etc. will use the established connection until CloseQBConnection is invoked.

The effect of OpenQBConnection is to increase performance. If OpenQBConnection is not invoked, a connection to QuickBooks will automatically be created and destroyed each time the class communicates with QuickBooks. Using OpenQBConnection will be faster, particularly in the case of automatic login.

After OpenQBConnection is invoked, QuickBooks will issue a connection ticket, and it will be stored in QBConnectionString. When CloseQBConnection is invoked the ticket will be invalidated, and any further attempts to use it will fail.

Be sure to invoke CloseQBConnection when you have finished communicating with QuickBooks. Leaving an open QuickBooks connection may lock out other integrated applications, affect QuickBooks performance, or cause other problems.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Reset Method (Deposit Class)

Resets all properties to their defaults.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int inqb_deposit_reset(void* lpObj);

int Reset();

Remarks

This method resets the values of all properties (and all special fields) to their defaults.

After calling this method, the class may be reused as if it were newly created.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SetCustomField Method (Deposit Class)

Sets a custom field value within QuickBooks.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SetCustomField(const char* lpszFieldName, const char* lpszFieldValue);

Unicode (Windows)
INT SetCustomField(LPCWSTR lpszFieldName, LPCWSTR lpszFieldValue);

int inqb_deposit_setcustomfield(void* lpObj, const char* lpszFieldName, const char* lpszFieldValue);

int SetCustomField(const QString& qsFieldName, const QString& qsFieldValue);

Remarks

This method requires QuickBooks 2004 or above, with QBXMLVersion set to at least "3.0".

This method will immediately set the value of a QuickBooks custom field, which has been defined by the user from within the QuickBooks UI. Before calling this method, the preceding operation must retrieve the object from QuickBooks, using Get, ObjSearch, etc. Then, you may use SetCustomField to set custom field values (the fields will be modified or added, as appropriate).

Note that invoking this method will create a connection to QuickBooks if one is not already in place.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Update Method (Deposit Class)

Updates the bill in QuickBooks.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Update();

Unicode (Windows)
INT Update();

int inqb_deposit_update(void* lpObj);

int Update();

Remarks

This method will update the bill in QuickBooks.

When the method is called, an Update request will be submitted to QuickBooks. The bill will have its information updated based on the various property values.

If QuickBooks is able to update the object, it will return a copy of the object, and the values of all properties will be reset from the QuickBooks response. The QBResponseAggregate property will also be set to the entire QBXML aggregate received from QuickBooks.

QBXMLVersion must be set to "3.0" or greater to update a bill. Moreover, QBXMLVersion should be set to the same value when retrieving the bill from QuickBooks (either through ObjSearch or through the Get method).

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Error Event (Deposit Class)

Information about errors during data delivery.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireError(DepositErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} DepositErrorEventParams;


Unicode (Windows)
virtual INT FireError(DepositErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} DepositErrorEventParams;

#define EID_DEPOSIT_ERROR 1

virtual INT INQB_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

class DepositErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(DepositErrorEventParams *e);

// Or, subclass Deposit and override this emitter function.
virtual int FireError(DepositErrorEventParams *e) {...}

Remarks

The Error event is fired in case of exceptional conditions during message processing.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

SSLServerAuthentication Event (Deposit Class)

Fired after the server presents its certificate to the client.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLServerAuthentication(DepositSSLServerAuthenticationEventParams *e);

typedef struct {
  const char *CertEncoded;
  int lenCertEncoded;
  const char *CertSubject;
  const char *CertIssuer;
  const char *Status;
  int Accept;
  int reserved;
} DepositSSLServerAuthenticationEventParams;


Unicode (Windows)
virtual INT FireSSLServerAuthentication(DepositSSLServerAuthenticationEventParams *e);

typedef struct {
  LPCSTR CertEncoded;
  INT lenCertEncoded;
  LPCWSTR CertSubject;
  LPCWSTR CertIssuer;
  LPCWSTR Status;
  BOOL Accept;
  INT reserved;
} DepositSSLServerAuthenticationEventParams;

#define EID_DEPOSIT_SSLSERVERAUTHENTICATION 2

virtual INT INQB_CALL FireSSLServerAuthentication(LPSTR &lpCertEncoded, INT &lenCertEncoded, LPSTR &lpszCertSubject, LPSTR &lpszCertIssuer, LPSTR &lpszStatus, BOOL &bAccept);

class DepositSSLServerAuthenticationEventParams {
public:
  const QByteArray &CertEncoded();

  const QString &CertSubject();

  const QString &CertIssuer();

  const QString &Status();

  bool Accept();
  void SetAccept(bool bAccept);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLServerAuthentication(DepositSSLServerAuthenticationEventParams *e);

// Or, subclass Deposit and override this emitter function.
virtual int FireSSLServerAuthentication(DepositSSLServerAuthenticationEventParams *e) {...}

Remarks

This event is where the client can decide whether to continue with the connection process or not. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether to continue or not.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string "OK"). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (Deposit Class)

Shows the progress of the secure connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLStatus(DepositSSLStatusEventParams *e);

typedef struct {
  const char *Message;
  int reserved;
} DepositSSLStatusEventParams;


Unicode (Windows)
virtual INT FireSSLStatus(DepositSSLStatusEventParams *e);

typedef struct {
  LPCWSTR Message;
  INT reserved;
} DepositSSLStatusEventParams;

#define EID_DEPOSIT_SSLSTATUS 3

virtual INT INQB_CALL FireSSLStatus(LPSTR &lpszMessage);

class DepositSSLStatusEventParams {
public:
  const QString &Message();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLStatus(DepositSSLStatusEventParams *e);

// Or, subclass Deposit and override this emitter function.
virtual int FireSSLStatus(DepositSSLStatusEventParams *e) {...}

Remarks

The event is fired for informational and logging purposes only. Used to track the progress of the connection.

Status Event (Deposit Class)

Shows the progress of the QuickBooks connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireStatus(DepositStatusEventParams *e);

typedef struct {
  const char *Message;
  int reserved;
} DepositStatusEventParams;


Unicode (Windows)
virtual INT FireStatus(DepositStatusEventParams *e);

typedef struct {
  LPCWSTR Message;
  INT reserved;
} DepositStatusEventParams;

#define EID_DEPOSIT_STATUS 4

virtual INT INQB_CALL FireStatus(LPSTR &lpszMessage);

class DepositStatusEventParams {
public:
  const QString &Message();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Status(DepositStatusEventParams *e);

// Or, subclass Deposit and override this emitter function.
virtual int FireStatus(DepositStatusEventParams *e) {...}

Remarks

The event is fired for informational and logging purposes only. Used to track the progress of the connection.

Warning Event (Deposit Class)

Fired when a warning occurs.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireWarning(DepositWarningEventParams *e);

typedef struct {
  int Code;
  const char *Description;
  int reserved;
} DepositWarningEventParams;


Unicode (Windows)
virtual INT FireWarning(DepositWarningEventParams *e);

typedef struct {
  INT Code;
  LPCWSTR Description;
  INT reserved;
} DepositWarningEventParams;