QuickBooks Integrator 2022 C++ Builder Edition
Version 22.0 [Build 8594]

StatementCharge Component

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

TiqbStatementCharge

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.
LinkedTxnCountThe number of records in the LinkedTxn arrays.
LinkedTxnAmountThe amount of the linked transaction.
LinkedTxnDateThe date of the linked transaction.
LinkedTxnLinkTypeIndicates the nature of the link between the transactions.
LinkedTxnRefNumberThis is the reference number assigned to the linked transaction.
LinkedTxnIdThis property can be used by another component to reference the original transaction which is linked to the current response.
LinkedTxnTypeThis property indicates which type of linked transaction has been returned.
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.

Config Settings


The following is a list of config 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 QuickBooks Gateway (aka Remote Connector).
SSLAcceptServerCertFileThe SSL certificate file being used by the QuickBooks Gateway (aka 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.
MaskSensitiveWhether sensitive data is masked in log messages.
UseInternalSecurityAPITells the component whether or not to use the system security libraries or an internal implementation.

Amount Property (StatementCharge Component)

The total amount (price) of the items in this statement.

Syntax

__property String Amount = { read=FAmount, write=FSetAmount };

Default Value

""

Remarks

The total dollar amount of the Item (specified by ItemId or ItemName) you're adding to the statement.

If Amount and Quantity are specified, QuickBooks will automatically calculate the Rate. Both Amount and Rate cannot be sent in the same transaction.

The amount should be formatted as a string in dollars. Leave this property blank and no amount will be sent to QuickBooks.

Data Type

String

ARAccountId Property (StatementCharge Component)

Reference to the Accounts Receivable account where money goes.

Syntax

__property String ARAccountId = { read=FARAccountId, write=FSetARAccountId };

Default Value

""

Remarks

A reference to the Accounts Receivable account where the money received from this transaction will go.

Id/Name Reference Properties

This property is used to reference an object that is already done within QuickBooks. This may be done with its Id (this property) or its full Name, for which a corresponding property is defined.

Using the Id is recommended when feasible, as the Id is guaranteed to never change once defined.

Setting the value of this property will set the corresponding Name property to an empty string.

Data Type

String

ARAccountName Property (StatementCharge Component)

Reference to the Accounts Receivable account where money goes.

Syntax

__property String ARAccountName = { read=FARAccountName, write=FSetARAccountName };

Default Value

""

Remarks

A reference to the Accounts Receivable account where the money received from this transaction will go.

Name/Id Reference Properties

This property is used to reference an object that is already done within QuickBooks. This may be done with its full Name (this property) or its Id, for which a corresponding property is defined. If Name is used, it must contain the full name of the object referred to, as generated by QuickBooks. For hierarchically defined objects, such as Customers, this includes the names of parent objects, and the full name can be determined by reading the FullName special field.

Setting the value of this property will set the corresponding Id property to an empty string.

Data Type

String

BalanceRemaining Property (StatementCharge Component)

Balance remaining.

Syntax

__property String BalanceRemaining = { read=FBalanceRemaining };

Default Value

""

Remarks

The balance remaining on the statement. The amount should be formatted as a string in dollars.

This property is read-only.

Data Type

String

BilledDate Property (StatementCharge Component)

Date when statement was billed.

Syntax

__property String BilledDate = { read=FBilledDate, write=FSetBilledDate };

Default Value

""

Remarks

The date when the customer was billed for what is now being charged to their credit card. This is the date entered in the Statement Date field when the statement was printed.

The standard formatting for dates is YYYY-MM-DD; i.e., September 2, 2002 is formatted as 2002-09-02. When getting the value of a date property, the date will always be in this format.

When setting the value of a date property, the formats MM-DD-YY, MM-DD-YYYY, MM/DD/YY, and MM/DD/YYYY are also acceptable. Dates in these formats will be automatically parsed and stored in YYYY-MM-DD format.

Data Type

String

ClassId Property (StatementCharge Component)

Reference to the class of the charge.

Syntax

__property String ClassId = { read=FClassId, write=FSetClassId };

Default Value

""

Remarks

A reference to the class of the item being added to the statement. Used if class tracking is being done with the QuickBooks company.

Id/Name Reference Properties

This property is used to reference an object that is already done within QuickBooks. This may be done with its Id (this property) or its full Name, for which a corresponding property is defined.

Using the Id is recommended when feasible, as the Id is guaranteed to never change once defined.

Setting the value of this property will set the corresponding Name property to an empty string.

Data Type

String

ClassName Property (StatementCharge Component)

Reference to the class of the charge.

Syntax

__property String ClassName = { read=FClassName, write=FSetClassName };

Default Value

""

Remarks

A reference to the class of the item added to the statement. Used if class tracking is being done with the QuickBooks company.

Id/Name Reference Properties

This property is used to reference an object that is already done within QuickBooks. This may be done with its Id (this property) or its full Name, for which a corresponding property is defined.

Using the Id is recommended when feasible, as the Id is guaranteed to never change once defined.

Setting the value of this property will set the corresponding Name property to an empty string.

Data Type

String

CustomerId Property (StatementCharge Component)

A reference to the customer or customer job.

Syntax

__property String CustomerId = { read=FCustomerId, write=FSetCustomerId };

Default Value

""

Remarks

The Customer property indicates the Customer who has purchased goods or services from the company.

Id/Name Reference Properties

This property is used to reference an object that is already done within QuickBooks. This may be done with its Id (this property) or its full Name, for which a corresponding property is defined.

Using the Id is recommended when feasible, as the Id is guaranteed to never change once defined.

Setting the value of this property will set the corresponding Name property to an empty string.

Either CustomerId or CustomerName is required.

Data Type

String

CustomerName Property (StatementCharge Component)

A reference to the customer or customer job.

Syntax

__property String CustomerName = { read=FCustomerName, write=FSetCustomerName };

Default Value

""

Remarks

The Customer property indicates the Customer who has purchased goods or services from the company.

Name/Id Reference Properties

This property is used to reference an object that is already done within QuickBooks. This may be done with its full Name (this property) or its Id, for which a corresponding property is defined. If Name is used, it must contain the full name of the object referred to, as generated by QuickBooks. For hierarchically defined objects, such as Customers, this includes the names of parent objects, and the full name can be determined by reading the FullName special field.

Setting the value of this property will set the corresponding Id property to an empty string.

Either CustomerId or CustomerName is required.

Data Type

String

Description Property (StatementCharge Component)

Description of this statement charge.

Syntax

__property String Description = { read=FDescription, write=FSetDescription };

Default Value

""

Remarks

A textual description for this charge.

Data Type

String

DueDate Property (StatementCharge Component)

Date when payment is due.

Syntax

__property String DueDate = { read=FDueDate, write=FSetDueDate };

Default Value

""

Remarks

Appears in a variety of transactions. The date when payment is due.

The standard formatting for dates is YYYY-MM-DD; i.e., September 2, 2002 is formatted as 2002-09-02. When getting the value of a date property, the date will always be in this format.

When setting the value of a date property, the formats MM-DD-YY, MM-DD-YYYY, MM/DD/YY, and MM/DD/YYYY are also acceptable. Dates in these formats will be automatically parsed and stored in YYYY-MM-DD format.

Data Type

String

IsPaid Property (StatementCharge Component)

Indicates whether this bill has been paid.

Syntax

__property bool IsPaid = { read=FIsPaid };

Default Value

false

Remarks

This property is only returned if the QBXMLVersion is set to "2.0" or higher.

This property is read-only.

Data Type

Boolean

ItemId Property (StatementCharge Component)

Item being added to the statement.

Syntax

__property String ItemId = { read=FItemId, write=FSetItemId };

Default Value

""

Remarks

Indicates the Id of the item being added to the statement.

Data Type

String

ItemName Property (StatementCharge Component)

Item being added to the statement.

Syntax

__property String ItemName = { read=FItemName, write=FSetItemName };

Default Value

""

Remarks

Indicates the name of the item being added to the statement.

Data Type

String

LinkedTxnCount Property (StatementCharge Component)

The number of records in the LinkedTxn arrays.

Syntax

__property int LinkedTxnCount = { read=FLinkedTxnCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

The array indices start at 0 and end at LinkedTxnCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

LinkedTxnAmount Property (StatementCharge Component)

The amount of the linked transaction.

Syntax

__property String LinkedTxnAmount[int LinkedTxnIndex] = { read=FLinkedTxnAmount };

Default Value

""

Remarks

The amount of the linked transaction.

The LinkedTxnIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LinkedTxnCount property.

This property is read-only and not available at design time.

Data Type

String

LinkedTxnDate Property (StatementCharge Component)

The date of the linked transaction.

Syntax

__property String LinkedTxnDate[int LinkedTxnIndex] = { read=FLinkedTxnDate };

Default Value

""

Remarks

The date of the linked transaction.

The LinkedTxnIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LinkedTxnCount property.

This property is read-only and not available at design time.

Data Type

String

LinkedTxnLinkType Property (StatementCharge Component)

Indicates the nature of the link between the transactions.

Syntax

__property String LinkedTxnLinkType[int LinkedTxnIndex] = { read=FLinkedTxnLinkType };

Default Value

""

Remarks

Indicates the nature of the link between the transactions. Possible responses include:

AMTTYPE The two transactions are linked based on an amount value (for example an invoice linked to a payment).
QUANTYPE The two transactions are linked based on a quantity. This affects transactions that are linked to sales orders, estimates and purchase orders. For example, an invoice might be created from a sales order, based on the quantity of items received.

The LinkedTxnIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LinkedTxnCount property.

This property is read-only and not available at design time.

Data Type

String

LinkedTxnRefNumber Property (StatementCharge Component)

This is the reference number assigned to the linked transaction.

Syntax

__property String LinkedTxnRefNumber[int LinkedTxnIndex] = { read=FLinkedTxnRefNumber };

Default Value

""

Remarks

This is the reference number assigned to the linked transaction. Depending on the type of transaction, it appears in the QuickBooks user interface as Bill Number, Invoice Number, etc.

Reference numbers are alphanumeric strings and are not limited to actually being numbers.

The LinkedTxnIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LinkedTxnCount property.

This property is read-only and not available at design time.

Data Type

String

LinkedTxnId Property (StatementCharge Component)

This property can be used by another component to reference the original transaction which is linked to the current response.

Syntax

__property String LinkedTxnId[int LinkedTxnIndex] = { read=FLinkedTxnId };

Default Value

""

Remarks

This property can be used by another component to reference the original transaction which is linked to the current response. Simply set the Id property of the appropriate component (based on the LinkedTxnTxnType property) and call the Get method.

The LinkedTxnIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LinkedTxnCount property.

This property is read-only and not available at design time.

Data Type

String

LinkedTxnType Property (StatementCharge Component)

This property indicates which type of linked transaction has been returned.

Syntax

__property String LinkedTxnType[int LinkedTxnIndex] = { read=FLinkedTxnType };

Default Value

""

Remarks

This property indicates which type of linked transaction has been returned. The LinkedTxnTxnType returned will tell you which component to use to retrieve the original transaction. Use the LinkedTxnTxnId as the Id parameter in the indicated component's Get method to return the original transaction details.

Valid values include:

Bill(Bill component)
BillPaymentCheck(n/a)
BillPaymentCreditCard(n/a)
BuildAssembly(n/a)
Charge(StatementCharge component)
Check(Check component)
CreditCardCharge(CCCredit component)
CreditCardCredit(CCCharge component)
CreditMemo(CreditMemo component)
Deposit(Deposit component)
Estimate(Estimate component)
InventoryAdjustment (AdjustInventory component)
Invoice(Invoice component)
ItemReceipt (ItemReceipt component)
JournalEntry(JournalEntry component)
LiabilityAdjustment(n/a)
Paycheck(n/a)
PayrollLiabilityCheck(n/a)
PurchaseOrder(PurchaseOrder component)
ReceivePayment(ReceivePayment component)
SalesOrder(SalesOrder component)
SalesReceipt(SalesReceipt component)
SalesTaxPaymentCheck(n/a)
Transfer(n/a)
VendorCredit(VendorCredit component)
YTDAdjustment(n/a)

Note: Not all of the above values are available in the QuickBooks API. Some are only available within the QuickBooks application itself. If the value above is available in the API, the corresponding component is indicated in parenthesis.

The LinkedTxnIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LinkedTxnCount property.

This property is read-only and not available at design time.

Data Type

String

QBConnectionString Property (StatementCharge Component)

An aggregate consisting of various QuickBooks connection properties.

Syntax

__property String QBConnectionString = { read=FQBConnectionString, write=FSetQBConnectionString };

Default Value

""

Remarks

QBConnectionString allows the user to customize the application's interaction with QuickBooks.

The connection properties should be formatted in a sequence as follows:

propertyname = "propertyvalue" propertyname = "propertyvalue" ...

The order is irrelevant, and the whitespace around the equal sign is optional.

The following properties are currently supported:

ApplicationNameThe name of the developer's application. This name will appear when the application first connects to QuickBooks; QuickBooks will display this name and prompt the user to grant or refuse access.
CompanyFileThe name of the company file to open. If QuickBooks is not currently open with a company file, QuickBooks will be automatically opened in the background with the file specified. Do not set CompanyFile when QuickBooks is open; if QuickBooks is open through the application UI, only that company file may be used.

This setting is not applicable when communicating with QB Connector.

URLThe URL for the Remote Connector, e.g., 'http://localhost:2080'. If the URL is specified, the component will not communicate directly with QuickBooks, and will instead send a request to the specified web address. QuickBooks and the Remote Connector should be installed at the remote location, and if the connector is listening on the specified port, it will communicate the component's request to QuickBooks, and return the response.
UserA username for the Remote Connector connection (if required on the Connector side)
PasswordA password for the Remote Connector connection (if required on the Connector side)
TimeoutA timeout, in seconds, for the Remote Connector connection. If the Connector does not finish and respond within the chosen length of time, the component will generate an exception instead of hanging.
DelayAfterCloseA delay, in milliseconds, to be applied after each time a connection to QuickBooks is closed. If QuickBooks is generating internal errors (in particular with automatic login) setting this delay to a positive value may solve the problem.
FirewallHostContains the name or IP address of firewall. If a FirewallHost is given, the requested connections will be authenticated through the specified firewall when connecting.
FirewallPasswordContains a password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword configs are used to connect and authenticate to the given firewall. If the authentication fails, the component raises an exception.
FirewallPortContains the TCP port for the firewall FirewallHost. Note this is set automatically when FirewallType is set to a valid value.
FirewallTypeDetermines the type of firewall to connect through. Supported values are: 0 - no firewall (default), 1 - Tunneling proxy, 2 - SOCKS4 proxy, and 3 - SOCKS5 proxy. For the Tunneling proxy (1), the FirewallPort defaults to 80. For SOCKS4 (2) and SOCKS5 (3) the FirewallPort defaults to 1080.
FirewallUserContains a user name if authentication is to be used connecting through a firewall. If the FirewallHost is specified, the FirewallUser and FirewallPassword configs are used to connect and authenticate to the given firewall. If the authentication fails, the component raises an exception.
ProxyAuthorizationSupported values are 0 - Basic authorization, 1 - Digest authentication, 3 - No authentication, and 4 - NTLM authentication.
ProxyPasswordContains a password if authentication is to be used for the proxy.
ProxyPortContains the TCP port for a ProxyServer; (default 80).
ProxySSLDetermines when to use SSL for the connection to the proxy. The applicable values are 0 - Automatic (SSL for https URLs, non-SSL for http URLs), 1 - The connection is always SSL-enabled, 2 - SSL is not enabled for any connection, and 3 - Connection is through a tunneling proxy.
ProxyServerIf a ProxyServer is specified, then the HTTP request is sent to the proxy instead of the server otherwise specified. If the ProxyServer is set to a Domain Name, a DNS request is initiated and upon successful termination of the request, the ProxyServer is set to the corresponding address. If the search is not successful, an error is returned.
ProxyUserContains a user name, if authentication is to be used for the proxy.
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
LocalPortThe TCP port in the local host where the component binds.
UseRDSWhether to connect using Remote Data Sharing (RDS). If set to True, the component will attempt to connect using the RDS client installed on the machine. The RDS client and server must be configured separately. The default value is False.

Data Type

String

QBRequestAggregate Property (StatementCharge Component)

The request aggregate.

Syntax

__property String QBRequestAggregate = { read=FQBRequestAggregate, write=FSetQBRequestAggregate };

Default Value

""

Remarks

This property will be populated when QBRequestMode is set to rmOffline and a method is called. This is used when working with the QBWCServer component to generate requests to be sent to QuickBooks Web Connector.

This property is not available at design time.

Data Type

String

QBRequestId Property (StatementCharge Component)

The Id of the next message to be sent to QuickBooks.

Syntax

__property String QBRequestId = { read=FQBRequestId, write=FSetQBRequestId };

Default Value

""

Remarks

The next message Id to be sent to QuickBooks. Message Id's are used by CheckRequestStatus to check on the status of previously made requests.

This property allows the user to determine whether a previous request was successfully processed by QuickBooks. Ordinarily QuickBooks either processes requests successfully or returns an error, but in the event of a power outage or other system failure, QuickBooks might or might not have time to process a request before issuing a response.

QuickBooks stores internally a list of QBRequestIds for which it has processed a request, and updated its internal state accordingly. Use of this property in conjunction with CheckRequestStatus allows the user to query this internal list.

To enable error recovery, the user application should store the value of QBRequestId before submitting a request to QuickBooks. If a system failure occurs, CheckRequestStatus should be called with this value of QBRequestId to find whether the request was processed before the system failed.

Unique values for QBRequestId will be generated on startup and after each request to QuickBooks. The automatically generated value may be overwritten by the user. Error checking may be turned off by setting QBRequestId equal to the empty string. See CheckRequestStatus for more information on error recovery.

This property is not available at design time.

Data Type

String

QBRequestMode Property (StatementCharge Component)

Defines whether the request is made online or stored offline.

Syntax

__property TiqbStatementChargeQBRequestModes QBRequestMode = { read=FQBRequestMode, write=FSetQBRequestMode };
enum TiqbStatementChargeQBRequestModes { rmOnline=0, rmOffline=1 };

Default Value

rmOnline

Remarks

This property defines the behavior of the component when calling a method. Possible values are:

0 (rmOnline - default) The request is made normally.
1 (rmOffline) The request is generated but not sent, and QBRequestAggregate is populated.

The use of offline mode is required when using the QBWCServer component. This allows requests to be generated and passed to QuickBooks Web Connector through the QBWCServer component.

For normal communication to QuickBooks either directly or through the QBConnector application use the default online mode.

Data Type

Integer

QBResponseAggregate Property (StatementCharge Component)

The last QBXML response aggregate received from QuickBooks.

Syntax

__property String QBResponseAggregate = { read=FQBResponseAggregate, write=FSetQBResponseAggregate };

Default Value

""

Remarks

The last QBXML response aggregate received from QuickBooks. This property is set whenever a response is received from QuickBooks.

This property may also be set to a response aggregate. When set to a QBXML aggregate, such as a response from ObjSearch or QBWCServer the component will parse the response as if it had been received directly from QuickBooks and the applicable properties will be updated.

This property is not available at design time.

Data Type

String

QBXMLVersion Property (StatementCharge Component)

The version of QBXML used in the outgoing message.

Syntax

__property String QBXMLVersion = { read=FQBXMLVersion, write=FSetQBXMLVersion };

Default Value

"3.0"

Remarks

The version of QBXML used in the outgoing message. Except as noted in the documentation, a value of "1.1" will suffice for all requests, and for all versions of QuickBooks which support integrated applications.

With each release of QuickBooks since 2002, a corresponding version of the QuickBooks SDK has also been released: 1.0 for QuickBooks 2002, 2.0 for QuickBooks 2003, 3.0 for QuickBooks 2004, etc., up to 8.0 for QuickBooks 2009. In addition, each release of QuickBooks continues to support all earlier versions of the SDK, meaning that requests using version 1.1 of the QuickBooks SDK are supported by all versions of QuickBooks. However, new requests and newer fields in existing requests are only supported in later versions of the QuickBooks SDK. As such, it is recommended that you set the QBXMLVersion property to correspond to the version of QuickBooks you are interacting with. These values are:

QuickBooks 20021.0, 1.1
QuickBooks 20032.0
QuickBooks 20043.0
QuickBooks 20054.0, 4.1
QuickBooks 20065.0
QuickBooks 20076.0
QuickBooks 20087.0
QuickBooks 20098.0
QuickBooks 20109.0
QuickBooks 201110.0
QuickBooks 201211.0
QuickBooks 201312.0
QuickBooks 201413.0
QuickBooks 201514.0
QuickBooks 201615.0

In addition, versions of QuickBooks outside of the U.S. released before Quickbooks 2008 adhere to a different version of the QuickBooks SDK. These versions were updated with less frequency than the U.S. SDK, and may omit features introduced in later releases:

QuickBooks Canadian 2003CA2.0
QuickBooks Canadian 2004 to 2007CA3.0
QuickBooks UK 2003UK2.0
QuickBooks UK 2004 to 2007UK3.0
QuickBooks Australian 2003OZ2.0
QuickBooks Australian 2004 to 2007AU3.0

With the exception of Province in Address (set State) or EligibleForT4A in Vendor (set EligibleFor1099), Canadian-only fields are read-only and may be accessed with Config.

This property is not available at design time.

Data Type

String

Quantity Property (StatementCharge Component)

Quantity of items in this statement.

Syntax

__property String Quantity = { read=FQuantity, write=FSetQuantity };

Default Value

""

Remarks

The quantity of the Item (specified by ItemId or ItemName) you're adding to the statement.

If Quantity and either Rate, or Amount are specified, QuickBooks will automatically calculate the other.

This property is a String type in order to allow setting fractional quantities. Setting this property with non-numeric data will cause an error. Correct usage of this Property is shown below:

component.Quantity = "3.5"

Leave this property blank and no quantity will be sent to QuickBooks.

Data Type

String

Rate Property (StatementCharge Component)

Unit rate of item.

Syntax

__property String Rate = { read=FRate, write=FSetRate };

Default Value

""

Remarks

The rate of the Item (specified by ItemId or ItemName) you're adding to the statement.

If Amount and Quantity are specified, then Rate will be calculated automatically and should not be specified.

The amount should be formatted as a string in dollars.

Data Type

String

RefId Property (StatementCharge Component)

An alphanumerical identifier generated by the server.

Syntax

__property String RefId = { read=FRefId };

Default Value

""

Remarks

An Id is an alphanumerical identifier assigned by the server whenever an object is added to QuickBooks. It is guaranteed to be unique across all objects of the same type.

This property is read-only and not available at design time.

Data Type

String

RefNumber Property (StatementCharge Component)

Reference number for the transaction.

Syntax

__property String RefNumber = { read=FRefNumber, write=FSetRefNumber };

Default Value

""

Remarks

This is the reference number assigned to a transaction. Depending on the type of transaction, it appears in the QuickBooks user interface as Bill Number, Invoice Number, etc.

Reference numbers are alphanumeric strings and are not limited to actually being numbers.

For some types of transactions, if RefNumber is not assigned, QuickBooks will automatically assign a unique one. Reference numbers should generally be unique, but are not guaranteed to be so. It is recommended that applications generating their own reference numbers take steps to ensure their uniqueness.

Data Type

String

TransactionDate Property (StatementCharge Component)

Date of transaction.

Syntax

__property String TransactionDate = { read=FTransactionDate, write=FSetTransactionDate };

Default Value

""

Remarks

The date of the transaction.

The standard formatting for dates is YYYY-MM-DD; i.e., September 2, 2002 is formatted as 2002-09-02. When getting the value of a date property, the date will always be in this format.

When setting the value of a date property, the formats MM-DD-YY, MM-DD-YYYY, MM/DD/YY, and MM/DD/YYYY are also acceptable. Dates in these formats will be automatically parsed and stored in YYYY-MM-DD format.

This property is required in Accounts Payable (Bill and VendorCredit) transactions. In other kinds of transactions this property is optional.

Data Type

String

Add Method (StatementCharge Component)

Adds the record into QuickBooks.

Syntax

void __fastcall Add();

Remarks

Add is used to add the object to QuickBooks.

If QuickBooks is able to add the object, it will return a copy of the object, and the values of all properties will be reset from the QuickBooks response. The QBResponseAggregate property will also be set to the entire QBXML aggregate received from QuickBooks.

For example, read-only properties such as RefIds will be assigned. In transaction objects, line item information will be filled out, and ItemGroups will be broken up into their respective Items. Also, a total will be calculated.

If QuickBooks is not able to add the object, a trappable error will occur.

Cancel Method (StatementCharge Component)

Cancels (voids) the transaction.

Syntax

void __fastcall Cancel();

Remarks

Cancel causes the transaction to be voided in QuickBooks. The amount of the transaction and all line item quantities are changed to zero, and the memo is changed to "VOID:". The transaction will not, however, be deleted.

The transaction canceled in QuickBooks is the one specified by RefId. If the value of RefId is known then Get should first be called to retrieve the transaction. Otherwise the ObjSearch component should be used to search for the desired transaction in the QuickBooks database.

As the QuickBooks response to Cancel does not include the updated transaction, the values of all properties are instead set to their defaults. To get a copy of the updated transaction, the value of RefId should first be stored, and then Get should be called.

CheckRequestStatus Method (StatementCharge Component)

Checks whether or not the specified request was processed by QuickBooks.

Syntax

String __fastcall CheckRequestStatus(String RequestId);

Remarks

This method allows the user to determine whether a previous request was successfully processed by QuickBooks. Ordinarily QuickBooks either processes requests successfully or returns an error, but in the event of a power outage or other system failure, QuickBooks might or might not have time to process a request before issuing a response.

QuickBooks stores internally a list of QBRequestIds for which it has processed a request, and updated its internal state accordingly. Use of this method allows the user to query the list for any RequestId whose value is known.

The method returns a string corresponding to the result of the query. If the request was processed successfully, an empty string ("") will be returned. If the request was not processed, the string "Request not processed." will be returned. If the request was processed but an error occurred, a string containing the error code and a description will be returned; for example, "801: A QuickBooks internal error has occurred."

See QBRequestId for more information on error recovery.

CloseQBConnection Method (StatementCharge Component)

Closes a persistent connection to QuickBooks.

Syntax

void __fastcall CloseQBConnection();

Remarks

Invoking CloseQBConnection closes the QuickBooks connection specified in QBConnectionString. After the connection has been closed, the component will revert to its default behavior, and a new connection will be established for each request until QBConnectionString is invoked again.

In case the connection is already closed invoking CloseQBConnection will have no effect. Moreover, if multiple connections are open CloseQBConnection will only close the connection specified in QBConnectionString.

Be sure to always invoke this method after calling OpenQBConnection.

Config Method (StatementCharge Component)

Sets or retrieves a configuration setting.

Syntax

String __fastcall Config(String ConfigurationString);

Remarks

Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Delete Method (StatementCharge Component)

Deletes the record from QuickBooks.

Syntax

void __fastcall Delete();

Remarks

Delete causes the object to be deleted in QuickBooks. After this method is called, the values of all fields will be reset to their defaults.

The object deleted in QuickBooks is the one specified by RefId. This read-only property may be assigned either by calling Get or by assigning the value of QBResponseAggregate.

A typical example: Customer.GetByName("John Smith") 'this will assign the RefId Customer.Delete() Deleting entity objects (Customer, Employee, and Vendor) requires that QuickBooks be open in single-user mode. Transaction objects, however, may be deleted while QuickBooks is in any mode.

Use this method with caution, as there is no way to recover deleted objects.

Get Method (StatementCharge Component)

Gets a single record from QuickBooks.

Syntax

void __fastcall Get(String Id);

Remarks

Get may be used to retrieve a single object from QuickBooks, based on its RefId. When the method is called, a search will be initiated for the requested object. If it is found, all properties of the component will be set to the information retrieved from QuickBooks. The QBResponseAggregate property will also be set to the entire QBXML aggregate received from QuickBooks.

The RefId of any component, or the Id of any reference property, may be used for the parameter. So for example, the following pseudocode would get customer information for a Customer listed on an Invoice:

Customer.Get( Invoice.CustomerId )

The GetByName method, present only in entity objects (Customer, Vendor, and Employee) and QBObject, may be used to get an object based on its Name. To retrieve multiple objects, to retrieve transaction objects whose RefId is not known, or to perform more advanced searches the ObjSearch component may be used.

GetCustomField Method (StatementCharge Component)

Gets a custom field value from QuickBooks.

Syntax

String __fastcall GetCustomField(String FieldName);

Remarks

This method will get the value of a custom field, which has been defined by the user from within the QuickBooks UI.

To read the values of custom fields, be sure to set QBXMLVersion to at least "2.0" when retrieving data from QuickBooks. Then, QuickBooks will return custom field information, and it will be accessible through this method.

You may also invoke Config to read the value of custom fields. However, to set the value of custom fields you must set QBXMLVersion to at least "3.0" and invoke SetCustomField.

ImportQBXML Method (StatementCharge Component)

Imports a QBXML response aggregate.

Syntax

void __fastcall ImportQBXML(String XMLData);

Remarks

This method imports a QBXML response aggregate. When called with a QBXML aggregate, such as a response from ObjSearch or QBWCServer the component will parse the response as if it had been received directly from QuickBooks and the applicable properties will be updated.

OpenQBConnection Method (StatementCharge Component)

Opens a persistent connection to QuickBooks.

Syntax

void __fastcall OpenQBConnection();

Remarks

Invoking OpenQBConnection will open a persistent connection to QuickBooks. After invoking OpenQBConnection, all requests such as Get, Add, etc. will use the established connection until CloseQBConnection is invoked.

The effect of OpenQBConnection is to increase performance. If OpenQBConnection is not invoked, a connection to QuickBooks will automatically be created and destroyed each time the component communicates with QuickBooks. Using OpenQBConnection will be faster, particularly in the case of automatic login.

After OpenQBConnection is invoked, QuickBooks will issue a connection ticket, and it will be stored in QBConnectionString. When CloseQBConnection is invoked the ticket will be invalidated, and any further attempts to use it will fail.

Be sure to invoke CloseQBConnection when you have finished communicating with QuickBooks. Leaving an open QuickBooks connection may lock out other integrated applications, affect QuickBooks performance, or cause other problems.

Reset Method (StatementCharge Component)

Resets all properties to their defaults.

Syntax

void __fastcall Reset();

Remarks

This method resets the values of all properties (and all special fields) to their defaults.

After calling this method, the component may be reused as if it were newly created.

SetCustomField Method (StatementCharge Component)

Sets a custom field value within QuickBooks.

Syntax

void __fastcall SetCustomField(String FieldName, String FieldValue);

Remarks

This method requires QuickBooks 2004 or above, with QBXMLVersion set to at least "3.0".

This method will immediately set the value of a QuickBooks custom field, which has been defined by the user from within the QuickBooks UI. Before calling this method, the preceding operation must retrieve the object from QuickBooks, using Get, ObjSearch, etc. Then, you may use SetCustomField to set custom field values (the fields will be modified or added, as appropriate).

Note that invoking this method will create a connection to QuickBooks if one is not already in place.

Update Method (StatementCharge Component)

Updates the bill in QuickBooks.

Syntax

void __fastcall Update();

Remarks

This method will update the bill in QuickBooks.

When the method is called, an Update request will be submitted to QuickBooks. The bill will have its information updated based on the various property values.

If QuickBooks is able to update the object, it will return a copy of the object, and the values of all properties will be reset from the QuickBooks response. The QBResponseAggregate property will also be set to the entire QBXML aggregate received from QuickBooks.

QBXMLVersion must be set to "3.0" or greater to update a bill. Moreover, QBXMLVersion should be set to the same value when retrieving the bill from QuickBooks (either through ObjSearch or through the Get method).

Error Event (StatementCharge Component)

Information about errors during data delivery.

Syntax

typedef struct {
  int ErrorCode;
  String Description;
} TiqbStatementChargeErrorEventParams;
typedef void __fastcall (__closure *TiqbStatementChargeErrorEvent)(System::TObject* Sender, TiqbStatementChargeErrorEventParams *e);
__property TiqbStatementChargeErrorEvent OnError = { read=FOnError, write=FOnError };

Remarks

The Error event is fired in case of exceptional conditions during message processing.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

SSLServerAuthentication Event (StatementCharge Component)

Fired after the server presents its certificate to the client.

Syntax

typedef struct {
  String CertEncoded;
  DynamicArray<Byte> CertEncodedB;
  String CertSubject;
  String CertIssuer;
  String Status;
  bool Accept;
} TiqbStatementChargeSSLServerAuthenticationEventParams;
typedef void __fastcall (__closure *TiqbStatementChargeSSLServerAuthenticationEvent)(System::TObject* Sender, TiqbStatementChargeSSLServerAuthenticationEventParams *e);
__property TiqbStatementChargeSSLServerAuthenticationEvent OnSSLServerAuthentication = { read=FOnSSLServerAuthentication, write=FOnSSLServerAuthentication };

Remarks

This event is where the client can decide whether to continue with the connection process or not. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether to continue or not.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string "OK"). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (StatementCharge Component)

Shows the progress of the secure connection.

Syntax

typedef struct {
  String Message;
} TiqbStatementChargeSSLStatusEventParams;
typedef void __fastcall (__closure *TiqbStatementChargeSSLStatusEvent)(System::TObject* Sender, TiqbStatementChargeSSLStatusEventParams *e);
__property TiqbStatementChargeSSLStatusEvent OnSSLStatus = { read=FOnSSLStatus, write=FOnSSLStatus };

Remarks

The event is fired for informational and logging purposes only. Used to track the progress of the connection.

Status Event (StatementCharge Component)

Shows the progress of the QuickBooks connection.

Syntax

typedef struct {
  String Message;
} TiqbStatementChargeStatusEventParams;
typedef void __fastcall (__closure *TiqbStatementChargeStatusEvent)(System::TObject* Sender, TiqbStatementChargeStatusEventParams *e);
__property TiqbStatementChargeStatusEvent OnStatus = { read=FOnStatus, write=FOnStatus };

Remarks

The event is fired for informational and logging purposes only. Used to track the progress of the connection.

Warning Event (StatementCharge Component)

Fired when a warning occurs.

Syntax

typedef struct {
  int Code;
  String Description;
} TiqbStatementChargeWarningEventParams;
typedef void __fastcall (__closure *TiqbStatementChargeWarningEvent)(System::TObject* Sender, TiqbStatementChargeWarningEventParams *e);
__property TiqbStatementChargeWarningEvent OnWarning = { read=FOnWarning, write=FOnWarning };

Remarks

The Warning event is fired when the component has produced, or will produce, possibly unexpected results.

Warnings may be generated by QuickBooks or the component. Starred warning codes correspond to warnings and warning codes generated by QuickBooks.

510*Object added successfully, but cannot now be read.
520*Insufficient permissions to get all data.
801 Unable to update field (name).
802Unable to parse name.

Unlisted QuickBooks warnings will cause the component to throw an exception instead.

Warning 801 will be thrown if the user attempts to Update properties that cannot be updated. For example, the following code will cause this warning to be fired: Customer1.GetByName("Joe Smith") Customer1.Email = "joe@abc.com" 'ok Customer1.CreditLimit = "200.00" 'Not used in Update operations! Customer1.Update() Only the email address will be updated, and the credit limit will be unchanged. Each property description for entity objects lists whether or not it is used in Update operations.

Config Settings (StatementCharge Component)

The component accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.

StatementCharge Config Settings

AppendAfter:   Appends an XML tag after the specified QBXML element.

Write-only; Appends the specified text after the specified QBXML element (whether the QBXML element is present). This may be useful to extend the functionality of the component beyond what is provided. Example: Control1.Config("AppendAfter:ListID=<WeirdNewField>abc</WeirdNewField>")

AuthFlags:   Connection Flags (use for QuickBooks Simple Start).

Since 2006, QuickBooks has allowed AuthFlags to be set before connecting to QuickBooks. By default, the component can connect to Pro, Premier, and Enterprise editions of QuickBooks. However, because QuickBooks Simple Start contains only a subset of the functionality that other desktop versions provide, Intuit does not allow COM connection to Simple Start unless these AuthFlags explicitly indicate you wish to support it.

A list of allowable AuthFlags is provided below.

"" or 0Do not send any auth flags
0x01Support QB Simple Start
0x02Support QB Pro
0x04Support QB Premier
0x08Support QB Enterprise
0x80000000Force Auth Dialog

To specify support for multiple editions, OR together the values for each edition.

NOTE: If the version of QuickBooks being used does not support AuthFlags, the contents of this config will be ignored. However, if QuickBooks does support this feature, setting "AuthFlags=1" (Support for Simple Start only) on a machine running QuickBooks 2013 Pro will result in an error message indicating that the Request Processor cannot be found.

EditSequence:   An identifier for this copy of the object.

Indicates the state of an object when doing an Update.

EnforceMaxLength:   Indicates whether to enforce max lengths for QB Fields.

If you change this setting to False, the component will no longer check (or error) when the length of a property exceeds the maximum length specified in the QuickBooks SDK.

GetHighestVersion:   Highest QBXMLVersion supported by the installed instance of QuickBooks.

If QuickBooks is installed on the system, this setting will retrieve the highest QBXMLVersion that may be used for sending transactions to 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.

If QuickBooks is installed on the system, this setting will retrieve a list of all supported QBXMLVersions that may be used for sending transactions to QuickBooks. While GetHighestVersion config returns only the highest QBXMLVersion supported, this config returns ALL supported QBXMLVersions. The list is delimited with '\n' (linefeed) characters.

IsReadOnly:   This causes the QuickBooks authorization dialog to display text informing the user that its access will be read-only.

The default value is false.

PersonalDataPref:   Whether the connecting application will require access to personal data such as SSN or credit card information.

This setting allows you to let the user know immediately whether your application requires access to personal data or not.

A list of available values is provided below.

pdpOptionalCauses the QuickBooks authorization dialog to display a checkbox for user selection asking whether the user wants to allow the application to access personal data.
pdpRequiredCauses the QuickBooks authorization dialog to not display the personal information checkbox for user selection, and instead display a warning that the application needs to access personal data.
pdpNotNeededCauses the QuickBooks authorization dialog to not display the personal information checkbox for user selection, and instead display an informational message that the application will NOT access personal data.

The default value is pdpOptional.

QBConnectionMode:   The mode of connection to QuickBooks.

Specifies whether the integrated application logs in using single-user or multi-user mode.

The following values are permitted:

0Don't Care
1Single-User Mode
2Multi-User Mode

About Single-User and Multi-User Modes

If the connection to QuickBooks is made in single-user mode, QuickBooks will give exclusive access to the connecting application. It will lock out all other integrated applications; if QuickBooks and the company file are not already open in single-user mode by the QuickBooks user, the user will be locked out as well.

If the connection is made in multi-user mode, QuickBooks will allow all other integrated applications access. QuickBooks end users on other machines will also be allowed to access the file. However, if the application (rather than the end user) starts QuickBooks automatically, end users on the same machine will still be locked out.

If cmDontCare is specified, an appropriate connection mode will be chosen automatically. If a company file is open in either single-user or multi-user mode, the integrated application will accept that connection mode. If no company file is open, QuickBooks will login automatically in multi-user mode.

About Integrated and Automatic Login

Note that your application's login to QuickBooks might be either automatic or interactive. Interactive login is used when QuickBooks is already open. Access will be shared between the integrated application and the QuickBooks end user, and if multi-user mode is specified, other applications and users will have access as well. When a connection is made, QuickBooks will show a dialog window to the user, and ask the user if he/she wants to permit the connection.

Automatic login is used when QuickBooks is not already open. QuickBooks will be opened in the background, and will run until your application has finished its connection with QuickBooks. The QuickBooks user interface will not be displayed, and end-users on the same machine will be locked out. End-users on other machines, however, will be allowed access if multi-user mode is specified.

By default integrated applications do not have permission to login automatically. The first time an application interacts with QuickBooks, it must do so interactively, with QuickBooks and the company file open. The QuickBooks end user may then grant automatic login permission through Edit Preferences - Integrated Applications in the QuickBooks user interface. Click on the name of the application and then "Properties", and you may allow the application to login automatically.

For automatic login the CompanyFile must be specified. CompanyFile, ApplicationName, and other properties relating to the QuickBooks connection may be edited through QBConnectionString.

QBFileStatus:   The status of the company file as it pertains to accepting connections.

This setting may be queried before attempting to connect to QuickBooks to determine the current company file status. When queried the component will attempt to determine whether a subsequent connection using the provided QBConnectionString value would succeed. Possible return values are:

0 The company file will accept the connection. This indicates that no company file is open, or the desired company file is already open.
1 The company file will not accept the connection. This indicates a different company file is already open.

QBOpenCompanyFile:   The file currently open in QuickBooks.

The name of the file currently open in QuickBooks, specified completely with the path. This field is read-only.

A query is submitted to QuickBooks when the value of this property is read. The empty string will be returned if no file is open, if QuickBooks is open in an access mode incompatible with QBConnectionMode, or if an error occurs.

If the value of this property is nonempty, the component may interact exclusively with the open file.

SendRawXML:   Sends specified XML to quickbooks without modification.

Available for write only. Immediately sends the specified XML over the current or default QuickBooks connection (as specified elsewhere), and returns the QBXML response. Syntax: Control1.Config("SendRawXML=<?xml version="1.0" ?>...")

SSLAcceptServerCert:   The SSL certificate being used by the QuickBooks Gateway (aka Remote Connector).

The Base-64 encoded certificate being used by the Remote Connector (you may get this certificate from the Remote Connector by going to the Security tab, and clicking Export.)

This is only necessary if using a self-signed certificate, or any other certificate that has not been signed by a Certificate Authority (CA) trusted by the system.

SSLAcceptServerCertFile:   The SSL certificate file being used by the QuickBooks Gateway (aka Remote Connector).

If your public key certificate is stored in a file, you may set this configuration setting to the full path of the certificate, and it will be immediately read from disk and stored in SSLAcceptServerCert. Equivalent to setting SSLAcceptServerCert to file contents.

Reading the value of this setting will return an empty string.

StopOnError:   Specifies how QuickBooks is to proceed if an error occurs in processing of the current request.

If StopOnError is True (default), QuickBooks will stop processing when an error occurs. Requests that have already been processed will not be rolled back. An error is returned for the operation that caused the error condition. If StopOnError is False, QuickBooks will continue processing the remaining requests if an error occurs.

TimeCreated:   The time the object was created.

This config setting is read-only.

TimeModified:   The time the object was created.

This config setting is read-only.

UnattendedModePref:   Whether connecting while QuickBooks is closed is required or optional for the user.

This setting allows you to let the user know immediately whether your application requires the ability to access QuickBooks while QuickBooks is closed.

A list of available values is provided below.

umpOptionalCauses the QuickBooks authorization dialog to display its default selections and let the user pick. Use this setting if you do not need unattended mode.
umpRequiredCauses the QuickBooks authorization dialog to display only the selection choices of "No" (no authorization) or "Yes, allow access even if QuickBooks is not running" (authorize unattended mode).

The default value is umpOptional.

WarningCodes:   A comma-separated list of QuickBooks warning codes that should not result in an exception.

By default, the component will throw an exception when a status code with severity "Warn" is returned in a QuickBooks response. Set this field to a comma-separated list of status codes that should not throw an exception if returned. Note that the QuickBooks response code is not necessarily the same as the exception code from the resulting exception.

Base Config Settings

BuildInfo:   Information about the product's build.

When queried, this setting will return a string containing information about the product's build.

CodePage:   The system code page used for Unicode to Multibyte translations.

The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:

IdentifierName
037IBM EBCDIC - U.S./Canada
437OEM - United States
500IBM EBCDIC - International
708Arabic - ASMO 708
709Arabic - ASMO 449+, BCON V4
710Arabic - Transparent Arabic
720Arabic - Transparent ASMO
737OEM - Greek (formerly 437G)
775OEM - Baltic
850OEM - Multilingual Latin I
852OEM - Latin II
855OEM - Cyrillic (primarily Russian)
857OEM - Turkish
858OEM - Multilingual Latin I + Euro symbol
860OEM - Portuguese
861OEM - Icelandic
862OEM - Hebrew
863OEM - Canadian-French
864OEM - Arabic
865OEM - Nordic
866OEM - Russian
869OEM - Modern Greek
870IBM EBCDIC - Multilingual/ROECE (Latin-2)
874ANSI/OEM - Thai (same as 28605, ISO 8859-15)
875IBM EBCDIC - Modern Greek
932ANSI/OEM - Japanese, Shift-JIS
936ANSI/OEM - Simplified Chinese (PRC, Singapore)
949ANSI/OEM - Korean (Unified Hangul Code)
950ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC)
1026IBM EBCDIC - Turkish (Latin-5)
1047IBM EBCDIC - Latin 1/Open System
1140IBM EBCDIC - U.S./Canada (037 + Euro symbol)
1141IBM EBCDIC - Germany (20273 + Euro symbol)
1142IBM EBCDIC - Denmark/Norway (20277 + Euro symbol)
1143IBM EBCDIC - Finland/Sweden (20278 + Euro symbol)
1144IBM EBCDIC - Italy (20280 + Euro symbol)
1145IBM EBCDIC - Latin America/Spain (20284 + Euro symbol)
1146IBM EBCDIC - United Kingdom (20285 + Euro symbol)
1147IBM EBCDIC - France (20297 + Euro symbol)
1148IBM EBCDIC - International (500 + Euro symbol)
1149IBM EBCDIC - Icelandic (20871 + Euro symbol)
1200Unicode UCS-2 Little-Endian (BMP of ISO 10646)
1201Unicode UCS-2 Big-Endian
1250ANSI - Central European
1251ANSI - Cyrillic
1252ANSI - Latin I
1253ANSI - Greek
1254ANSI - Turkish
1255ANSI - Hebrew
1256ANSI - Arabic
1257ANSI - Baltic
1258ANSI/OEM - Vietnamese
1361Korean (Johab)
10000MAC - Roman
10001MAC - Japanese
10002MAC - Traditional Chinese (Big5)
10003MAC - Korean
10004MAC - Arabic
10005MAC - Hebrew
10006MAC - Greek I
10007MAC - Cyrillic
10008MAC - Simplified Chinese (GB 2312)
10010MAC - Romania
10017MAC - Ukraine
10021MAC - Thai
10029MAC - Latin II
10079MAC - Icelandic
10081MAC - Turkish
10082MAC - Croatia
12000Unicode UCS-4 Little-Endian
12001Unicode UCS-4 Big-Endian
20000CNS - Taiwan
20001TCA - Taiwan
20002Eten - Taiwan
20003IBM5550 - Taiwan
20004TeleText - Taiwan
20005Wang - Taiwan
20105IA5 IRV International Alphabet No. 5 (7-bit)
20106IA5 German (7-bit)
20107IA5 Swedish (7-bit)
20108IA5 Norwegian (7-bit)
20127US-ASCII (7-bit)
20261T.61
20269ISO 6937 Non-Spacing Accent
20273IBM EBCDIC - Germany
20277IBM EBCDIC - Denmark/Norway
20278IBM EBCDIC - Finland/Sweden
20280IBM EBCDIC - Italy
20284IBM EBCDIC - Latin America/Spain
20285IBM EBCDIC - United Kingdom
20290IBM EBCDIC - Japanese Katakana Extended
20297IBM EBCDIC - France
20420IBM EBCDIC - Arabic
20423IBM EBCDIC - Greek
20424IBM EBCDIC - Hebrew
20833IBM EBCDIC - Korean Extended
20838IBM EBCDIC - Thai
20866Russian - KOI8-R
20871IBM EBCDIC - Icelandic
20880IBM EBCDIC - Cyrillic (Russian)
20905IBM EBCDIC - Turkish
20924IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol)
20932JIS X 0208-1990 & 0121-1990
20936Simplified Chinese (GB2312)
21025IBM EBCDIC - Cyrillic (Serbian, Bulgarian)
21027Extended Alpha Lowercase
21866Ukrainian (KOI8-U)
28591ISO 8859-1 Latin I
28592ISO 8859-2 Central Europe
28593ISO 8859-3 Latin 3
28594ISO 8859-4 Baltic
28595ISO 8859-5 Cyrillic
28596ISO 8859-6 Arabic
28597ISO 8859-7 Greek
28598ISO 8859-8 Hebrew
28599ISO 8859-9 Latin 5
28605ISO 8859-15 Latin 9
29001Europa 3
38598ISO 8859-8 Hebrew
50220ISO 2022 Japanese with no halfwidth Katakana
50221ISO 2022 Japanese with halfwidth Katakana
50222ISO 2022 Japanese JIS X 0201-1989
50225ISO 2022 Korean
50227ISO 2022 Simplified Chinese
50229ISO 2022 Traditional Chinese
50930Japanese (Katakana) Extended
50931US/Canada and Japanese
50933Korean Extended and Korean
50935Simplified Chinese Extended and Simplified Chinese
50936Simplified Chinese
50937US/Canada and Traditional Chinese
50939Japanese (Latin) Extended and Japanese
51932EUC - Japanese
51936EUC - Simplified Chinese
51949EUC - Korean
51950EUC - Traditional Chinese
52936HZ-GB2312 Simplified Chinese
54936Windows XP: GB18030 Simplified Chinese (4 Byte)
57002ISCII Devanagari
57003ISCII Bengali
57004ISCII Tamil
57005ISCII Telugu
57006ISCII Assamese
57007ISCII Oriya
57008ISCII Kannada
57009ISCII Malayalam
57010ISCII Gujarati
57011ISCII Punjabi
65000Unicode UTF-7
65001Unicode UTF-8

