QuickBooks Integrator 2020 Python Edition

Questions / Feedback?

StatementCharge Class

Properties   Methods   Events   Configuration Settings   Errors  

The STATEMENTCHARGE class allows you to add and modify individual charges on a customer's statement.

Syntax

class inqb.StatementCharge

Remarks

The StatementCharge class provides the functionality found in the Statement Charge form in the QuickBooks UI. Statement charges are similar to individual line items for Bill or Invoice transactions, but considerably simpler. They consist of a single Item (designated by item_name or item_id) to be added and an Accounts Receivable account (specified by ar_account_name or ar_account_id) where the funds will end up after a payment is received from the Customer (indicated by customer_name or customer_id).

Add a charges for every item you wish to be on the customer's statement. The billed_date allows you to add charges to a particular statement. (Changing billed_date will create a new statement or add charges to an older one).

Required Fields (Add): Customer (customer_name or customer_id), and an Item (item_name or item_id).

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

Example:

StatementCharge1.CustomerName = "Baker, Chris";
StatementCharge1.ItemName = "Hardware";
StatementCharge1.Amount = "90.00";
StatementCharge1.Rate = "10.00";
StatementCharge1.ARAccountName = "Accounts Receivable";
StatementCharge1.BilledDate = "2009-06-20";
StatementCharge1.ClassName = "Remodel";
StatementCharge1.CustomerName = "Baker, Chris";
StatementCharge1.Description = "Test transaction";
StatementCharge1.DueDate = "2009-07-04";
StatementCharge1.Quantity = "9";
StatementCharge1.RefNumber = "543";
StatementCharge1.TransactionDate = "2009-06-24";
StatementCharge1.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 StatementCharges, respectively. The ObjSearch Class may be used to search for StatementCharges 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.

amountThe total amount (price) of the items in this statement.
ar_account_idReference to the Accounts Receivable account where money goes.
ar_account_nameReference to the Accounts Receivable account where money goes.
balance_remainingBalance remaining.
billed_dateDate when statement was billed.
class_idReference to the class of the charge.
class_nameReference to the class of the charge.
customer_idA reference to the customer or customer job.
customer_nameA reference to the customer or customer job.
descriptionDescription of this statement charge.
due_dateDate when payment is due.
is_paidIndicates whether this bill has been paid.
item_idItem being added to the statement.
item_nameItem being added to the statement.
linked_txn_countThe number of records in the LinkedTxn arrays.
linked_txn_amountThe amount of the linked transaction.
linked_txn_dateThe date of the linked transaction.
linked_txn_link_typeIndicates the nature of the link between the transactions.
linked_txn_ref_numberThis is the reference number assigned to the linked transaction.
linked_txn_idThis property can be used by another class to reference the original transaction which is linked to the current response.
linked_txn_typeThis property indicates which type of linked transaction has been returned.
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.
quantityQuantity of items in this statement.
rateUnit rate of item.
ref_idAn alphanumerical identifier generated by the server.
ref_numberReference number for the transaction.
transaction_dateDate 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.

addAdds the record into QuickBooks.
cancelCancels (voids) the transaction.
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 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_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.
AuthFlagsConnection Flags (use for QuickBooks Simple Start).
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]