IBiz QuickBooks receivepayment Component : receivepayment OCX, receivepayment .NET Component, receivepayment Class, receivepayment Bean, receivepayment Object

Available in: QUICKBOOKS

ReceivePayment Component [IBiz Integrator for QuickBooks - V4]

Properties Methods Events Configuration Settings

The ReceivePayment component is used to receive payments from customers.

NOTE: What follows is a very short description of the component interfaces. For more information, please consult the help files that come with the respective package.

Remarks

The ReceivePayment component 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

Online Edition: Same as the desktop edition.

Example

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

The component supports a variety of other operations as well. The component's Get, and Delete methods may be used to retrieve, and delete payments, respectively. The OBJSEARCH component may be used to search for ReceivePayments in the QuickBooks database.

Starting with QuickBooks 2005, the ReceivePayment component can be used to reconcile credit card transactions made with the QBMSAUTHORIZE component into QuickBooks. After a successful authorization, set the CCAggregate property with the data returned from the QBMSAUTHORIZE's GetXMLAggregate method. Then do an Add as normal.

In order to be able to push credit card transactions into QuickBooks 2005 or greater, your merchant account must be signed up with QuickBooks Merchant Services. You may sign up for a live account through QuickBooks by selecting the Customers menu and then clicking on "Receive Payments". Now click on the "Process credit card payment when saving" checkbox, and follow the instructions.

If you wish to set up a TEST account, you will need to download Quickbooks SDK 5.0 from http://www.intuit.com and run the "QBMS use IDNBeta" tool. Then follow the same instructions above. When you get to the screen that indicates you should receive a confirmation email, your test account is set up, and you can now process test transactions from within QuickBooks, as well as reconcile charges made with the QBMSAUTHORIZE component using RECEIVEPAYMENT or SALESRECEIPT.

Property List

The following is the full list of the properties of the component with short descriptions. Click on the links for complete descriptions.


ARAccountId	Reference to the Accounts Receivable account where money goes.
ARAccountName	Reference to the Accounts Receivable account where money goes.
Amount	Amount of payment.
ApplyTo	How the payment should be applied.
CCAggregate	Credit Card transaction aggregate from the QBMSAuthorize component.
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.
QBAddRequestAggregate	Request aggregate for an Add.
QBConnectionMode	The mode of connection to QuickBooks.
QBConnectionString	An aggregate consisting of various QuickBooks connection properties.
QBOpenCompanyFile	The file currently open in QuickBooks.
QBRequestId	The Id of the next message to be sent to QuickBooks.
QBResponseAggregate	The last XML 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 component with short descriptions. Click on the links for complete descriptions.


AXMExport	Exports the object.
AXMImport	Imports the object.
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 component configuration setting.
Delete	Deletes the record from QuickBooks.
Get	Gets a single record from QuickBooks.
GetCustomField	Gets a custom field value from QuickBooks.
OpenQBConnection	Opens a persistent connection to QuickBooks.
Reset	Resets all properties to their defaults.
SetCustomField	Sets a custom field value within QuickBooks.
WebExport	Exports the object to a web client.

Event List

The following is the full list of the events fired by the component with short descriptions. Click on the links for complete descriptions.


Error	Information about errors during data delivery.
Status	Shows the progress of the QuickBooks connection.
Warning	Fired when a warning occurs.

Configuration Settings

The following is a list of configuration settings for the component with short descriptions. Click on the links for complete descriptions.


AppendAfter	Appends an xml tag after the specified QBXML element.
AppliedToTransactionDetails	Instructions on where to apply the payment, in case is set to atCustom. The value should be set to one or more AppliedToTxnAdd XML aggregates, as defined in the QBXML specification.
AppliedToTransactions.Count	Number of transactions returned.
AuthFlags	Connection Flags (use for QuickBooks Simple Start).
CodePage	The system code page used for Unicode to Multibyte translations (Windows/COM only).
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.
IgnoreQBOEWarnings	Ignores warnings returned from QuickBooks Online.
SSLAcceptServerCert	The SSL certificate being used by the Remote Connector
SSLAcceptServerCertFile	The SSL certificate file being used by the Remote Connector
SendRawXML	Sends specified XML to quickbooks without modification.
TimeCreated	The time the object was created.
TimeModified	The time the object was created.
{AppliedToTransactions[index].Amount}	The total amount of the transaction.
{AppliedToTransactions[index].BalanceRemaining}	The balance remaining on the transaction.
{AppliedToTransactions[index].RefNumber}	The reference number of the transaction.
{AppliedToTransactions[index].TransactionDate}	The date of the transaction.
{AppliedToTransactions[index].TransactionId}	The unique ID of the transaction.
{AppliedToTransactions[index].TransactionType}	A textual description of the transaction.