QuickBooks Integrator 2020 Python Edition

Questions / Feedback?

ReceivePayment Class

Properties   Methods   Events   Configuration Settings   Errors  

The ReceivePayment class is used to receive payments from customers.

Syntax

class inqb.ReceivePayment

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), transaction_date, ref_number, 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.
applied_to_countThe number of records in the AppliedTo arrays.
applied_to_amountThe amount of the transaction that has just been paid.
applied_to_balance_remainingThe outstanding balance that has yet to be paid for the transaction indicated by RefId .
applied_to_credit_applied_amountAmount of a credit that is applied to a customer's bill.
applied_to_credit_memo_idThe ID of the credit memo that you are applying to this bill.
applied_to_discount_account_idRefers to the account where this discount is tracked.
applied_to_discount_account_nameRefers to the account where this discount is tracked.
applied_to_discount_amountReduces the receivable amount.
applied_to_payment_amountRepresents the amount assigned to a particular bill payment.
applied_to_ref_idRefers to the transaction Id of the bill that is being paid.
applied_to_ref_numberRefNumber of the transaction that was just paid.
applied_to_txn_dateDate of the transaction that has just been paid.
applied_to_txn_typeThe type of the transaction.
ar_account_idReference to the Accounts Receivable account where money goes.
ar_account_nameReference to the Accounts Receivable account where money goes.
auto_applyHow the payment should be applied.
customer_idA reference to the customer or customer job.
customer_nameA reference to the customer or customer job.
deposit_to_account_idThe account to which the payment should be deposited.
deposit_to_account_nameThe account to which the payment should be deposited.
memoMemo to appear on internal reports only.
payment_method_idReference to method of payment.
payment_method_nameReference to method of payment.
qb_connection_stringAn aggregate consisting of various QuickBooks connection properties.
qb_request_aggregateThe request aggregate.
qb_request_idThe Id of the next message to be sent to QuickBooks.
qb_request_modeDefines whether the request is made online or stored offline.
qb_response_aggregateThe last QBXML response aggregate received from QuickBooks.
qbxml_versionThe version of QBXML used in the outgoing message.
ref_idAn alphanumerical identifier generated by the server.
ref_numberReference number for the transaction.
transaction_dateDate of transaction.
unused_paymentThe 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.
check_request_statusChecks whether or not the specified request was processed by QuickBooks.
close_qb_connectionCloses a persistent connection to QuickBooks.
configSets or retrieves a configuration setting.
deleteDeletes the record from QuickBooks.
getGets a single record from QuickBooks.
get_custom_fieldGets a custom field value from QuickBooks.
import_qbxmlImports a QBXML response aggregate.
open_qb_connectionOpens a persistent connection to QuickBooks.
resetResets all properties to their defaults.
set_custom_fieldSets 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.

on_errorInformation about errors during data delivery.
on_ssl_server_authenticationFired after the server presents its certificate to the client.
on_ssl_statusShows the progress of the secure connection.
on_statusShows the progress of the QuickBooks connection.
on_warningFired 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 Python Edition - Version 20.0 [Build 7941]