BillPayment Class

Properties Methods Events Configuration Settings Errors

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

Syntax

class inqb.BillPayment

Remarks

The BillPayment class 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 ap_account_id and/or ap_account_name 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 payment_method property. If using a credit card, the credit_card_name or credit_card_id properties are required. If paying by check, the bank_account_name or bank_account_id properties are required, and you may optionally use the ref_number property to indicate the check number.

Required Fields (Add):payee_name, applied_to, payment_method, ref_number or is_to_be_printed, bank_account_name or bank_account_id (Checks), credit_card_name or credit_card_id (Credit Cards)

Supported Methods:add, get (Id), cancel, delete

Example:

BillPayment1.PayeeName = "Daigle Lighting"
BillPayment1.BankAccountName = "Checking"
BillPayment1.AppliedToCount = 1
BillPayment1.AppliedToRefId(0) = "5CAE-1197739628"
BillPayment1.AppliedToPaymentAmount(0) = "10.00"
BillPayment1.PaymentMethod = BillpaymentPaymentMethods.pmCheck
BillPayment1.IsToBePrinted = true    
BillPayment1.Add()

The class supports a variety of other operations as well. The class's get, cancel, and delete methods may be used to retrieve, cancel, and delete BILLPAYMENTSs, respectively. The ObjSearch Class may be used to search for BILLPAYMENTSs 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.


address	Address printed on the check.
amount	Amount of transaction.
ap_account_id	Reference to the Accounts Payable account where money goes.
ap_account_name	Reference to the Accounts Payable account.
applied_to_count	The number of records in the AppliedTo arrays.
applied_to_amount	The amount of the transaction that has just been paid.
applied_to_balance_remaining	The outstanding balance that has yet to be paid for the transaction indicated by RefId .
applied_to_credit_applied_amount	Amount of a credit that is applied to a customer's bill.
applied_to_credit_memo_id	The ID of the credit memo that you are applying to this bill.
applied_to_discount_account_id	Refers to the account where this discount is tracked.
applied_to_discount_account_name	Refers to the account where this discount is tracked.
applied_to_discount_amount	Reduces the receivable amount.
applied_to_payment_amount	Represents the amount assigned to a particular bill payment.
applied_to_ref_id	Refers to the transaction Id of the bill that is being paid.
applied_to_ref_number	RefNumber of the transaction that was just paid.
applied_to_txn_date	Date of the transaction that has just been paid.
applied_to_txn_type	The type of the transaction.
bank_account_id	Refers to the account from which the funds are being drawn for this bill payment.
bank_account_name	Refers to the account from which the funds are being drawn for this bill payment.
credit_card_id	Refers to the credit card account to which this payment is being charged.
credit_card_name	Refers to the credit card account to which this payment is being charged.
is_to_be_printed	Whether this transaction is to be printed.
memo	Memo to appear on internal reports only.
payee_id	Reference to entity from whom merchandise was purchased.
payee_name	Reference to entity from whom merchandise was purchased.
payment_method	Indicates whether the Bill Payment is being made with a check or a credit card.
qb_connection_string	An aggregate consisting of various QuickBooks connection properties.
qb_request_aggregate	The request aggregate.
qb_request_id	The Id of the next message to be sent to QuickBooks.
qb_request_mode	Defines whether the request is made online or stored offline.
qb_response_aggregate	The last QBXML response aggregate received from QuickBooks.
qbxml_version	The version of QBXML used in the outgoing message.
ref_id	An alphanumerical identifier generated by the server.
ref_number	Reference number for the transaction.
transaction_date	Date of transaction.

Method List

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


add	Adds the record into QuickBooks.
cancel	Cancels (voids) the transaction.
check_request_status	Checks whether or not the specified request was processed by QuickBooks.
close_qb_connection	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.
get_custom_field	Gets a custom field value from QuickBooks.
import_qbxml	Imports a QBXML response aggregate.
open_qb_connection	Opens a persistent connection to QuickBooks.
reset	Resets all properties to their defaults.
set_custom_field	Sets a custom field value within QuickBooks.
update	Updates the bill 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_error	Information about errors during data delivery.
on_ssl_server_authentication	Fired after the server presents its certificate to the client.
on_ssl_status	Shows the progress of the secure connection.
on_status	Shows the progress of the QuickBooks connection.
on_warning	Fired 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.


AppliedToAggregate[index]	Contains the XML aggregate of the AppliedTo element.
AuthFlags	Connection Flags (use for QuickBooks Simple Start).
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.
SSLAcceptServerCert	The SSL certificate being used by the Remote Connector.
SSLAcceptServerCertFile	The SSL certificate file being used by the Remote Connector.
StopOnError	Specifies how QuickBooks is to proceed if an error occurs in processing of the current request.
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.
CodePage	The system code page used for Unicode to Multibyte translations.
LicenseInfo	Information about the current license.
ProcessIdleEvents	Whether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillis	The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseInternalSecurityAPI	Tells the class whether or not to use the system security libraries or an internal implementation.