The following is a list of valid code page identifiers for Mac OS only:

IdentifierName
1ASCII
2NEXTSTEP
3JapaneseEUC
4UTF8
5ISOLatin1
6Symbol
7NonLossyASCII
8ShiftJIS
9ISOLatin2
10Unicode
11WindowsCP1251
12WindowsCP1252
13WindowsCP1253
14WindowsCP1254
15WindowsCP1250
21ISO2022JP
30MacOSRoman
10UTF16String
0x90000100UTF16BigEndian
0x94000100UTF16LittleEndian
0x8c000100UTF32String
0x98000100UTF32BigEndian
0x9c000100UTF32LittleEndian
65536Proprietary

LicenseInfo:   Information about the current license.

When queried, this setting will return a string containing information about the license this instance of a component is using. It will return the following information:

  • Product: The product the license is for.
  • Product Key: The key the license was generated from.
  • License Source: Where the license was found (e.g., RuntimeLicense, License File).
  • License Type: The type of license installed (e.g., Royalty Free, Single Server).
  • Last Valid Build: The last valid build number for which the license will work.
MaskSensitive:   Whether sensitive data is masked in log messages.

In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to true to mask sensitive data. The default is true.

This setting only works on these components: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.

UseInternalSecurityAPI:   Tells the component whether or not to use the system security libraries or an internal implementation.

