4D Accounting SDK 2020 .NET Edition

Questions / Feedback?

BillPayment Component

Properties   Methods   Events   Configuration Settings   Errors  

The BILLPAYMENT component provides the functionality found in the Pay Bills form in the QuickBooks UI.

Syntax

DPayments.DAccountingSDK.Billpayment

Remarks

The BillPayment component provides the functionality found in the Pay Bills form in the QuickBooks UI. You can reach this form by selecting Retail->Pay Bills from the main QuickBooks menubar. If you want to pay multiple bills, you must issue a separate request for each bill pay.

If you are using more than one Accounts payable account, make sure that the APAccountId and/or APAccountName matches the account that was used when the Bill was originally added. That is, the bill was entered in a particular account payable: use that same account payable when you pay the bill using this request.

You may use a credit card or check to make the billpayment by setting the PaymentMethod property. If using a credit card, the CreditCardName or CreditCardId properties are required. If paying by check, the BankAccountName or BankAccountId properties are required, and you may optionally use the RefNumber property to indicate the check number.

Required Fields (Add):PayeeName, AppliedTo, PaymentMethod, RefNumber or IsToBePrinted, BankAccountName or BankAccountId (Checks), CreditCardName or CreditCardId (Credit Cards)

Supported Methods:Add, Get (Id), Cancel, Delete

Example:

BillPayment1.PayeeName = "Daigle Lighting"
BillPayment1.BankAccountName = "Checking"
BillPayment1.AppliedTo.Add(New AppliedTo())
BillPayment1.AppliedTo(0).RefId = "5CAE-1197739628"
BillPayment1.AppliedTo(0).PaymentAmount = "10.00"
BillPayment1.PaymentMethod = BillpaymentPaymentMethods.pmCheck
BillPayment1.IsToBePrinted = true    
BillPayment1.Add()
The component supports a variety of other operations as well. The component's Get, Cancel, and Delete methods may be used to retrieve, cancel, and delete BILLPAYMENTSs, respectively. The ObjSearch Component may be used to search for BILLPAYMENTSs 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.

AddressAddress printed on the check.
AmountAmount of transaction.
APAccountIdReference to the Accounts Payable account where money goes.
APAccountNameReference to the Accounts Payable account.
AppliedToIndicates the transactions that this Payment applies to.
BankAccountIdRefers to the account from which the funds are being drawn for this bill payment.
BankAccountNameRefers to the account from which the funds are being drawn for this bill payment.
CreditCardIdRefers to the credit card account to which this payment is being charged.
CreditCardNameRefers to the credit card account to which this payment is being charged.
IsToBePrintedWhether this transaction is to be printed.
MemoMemo to appear on internal reports only.
PayeeIdReference to entity from whom merchandise was purchased.
PayeeNameReference to entity from whom merchandise was purchased.
PaymentMethodIndicates whether the Bill Payment is being made with a check or a credit card.
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.

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.
CancelCancels (voids) the transaction.
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 bill 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.

AppliedToAggregate[index]Contains the XML aggregate of the AppliedTo element.
AuthFlagsConnection Flags (use for QuickBooks Simple Start).
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.
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.
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]