The ReceivePayment component is used to receive payments from customers.
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
ReceivePayment1.CustomerName = "Abercrombie, Kristy" '* ReceivePayment1.Amount = "56.24" '$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.
The following is the full list of the properties of the component with short descriptions. Click on the links for further details.
|Amount||Amount of payment.|
|AppliedTo||Indicates the transactions that this Payment applies to.|
|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.|
The following is the full list of the methods of the component 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.|
The following is the full list of the events fired by the component 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.|
The following is a list of configuration settings for the component 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.|
|BuildInfo||Information about the product's build.|
|GUIAvailable||Tells the component whether or not a message loop is available for processing events.|
|LicenseInfo||Information about the current license.|
|UseInternalSecurityAPI||Tells the component whether or not to use the system security libraries or an internal implementation.|