ReceivePayment Control

Properties   Methods   Events   Config Settings   Errors  

The ReceivePayment control is used to receive payments from customers.

Syntax

ReceivePayment

Remarks

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

Property List

---

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

Amount	Amount of payment.
AppliedToCount	The number of records in the AppliedTo arrays.
AppliedToAmount	The amount of the transaction that has just been paid.
AppliedToBalanceRemaining	The outstanding balance that has yet to be paid for the transaction indicated by RefId .
AppliedToCreditAppliedAmount	Amount of a credit that is applied to a customer's bill.
AppliedToCreditMemoId	The ID of the credit memo that you are applying to this bill.
AppliedToDiscountAccountId	Refers to the account where this discount is tracked.
AppliedToDiscountAccountName	Refers to the account where this discount is tracked.
AppliedToDiscountAmount	Reduces the receivable amount.
AppliedToPaymentAmount	Represents the amount assigned to a particular bill payment.
AppliedToRefId	Refers to the transaction Id of the bill that is being paid.
AppliedToRefNumber	RefNumber of the transaction that was just paid.
AppliedToTxnDate	Date of the transaction that has just been paid.
AppliedToTxnType	The type of the transaction.
ARAccountId	Reference to the Accounts Receivable account where money goes.
ARAccountName	Reference to the Accounts Receivable account where money goes.
AutoApply	How the payment should be applied.
CustomerId	A reference to the customer or customer job.
CustomerName	A reference to the customer or customer job.
DepositToAccountId	The account to which the payment should be deposited.
DepositToAccountName	The account to which the payment should be deposited.
Memo	Memo to appear on internal reports only.
PaymentMethodId	Reference to method of payment.
PaymentMethodName	Reference to method of payment.
QBConnectionString	An aggregate consisting of various QuickBooks connection properties.
QBRequestAggregate	The request aggregate.
QBRequestId	The Id of the next message to be sent to QuickBooks.
QBRequestMode	Defines whether the request is made online or stored offline.
QBResponseAggregate	The last QBXML response aggregate received from QuickBooks.
QBXMLVersion	The version of QBXML used in the outgoing message.
RefId	An alphanumerical identifier generated by the server.
RefNumber	Reference number for the transaction.
TransactionDate	Date of transaction.
UnusedPayment	The amount of the payment that remains unused.

Method List

---

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

Add	Adds the record into QuickBooks.
CheckRequestStatus	Checks whether or not the specified request was processed by QuickBooks.
CloseQBConnection	Closes a persistent connection to QuickBooks.
Config	Sets or retrieves a configuration setting.
Delete	Deletes the record from QuickBooks.
Get	Gets a single record from QuickBooks.
GetCustomField	Gets a custom field value from QuickBooks.
ImportQBXML	Imports a QBXML response aggregate.
OpenQBConnection	Opens a persistent connection to QuickBooks.
Reset	Resets all properties to their defaults.
SetCustomField	Sets a custom field value within QuickBooks.
Update	Updates the sales order in QuickBooks.

Event List

---

The following is the full list of the events fired by the control with short descriptions. Click on the links for further details.

Error	Information about errors during data delivery.
SSLServerAuthentication	Fired after the server presents its certificate to the client.
SSLStatus	Shows the progress of the secure connection.
Status	Shows the progress of the QuickBooks connection.
Warning	Fired when a warning occurs.

Config Settings

---

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

AppendAfter	Appends an XML tag after the specified QBXML element.
AppliedToAggregate[index]	Contains the XML aggregate of the AppliedTo element.
AuthFlags	Connection Flags (use for QuickBooks Simple Start).
CreditCardTxnInfo	XML aggregate containing the result of an actual credit card transaction to be reconciled with QuickBooks.
EditSequence	An identifier for this copy of the object.
EnforceMaxLength	Indicates whether to enforce max lengths for QB Fields.
GetHighestVersion	Highest QBXMLVersion supported by the installed instance of QuickBooks.
GetRequestProcessorDLLVersion	Returns the version of the QB Request Processor that is installed on your system.
GetSupportedVersions	Returns a list of QBXMLVersions that are supported by QuickBooks.
IsReadOnly	This causes the QuickBooks authorization dialog to display text informing the user that its access will be read-only.
PersonalDataPref	Whether the connecting application will require access to personal data such as SSN or credit card information.
QBConnectionMode	The mode of connection to QuickBooks.
QBFileStatus	The status of the company file as it pertains to accepting connections.
QBOpenCompanyFile	The file currently open in QuickBooks.
SendRawXML	Sends specified XML to quickbooks without modification.
SSLAcceptServerCert	The SSL certificate being used by the QuickBooks Gateway (aka Remote Connector).
SSLAcceptServerCertFile	The SSL certificate file being used by the QuickBooks Gateway (aka Remote Connector).
StopOnError	Specifies how QuickBooks is to proceed if an error occurs in processing of the current request.
TimeCreated	The time the object was created.
TimeModified	The time the object was created.
UnattendedModePref	Whether connecting while QuickBooks is closed is required or optional for the user.
WarningCodes	A comma-separated list of QuickBooks warning codes that should not result in an exception.
CodePage	The system code page used for Unicode to Multibyte translations.
MaskSensitive	Whether sensitive data is masked in log messages.
UseInternalSecurityAPI	Tells the control whether or not to use the system security libraries or an internal implementation.

