StatementCharge Component [QuickBooks Integrator V5]
Properties
Methods
Events
Configuration Settings
The STATEMENTCHARGE component allows you to add and modify individual charges on a customer's statement.
NOTE: What follows is a very short description of the component interfaces.
For more information, please consult the help files that come with the respective package.
Remarks
The STATEMENTCHARGE component 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
Online Edition: This component is not supported by QBOE.
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 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 STATEMENTCHARGEs, respectively. The OBJSEARCH Component may be used to search
for STATEMENTCHARGEs 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.
| |
| 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. |
| QBRequestId | The Id of the next message to be sent to QuickBooks. |
| QBResponseAggregate | The last XML 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 component with short
descriptions. Click on the links for further details.
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.
| |
| 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 component with short
descriptions. Click on the links for further details.
