4D Accounting SDK 2020 .NET Edition

Questions / Feedback?

ReceivePayment Component

Properties   Methods   Events   Configuration Settings   Errors  

The ReceivePayment component is used to receive payments from customers.

Syntax

DPayments.DAccountingSDK.Receivepayment

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

Example

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.

Property List


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

AmountAmount of payment.
AppliedToIndicates the transactions that this Payment applies to.
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 component 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 component with short descriptions. Click on the links for further details.

ErrorInformation about errors during data delivery.
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusShows the progress of the secure connection.
StatusShows the progress of the QuickBooks connection.
WarningFired 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 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.
GUIAvailableTells the component whether or not a message loop is available for processing events.
LicenseInfoInformation about the current license.
UseInternalSecurityAPITells the component whether or not to use the system security libraries or an internal implementation.

 
 
Copyright (c) 2021 4D Payments Inc. - All rights reserved.
4D Accounting SDK 2020 .NET Edition - Version 20.0 [Build 7887]