Amount Property (ReceivePayment Control)

Amount of payment.

Syntax

receivepaymentcontrol.Amount[=string]

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 Control)

The number of records in the AppliedTo arrays.

Syntax

receivepaymentcontrol.AppliedToCount[=integer]

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 Control)

The amount of the transaction that has just been paid.

Syntax

receivepaymentcontrol.AppliedToAmount(AppliedToIndex)

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 Control)

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

Syntax

receivepaymentcontrol.AppliedToBalanceRemaining(AppliedToIndex)

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 Control)

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

Syntax

receivepaymentcontrol.AppliedToCreditAppliedAmount(AppliedToIndex)[=string]

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 Control)

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

Syntax

receivepaymentcontrol.AppliedToCreditMemoId(AppliedToIndex)[=string]

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 Control)

Refers to the account where this discount is tracked.

Syntax

receivepaymentcontrol.AppliedToDiscountAccountId(AppliedToIndex)[=string]

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 Control)

Refers to the account where this discount is tracked.

Syntax

receivepaymentcontrol.AppliedToDiscountAccountName(AppliedToIndex)[=string]

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 Control)

Reduces the receivable amount.

Syntax

receivepaymentcontrol.AppliedToDiscountAmount(AppliedToIndex)[=string]

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 Control)

Represents the amount assigned to a particular bill payment.

Syntax

receivepaymentcontrol.AppliedToPaymentAmount(AppliedToIndex)[=string]

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 Control)

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

Syntax

receivepaymentcontrol.AppliedToRefId(AppliedToIndex)[=string]

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 Control)

RefNumber of the transaction that was just paid.

Syntax

receivepaymentcontrol.AppliedToRefNumber(AppliedToIndex)

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 Control)

Date of the transaction that has just been paid.

Syntax

receivepaymentcontrol.AppliedToTxnDate(AppliedToIndex)

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 Control)

The type of the transaction.

Syntax

receivepaymentcontrol.AppliedToTxnType(AppliedToIndex)

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 Control)

Reference to the Accounts Receivable account where money goes.

Syntax

receivepaymentcontrol.ARAccountId[=string]

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 Control)

Reference to the Accounts Receivable account where money goes.

Syntax

receivepaymentcontrol.ARAccountName[=string]

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 Control)

How the payment should be applied.

Syntax

receivepaymentcontrol.AutoApply[=integer]

Possible Values

aaNotSet(0), 
aaFutureTransactions(1), 
aaExistingTransactions(2), 
aaCustom(3)

Default Value

0

Remarks

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

aaCustom (3)	Manually specify how the payment should be applied. Use the AppliedTo property to specify each transaction this Receive Payment applies to.
aaExistingTransactions (2)	Apply the payment to existing customer transactions (e.g., invoices). QuickBooks will automatically apply the payment to appropriate transactions, which will be reported in the AppliedToTransactions special field after Add is invoked.
aaFutureTransactions (1)	Apply the payment to future transactions; i.e., set a credit for the customer.
aaNotSet (0)	The default value. You must change the value of AutoApply before it is used in Add transactions.

Data Type

Integer

CustomerId Property (ReceivePayment Control)

A reference to the customer or customer job.

Syntax

receivepaymentcontrol.CustomerId[=string]

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 Control)

A reference to the customer or customer job.

Syntax

receivepaymentcontrol.CustomerName[=string]

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 Control)

The account to which the payment should be deposited.

Syntax

receivepaymentcontrol.DepositToAccountId[=string]

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 Control)

The account to which the payment should be deposited.

Syntax

receivepaymentcontrol.DepositToAccountName[=string]

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 Control)

Memo to appear on internal reports only.

Syntax

receivepaymentcontrol.Memo[=string]

Default Value

""

Remarks

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

Data Type

String

PaymentMethodId Property (ReceivePayment Control)

Reference to method of payment.

Syntax

receivepaymentcontrol.PaymentMethodId[=string]

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 Control)

Reference to method of payment.

Syntax

receivepaymentcontrol.PaymentMethodName[=string]

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 Control)

An aggregate consisting of various QuickBooks connection properties.

Syntax

receivepaymentcontrol.QBConnectionString[=string]

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:

