StatementCharge Control
Properties Methods Events Configuration Settings Errors
The STATEMENTCHARGE component allows you to add and modify individual charges on a customer's statement.
Syntax
StatementCharge
Remarks
The StatementCharge control 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 ItemName or ItemId) to be added and an Accounts Receivable account (specified by ARAccountName or ARAccountId) where the funds will end up after a payment is received from the Customer (indicated by CustomerName or CustomerId).
Add a charges for every item you wish to be on the customer's statement. The BilledDate allows you to add charges to a particular statement. (Changing BilledDate will create a new statement or add charges to an older one).
Required Fields (Add): Customer (CustomerName or CustomerId), and an Item (ItemName or ItemId).
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 control supports a variety of other operations as well. The control's Get, Cancel, and Delete methods may be used to retrieve, cancel, and delete StatementCharges, respectively. The ObjSearch Control may be used to search for StatementCharges in the QuickBooks database.
Property List
The following is the full list of the properties of the control with short descriptions. Click on the links for further details.
Amount | The total amount (price) of the items in this statement. |
ARAccountId | Reference to the Accounts Receivable account where money goes. |
ARAccountName | Reference to the Accounts Receivable account where money goes. |
BalanceRemaining | Balance remaining. |
BilledDate | Date when statement was billed. |
ClassId | Reference to the class of the charge. |
ClassName | Reference to the class of the charge. |
CustomerId | A reference to the customer or customer job. |
CustomerName | A reference to the customer or customer job. |
Description | Description of this statement charge. |
DueDate | Date when payment is due. |
IsPaid | Indicates whether this bill has been paid. |
ItemId | Item being added to the statement. |
ItemName | Item being added to the statement. |
LinkedTxnCount | The number of records in the LinkedTxn arrays. |
LinkedTxnAmount | The amount of the linked transaction. |
LinkedTxnDate | The date of the linked transaction. |
LinkedTxnLinkType | Indicates the nature of the link between the transactions. |
LinkedTxnRefNumber | This is the reference number assigned to the linked transaction. |
LinkedTxnId | This property can be used by another component to reference the original transaction which is linked to the current response. |
LinkedTxnType | This property indicates which type of linked transaction has been returned. |
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. |
Quantity | Quantity of items in this statement. |
Rate | Unit rate of item. |
RefId | An alphanumerical identifier generated by the server. |
RefNumber | Reference number for the transaction. |
TransactionDate | Date of transaction. |
Method List
The following is the full list of the methods of the control 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. |
Event List
The following is the full list of the events fired by the control 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. |
Configuration Settings
The following is a list of configuration settings for the control with short descriptions. Click on the links for further details.
SendRawXML | Sends specified XML to quickbooks without modification. |
AppendAfter | Appends an XML tag after the specified QBXML element. |
TimeCreated | The time the object was created. |
TimeModified | The time the object was created. |
EditSequence | An identifier for this copy of the object. |
StopOnError | Specifies how QuickBooks is to proceed if an error occurs in processing of the current request. |
SSLAcceptServerCert | The SSL certificate being used by the Remote Connector. |
SSLAcceptServerCertFile | The SSL certificate file being used by the Remote Connector. |
EnforceMaxLength | Indicates whether to enforce max lengths for QB Fields. |
AuthFlags | Connection Flags (use for QuickBooks Simple Start). |
GetHighestVersion | Highest QBXMLVersion supported by the installed instance of QuickBooks. |
GetSupportedVersions | Returns a list of QBXMLVersions that are supported by QuickBooks. |
GetRequestProcessorDLLVersion | Returns the version of the QB Request Processor that is installed on your system. |
IsReadOnly | This causes the QuickBooks authorization dialog to display text informing the user that its access will be read-only. |
UnattendedModePref | Whether connecting while QuickBooks is closed is required or optional for the user. |
PersonalDataPref | Whether the connecting application will require access to personal data such as SSN or credit card information. |
QBOpenCompanyFile | The file currently open in QuickBooks. |
QBConnectionMode | The mode of connection to QuickBooks. |
QBFileStatus | The status of the company file as it pertains to accepting connections. |
WarningCodes | A comma-separated list of QuickBooks warning codes that should not result in an exception. |
CodePage | The system code page used for Unicode to Multibyte translations. |