The BILLPAYMENT component provides the functionality found in the Pay Bills form in the QuickBooks UI.
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.
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.
The following is the full list of the properties of the component with short descriptions. Click on the links for further details.
|Address||Address printed on the check.|
|Amount||Amount of transaction.|
|APAccountId||Reference to the Accounts Payable account where money goes.|
|APAccountName||Reference to the Accounts Payable account.|
|AppliedTo||Indicates the transactions that this Payment applies to.|
|BankAccountId||Refers to the account from which the funds are being drawn for this bill payment.|
|BankAccountName||Refers to the account from which the funds are being drawn for this bill payment.|
|CreditCardId||Refers to the credit card account to which this payment is being charged.|
|CreditCardName||Refers to the credit card account to which this payment is being charged.|
|IsToBePrinted||Whether this transaction is to be printed.|
|Memo||Memo to appear on internal reports only.|
|PayeeId||Reference to entity from whom merchandise was purchased.|
|PayeeName||Reference to entity from whom merchandise was purchased.|
|PaymentMethod||Indicates whether the Bill Payment is being made with a check or a credit card.|
|QBConnectionString||An aggregate consisting of various QuickBooks connection properties.|
|QBRequestAggregate||The request aggregate.|
|QBRequestId||The Id of the next message to be sent to QuickBooks.|
|QBRequestMode||Defines whether the request is made online or stored offline.|
|QBResponseAggregate||The last QBXML response aggregate received from QuickBooks.|
|QBXMLVersion||The version of QBXML used in the outgoing message.|
|RefId||An alphanumerical identifier generated by the server.|
|RefNumber||Reference number for the transaction.|
|TransactionDate||Date of transaction.|
The following is the full list of the methods of the component with short descriptions. Click on the links for further details.
|Add||Adds the record into QuickBooks.|
|Cancel||Cancels (voids) the transaction.|
|CheckRequestStatus||Checks whether or not the specified request was processed by QuickBooks.|
|CloseQBConnection||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.|
|GetCustomField||Gets a custom field value from QuickBooks.|
|ImportQBXML||Imports a QBXML response aggregate.|
|OpenQBConnection||Opens a persistent connection to QuickBooks.|
|Reset||Resets all properties to their defaults.|
|SetCustomField||Sets a custom field value within QuickBooks.|
|Update||Updates the bill in QuickBooks.|
The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.
|Error||Information about errors during data delivery.|
|SSLServerAuthentication||Fired after the server presents its certificate to the client.|
|SSLStatus||Shows the progress of the secure connection.|
|Status||Shows the progress of the QuickBooks connection.|
|Warning||Fired when a warning occurs.|
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.|
|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 QuickBooks Gateway (aka Remote Connector).|
|SSLAcceptServerCertFile||The SSL certificate file being used by the QuickBooks Gateway (aka 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.|
|GUIAvailable||Tells the component whether or not a message loop is available for processing events.|
|LicenseInfo||Information about the current license.|
|UseInternalSecurityAPI||Tells the component whether or not to use the system security libraries or an internal implementation.|