ApplicationName	The name of the developer's application. This name will appear when the application first connects to QuickBooks; QuickBooks will display this name and prompt the user to grant or refuse access.
CompanyFile	The name of the company file to open. If QuickBooks is not currently open with a company file, QuickBooks will be automatically opened in the background with the file specified. Do not set CompanyFile when QuickBooks is open; if QuickBooks is open through the application UI, only that company file may be used. This setting is not applicable when communicating with QB Connector.
URL	The URL for the Remote Connector, e.g., 'http://localhost:2080'. If the URL is specified, the control will not communicate directly with QuickBooks, and will instead send a request to the specified web address. QuickBooks and the Remote Connector should be installed at the remote location, and if the connector is listening on the specified port, it will communicate the control's request to QuickBooks, and return the response.
User	A username for the Remote Connector connection (if required on the Connector side)
Password	A password for the Remote Connector connection (if required on the Connector side)
Timeout	A timeout, in seconds, for the Remote Connector connection. If the Connector does not finish and respond within the chosen length of time, the control will generate an exception instead of hanging.
DelayAfterClose	A delay, in milliseconds, to be applied after each time a connection to QuickBooks is closed. If QuickBooks is generating internal errors (in particular with automatic login) setting this delay to a positive value may solve the problem.
FirewallHost	Contains the name or IP address of firewall. If a FirewallHost is given, the requested connections will be authenticated through the specified firewall when connecting.
FirewallPassword	Contains a password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword configs are used to connect and authenticate to the given firewall. If the authentication fails, the control fails with an error.
FirewallPort	Contains the TCP port for the firewall FirewallHost. Note this is set automatically when FirewallType is set to a valid value.
FirewallType	Determines the type of firewall to connect through. Supported values are: 0 - no firewall (default), 1 - Tunneling proxy, 2 - SOCKS4 proxy, and 3 - SOCKS5 proxy. For the Tunneling proxy (1), the FirewallPort defaults to 80. For SOCKS4 (2) and SOCKS5 (3) the FirewallPort defaults to 1080.
FirewallUser	Contains a user name if authentication is to be used connecting through a firewall. If the FirewallHost is specified, the FirewallUser and FirewallPassword configs are used to connect and authenticate to the given firewall. If the authentication fails, the control fails with an error.
ProxyAuthorization	Supported values are 0 - Basic authorization, 1 - Digest authentication, 3 - No authentication, and 4 - NTLM authentication.
ProxyPassword	Contains a password if authentication is to be used for the proxy.
ProxyPort	Contains the TCP port for a ProxyServer; (default 80).
ProxySSL	Determines when to use SSL for the connection to the proxy. The applicable values are 0 - Automatic (SSL for https URLs, non-SSL for http URLs), 1 - The connection is always SSL-enabled, 2 - SSL is not enabled for any connection, and 3 - Connection is through a tunneling proxy.
ProxyServer	If a ProxyServer is specified, then the HTTP request is sent to the proxy instead of the server otherwise specified. If the ProxyServer is set to a Domain Name, a DNS request is initiated and upon successful termination of the request, the ProxyServer is set to the corresponding address. If the search is not successful, an error is returned.
ProxyUser	Contains a user name, if authentication is to be used for the proxy.
LocalHost	The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
LocalPort	The TCP port in the local host where the control binds.
UseRDS	Whether to connect using Remote Data Sharing (RDS). If set to True, the control will attempt to connect using the RDS client installed on the machine. The RDS client and server must be configured separately. The default value is False.

Data Type

String

QBRequestAggregate Property (ReceivePayment Control)

The request aggregate.

Syntax

receivepaymentcontrol.QBRequestAggregate[=string]

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 control to generate requests to be sent to QuickBooks Web Connector.

This property is not available at design time.

Data Type

String

QBRequestId Property (ReceivePayment Control)

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

Syntax

receivepaymentcontrol.QBRequestId[=string]

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 Control)

Defines whether the request is made online or stored offline.

Syntax

receivepaymentcontrol.QBRequestMode[=integer]

Possible Values

rmOnline(0), 
rmOffline(1)

Default Value

0

Remarks

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

0 (rmOnline - default)	The request is made normally.
1 (rmOffline)	The request is generated but not sent, and QBRequestAggregate is populated.

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

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

Data Type

Integer

QBResponseAggregate Property (ReceivePayment Control)

The last QBXML response aggregate received from QuickBooks.

Syntax

receivepaymentcontrol.QBResponseAggregate[=string]

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 control 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 Control)

The version of QBXML used in the outgoing message.

Syntax

receivepaymentcontrol.QBXMLVersion[=string]

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:

QuickBooks 2002	1.0, 1.1
QuickBooks 2003	2.0
QuickBooks 2004	3.0
QuickBooks 2005	4.0, 4.1
QuickBooks 2006	5.0
QuickBooks 2007	6.0
QuickBooks 2008	7.0
QuickBooks 2009	8.0
QuickBooks 2010	9.0
QuickBooks 2011	10.0
QuickBooks 2012	11.0
QuickBooks 2013	12.0
QuickBooks 2014	13.0
QuickBooks 2015	14.0
QuickBooks 2016	15.0

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:

