Check Component
Properties Methods Events Config Settings Errors
A Check is used to record point-of-receipt payments.
Syntax
DPayments.InQB.Check
Remarks
A Check is used to pay Vendors or other entities whom the QuickBooks company owes money. The Check component corresponds to a standard check in QuickBooks, and allows the QuickBooks user to record the receipt of goods or services at the time they are paid for. The Check component does not correspond to QuickBooks payroll, sales tax, or bill payment checks, and should not be used for any of these purposes.
Required Fields (Add): Account*, Payee*, TransactionDate, Items or Expenses
Supported Methods: Add, Get (Id), Cancel, Delete
Example
Check1.PayeeName = "ACME Inc." '*
Check1.AccountName = "Checking" '*
Check1.TransactionDate = "1/17/03"
Check1.LineItems.Add(New StandardItem())
Check1.LineItems(0).ItemName = "ACME Widget X" '*
Check1.LineItems(0).Amount = "299.95"
Check1.Expenses.Add(New ExpenseLine())
Check1.Expenses(0).AccountName = Expenses '*
Check1.Expenses(0).Amount = "12.00"
Check1.Add()
'*: Item must already exist in QuickBooks.
Payee refers to the entity from whom merchandise was purchased, typically but not always a Vendor. The Account is the account from which funds are being drawn; for example, "Checking" or "Corporate MasterCard". The Payee and Account must already be specified in QuickBooks. Amount is the total of the item lines and (if present) expense lines. It is computed automatically, and should never be set.
Item Lines: Item lines are used to track the purchase of goods or services. Line items may be added by first setting ItemCount. Then, for each line set the Item ID (or Name), Cost, Quantity, Description, Class, Customer, and Amount.
Note: For advanced users, the entire XML item structure may be set and retrieved through the Item's Aggregate field. However, it is up to the developer to ensure that this aggregate is formatted correctly.
Expense Lines: Expense lines are used to track portions of the total amount to expense accounts. Each expense will be tracked to the account specified in ExpenseAccount. The ExpenseAmount should also be specified for each expense; optionally, the ExpenseClass, ExpenseCustomer, and ExpenseMemo fields may be set as well.
The Check 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 Checks, respectively. The ObjSearch Component may be used to search for Checks 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.
AccountId | Reference to account from which funds are being drawn. |
AccountName | Reference to account from which funds are being drawn. |
Address | Address printed on the check. |
Amount | Amount of transaction. |
Expenses | Collection of line items indicating individual expenses. |
IsToBePrinted | Whether this transaction is to be printed. |
LineItems | Collection of line items. |
Memo | Memo to appear on internal reports only. |
PayeeId | Reference to payee of check. |
PayeeName | Reference to payee of check. |
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. |
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.
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 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. |
Config Settings
The following is a list of config settings for the component with short descriptions. Click on the links for further details.
AppendAfter | Appends an XML tag after the specified QBXML element. |
ApplyCheckToTxnAmount | The amount of the transaction to be paid by this check. |
ApplyCheckToTxnId | Identifies the transaction to be paid by this check. |
AuthFlags | Connection Flags (use for QuickBooks Simple Start). |
EditSequence | An identifier for this copy of the object. |
EnforceMaxLength | Indicates whether to enforce max lengths for QB Fields. |
ExchangeRate | Indicates the exchange rate for the transaction. |
ExpenseLineAggregate[index] | Contains the XML aggregate of the expense line item. |
GetHighestVersion | Highest QBXMLVersion supported by the installed instance of 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. |
IsReadOnly | This causes the QuickBooks authorization dialog to display text informing the user that its access will be read-only. |
Items[index].OverrideItemAccountId | An account which will override the default account for the line item. |
Items[index].OverrideItemAccountName | An account which will override the default account for the line item. |
PersonalDataPref | Whether the connecting application will require access to personal data such as SSN or credit card information. |
QBConnectionMode | The mode of connection to QuickBooks. |
QBFileStatus | The status of the company file as it pertains to accepting connections. |
QBOpenCompanyFile | The file currently open in QuickBooks. |
SendRawXML | Sends specified XML to quickbooks without modification. |
SSLAcceptServerCert | The SSL certificate being used by the QuickBooks Gateway (aka Remote Connector). |
SSLAcceptServerCertFile | The SSL certificate file being used by the QuickBooks Gateway (aka Remote Connector). |
StopOnError | Specifies how QuickBooks is to proceed if an error occurs in processing of the current request. |
Tax1Total | Canadian field used for Goods and Services Tax, or GST. |
Tax2Total | Canadian field used for Provincial Sales Taxes, or PST. |
TimeCreated | The time the object was created. |
TimeModified | The time the object was created. |
UnattendedModePref | Whether connecting while QuickBooks is closed is required or optional for the user. |
WarningCodes | A comma-separated list of QuickBooks warning codes that should not result in an exception. |
BuildInfo | Information about the product's build. |
GUIAvailable | Tells the component whether or not a message loop is available for processing events. |
LicenseInfo | Information about the current license. |
MaskSensitive | Whether sensitive data is masked in log messages. |
UseInternalSecurityAPI | Tells the component whether or not to use the system security libraries or an internal implementation. |
AccountId Property (Check Component)
Reference to account from which funds are being drawn.
Syntax
Default Value
""
Remarks
A reference to an account from which funds are being drawn; for example, "Checking". 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. This property is required.
AccountName Property (Check Component)
Reference to account from which funds are being drawn.
Syntax
Default Value
""
Remarks
A reference to an account from which funds are being drawn; for example, "Checking". 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. This property is required.
Address Property (Check Component)
Address printed on the check.
Syntax
Default Value
""
Remarks
The address that is printed on the check.
The address is stored as a string, formatted as XML. It may be read and written directly, or with the Address component.
To read an address, set the Aggregate property of an Address component to this value, and read the values of the desired fields. To write an address, write the values of the desired Address fields and set this property to the Address's Aggregate.
To read and/or write directly, use the QBXML formatting: <Addr1>Line1</Addr1><Addr2>Line2</Addr2><Addr3>Line3</Addr3> <City>City</City><State>State</State><PostalCode>PostalCode</PostalCode> <Country>Country</Country>
Amount Property (Check Component)
Amount of transaction.
Syntax
Default Value
""
Remarks
The amount of the transaction. Amount will be total of the amounts in the item lines and (if present) expense lines.
The amount should be formatted as a string in dollars.
This property is read-only.
Expenses Property (Check Component)
Collection of line items indicating individual expenses.
Syntax
public ExpenseLineList Expenses { get; }
Public Property Expenses As ExpenseLineList
Remarks
About Expenses:
In payment transactions (a Bill, a VendorCredit, a CCCharge, a CCCredit, or a Check) the payment may be tracked through Items and/or Expenses. A set of array properties is available for each. Expense lines are used to charge regularly occurring expenses such as freight charges, rent, etc., to an ExpenseAccount.
Expense line items consist of an ExpenseAccount (Name or Id), an Amount, an ExpenseClass (Name or Id), an ExpenseCustomer (Name or Id), and an Memo.
This property is not available at design time.
IsToBePrinted Property (Check Component)
Whether this transaction is to be printed.
Syntax
Default Value
False
Remarks
Indicates whether or not the transaction is to be printed. If set to true, the "To Be Printed" box in the QuickBooks user interface will be checked.
LineItems Property (Check Component)
Collection of line items.
Syntax
public StandardItemList LineItems { get; }
Public Property LineItems As StandardItemList
Remarks
A Line Item is used to track any portion of a transaction that represents the purchase of an "item". If a line does not specify an Amount, Quantity, or Cost, then QuickBooks will calculate Amount based on a Quantity of 1 and the suggested cost.
This property is not available at design time.
Memo Property (Check Component)
Memo to appear on internal reports only.
Syntax
Default Value
""
Remarks
A memo to appear on internal reports. Will not appear to customers, vendors, etc.
PayeeId Property (Check Component)
Reference to payee of check.
Syntax
Default Value
""
Remarks
A reference to the payee of the check. Might be a Customer, Vendor, or Employee.
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.
PayeeName Property (Check Component)
Reference to payee of check.
Syntax
Default Value
""
Remarks
A reference to the payee of the check. Might be a Customer, Vendor, or Employee.
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.
QBConnectionString Property (Check Component)
An aggregate consisting of various QuickBooks connection properties.
Syntax
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:
ApplicationName | The 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. |
CompanyFile | The 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. |
URL | The 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. |
User | A username for the Remote Connector connection (if required on the Connector side) |
Password | A password for the Remote Connector connection (if required on the Connector side) |
Timeout | A 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. |
DelayAfterClose | A 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. |
FirewallHost | Contains the name or IP address of firewall. If a FirewallHost is given, the requested connections will be authenticated through the specified firewall when connecting. |
FirewallPassword | Contains 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 throws an exception. |
FirewallPort | Contains the TCP port for the firewall FirewallHost. Note this is set automatically when FirewallType is set to a valid value. |
FirewallType | Determines 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. |
FirewallUser | Contains 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 throws an exception. |
ProxyAuthorization | Supported values are 0 - Basic authorization, 1 - Digest authentication, 3 - No authentication, and 4 - NTLM authentication. |
ProxyPassword | Contains a password if authentication is to be used for the proxy. |
ProxyPort | Contains the TCP port for a ProxyServer; (default 80). |
ProxySSL | Determines 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. |
ProxyServer | If 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. |
ProxyUser | Contains a user name, if authentication is to be used for the proxy. |
LocalHost | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
LocalPort | The TCP port in the local host where the component binds. |
UseRDS | Whether 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. |
QBRequestAggregate Property (Check Component)
The request aggregate.
Syntax
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.
QBRequestId Property (Check Component)
The Id of the next message to be sent to QuickBooks.
Syntax
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.
QBRequestMode Property (Check Component)
Defines whether the request is made online or stored offline.
Syntax
public CheckQBRequestModes QBRequestMode { get; set; }
enum CheckQBRequestModes { rmOnline, rmOffline }
Public Property QBRequestMode As CheckQBRequestModes
Enum CheckQBRequestModes rmOnline rmOffline End Enum
Default Value
0
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. |
For normal communication to QuickBooks either directly or through the QBConnector application use the default online mode.
QBResponseAggregate Property (Check Component)
The last QBXML response aggregate received from QuickBooks.
Syntax
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.
QBXMLVersion Property (Check Component)
The version of QBXML used in the outgoing message.
Syntax
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 2002 | 1.0, 1.1 |
QuickBooks 2003 | 2.0 |
QuickBooks 2004 | 3.0 |
QuickBooks 2005 | 4.0, 4.1 |
QuickBooks 2006 | 5.0 |
QuickBooks 2007 | 6.0 |
QuickBooks 2008 | 7.0 |
QuickBooks 2009 | 8.0 |
QuickBooks 2010 | 9.0 |
QuickBooks 2011 | 10.0 |
QuickBooks 2012 | 11.0 |
QuickBooks 2013 | 12.0 |
QuickBooks 2014 | 13.0 |
QuickBooks 2015 | 14.0 |
QuickBooks 2016 | 15.0 |
QuickBooks Canadian 2003 | CA2.0 |
QuickBooks Canadian 2004 to 2007 | CA3.0 |
QuickBooks UK 2003 | UK2.0 |
QuickBooks UK 2004 to 2007 | UK3.0 |
QuickBooks Australian 2003 | OZ2.0 |
QuickBooks Australian 2004 to 2007 | AU3.0 |
This property is not available at design time.
RefId Property (Check Component)
An alphanumerical identifier generated by the server.
Syntax
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.
RefNumber Property (Check Component)
Reference number for the transaction.
Syntax
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.
TransactionDate Property (Check Component)
Date of transaction.
Syntax
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.
Add Method (Check Component)
Adds the record into QuickBooks.
Syntax
public void Add();
Public Sub 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 (Check Component)
Cancels (voids) the transaction.
Syntax
public void Cancel();
Public Sub 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 (Check Component)
Checks whether or not the specified request was processed by QuickBooks.
Syntax
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 (Check Component)
Closes a persistent connection to QuickBooks.
Syntax
public void CloseQBConnection();
Public Sub 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 (Check Component)
Sets or retrieves a configuration setting.
Syntax
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 (Check Component)
Deletes the record from QuickBooks.
Syntax
public void Delete();
Public Sub 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 (Check Component)
Gets a single record from QuickBooks.
Syntax
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 (Check Component)
Gets a custom field value from QuickBooks.
Syntax
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 (Check Component)
Imports a QBXML response aggregate.
Syntax
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 (Check Component)
Opens a persistent connection to QuickBooks.
Syntax
public void OpenQBConnection();
Public Sub 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 (Check Component)
Resets all properties to their defaults.
Syntax
public void Reset();
Public Sub 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 (Check Component)
Sets a custom field value within QuickBooks.
Syntax
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 (Check Component)
Updates the bill in QuickBooks.
Syntax
public void Update();
Public Sub 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 (Check Component)
Information about errors during data delivery.
Syntax
public event OnErrorHandler OnError; public delegate void OnErrorHandler(object sender, CheckErrorEventArgs e); public class CheckErrorEventArgs : EventArgs { public int ErrorCode { get; } public string Description { get; } }
Public Event OnError As OnErrorHandler Public Delegate Sub OnErrorHandler(sender As Object, e As CheckErrorEventArgs) Public Class CheckErrorEventArgs Inherits EventArgs Public ReadOnly Property ErrorCode As Integer Public ReadOnly Property Description As String End Class
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 (Check Component)
Fired after the server presents its certificate to the client.
Syntax
public event OnSSLServerAuthenticationHandler OnSSLServerAuthentication; public delegate void OnSSLServerAuthenticationHandler(object sender, CheckSSLServerAuthenticationEventArgs e); public class CheckSSLServerAuthenticationEventArgs : EventArgs { public string CertEncoded { get; }
public byte[] CertEncodedB { get; } public string CertSubject { get; } public string CertIssuer { get; } public string Status { get; } public bool Accept { get; set; } }
Public Event OnSSLServerAuthentication As OnSSLServerAuthenticationHandler Public Delegate Sub OnSSLServerAuthenticationHandler(sender As Object, e As CheckSSLServerAuthenticationEventArgs) Public Class CheckSSLServerAuthenticationEventArgs Inherits EventArgs Public ReadOnly Property CertEncoded As String
Public ReadOnly Property CertEncodedB As Byte() Public ReadOnly Property CertSubject As String Public ReadOnly Property CertIssuer As String Public ReadOnly Property Status As String Public Property Accept As Boolean End Class
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 (Check Component)
Shows the progress of the secure connection.
Syntax
public event OnSSLStatusHandler OnSSLStatus; public delegate void OnSSLStatusHandler(object sender, CheckSSLStatusEventArgs e); public class CheckSSLStatusEventArgs : EventArgs { public string Message { get; } }
Public Event OnSSLStatus As OnSSLStatusHandler Public Delegate Sub OnSSLStatusHandler(sender As Object, e As CheckSSLStatusEventArgs) Public Class CheckSSLStatusEventArgs Inherits EventArgs Public ReadOnly Property Message As String End Class
Remarks
The event is fired for informational and logging purposes only. Used to track the progress of the connection.
Status Event (Check Component)
Shows the progress of the QuickBooks connection.
Syntax
public event OnStatusHandler OnStatus; public delegate void OnStatusHandler(object sender, CheckStatusEventArgs e); public class CheckStatusEventArgs : EventArgs { public string Message { get; } }
Public Event OnStatus As OnStatusHandler Public Delegate Sub OnStatusHandler(sender As Object, e As CheckStatusEventArgs) Public Class CheckStatusEventArgs Inherits EventArgs Public ReadOnly Property Message As String End Class
Remarks
The event is fired for informational and logging purposes only. Used to track the progress of the connection.
Warning Event (Check Component)
Fired when a warning occurs.
Syntax
public event OnWarningHandler OnWarning; public delegate void OnWarningHandler(object sender, CheckWarningEventArgs e); public class CheckWarningEventArgs : EventArgs { public int Code { get; } public string Description { get; } }
Public Event OnWarning As OnWarningHandler Public Delegate Sub OnWarningHandler(sender As Object, e As CheckWarningEventArgs) Public Class CheckWarningEventArgs Inherits EventArgs Public ReadOnly Property Code As Integer Public ReadOnly Property Description As String End Class
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). |
802 | Unable to parse name. |
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.
ExpenseLine Type
A single expense line item.
Remarks
This type of line item is used by the Estimate component.
Fields
AccountId String |
A reference to the account to which this expense is be charged. Either AccountName or AccountId (but not both) may be used to specify the Account. For example, an AccountName of "Rent". 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. |
AccountName String |
A reference to the account to which this expense is be charged. Either AccountName or AccountId (but not both) may be used to specify the Account. For example, an AccountName of "Rent". 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. |
Amount String |
The total amount of this expense line. The amount should be formatted as a string in dollars. About Expenses: In payment transactions (a Bill, a VendorCredit, a CCCharge, a CCCredit, or a Check) the payment may be tracked through Items and/or Expenses. A set of array properties is available for each. Expense lines are used to charge regularly occurring expenses such as freight charges, rent, etc., to an ExpenseAccount. Expense line items consist of an ExpenseAccount (Name or Id), an Amount, an ExpenseClass (Name or Id), an ExpenseCustomer (Name or Id), and an Memo. |
BillableStatus BillableStatus |
The billing status of this expense line. If the billing status is empty (that is, if no billing status appears in QuickBooks), then BillableStatus will be bsEmpty Values:
About Expenses: In payment transactions (a Bill, a VendorCredit, a CCCharge, a CCCredit, or a Check) the payment may be tracked through Items and/or Expenses. A set of array properties is available for each. Expense lines are used to charge regularly occurring expenses such as freight charges, rent, etc., to an ExpenseAccount. Expense line items consist of an ExpenseAccount (Name or Id), an Amount, an ExpenseClass (Name or Id), an ExpenseCustomer (Name or Id), and an Memo. |
ClassId String |
A reference to the class of this expense. The class may be specified by either ClassName or ClassId. This field is only used if class tracking is being done with the QuickBooks 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. About Expenses: In payment transactions (a Bill, a VendorCredit, a CCCharge, a CCCredit, or a Check) the payment may be tracked through Items and/or Expenses. A set of array properties is available for each. Expense lines are used to charge regularly occurring expenses such as freight charges, rent, etc., to an ExpenseAccount. Expense line items consist of an ExpenseAccount (Name or Id), an Amount, an ExpenseClass (Name or Id), an ExpenseCustomer (Name or Id), and an Memo. |
ClassName String |
A reference to the class of this expense. The class may be specified by either ClassName or ClassId. This field is only used if class tracking is being done with the QuickBooks 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. About Expenses: In payment transactions (a Bill, a VendorCredit, a CCCharge, a CCCredit, or a Check) the payment may be tracked through Items and/or Expenses. A set of array properties is available for each. Expense lines are used to charge regularly occurring expenses such as freight charges, rent, etc., to an ExpenseAccount. Expense line items consist of an ExpenseAccount (Name or Id), an Amount, an ExpenseClass (Name or Id), an ExpenseCustomer (Name or Id), and an Memo. |
CustomerId String |
The customer associated with this expense line. Either CustomerName or CustomerId may reference to a Customer for this expense line. If this field is set, the expense will be set as billable to the Customer referenced. 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. About Expenses: In payment transactions (a Bill, a VendorCredit, a CCCharge, a CCCredit, or a Check) the payment may be tracked through Items and/or Expenses. A set of array properties is available for each. Expense lines are used to charge regularly occurring expenses such as freight charges, rent, etc., to an ExpenseAccount. Expense line items consist of an ExpenseAccount (Name or Id), an Amount, an ExpenseClass (Name or Id), an ExpenseCustomer (Name or Id), and an Memo. |
CustomerName String |
The customer associated with this expense line. Either CustomerName or CustomerId may reference to a Customer for this expense line. If this field is set, the expense will be set as billable to the Customer referenced. 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. About Expenses: In payment transactions (a Bill, a VendorCredit, a CCCharge, a CCCredit, or a Check) the payment may be tracked through Items and/or Expenses. A set of array properties is available for each. Expense lines are used to charge regularly occurring expenses such as freight charges, rent, etc., to an ExpenseAccount. Expense line items consist of an ExpenseAccount (Name or Id), an Amount, an ExpenseClass (Name or Id), an ExpenseCustomer (Name or Id), and an Memo. |
LineId String |
Identification number of the expense line, used for Updates. If you need to add a new expense line in a transaction Update request, you can do so by setting the LineId to -1. |
Memo String |
A memo for this expense line, which will appear to the QuickBooks user only. About Expenses: In payment transactions (a Bill, a VendorCredit, a CCCharge, a CCCredit, or a Check) the payment may be tracked through Items and/or Expenses. A set of array properties is available for each. Expense lines are used to charge regularly occurring expenses such as freight charges, rent, etc., to an ExpenseAccount. Expense line items consist of an ExpenseAccount (Name or Id), an Amount, an ExpenseClass (Name or Id), an ExpenseCustomer (Name or Id), and an Memo. |
TaxCodeId String |
Line item field: Sales tax information for this item. This is a reference to a sales tax code predefined within QuickBooks. By default, two standard TaxCodes exist: "TAX", or Taxable Sales, and "NON", or Non-Taxable Sales. The QuickBooks user may also define custom tax codes. 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. About Expenses: In payment transactions (a Bill, a VendorCredit, a CCCharge, a CCCredit, or a Check) the payment may be tracked through Items and/or Expenses. A set of array properties is available for each. Expense lines are used to charge regularly occurring expenses such as freight charges, rent, etc., to an ExpenseAccount. Expense line items consist of an ExpenseAccount (Name or Id), an Amount, an ExpenseClass (Name or Id), an ExpenseCustomer (Name or Id), and an Memo. |
TaxCodeName String |
Line item field: Sales tax information for this item. This is a reference to a sales tax code predefined within QuickBooks. By default, two standard TaxCodes exist: "TAX", or Taxable Sales, and "NON", or Non-Taxable Sales. The QuickBooks user may also define custom tax codes. 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. About Expenses: In payment transactions (a Bill, a VendorCredit, a CCCharge, a CCCredit, or a Check) the payment may be tracked through Items and/or Expenses. A set of array properties is available for each. Expense lines are used to charge regularly occurring expenses such as freight charges, rent, etc., to an ExpenseAccount. Expense line items consist of an ExpenseAccount (Name or Id), an Amount, an ExpenseClass (Name or Id), an ExpenseCustomer (Name or Id), and an Memo. |
Constructors
public ExpenseLine();
Public ExpenseLine()
StandardItem Type
A single standard line item.
Remarks
This type of line item is used by the Bill, CCCharge, CCCredit, Check, VendorCredit, and ItemReceipt components.
Fields
Aggregate String |
Contains an XML aggregate of the line item. If the line item has not been modified since receiving a response from QuickBooks, the exact LineRet aggregate that QuickBooks returned will be contained in this XML aggregate. However, if you have made changes to the this line item's fields the Aggregate field will re-generate the line item XML with the new data. If you set the other line item fields and then query the Aggregate, a LineRet aggregate will be generated from the currently set fields. You may set this field with raw xml. So long as you do not modify any other fields (forcing the line item to regenerate based on new changes), the xml will be sent as-is to the QuickBooks request processor. It is essential that you properly format the XML that you place in this field. When setting this field manually, the component will send exactly what you have set. You must ensure your xml is appropriate for the action you are attempting. For instance, if you are Adding an Invoice, you must ensure the outer tags are "InvoiceLineAdd". If Modifying an Invoice, the outer tags must be "InvoiceLineMod". If you do not expressly set the Aggregate field with your own custom XML, all of this will be taken care of you automatically by the component. |
Amount String |
Line item field: the total amount of this item. This field represents the total amount of a transaction line. If Rate, Cost and/or Quantity are specified the Amount will be automatically computed by QuickBooks. Whether Rate or Cost is used will depend on the transaction type. Rate is available for CreditMemo, Estimate, Invoice, PurchaseOrder, SalesOrder, and SalesReceipt transactions while Cost is available for Bill, CCCharge, CCCredit, Check, ItemReceipt, and VendorCredit transactions. The amount should be formatted as a string in dollars. |
BillableStatus BillableStatus |
Line item field: Billing status of this item. The billing status of this line item. If the billing status is empty (that is, if no billing status appears in QuickBooks), then no BillableStatus value will be returned. Values:
|
ClassId String |
Line item field: Reference to the class of the item. A reference to the class of this item. 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. |
ClassName String |
Line item field: Reference to the class of the item. 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. |
Cost String |
Line item field: Unit cost for item. The unit cost for this item. If Amount is specified, then Cost will be calculated automatically and should not be specified. The amount should be formatted as a string in dollars. |
CustomerId String |
Line item property: A reference to customer for whom the item was ordered. A reference to a Customer for whom this item was ordered. If this field is set, the expense will be set as billable to the Customer referenced. 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. |
CustomerName String |
Line item field: A reference to customer for whom the item was ordered. A reference to a Customer for whom this item was ordered. If this field is set, the expense will be set as billable to the Customer referenced. 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. |
Description String |
Line item field: Description of item. A string description of the Item specified by ItemName or ItemId. |
GroupId String |
Reference to a group of line items. Line item groups represent sets of items that are grouped together. A line item group is a predefined shortcut within QuickBooks. For example, a "Cheeseburger Meal" might consist of a cheeseburger, an order of french fries, and a soft drink. To include an item group in a transaction one should simply set the value of ItemGroup, and optionally, of ItemQuantity. QuickBooks will automatically expand the group into its constituent items. This will send an ItemGroup instead of a regular Item on for this index. When an ItemGroup is returned from QuickBooks it contains xml aggregates of all of the items in the group you specified. You may access the group's regular fields (total Amount, Quantity, and Description), but the line items returned are not accessible with this object. However, you may parse the returned line items by passing the contents of the Aggregate field to the LineItemGroups component. You may use the LineItemGroups component to view or change the contents of the line items, and then pass the xml aggregate generated by the component back to the Aggregate field to use in an Update transaction. |
GroupName String |
Reference to a group of line items. Line item groups represent sets of items that are grouped together. A line item group is a predefined shortcut within QuickBooks. For example, a "Cheeseburger Meal" might consist of a cheeseburger, an order of french fries, and a soft drink. To include an item group in a transaction one should simply set the value of ItemGroup, and optionally, of ItemQuantity. QuickBooks will automatically expand the group into its constituent items. This will send an ItemGroup instead of a regular Item on for this index. When an ItemGroup is returned from QuickBooks it contains xml aggregates of all of the items in the group you specified. You may access the group's regular fields (total Amount, Quantity, and Description), but the line items returned are not accessible with this object. However, you may parse the returned line items by passing the contents of the Aggregate field to the LineItemGroups component. You may use the LineItemGroups component to view or change the contents of the line items, and then pass the xml aggregate generated by the component back to the Aggregate field to use in an Update transaction. |
ItemId String |
Line item field: Reference to the kind of item. Line items represent goods or services bought in a QuickBooks transaction. Each line item is represented by a number of properties, each prefixed by Item (see the list of properties for individual components for details). Properties such as Quantity and Description are always present; some properties are found in only certain types of transactions. Item is a reference to a kind of item, predefined within QuickBooks. Generally items defined within QuickBooks have default values for Description, etc., and if only Item is set when adding a record to QuickBooks, the other properties will be set automatically. This component is used to create a single item. However, any InQB component may be set with an unlimited number of these items. For example:
Items may also be grouped into ItemGroups, using the LineItemGroups component. |
ItemName String |
Line item field: Reference to the kind of item. Line items represent goods or services bought in a QuickBooks transaction. Each line item is represented by a number of properties, each prefixed by Item (see the list of properties for individual components for details). Properties such as Quantity and Description are always present; some properties are found in only certain types of transactions. Item is a reference to a kind of item, predefined within QuickBooks. Generally items defined within QuickBooks have default values for Description, etc., and if only Item is set when adding a record to QuickBooks, the other properties will be set automatically. This component is used to create a single item. However, any InQB component may be set with an unlimited number of these items. For example:
Items may also be grouped into ItemGroups, using the LineItemGroups component. |
LineId String |
Identification number of the transaction line, used for Updates. If you need to add a new transaction line in a transaction Update request, you can do so by setting the LineId to -1. |
OverrideAccountId String |
An account which will override the default account for the line item. QBXMLVersion must be 2.0 or higher to use this configuration setting. |
OverrideAccountName String |
An account which will override the default account for the line item. QBXMLVersion must be 2.0 or higher to use this configuration setting. |
Quantity String |
Line item field: Quantity of item or item group. The quantity of the Item specified in this line. If Quantity and only one of Cost, Rate, or Amount are specified, QuickBooks will automatically calculate the other. This field is a String type in order to allow setting fractional quantities. Setting this field with non-numeric data will cause an error. Correct usage of this field is shown below:
Leave this field blank and no quantity will be sent to QuickBooks. |
TaxCodeId String |
Line item field: Sales tax information for this item. This is a reference to a sales tax code predefined within QuickBooks. By default, two standard TaxCodes exist: "TAX", or Taxable Sales, and "NON", or Non-Taxable Sales. The QuickBooks user may also define custom tax codes. 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. |
TaxCodeName String |
Line item field: Sales tax information for this item. This is a reference to a sales tax code predefined within QuickBooks. By default, two standard TaxCodes exist: "TAX", or Taxable Sales, and "NON", or Non-Taxable Sales. The QuickBooks user may also define custom tax codes. 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. |
UnitOfMeasure String |
Unit of measure describing the Quantity. In a transaction line item, the name of the unit of measure selected from within the item's available units. If the company file is enabled only for single unit of measure per item, this must be the base unit! This field is only available for QBXMLVersion 7.0 and higher. |
Constructors
public StandardItem();
Public StandardItem()
Config Settings (Check 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.Check 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>") | |||||||||||||
ApplyCheckToTxnAmount: The amount of the transaction to be paid by this check.ApplyCheckToTxnId specifies the transaction to be paid by this check, and ApplyCheckToTxnAmount optionally indicates the amount of that transaction the check is paying. | |||||||||||||
ApplyCheckToTxnId: Identifies the transaction to be paid by this check.Any transaction linked by this property must use the same Accounts Receivable account specified in the Expenses or AccountName/AccountId, and must apply to the same Entity referred to by the Check's PayeeName or PayeeId. | |||||||||||||
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.
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. | |||||||||||||
ExchangeRate:
Indicates the exchange rate for the transaction.Exchange Rate is a floating-point number stored with five digits after the decimal place.
The exchange rate is multiplied by the foreign currency amount to get the home currency amount; that is,
ExchangeRate x (foreign currency amount) = (home currency amount). (The foreign currency and home currency are set in the QuickBooks application) |
|||||||||||||
ExpenseLineAggregate[index]:
Contains the XML aggregate of the expense line item.If the line item has not been modified since receiving a response
from QuickBooks, the exact ExpenseLineRet aggregate that QuickBooks
returned will be contained in this XML aggregate. However, if you
have made changes to the ExpenseLine fields, the Aggregate
field will re-generate the line item XML with the new data.
If you set the other line item fields and then query the Aggregate, a ExpenseLineRet aggregate will be generated from the currently set fields. You may set this field with raw xml. So long as you do not modify any other fields (forcing the line item to regenerate based on new changes), the xml will be sent as-is to the QuickBooks request processor. It is essential that you properly format the XML that you place in this field. When setting this field manually, the component will send exactly what you have set. You must ensure your xml is appropriate for the action you are attempting. For instance, if you are Adding, you must ensure the outer tags are "ExpenseLineAdd". If modifying, the outer tags must be "ExpenseLineMod". If you do not expressly set the Aggregate field with your own custom XML, all of this will be taken care of you automatically by the component. |
|||||||||||||
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. | |||||||||||||
Items[index].OverrideItemAccountId: An account which will override the default account for the line item.QBXMLVersion must be 2.0 or higher to use this configuration setting. | |||||||||||||
Items[index].OverrideItemAccountName: An account which will override the default account for the line item.QBXMLVersion must be 2.0 or higher to use this configuration setting. | |||||||||||||
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.
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:
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:
|
|||||||||||||
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. | |||||||||||||
Tax1Total:
Canadian field used for Goods and Services Tax, or GST.QBXMLVersion must be set to "CA2.0", "OZ2.0", "UK2.0", or "AU2.0" to use this property.
Note: U.K. editions of QuickBooks use Tax1 for Value Added Tax (VAT) and do not use Tax2Total at all. |
|||||||||||||
Tax2Total:
Canadian field used for Provincial Sales Taxes, or PST.QBXMLVersion must be set to "CA2.0", "OZ2.0", "UK2.0", or "AU2.0" to use this property.
Note: U.K. editions of QuickBooks use Tax1 for Value Added Tax (VAT) and do not use Tax2Total at all. |
|||||||||||||
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.
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. | |
GUIAvailable:
Tells the component whether or not a message loop is available for processing events.In a GUI-based application, long-running blocking operations may cause the application to stop responding to input until the operation returns. The component will attempt to discover whether or not the application has a message loop and, if one is discovered, it will process events in that message loop during any such blocking operation.
In some non-GUI applications, an invalid message loop may be discovered that will result in errant behavior. In these cases, setting GUIAvailable to false will ensure that the component does not attempt to process external events. |
|
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:
|
|
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.
In this case, calls to unmanaged code will be made. In certain environments this is not desirable.
To use a completely managed security implementation set this setting to true.
Setting this setting to true tells the component to use the internal implementation instead of using the system security libraries. On Windows, this setting is set to false by default. On Linux/macOS, this setting is set to true by default. If using the .NET Standard Library, this setting will be true on all platforms. The .NET Standard library does not support using the system security libraries. Note: This setting is static. The value set is applicable to all components used in the application. When this value is set the product's system DLL is no longer required as a reference, as all unmanaged code is stored in that file. |
Trappable Errors (Check Component)
ErrorsThe following errors may be generated by the component. Note that frequently the error message will contain more specific information than what is listed here.
Check 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. |