ReceivePayment Class

Properties   Methods   Events   Config Settings   Errors  

The ReceivePayment class is used to receive payments from customers.

Syntax

ReceivePayment

Remarks

The ReceivePayment class allows you to enter customer payments into QuickBooks.

To receive a payment, first enter the name or id of the Customer, and the Amount of the payment. Then, if desired, you may specify additional fields such as PaymentMethod (Name or Id), TransactionDate, RefNumber, and so on. Finally, invoke Add to add the payment to QuickBooks.

By default, QuickBooks will choose appropriate invoices or other transactions to apply the payments to. After invoking Add the AppliedToTransactions special field will provide information about which invoices were paid, whether there is any balance remaining, etc. See the documentation for Config for more information.

Required Fields (Add): Customer*

Supported Methods: Add, Get (Id), Delete

Example ReceivePayment1.CustomerName = "Abercrombie, Kristy" '* ReceivePayment1.Amount = "56.24" '$56.24 ReceivePayment1.Add() '*: Item must already exist in QuickBooks.

The class supports a variety of other operations as well. The class's Get, and Delete methods may be used to retrieve, and delete payments, respectively. The ObjSearch Class may be used to search for ReceivePayments 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.

Amount Property (ReceivePayment Class)

Amount of payment.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAmount();
int SetAmount(const char* lpszAmount);

Unicode (Windows)
LPWSTR GetAmount();
INT SetAmount(LPCWSTR lpszAmount);

char* inqb_receivepayment_getamount(void* lpObj);
int inqb_receivepayment_setamount(void* lpObj, const char* lpszAmount);

QString GetAmount();
int SetAmount(QString qsAmount);

Default Value

"0"

Remarks

The amount of the payment received from the Customer. This property is required.

The amount should be formatted as a string in dollars.

Data Type

String

AppliedToCount Property (ReceivePayment Class)

The number of records in the AppliedTo arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAppliedToCount();
int SetAppliedToCount(int iAppliedToCount);

Unicode (Windows)
INT GetAppliedToCount();
INT SetAppliedToCount(INT iAppliedToCount);

int inqb_receivepayment_getappliedtocount(void* lpObj);
int inqb_receivepayment_setappliedtocount(void* lpObj, int iAppliedToCount);