QuickBooks Canadian 2003	CA2.0
QuickBooks Canadian 2004 to 2007	CA3.0
QuickBooks UK 2003	UK2.0
QuickBooks UK 2004 to 2007	UK3.0
QuickBooks Australian 2003	OZ2.0
QuickBooks Australian 2004 to 2007	AU3.0

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 Control)

An alphanumerical identifier generated by the server.

Syntax

receivepaymentcontrol.RefId

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 Control)

Reference number for the transaction.

Syntax

receivepaymentcontrol.RefNumber[=string]

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 Control)

Date of transaction.

Syntax

receivepaymentcontrol.TransactionDate[=string]

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 Control)

The amount of the payment that remains unused.

Syntax

receivepaymentcontrol.UnusedPayment

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 Control)

Adds the record into QuickBooks.

Syntax

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

CheckRequestStatus Method (ReceivePayment Control)

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

Syntax

receivepaymentcontrol.CheckRequestStatus RequestId

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.

CloseQBConnection Method (ReceivePayment Control)

Closes a persistent connection to QuickBooks.

Syntax

receivepaymentcontrol.CloseQBConnection 

Remarks

Invoking CloseQBConnection closes the QuickBooks connection specified in QBConnectionString. After the connection has been closed, the control 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.

Config Method (ReceivePayment Control)

Sets or retrieves a configuration setting.

Syntax

receivepaymentcontrol.Config ConfigurationString

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the control, 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.

Delete Method (ReceivePayment Control)

Deletes the record from QuickBooks.

Syntax

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

Get Method (ReceivePayment Control)

Gets a single record from QuickBooks.

Syntax

receivepaymentcontrol.Get Id

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 control 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 control, 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 control may be used.

GetCustomField Method (ReceivePayment Control)

Gets a custom field value from QuickBooks.

Syntax

receivepaymentcontrol.GetCustomField FieldName

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.

ImportQBXML Method (ReceivePayment Control)

Imports a QBXML response aggregate.

Syntax

receivepaymentcontrol.ImportQBXML XMLData

Remarks

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

OpenQBConnection Method (ReceivePayment Control)

Opens a persistent connection to QuickBooks.

Syntax

receivepaymentcontrol.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 control 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.

Reset Method (ReceivePayment Control)

Resets all properties to their defaults.

Syntax

receivepaymentcontrol.Reset 

Remarks

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

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

SetCustomField Method (ReceivePayment Control)

Sets a custom field value within QuickBooks.

Syntax

receivepaymentcontrol.SetCustomField FieldName, FieldValue

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.

Update Method (ReceivePayment Control)

Updates the sales order in QuickBooks.

Syntax

receivepaymentcontrol.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 Event (ReceivePayment Control)

Information about errors during data delivery.

Syntax

Sub receivepaymentcontrol_Error(ErrorCode As Integer, Description As String)

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 Control)

Fired after the server presents its certificate to the client.

Syntax

Sub receivepaymentcontrol_SSLServerAuthentication(CertEncoded As String, CertSubject As String, CertIssuer As String, Status As String, Accept As Boolean)

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 Control)

Shows the progress of the secure connection.

Syntax

Sub receivepaymentcontrol_SSLStatus(Message As String)

Remarks

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

Status Event (ReceivePayment Control)

Shows the progress of the QuickBooks connection.

Syntax

Sub receivepaymentcontrol_Status(Message As String)

Remarks

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

Warning Event (ReceivePayment Control)

Fired when a warning occurs.

Syntax

Sub receivepaymentcontrol_Warning(Code As Integer, Description As String)

Remarks

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

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

510*	Object added successfully, but cannot now be read.
520*	Insufficient permissions to get all data.
801	Unable to update field (name).
802	Unable to parse name.

Unlisted QuickBooks warnings will cause the control 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 Control)

The control accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the control, access to these internal properties is provided through the Config method.

ReceivePayment Config Settings

AppendAfter:   Appends an XML tag after the specified QBXML element. Write-only; Appends the specified text after the specified QBXML element (whether the QBXML element is present). This may be useful to extend the functionality of the component beyond what is provided. Example: Control1.Config("AppendAfter:ListID=<WeirdNewField>abc</WeirdNewField>")

AppliedToAggregate[index]:   Contains the XML aggregate of the AppliedTo element. If the line item has not been modified since receiving a response from QuickBooks, the exact AppliedTo aggregate that QuickBooks returned will be contained in this XML aggregate. However, if you have made changes to the AppliedTo fields, the Aggregate field will re-generate the XML with the new data. If you set the other line item fields and then query the Aggregate, an AppliedTo aggregate will be generated from the currently set fields. You may set this field with raw XML. So long as you do not modify any other fields (forcing the aggregate to regenerate based on new changes), the XML will be sent as-is to the QuickBooks request processor. It is essential that you properly format the XML that you place in this field. When setting this field manually, the component will send exactly what you have set. You must ensure your XML is appropriate for the action you are attempting. For instance, if you are Adding, you must ensure the outer tags are "AppliedToTxnAdd". If modifying, the outer tags must be "AppliedToTxnMod". If you do not expressly set the Aggregate field with your own custom XML, all of this will be taken care of you automatically by the component.

