4D Accounting SDK 2020 .NET Edition

Questions / Feedback?

StatementCharge Component

Properties   Methods   Events   Configuration Settings   Errors  

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

Syntax

DPayments.DAccountingSDK.Statementcharge

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

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.

AmountThe total amount (price) of the items in this statement.
ARAccountIdReference to the Accounts Receivable account where money goes.
ARAccountNameReference to the Accounts Receivable account where money goes.
BalanceRemainingBalance remaining.
BilledDateDate when statement was billed.
ClassIdReference to the class of the charge.
ClassNameReference to the class of the charge.
CustomerIdA reference to the customer or customer job.
CustomerNameA reference to the customer or customer job.
DescriptionDescription of this statement charge.
DueDateDate when payment is due.
IsPaidIndicates whether this bill has been paid.
ItemIdItem being added to the statement.
ItemNameItem being added to the statement.
LinkedTxnsInformation used to reference a transaction that is linked to the existing transaction.
QBConnectionStringAn aggregate consisting of various QuickBooks connection properties.
QBRequestAggregateThe request aggregate.
QBRequestIdThe Id of the next message to be sent to QuickBooks.
QBRequestModeDefines whether the request is made online or stored offline.
QBResponseAggregateThe last QBXML response aggregate received from QuickBooks.
QBXMLVersionThe version of QBXML used in the outgoing message.
QuantityQuantity of items in this statement.
RateUnit rate of item.
RefIdAn alphanumerical identifier generated by the server.
RefNumberReference number for the transaction.
TransactionDateDate 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.

AddAdds the record into QuickBooks.
CancelCancels (voids) the transaction.
CheckRequestStatusChecks whether or not the specified request was processed by QuickBooks.
CloseQBConnectionCloses a persistent connection to QuickBooks.
ConfigSets or retrieves a configuration setting.
DeleteDeletes the record from QuickBooks.
GetGets a single record from QuickBooks.
GetCustomFieldGets a custom field value from QuickBooks.
ImportQBXMLImports a QBXML response aggregate.
OpenQBConnectionOpens a persistent connection to QuickBooks.
ResetResets all properties to their defaults.
SetCustomFieldSets 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 component with short descriptions. Click on the links for further details.

ErrorInformation about errors during data delivery.
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusShows the progress of the secure connection.
StatusShows the progress of the QuickBooks connection.
WarningFired 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.

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.
GUIAvailableTells the component whether or not a message loop is available for processing events.
LicenseInfoInformation about the current license.
UseInternalSecurityAPITells the component whether or not to use the system security libraries or an internal implementation.

 
 
Copyright (c) 2021 4D Payments Inc. - All rights reserved.
4D Accounting SDK 2020 .NET Edition - Version 20.0 [Build 7887]