When set to false, the component will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this setting to true tells the component to use the internal implementation instead of using the system security libraries.

This setting is set to false by default on all platforms.

Trappable Errors (StatementCharge Component)

Errors

The following errors may be generated by the component. Note that frequently the error message will contain more specific information than what is listed here.

StatementCharge Errors

101   String too long.
103   Invalid date format (YYYY-MM-DD is standard).
104   Invalid value for enumerated field.
105   Invalid integer.
106   Invalid dollar amount.
107   Invalid boolean value (must be 'true' or 'false').
108   Invalid number.
111   Invalid special characters in string.
112   Invalid special field syntax.
181   Could not load certificate file.
201   Required field unspecified.
211   Unsupported field specified.
301   Array line count must be nonnegative.
302   Array index out of bounds.
303   Invalid field index.
401   Field not accessible as a special field.
402   Write access attempted of readonly field.
403   Read access attempted of writeonly field.
421   The object cannot be modified.
511   The QBRequestId has been previously used. Please generate a new one.
601   Could not access QuickBooks.
602   Could not open specified file.
603   The version of QuickBooks currently being used is not supported.
604   QuickBooks has not been installed properly.
605   The specified file was of an incorrect version.
606   Could not start QuickBooks.
607   QuickBooks is open in a mode different than the one requested.
608   QuickBooks cannot currently be accessed.
609   An application name must be specified.
610   A file name must be specified if one is not currently open in QuickBooks.
611   Access denied.
612   QuickBooks is busy and cannot open your application in the mode requested.
699   The connection to QuickBooks has failed for an unknown reason.
702   The object requested does not exist in QuickBooks.
751   Unsupported QBXML version.
752   The QBXMLVersion chosen is insufficient to execute the request.
801   A QuickBooks internal error has occurred.
802   QuickBooks is not available due to a system-related problem.
803   The Id specified is invalid.
804   Invalid object name.
805   The name already exists in QuickBooks.
807   An object could not be found in QuickBooks.
808   A reference did not refer to an object that exists in QuickBooks.
809   The object is currently in use by the QuickBooks end user.
810   The object may not be added.
811   The object may not be updated because it is obsolete.
812   The address is invalid.
813   Permission to perform this operation is not granted.
814   The request has not been processed.
815   Time creation mismatch.
816   The feature is turned off or not enabled.
817   Permission level configured is insufficient for access.
818    The item specified was of an unknown type.
819   The object may not be changed.
820   An internal QuickBooks error has occurred.
821   An attempt was made to use a connection that was not properly initiated.
822   An attempt was made to use a connection that is invalid or was previously closed.
823   Not enough memory.
824   Unable to lock the necessary information to allow this application access to the company file. Try again later.
850   An older version of QuickBooks 2002 is being used. Please download the latest update from Intuit.
851   The QuickBooks request processor was not found. Check that QuickBooks Pro 2002 or higher is installed on your system.
861   Server error on WebExport (details follow).
862   The WebExport is impossible: an HTTP context was not found.
871   You may not set the value of QBConnectionTicket. This value is readonly.
880   Interrupted by the user.
881   An error has occurred connecting to a remote machine.
899   An unknown QuickBooks error has occurred. The message contains more details.
901   XML Parser Error. Should not occur under normal circumstances.
102   Tax identity must be in format ##-#######.
109   Valid US address with City, State, Zip must be specified for 1099 Vendors.

Copyright (c) 2023 4D Payments Inc.
QuickBooks Integrator 2022 C++ Builder Edition - Version 22.0 [Build 8594]