AuthFlags:   Connection Flags (use for QuickBooks Simple Start). Since 2006, QuickBooks has allowed AuthFlags to be set before connecting to QuickBooks. By default, the control can connect to Pro, Premier, and Enterprise editions of QuickBooks. However, because QuickBooks Simple Start contains only a subset of the functionality that other desktop versions provide, Intuit does not allow COM connection to Simple Start unless these AuthFlags explicitly indicate you wish to support it. A list of allowable AuthFlags is provided below. "" or 0 Do not send any auth flags 0x01 Support QB Simple Start 0x02 Support QB Pro 0x04 Support QB Premier 0x08 Support QB Enterprise 0x80000000 Force Auth Dialog To specify support for multiple editions, OR together the values for each edition. NOTE: If the version of QuickBooks being used does not support AuthFlags, the contents of this config will be ignored. However, if QuickBooks does support this feature, setting "AuthFlags=1" (Support for Simple Start only) on a machine running QuickBooks 2013 Pro will result in an error message indicating that the Request Processor cannot be found.

CreditCardTxnInfo:   XML aggregate containing the result of an actual credit card transaction to be reconciled with QuickBooks. This aggregate can be used to add credit card transactions authorized by a third party into QuickBooks.

EditSequence:   An identifier for this copy of the object. Indicates the state of an object when doing an Update.

EnforceMaxLength:   Indicates whether to enforce max lengths for QB Fields. If you change this setting to False, the control will no longer check (or error) when the length of a property exceeds the maximum length specified in the QuickBooks SDK.

GetHighestVersion:   Highest QBXMLVersion supported by the installed instance of QuickBooks. If QuickBooks is installed on the system, this setting will retrieve the highest QBXMLVersion that may be used for sending transactions to QuickBooks.

GetRequestProcessorDLLVersion:   Returns the version of the QB Request Processor that is installed on your system.

GetSupportedVersions:   Returns a list of QBXMLVersions that are supported by QuickBooks. If QuickBooks is installed on the system, this setting will retrieve a list of all supported QBXMLVersions that may be used for sending transactions to QuickBooks. While GetHighestVersion config returns only the highest QBXMLVersion supported, this config returns ALL supported QBXMLVersions. The list is delimited with '\n' (linefeed) characters.

IsReadOnly:   This causes the QuickBooks authorization dialog to display text informing the user that its access will be read-only. The default value is false.

PersonalDataPref:   Whether the connecting application will require access to personal data such as SSN or credit card information. This setting allows you to let the user know immediately whether your application requires access to personal data or not. A list of available values is provided below. pdpOptional Causes the QuickBooks authorization dialog to display a checkbox for user selection asking whether the user wants to allow the application to access personal data. pdpRequired Causes the QuickBooks authorization dialog to not display the personal information checkbox for user selection, and instead display a warning that the application needs to access personal data. pdpNotNeeded Causes the QuickBooks authorization dialog to not display the personal information checkbox for user selection, and instead display an informational message that the application will NOT access personal data. The default value is pdpOptional.

QBConnectionMode:   The mode of connection to QuickBooks. Specifies whether the integrated application logs in using single-user or multi-user mode. The following values are permitted: 0 Don't Care 1 Single-User Mode 2 Multi-User Mode About Single-User and Multi-User Modes If the connection to QuickBooks is made in single-user mode, QuickBooks will give exclusive access to the connecting application. It will lock out all other integrated applications; if QuickBooks and the company file are not already open in single-user mode by the QuickBooks user, the user will be locked out as well. If the connection is made in multi-user mode, QuickBooks will allow all other integrated applications access. QuickBooks end users on other machines will also be allowed to access the file. However, if the application (rather than the end user) starts QuickBooks automatically, end users on the same machine will still be locked out. If cmDontCare is specified, an appropriate connection mode will be chosen automatically. If a company file is open in either single-user or multi-user mode, the integrated application will accept that connection mode. If no company file is open, QuickBooks will login automatically in multi-user mode. About Integrated and Automatic Login Note that your application's login to QuickBooks might be either automatic or interactive. Interactive login is used when QuickBooks is already open. Access will be shared between the integrated application and the QuickBooks end user, and if multi-user mode is specified, other applications and users will have access as well. When a connection is made, QuickBooks will show a dialog window to the user, and ask the user if he/she wants to permit the connection. Automatic login is used when QuickBooks is not already open. QuickBooks will be opened in the background, and will run until your application has finished its connection with QuickBooks. The QuickBooks user interface will not be displayed, and end-users on the same machine will be locked out. End-users on other machines, however, will be allowed access if multi-user mode is specified. By default integrated applications do not have permission to login automatically. The first time an application interacts with QuickBooks, it must do so interactively, with QuickBooks and the company file open. The QuickBooks end user may then grant automatic login permission through Edit Preferences - Integrated Applications in the QuickBooks user interface. Click on the name of the application and then "Properties", and you may allow the application to login automatically. For automatic login the CompanyFile must be specified. CompanyFile, ApplicationName, and other properties relating to the QuickBooks connection may be edited through QBConnectionString.