int GetAppliedToCount();
int SetAppliedToCount(int iAppliedToCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• AppliedToAmount
• AppliedToBalanceRemaining
• AppliedToCreditAppliedAmount
• AppliedToCreditMemoId
• AppliedToDiscountAccountId
• AppliedToDiscountAccountName
• AppliedToDiscountAmount
• AppliedToPaymentAmount
• AppliedToRefId
• AppliedToRefNumber
• AppliedToTxnDate
• AppliedToTxnType

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

This property is not available at design time.

Data Type

Integer

AppliedToAmount Property (ReceivePayment Class)

The amount of the transaction that has just been paid.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAppliedToAmount(int iAppliedToIndex);

Unicode (Windows)
LPWSTR GetAppliedToAmount(INT iAppliedToIndex);

char* inqb_receivepayment_getappliedtoamount(void* lpObj, int appliedtoindex);

QString GetAppliedToAmount(int iAppliedToIndex);

Default Value

""

Remarks

The amount of the transaction that has just been paid.

The AppliedToIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AppliedToCount property.

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

Data Type

String

AppliedToBalanceRemaining Property (ReceivePayment Class)

The outstanding balance that has yet to be paid for the transaction indicated by RefId .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAppliedToBalanceRemaining(int iAppliedToIndex);

Unicode (Windows)
LPWSTR GetAppliedToBalanceRemaining(INT iAppliedToIndex);

char* inqb_receivepayment_getappliedtobalanceremaining(void* lpObj, int appliedtoindex);

QString GetAppliedToBalanceRemaining(int iAppliedToIndex);

Default Value

""

Remarks

The outstanding balance that has yet to be paid for the transaction indicated by AppliedToRefId.

The AppliedToIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AppliedToCount property.

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

Data Type

String

AppliedToCreditAppliedAmount Property (ReceivePayment Class)

Amount of a credit that is applied to a customer's bill.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAppliedToCreditAppliedAmount(int iAppliedToIndex);
int SetAppliedToCreditAppliedAmount(int iAppliedToIndex, const char* lpszAppliedToCreditAppliedAmount);

Unicode (Windows)
LPWSTR GetAppliedToCreditAppliedAmount(INT iAppliedToIndex);
INT SetAppliedToCreditAppliedAmount(INT iAppliedToIndex, LPCWSTR lpszAppliedToCreditAppliedAmount);

char* inqb_receivepayment_getappliedtocreditappliedamount(void* lpObj, int appliedtoindex);
int inqb_receivepayment_setappliedtocreditappliedamount(void* lpObj, int appliedtoindex, const char* lpszAppliedToCreditAppliedAmount);

QString GetAppliedToCreditAppliedAmount(int iAppliedToIndex);
int SetAppliedToCreditAppliedAmount(int iAppliedToIndex, QString qsAppliedToCreditAppliedAmount);

Default Value

""

Remarks

Amount of a credit that is applied to a customer's bill.

The AppliedToIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AppliedToCount property.

This property is not available at design time.

Data Type

String

AppliedToCreditMemoId Property (ReceivePayment Class)

The ID of the credit memo that you are applying to this bill.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAppliedToCreditMemoId(int iAppliedToIndex);
int SetAppliedToCreditMemoId(int iAppliedToIndex, const char* lpszAppliedToCreditMemoId);

Unicode (Windows)
LPWSTR GetAppliedToCreditMemoId(INT iAppliedToIndex);
INT SetAppliedToCreditMemoId(INT iAppliedToIndex, LPCWSTR lpszAppliedToCreditMemoId);

char* inqb_receivepayment_getappliedtocreditmemoid(void* lpObj, int appliedtoindex);
int inqb_receivepayment_setappliedtocreditmemoid(void* lpObj, int appliedtoindex, const char* lpszAppliedToCreditMemoId);

QString GetAppliedToCreditMemoId(int iAppliedToIndex);
int SetAppliedToCreditMemoId(int iAppliedToIndex, QString qsAppliedToCreditMemoId);

Default Value

""

Remarks

The ID of the credit memo that you are applying to this bill.

The AppliedToIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AppliedToCount property.

This property is not available at design time.

Data Type

String

AppliedToDiscountAccountId Property (ReceivePayment Class)

Refers to the account where this discount is tracked.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAppliedToDiscountAccountId(int iAppliedToIndex);
int SetAppliedToDiscountAccountId(int iAppliedToIndex, const char* lpszAppliedToDiscountAccountId);

Unicode (Windows)
LPWSTR GetAppliedToDiscountAccountId(INT iAppliedToIndex);
INT SetAppliedToDiscountAccountId(INT iAppliedToIndex, LPCWSTR lpszAppliedToDiscountAccountId);

char* inqb_receivepayment_getappliedtodiscountaccountid(void* lpObj, int appliedtoindex);
int inqb_receivepayment_setappliedtodiscountaccountid(void* lpObj, int appliedtoindex, const char* lpszAppliedToDiscountAccountId);

QString GetAppliedToDiscountAccountId(int iAppliedToIndex);
int SetAppliedToDiscountAccountId(int iAppliedToIndex, QString qsAppliedToDiscountAccountId);

Default Value

""

Remarks

Refers to the account where this discount is tracked.

The AppliedToIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AppliedToCount property.

This property is not available at design time.

Data Type

String

AppliedToDiscountAccountName Property (ReceivePayment Class)

Refers to the account where this discount is tracked.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAppliedToDiscountAccountName(int iAppliedToIndex);
int SetAppliedToDiscountAccountName(int iAppliedToIndex, const char* lpszAppliedToDiscountAccountName);

Unicode (Windows)
LPWSTR GetAppliedToDiscountAccountName(INT iAppliedToIndex);
INT SetAppliedToDiscountAccountName(INT iAppliedToIndex, LPCWSTR lpszAppliedToDiscountAccountName);

char* inqb_receivepayment_getappliedtodiscountaccountname(void* lpObj, int appliedtoindex);
int inqb_receivepayment_setappliedtodiscountaccountname(void* lpObj, int appliedtoindex, const char* lpszAppliedToDiscountAccountName);

QString GetAppliedToDiscountAccountName(int iAppliedToIndex);
int SetAppliedToDiscountAccountName(int iAppliedToIndex, QString qsAppliedToDiscountAccountName);

Default Value

""

Remarks

Refers to the account where this discount is tracked.

The AppliedToIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AppliedToCount property.

This property is not available at design time.

Data Type

String

AppliedToDiscountAmount Property (ReceivePayment Class)

Reduces the receivable amount.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAppliedToDiscountAmount(int iAppliedToIndex);
int SetAppliedToDiscountAmount(int iAppliedToIndex, const char* lpszAppliedToDiscountAmount);

Unicode (Windows)
LPWSTR GetAppliedToDiscountAmount(INT iAppliedToIndex);
INT SetAppliedToDiscountAmount(INT iAppliedToIndex, LPCWSTR lpszAppliedToDiscountAmount);

char* inqb_receivepayment_getappliedtodiscountamount(void* lpObj, int appliedtoindex);
int inqb_receivepayment_setappliedtodiscountamount(void* lpObj, int appliedtoindex, const char* lpszAppliedToDiscountAmount);

QString GetAppliedToDiscountAmount(int iAppliedToIndex);
int SetAppliedToDiscountAmount(int iAppliedToIndex, QString qsAppliedToDiscountAmount);

Default Value

""

Remarks

Reduces the receivable amount.

The AppliedToIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AppliedToCount property.

This property is not available at design time.

Data Type

String

AppliedToPaymentAmount Property (ReceivePayment Class)

Represents the amount assigned to a particular bill payment.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAppliedToPaymentAmount(int iAppliedToIndex);
int SetAppliedToPaymentAmount(int iAppliedToIndex, const char* lpszAppliedToPaymentAmount);

Unicode (Windows)
LPWSTR GetAppliedToPaymentAmount(INT iAppliedToIndex);
INT SetAppliedToPaymentAmount(INT iAppliedToIndex, LPCWSTR lpszAppliedToPaymentAmount);

char* inqb_receivepayment_getappliedtopaymentamount(void* lpObj, int appliedtoindex);
int inqb_receivepayment_setappliedtopaymentamount(void* lpObj, int appliedtoindex, const char* lpszAppliedToPaymentAmount);

QString GetAppliedToPaymentAmount(int iAppliedToIndex);
int SetAppliedToPaymentAmount(int iAppliedToIndex, QString qsAppliedToPaymentAmount);

Default Value

""

Remarks

Represents the amount assigned to a particular bill payment. The sum of all AppliedToPaymentAmounts in any given transaction must not be greater than the total amount.

Note, if submitting an update and no AppliedToPaymentAmount is specified, the contents of the AppliedToAmount field will be used instead.

The AppliedToIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AppliedToCount property.

This property is not available at design time.

Data Type

String

AppliedToRefId Property (ReceivePayment Class)

Refers to the transaction Id of the bill that is being paid.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAppliedToRefId(int iAppliedToIndex);
int SetAppliedToRefId(int iAppliedToIndex, const char* lpszAppliedToRefId);

Unicode (Windows)
LPWSTR GetAppliedToRefId(INT iAppliedToIndex);
INT SetAppliedToRefId(INT iAppliedToIndex, LPCWSTR lpszAppliedToRefId);

char* inqb_receivepayment_getappliedtorefid(void* lpObj, int appliedtoindex);
int inqb_receivepayment_setappliedtorefid(void* lpObj, int appliedtoindex, const char* lpszAppliedToRefId);

QString GetAppliedToRefId(int iAppliedToIndex);
int SetAppliedToRefId(int iAppliedToIndex, QString qsAppliedToRefId);

Default Value

""

Remarks

Refers to the transaction Id of the bill that is being paid.

The AppliedToIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AppliedToCount property.

This property is not available at design time.

Data Type

String

AppliedToRefNumber Property (ReceivePayment Class)

RefNumber of the transaction that was just paid.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAppliedToRefNumber(int iAppliedToIndex);

Unicode (Windows)
LPWSTR GetAppliedToRefNumber(INT iAppliedToIndex);

char* inqb_receivepayment_getappliedtorefnumber(void* lpObj, int appliedtoindex);

QString GetAppliedToRefNumber(int iAppliedToIndex);

Default Value

""

Remarks

RefNumber of the transaction that was just paid.

The AppliedToIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AppliedToCount property.

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

Data Type

String

AppliedToTxnDate Property (ReceivePayment Class)

Date of the transaction that has just been paid.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAppliedToTxnDate(int iAppliedToIndex);

Unicode (Windows)
LPWSTR GetAppliedToTxnDate(INT iAppliedToIndex);

char* inqb_receivepayment_getappliedtotxndate(void* lpObj, int appliedtoindex);

QString GetAppliedToTxnDate(int iAppliedToIndex);

Default Value

""

Remarks

Date of the transaction that has just been paid.

The AppliedToIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AppliedToCount property.

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

Data Type

String

AppliedToTxnType Property (ReceivePayment Class)

The type of the transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAppliedToTxnType(int iAppliedToIndex);

Unicode (Windows)
LPWSTR GetAppliedToTxnType(INT iAppliedToIndex);

char* inqb_receivepayment_getappliedtotxntype(void* lpObj, int appliedtoindex);

QString GetAppliedToTxnType(int iAppliedToIndex);

Default Value

""

Remarks

The type of the transaction. At the time of this writing, TxnType may contain any of the following values:

"ARRefundCreditCard", "Bill", "BillPaymentCheck", "BillPaymentCreditCard", "BuildAssembly", "Charge", "Check", " CreditCardCharge", "CreditCardCredit", "CreditMemo", "Deposit", "Estimate", "InventoryAdjustment", "Invoice", " ItemReceipt", "JournalEntry", "LiabilityAdjustment", "Paycheck", "PayrollLiabilityCheck", "PurchaseOrder", " ReceivePayment", "SalesOrder", "SalesReceipt", "SalesTaxPaymentCheck", "Transfer", "VendorCredit", or "YTDAdjustment"

The AppliedToIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AppliedToCount property.

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

Data Type

String

ARAccountId Property (ReceivePayment Class)

Reference to the Accounts Receivable account where money goes.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetARAccountId();
int SetARAccountId(const char* lpszARAccountId);

Unicode (Windows)
LPWSTR GetARAccountId();
INT SetARAccountId(LPCWSTR lpszARAccountId);

char* inqb_receivepayment_getaraccountid(void* lpObj);
int inqb_receivepayment_setaraccountid(void* lpObj, const char* lpszARAccountId);

QString GetARAccountId();
int SetARAccountId(QString qsARAccountId);

Default Value

""

Remarks

A reference to the Accounts Receivable account where the money received from this transaction will go.

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

ARAccountName Property (ReceivePayment Class)

Reference to the Accounts Receivable account where money goes.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetARAccountName();
int SetARAccountName(const char* lpszARAccountName);

Unicode (Windows)
LPWSTR GetARAccountName();
INT SetARAccountName(LPCWSTR lpszARAccountName);

char* inqb_receivepayment_getaraccountname(void* lpObj);
int inqb_receivepayment_setaraccountname(void* lpObj, const char* lpszARAccountName);

QString GetARAccountName();
int SetARAccountName(QString qsARAccountName);

Default Value

""

Remarks

A reference to the Accounts Receivable account where the money received from this transaction will go.

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

AutoApply Property (ReceivePayment Class)

How the payment should be applied.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAutoApply();
int SetAutoApply(int iAutoApply);

Unicode (Windows)
INT GetAutoApply();
INT SetAutoApply(INT iAutoApply);

AA_NOT_SET(0), 
AA_FUTURE_TRANSACTIONS(1), 
AA_EXISTING_TRANSACTIONS(2), 
AA_CUSTOM(3)

int inqb_receivepayment_getautoapply(void* lpObj);
int inqb_receivepayment_setautoapply(void* lpObj, int iAutoApply);

int GetAutoApply();
int SetAutoApply(int iAutoApply);

Default Value

0

Remarks

How the payment should be applied. The following values are permitted:

Data Type

Integer

CustomerId Property (ReceivePayment Class)

A reference to the customer or customer job.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCustomerId();
int SetCustomerId(const char* lpszCustomerId);

Unicode (Windows)
LPWSTR GetCustomerId();
INT SetCustomerId(LPCWSTR lpszCustomerId);

char* inqb_receivepayment_getcustomerid(void* lpObj);
int inqb_receivepayment_setcustomerid(void* lpObj, const char* lpszCustomerId);

QString GetCustomerId();
int SetCustomerId(QString qsCustomerId);

Default Value

""

Remarks

The Customer property indicates the Customer who has purchased goods or services from the company.

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.

Either CustomerId or CustomerName is required.

Data Type

String

CustomerName Property (ReceivePayment Class)

A reference to the customer or customer job.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCustomerName();
int SetCustomerName(const char* lpszCustomerName);

Unicode (Windows)
LPWSTR GetCustomerName();
INT SetCustomerName(LPCWSTR lpszCustomerName);

char* inqb_receivepayment_getcustomername(void* lpObj);
int inqb_receivepayment_setcustomername(void* lpObj, const char* lpszCustomerName);

QString GetCustomerName();
int SetCustomerName(QString qsCustomerName);

Default Value

""

Remarks

The Customer property indicates the Customer who has purchased goods or services from the 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.

Either CustomerId or CustomerName is required.

Data Type

String

DepositToAccountId Property (ReceivePayment Class)

The account to which the payment should be deposited.

Syntax

• C++
• C
• Qt

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

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

char* inqb_receivepayment_getdeposittoaccountid(void* lpObj);
int inqb_receivepayment_setdeposittoaccountid(void* lpObj, const char* lpszDepositToAccountId);

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

Default Value

""

Remarks

The account to which the payment should be deposited, e.g., "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.

Data Type

String

DepositToAccountName Property (ReceivePayment Class)

The account to which the payment should be deposited.

Syntax

• C++
• C
• Qt

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

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

char* inqb_receivepayment_getdeposittoaccountname(void* lpObj);
int inqb_receivepayment_setdeposittoaccountname(void* lpObj, const char* lpszDepositToAccountName);

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

Default Value

""

Remarks

The account to which the payment should be deposited, e.g., "Checking". 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 (ReceivePayment 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_receivepayment_getmemo(void* lpObj);
int inqb_receivepayment_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

PaymentMethodId Property (ReceivePayment Class)

Reference to method of payment.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPaymentMethodId();
int SetPaymentMethodId(const char* lpszPaymentMethodId);

Unicode (Windows)
LPWSTR GetPaymentMethodId();
INT SetPaymentMethodId(LPCWSTR lpszPaymentMethodId);

char* inqb_receivepayment_getpaymentmethodid(void* lpObj);
int inqb_receivepayment_setpaymentmethodid(void* lpObj, const char* lpszPaymentMethodId);

QString GetPaymentMethodId();
int SetPaymentMethodId(QString qsPaymentMethodId);

Default Value

""

Remarks

A reference to the method of payment used. For example, "Cash".

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

PaymentMethodName Property (ReceivePayment Class)

Reference to method of payment.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPaymentMethodName();
int SetPaymentMethodName(const char* lpszPaymentMethodName);

Unicode (Windows)
LPWSTR GetPaymentMethodName();
INT SetPaymentMethodName(LPCWSTR lpszPaymentMethodName);

char* inqb_receivepayment_getpaymentmethodname(void* lpObj);
int inqb_receivepayment_setpaymentmethodname(void* lpObj, const char* lpszPaymentMethodName);

QString GetPaymentMethodName();
int SetPaymentMethodName(QString qsPaymentMethodName);

Default Value

""

Remarks

A reference to the method of payment used. For example, "Cash".

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

QBConnectionString Property (ReceivePayment 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_receivepayment_getqbconnectionstring(void* lpObj);
int inqb_receivepayment_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 (ReceivePayment 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_receivepayment_getqbrequestaggregate(void* lpObj);
int inqb_receivepayment_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 (ReceivePayment 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_receivepayment_getqbrequestid(void* lpObj);
int inqb_receivepayment_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 (ReceivePayment 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_receivepayment_getqbrequestmode(void* lpObj);
int inqb_receivepayment_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 (ReceivePayment 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_receivepayment_getqbresponseaggregate(void* lpObj);
int inqb_receivepayment_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 (ReceivePayment 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_receivepayment_getqbxmlversion(void* lpObj);
int inqb_receivepayment_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 (ReceivePayment Class)

An alphanumerical identifier generated by the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRefId();

Unicode (Windows)
LPWSTR GetRefId();

char* inqb_receivepayment_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

RefNumber Property (ReceivePayment Class)

Reference number for the transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRefNumber();
int SetRefNumber(const char* lpszRefNumber);

Unicode (Windows)
LPWSTR GetRefNumber();
INT SetRefNumber(LPCWSTR lpszRefNumber);

char* inqb_receivepayment_getrefnumber(void* lpObj);
int inqb_receivepayment_setrefnumber(void* lpObj, const char* lpszRefNumber);

QString GetRefNumber();
int SetRefNumber(QString qsRefNumber);

Default Value

""

Remarks

This is the reference number assigned to a transaction. Depending on the type of transaction, it appears in the QuickBooks user interface as Bill Number, Invoice Number, etc.

Reference numbers are alphanumeric strings and are not limited to actually being numbers.

For some types of transactions, if RefNumber is not assigned, QuickBooks will automatically assign a unique one. Reference numbers should generally be unique, but are not guaranteed to be so. It is recommended that applications generating their own reference numbers take steps to ensure their uniqueness.

Data Type

String

TransactionDate Property (ReceivePayment 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_receivepayment_gettransactiondate(void* lpObj);
int inqb_receivepayment_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

UnusedPayment Property (ReceivePayment Class)

The amount of the payment that remains unused.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetUnusedPayment();

Unicode (Windows)
LPWSTR GetUnusedPayment();

char* inqb_receivepayment_getunusedpayment(void* lpObj);

QString GetUnusedPayment();

Default Value

""

Remarks

This property will contain the amount of the payment that was not applied to existing invoices.

The amount should be formatted as a string in dollars.

This property is read-only.

Data Type

String

Add Method (ReceivePayment Class)

Adds the record into QuickBooks.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Add();

Unicode (Windows)
INT Add();

int inqb_receivepayment_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.)

CheckRequestStatus Method (ReceivePayment 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_receivepayment_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 (ReceivePayment Class)

Closes a persistent connection to QuickBooks.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int CloseQBConnection();

Unicode (Windows)
INT CloseQBConnection();

int inqb_receivepayment_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 (ReceivePayment 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_receivepayment_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 (ReceivePayment Class)

Deletes the record from QuickBooks.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Delete();

Unicode (Windows)
INT Delete();

int inqb_receivepayment_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 (ReceivePayment 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_receivepayment_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 (ReceivePayment 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_receivepayment_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 (ReceivePayment 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_receivepayment_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 (ReceivePayment Class)

Opens a persistent connection to QuickBooks.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int OpenQBConnection();

Unicode (Windows)
INT OpenQBConnection();

int inqb_receivepayment_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 (ReceivePayment Class)

Resets all properties to their defaults.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int inqb_receivepayment_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 (ReceivePayment 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_receivepayment_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 (ReceivePayment Class)

Updates the sales order in QuickBooks.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Update();

Unicode (Windows)
INT Update();

int inqb_receivepayment_update(void* lpObj);

int Update();

Remarks

This method is used to update entity (Customer, Vendor, and Employee) records in QuickBooks.

When the method is called, an Update request will be submitted to QuickBooks. The object represented by RefId 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.

One condition must be met for an Update operation to succeed: QuickBooks checks a property called EditSequence. EditSequence is similar to RefId, but is changed every time the object is changed. When an Updateoperation is submitted, the server compares EditSequence with its own EditSequence for the object. If they match, this means that the client program has the latest copy of the object, and the Update operation is permitted. If they don't match, an error will be returned.

If this object represents a value returned from QuickBooks (i.e., a Get or Add call has been made, or the QBResponseAggregate property has been set), the EditSequence will be automatically set. Otherwise this value may be accessed through Config.

This method will update the sales order in QuickBooks.

When the method is called, an Update request will be submitted to QuickBooks. The sales order 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 sales order. Moreover, QBXMLVersion should be set to the same value when retrieving the sales order 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 (ReceivePayment Class)

Information about errors during data delivery.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_RECEIVEPAYMENT_ERROR 1

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

class ReceivePaymentErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

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

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

// Or, subclass ReceivePayment and override this emitter function.
virtual int FireError(ReceivePaymentErrorEventParams *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 (ReceivePayment Class)

Fired after the server presents its certificate to the client.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_RECEIVEPAYMENT_SSLSERVERAUTHENTICATION 2

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

class ReceivePaymentSSLServerAuthenticationEventParams {
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(ReceivePaymentSSLServerAuthenticationEventParams *e);

// Or, subclass ReceivePayment and override this emitter function.
virtual int FireSSLServerAuthentication(ReceivePaymentSSLServerAuthenticationEventParams *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 (ReceivePayment Class)

Shows the progress of the secure connection.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_RECEIVEPAYMENT_SSLSTATUS 3

virtual INT INQB_CALL FireSSLStatus(LPSTR &lpszMessage);

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

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

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

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

Remarks

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

Status Event (ReceivePayment Class)

Shows the progress of the QuickBooks connection.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_RECEIVEPAYMENT_STATUS 4

virtual INT INQB_CALL FireStatus(LPSTR &lpszMessage);

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

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

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

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

Remarks

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

Warning Event (ReceivePayment Class)

Fired when a warning occurs.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_RECEIVEPAYMENT_WARNING 5

virtual INT INQB_CALL FireWarning(INT &iCode, LPSTR &lpszDescription);

class ReceivePaymentWarningEventParams {
public:
  int Code();

  const QString &Description();

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

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

// Or, subclass ReceivePayment and override this emitter function.
virtual int FireWarning(ReceivePaymentWarningEventParams *e) {...}

Remarks

The Warning event is fired when the class has produced, or will produce, possibly unexpected results.

Warnings may be generated by QuickBooks or the class. Starred warning codes correspond to warnings and warning codes generated by QuickBooks.

Unlisted QuickBooks warnings will cause the class to throw an exception instead.

Warning 801 will be thrown if the user attempts to Update properties that cannot be updated. For example, the following code will cause this warning to be fired: Customer1.GetByName("Joe Smith") Customer1.Email = "joe@abc.com" 'ok Customer1.CreditLimit = "200.00" 'Not used in Update operations! Customer1.Update() Only the email address will be updated, and the credit limit will be unchanged. Each property description for entity objects lists whether or not it is used in Update operations.

Config Settings (ReceivePayment Class)