QuickBooks Integrator 2020 iOS Edition

Questions / Feedback?

ReceivePayment Class

Properties   Methods   Events   Configuration Settings   Errors  

The ReceivePayment class is used to receive payments from customers.

Syntax

InQBReceivePayment
InQBReceivePaymentSwift

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.

- amountAmount of payment.
- appliedToCountThe number of records in the AppliedTo arrays.
- appliedToAmount:(int)appliedToIndexThe amount of the transaction that has just been paid.
- appliedToBalanceRemaining:(int)appliedToIndexThe outstanding balance that has yet to be paid for the transaction indicated by RefId .
- appliedToCreditAppliedAmount:(int)appliedToIndexAmount of a credit that is applied to a customer's bill.
- appliedToCreditMemoId:(int)appliedToIndexThe ID of the credit memo that you are applying to this bill.
- appliedToDiscountAccountId:(int)appliedToIndexRefers to the account where this discount is tracked.
- appliedToDiscountAccountName:(int)appliedToIndexRefers to the account where this discount is tracked.
- appliedToDiscountAmount:(int)appliedToIndexReduces the receivable amount.
- appliedToPaymentAmount:(int)appliedToIndexRepresents the amount assigned to a particular bill payment.
- appliedToRefId:(int)appliedToIndexRefers to the transaction Id of the bill that is being paid.
- appliedToRefNumber:(int)appliedToIndexRefNumber of the transaction that was just paid.
- appliedToTxnDate:(int)appliedToIndexDate of the transaction that has just been paid.
- appliedToTxnType:(int)appliedToIndexThe type of the transaction.
- ARAccountIdReference to the Accounts Receivable account where money goes.
- ARAccountNameReference to the Accounts Receivable account where money goes.
- autoApplyHow the payment should be applied.
- customerIdA reference to the customer or customer job.
- customerNameA reference to the customer or customer job.
- depositToAccountIdThe account to which the payment should be deposited.
- depositToAccountNameThe account to which the payment should be deposited.
- memoMemo to appear on internal reports only.
- paymentMethodIdReference to method of payment.
- paymentMethodNameReference to method of payment.
- QBConnectionStringAn aggregate consisting of various QuickBooks connection properties.
- QBRequestAggregateThe request aggregate.
- QBRequestIdThe Id of the next message to be sent to QuickBooks.
- QBRequestModeDefines whether the request is made online or stored offline.
- QBResponseAggregateThe last QBXML response aggregate received from QuickBooks.
- QBXMLVersionThe version of QBXML used in the outgoing message.
- refIdAn alphanumerical identifier generated by the server.
- refNumberReference number for the transaction.
- transactionDateDate of transaction.
- unusedPaymentThe amount of the payment that remains unused.

Method List


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

- addAdds the record into QuickBooks.
- checkRequestStatusChecks whether or not the specified request was processed by QuickBooks.
- closeQBConnectionCloses a persistent connection to QuickBooks.
- configSets or retrieves a configuration setting.
- deleteDeletes the record from QuickBooks.
- getGets a single record from QuickBooks.
- getCustomFieldGets a custom field value from QuickBooks.
- importQBXMLImports a QBXML response aggregate.
- openQBConnectionOpens a persistent connection to QuickBooks.
- resetResets all properties to their defaults.
- setCustomFieldSets a custom field value within QuickBooks.
- updateUpdates the sales order in QuickBooks.

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.

- onErrorInformation about errors during data delivery.
- onSSLServerAuthenticationFired after the server presents its certificate to the client.
- onSSLStatusShows the progress of the secure connection.
- onStatusShows the progress of the QuickBooks connection.
- onWarningFired when a warning occurs.

Configuration Settings


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

AppendAfterAppends an XML tag after the specified QBXML element.
AppliedToAggregate[index]Contains the XML aggregate of the AppliedTo element.
AuthFlagsConnection Flags (use for QuickBooks Simple Start).
CreditCardTxnInfoXML aggregate containing the result of an actual credit card transaction to be reconciled with QuickBooks.
EditSequenceAn identifier for this copy of the object.
EnforceMaxLengthIndicates whether to enforce max lengths for QB Fields.
GetHighestVersionHighest QBXMLVersion supported by the installed instance of QuickBooks.
GetRequestProcessorDLLVersionReturns the version of the QB Request Processor that is installed on your system.
GetSupportedVersionsReturns a list of QBXMLVersions that are supported by QuickBooks.
IsReadOnlyThis causes the QuickBooks authorization dialog to display text informing the user that its access will be read-only.
PersonalDataPrefWhether the connecting application will require access to personal data such as SSN or credit card information.
QBConnectionModeThe mode of connection to QuickBooks.
QBFileStatusThe status of the company file as it pertains to accepting connections.
QBOpenCompanyFileThe file currently open in QuickBooks.
SendRawXMLSends specified XML to quickbooks without modification.
SSLAcceptServerCertThe SSL certificate being used by the Remote Connector.
SSLAcceptServerCertFileThe SSL certificate file being used by the Remote Connector.
StopOnErrorSpecifies how QuickBooks is to proceed if an error occurs in processing of the current request.
TimeCreatedThe time the object was created.
TimeModifiedThe time the object was created.
UnattendedModePrefWhether connecting while QuickBooks is closed is required or optional for the user.
WarningCodesA comma-separated list of QuickBooks warning codes that should not result in an exception.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
ProcessIdleEventsWhether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillisThe length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseInternalSecurityAPITells the class whether or not to use the system security libraries or an internal implementation.

Copyright (c) 2021 /n software inc. - All rights reserved.
QuickBooks Integrator 2020 iOS Edition - Version 20.0 [Build 7941]