QBFileStatus:   The status of the company file as it pertains to accepting connections. This setting may be queried before attempting to connect to QuickBooks to determine the current company file status. When queried the control will attempt to determine whether a subsequent connection using the provided QBConnectionString value would succeed. Possible return values are: 0 The company file will accept the connection. This indicates that no company file is open, or the desired company file is already open. 1 The company file will not accept the connection. This indicates a different company file is already open.

QBOpenCompanyFile:   The file currently open in QuickBooks. The name of the file currently open in QuickBooks, specified completely with the path. This field is read-only. A query is submitted to QuickBooks when the value of this property is read. The empty string will be returned if no file is open, if QuickBooks is open in an access mode incompatible with QBConnectionMode, or if an error occurs. If the value of this property is nonempty, the control may interact exclusively with the open file.

SendRawXML:   Sends specified XML to quickbooks without modification. Available for write only. Immediately sends the specified XML over the current or default QuickBooks connection (as specified elsewhere), and returns the QBXML response. Syntax: Control1.Config("SendRawXML=<?xml version="1.0" ?>...")

SSLAcceptServerCert:   The SSL certificate being used by the QuickBooks Gateway (aka Remote Connector). The Base-64 encoded certificate being used by the Remote Connector (you may get this certificate from the Remote Connector by going to the Security tab, and clicking Export.) This is only necessary if using a self-signed certificate, or any other certificate that has not been signed by a Certificate Authority (CA) trusted by the system.

SSLAcceptServerCertFile:   The SSL certificate file being used by the QuickBooks Gateway (aka Remote Connector). If your public key certificate is stored in a file, you may set this configuration setting to the full path of the certificate, and it will be immediately read from disk and stored in SSLAcceptServerCert. Equivalent to setting SSLAcceptServerCert to file contents. Reading the value of this setting will return an empty string.

StopOnError:   Specifies how QuickBooks is to proceed if an error occurs in processing of the current request. If StopOnError is True (default), QuickBooks will stop processing when an error occurs. Requests that have already been processed will not be rolled back. An error is returned for the operation that caused the error condition. If StopOnError is False, QuickBooks will continue processing the remaining requests if an error occurs.

TimeCreated:   The time the object was created. This config setting is read-only.

TimeModified:   The time the object was created. This config setting is read-only.

UnattendedModePref:   Whether connecting while QuickBooks is closed is required or optional for the user. This setting allows you to let the user know immediately whether your application requires the ability to access QuickBooks while QuickBooks is closed. A list of available values is provided below. umpOptional Causes the QuickBooks authorization dialog to display its default selections and let the user pick. Use this setting if you do not need unattended mode. umpRequired Causes the QuickBooks authorization dialog to display only the selection choices of "No" (no authorization) or "Yes, allow access even if QuickBooks is not running" (authorize unattended mode). The default value is umpOptional.

WarningCodes:   A comma-separated list of QuickBooks warning codes that should not result in an exception. By default, the control will throw an exception when a status code with severity "Warn" is returned in a QuickBooks response. Set this field to a comma-separated list of status codes that should not throw an exception if returned. Note that the QuickBooks response code is not necessarily the same as the exception code from the resulting exception.

Base Config Settings

CodePage:   The system code page used for Unicode to Multibyte translations. The default code page is Unicode UTF-8 (65001). The following is a list of valid code page identifiers: Identifier Name 037 IBM EBCDIC - U.S./Canada 437 OEM - United States 500 IBM EBCDIC - International 708 Arabic - ASMO 708 709 Arabic - ASMO 449+, BCON V4 710 Arabic - Transparent Arabic 720 Arabic - Transparent ASMO 737 OEM - Greek (formerly 437G) 775 OEM - Baltic 850 OEM - Multilingual Latin I 852 OEM - Latin II 855 OEM - Cyrillic (primarily Russian) 857 OEM - Turkish 858 OEM - Multilingual Latin I + Euro symbol 860 OEM - Portuguese 861 OEM - Icelandic 862 OEM - Hebrew 863 OEM - Canadian-French 864 OEM - Arabic 865 OEM - Nordic 866 OEM - Russian 869 OEM - Modern Greek 870 IBM EBCDIC - Multilingual/ROECE (Latin-2) 874 ANSI/OEM - Thai (same as 28605, ISO 8859-15) 875 IBM EBCDIC - Modern Greek 932 ANSI/OEM - Japanese, Shift-JIS 936 ANSI/OEM - Simplified Chinese (PRC, Singapore) 949 ANSI/OEM - Korean (Unified Hangul Code) 950 ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) 1026 IBM EBCDIC - Turkish (Latin-5) 1047 IBM EBCDIC - Latin 1/Open System 1140 IBM EBCDIC - U.S./Canada (037 + Euro symbol) 1141 IBM EBCDIC - Germany (20273 + Euro symbol) 1142 IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) 1143 IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) 1144 IBM EBCDIC - Italy (20280 + Euro symbol) 1145 IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) 1146 IBM EBCDIC - United Kingdom (20285 + Euro symbol) 1147 IBM EBCDIC - France (20297 + Euro symbol) 1148 IBM EBCDIC - International (500 + Euro symbol) 1149 IBM EBCDIC - Icelandic (20871 + Euro symbol) 1200 Unicode UCS-2 Little-Endian (BMP of ISO 10646) 1201 Unicode UCS-2 Big-Endian 1250 ANSI - Central European 1251 ANSI - Cyrillic 1252 ANSI - Latin I 1253 ANSI - Greek 1254 ANSI - Turkish 1255 ANSI - Hebrew 1256 ANSI - Arabic 1257 ANSI - Baltic 1258 ANSI/OEM - Vietnamese 1361 Korean (Johab) 10000 MAC - Roman 10001 MAC - Japanese 10002 MAC - Traditional Chinese (Big5) 10003 MAC - Korean 10004 MAC - Arabic 10005 MAC - Hebrew 10006 MAC - Greek I 10007 MAC - Cyrillic 10008 MAC - Simplified Chinese (GB 2312) 10010 MAC - Romania 10017 MAC - Ukraine 10021 MAC - Thai 10029 MAC - Latin II 10079 MAC - Icelandic 10081 MAC - Turkish 10082 MAC - Croatia 12000 Unicode UCS-4 Little-Endian 12001 Unicode UCS-4 Big-Endian 20000 CNS - Taiwan 20001 TCA - Taiwan 20002 Eten - Taiwan 20003 IBM5550 - Taiwan 20004 TeleText - Taiwan 20005 Wang - Taiwan 20105 IA5 IRV International Alphabet No. 5 (7-bit) 20106 IA5 German (7-bit) 20107 IA5 Swedish (7-bit) 20108 IA5 Norwegian (7-bit) 20127 US-ASCII (7-bit) 20261 T.61 20269 ISO 6937 Non-Spacing Accent 20273 IBM EBCDIC - Germany 20277 IBM EBCDIC - Denmark/Norway 20278 IBM EBCDIC - Finland/Sweden 20280 IBM EBCDIC - Italy 20284 IBM EBCDIC - Latin America/Spain 20285 IBM EBCDIC - United Kingdom 20290 IBM EBCDIC - Japanese Katakana Extended 20297 IBM EBCDIC - France 20420 IBM EBCDIC - Arabic 20423 IBM EBCDIC - Greek 20424 IBM EBCDIC - Hebrew 20833 IBM EBCDIC - Korean Extended 20838 IBM EBCDIC - Thai 20866 Russian - KOI8-R 20871 IBM EBCDIC - Icelandic 20880 IBM EBCDIC - Cyrillic (Russian) 20905 IBM EBCDIC - Turkish 20924 IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) 20932 JIS X 0208-1990 & 0121-1990 20936 Simplified Chinese (GB2312) 21025 IBM EBCDIC - Cyrillic (Serbian, Bulgarian) 21027 Extended Alpha Lowercase 21866 Ukrainian (KOI8-U) 28591 ISO 8859-1 Latin I 28592 ISO 8859-2 Central Europe 28593 ISO 8859-3 Latin 3 28594 ISO 8859-4 Baltic 28595 ISO 8859-5 Cyrillic 28596 ISO 8859-6 Arabic 28597 ISO 8859-7 Greek 28598 ISO 8859-8 Hebrew 28599 ISO 8859-9 Latin 5 28605 ISO 8859-15 Latin 9 29001 Europa 3 38598 ISO 8859-8 Hebrew 50220 ISO 2022 Japanese with no halfwidth Katakana 50221 ISO 2022 Japanese with halfwidth Katakana 50222 ISO 2022 Japanese JIS X 0201-1989 50225 ISO 2022 Korean 50227 ISO 2022 Simplified Chinese 50229 ISO 2022 Traditional Chinese 50930 Japanese (Katakana) Extended 50931 US/Canada and Japanese 50933 Korean Extended and Korean 50935 Simplified Chinese Extended and Simplified Chinese 50936 Simplified Chinese 50937 US/Canada and Traditional Chinese 50939 Japanese (Latin) Extended and Japanese 51932 EUC - Japanese 51936 EUC - Simplified Chinese 51949 EUC - Korean 51950 EUC - Traditional Chinese 52936 HZ-GB2312 Simplified Chinese 54936 Windows XP: GB18030 Simplified Chinese (4 Byte) 57002 ISCII Devanagari 57003 ISCII Bengali 57004 ISCII Tamil 57005 ISCII Telugu 57006 ISCII Assamese 57007 ISCII Oriya 57008 ISCII Kannada 57009 ISCII Malayalam 57010 ISCII Gujarati 57011 ISCII Punjabi 65000 Unicode UTF-7 65001 Unicode UTF-8 The following is a list of valid code page identifiers for Mac OS only: Identifier Name 1 ASCII 2 NEXTSTEP 3 JapaneseEUC 4 UTF8 5 ISOLatin1 6 Symbol 7 NonLossyASCII 8 ShiftJIS 9 ISOLatin2 10 Unicode 11 WindowsCP1251 12 WindowsCP1252 13 WindowsCP1253 14 WindowsCP1254 15 WindowsCP1250 21 ISO2022JP 30 MacOSRoman 10 UTF16String 0x90000100 UTF16BigEndian 0x94000100 UTF16LittleEndian 0x8c000100 UTF32String 0x98000100 UTF32BigEndian 0x9c000100 UTF32LittleEndian 65536 Proprietary

MaskSensitive:   Whether sensitive data is masked in log messages. In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to to mask sensitive data. The default is . This setting only works on these controls: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.

UseInternalSecurityAPI:   Tells the control whether or not to use the system security libraries or an internal implementation. When set to , the control will use the system security libraries by default to perform cryptographic functions where applicable. Setting this setting to tells the control to use the internal implementation instead of using the system security libraries. This setting is set to by default on all platforms.

Trappable Errors (ReceivePayment Control)

Errors

The following errors may be generated by the control. Note that frequently the error message will contain more specific information than what is listed here.

ReceivePayment Errors

	20102    String too long.
	20104    Invalid date format (YYYY-MM-DD is standard).
	20105    Invalid value for enumerated field.
	20106    Invalid integer.
	20107    Invalid dollar amount.
	20108    Invalid boolean value (must be 'true' or 'false').
	20109    Invalid number.
	20112    Invalid special characters in string.
	20113    Invalid special field syntax.
	20182    Could not load certificate file.
	20202    Required field unspecified.
	20212    Unsupported field specified.
	20302    Array line count must be nonnegative.
	20303    Array index out of bounds.
	20304    Invalid field index.
	20402    Field not accessible as a special field.
	20403    Write access attempted of readonly field.
	20404    Read access attempted of writeonly field.
	20422    The object cannot be modified.
	20512    The QBRequestId has been previously used. Please generate a new one.
	20602    Could not access QuickBooks.
	20603    Could not open specified file.
	20604    The version of QuickBooks currently being used is not supported.
	20605    QuickBooks has not been installed properly.
	20606    The specified file was of an incorrect version.
	20607    Could not start QuickBooks.
	20608    QuickBooks is open in a mode different than the one requested.
	20609    QuickBooks cannot currently be accessed.
	20610    An application name must be specified.
	20611    A file name must be specified if one is not currently open in QuickBooks.
	20612    Access denied.
	20613    QuickBooks is busy and cannot open your application in the mode requested.
	20700    The connection to QuickBooks has failed for an unknown reason.
	20703    The object requested does not exist in QuickBooks.
	20752    Unsupported QBXML version.
	20753    The QBXMLVersion chosen is insufficient to execute the request.
	20802    A QuickBooks internal error has occurred.
	20803    QuickBooks is not available due to a system-related problem.
	20804    The Id specified is invalid.
	20805    Invalid object name.
	20806    The name already exists in QuickBooks.
	20808    An object could not be found in QuickBooks.
	20809    A reference did not refer to an object that exists in QuickBooks.
	20810    The object is currently in use by the QuickBooks end user.
	20811    The object may not be added.
	20812    The object may not be updated because it is obsolete.
	20813    The address is invalid.
	20814    Permission to perform this operation is not granted.
	20815    The request has not been processed.
	20816    Time creation mismatch.
	20817    The feature is turned off or not enabled.
	20818    Permission level configured is insufficient for access.
	20819     The item specified was of an unknown type.
	20820    The object may not be changed.
	20821    An internal QuickBooks error has occurred.
	20822    An attempt was made to use a connection that was not properly initiated.
	20823    An attempt was made to use a connection that is invalid or was previously closed.
	20824    Not enough memory.
	20825    Unable to lock the necessary information to allow this application access to the company file. Try again later.
	20851    An older version of QuickBooks 2002 is being used. Please download the latest update from Intuit.
	20852    The QuickBooks request processor was not found. Check that QuickBooks Pro 2002 or higher is installed on your system.
	20862    Server error on WebExport (details follow).
	20863    The WebExport is impossible: an HTTP context was not found.
	20872    You may not set the value of QBConnectionTicket. This value is readonly.
	20881    Interrupted by the user.
	20882    An error has occurred connecting to a remote machine.
	20900    An unknown QuickBooks error has occurred. The message contains more details.
	20902    XML Parser Error. Should not occur under normal circumstances.
	20142    You must set AppliedToTransactionDetails to do a custom ReceivePayment.