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.

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.

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.

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:

• bsEmpty (0)
• bsBillable (1)
• bsNotBillable (2)
• bsHasBeenBilled (3)

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.

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.

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.

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.

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.

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.

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.

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.

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.

The amount of the linked transaction.

The date of the linked transaction.

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

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.

This field 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 TxnType property) and call the Get method.

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

Valid values include:

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.

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.

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.

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:

• bsEmpty (0)
• bsBillable (1)
• bsNotBillable (2)
• bsHasBeenBilled (3)

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.

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.

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.

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.

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.

Line item field: Description of item.

A string description of the Item specified by ItemName or ItemId.

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.

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.

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:

Invoice.ItemCount = 3 LineItems.ItemName = "Wingnut" LineItems.Quantity = 8 Invoice.ItemAggregate[0] = LineItems.GetAggregate() LineItems.ItemName = "Shovel" LineItems.Quantity = 1 Invoice.ItemAggregate[1] = LineItems.GetAggregate() LineItems.ItemName = "Mower blade" LineItems.Quantity = 1 Invoice.ItemAggregate[2] = LineItems.GetAggregate()

Items may also be grouped into ItemGroups, using the LineItemGroups component.

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:

Invoice.ItemCount = 3 LineItems.ItemName = "Wingnut" LineItems.Quantity = 8 Invoice.ItemAggregate[0] = LineItems.GetAggregate() LineItems.ItemName = "Shovel" LineItems.Quantity = 1 Invoice.ItemAggregate[1] = LineItems.GetAggregate() LineItems.ItemName = "Mower blade" LineItems.Quantity = 1 Invoice.ItemAggregate[2] = LineItems.GetAggregate()

Items may also be grouped into ItemGroups, using the LineItemGroups component.

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.

An account which will override the default account for the line item. QBXMLVersion must be 2.0 or higher to use this configuration setting.

An account which will override the default account for the line item. QBXMLVersion must be 2.0 or higher to use this configuration setting.

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:

component.Quantity = "3.5"

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

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.

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.

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.

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>")

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.

Indicates the state of an object when doing an Update.

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.

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.

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

The default value is false.

The ItemLineLinkToTxnId config links this item receipt line with a PurchaseOrder transaction. The ItemLineLinkToTxnId config links to a specific line item in that PurchaseOrder. Both of these configs must be set if you wish to link a purchase order line.

Note that if you set ItemLineLinkToTxnId and ItemLineLinkToTxnLineId in an item receipt line, you may not set the ItemName or ItemId fields. ItemLineLinkToTxnId and ItemLineLinkToTxnLineId bring in all the item information you need. (You can however specify whatever Quantity or Rate that you want, or any other item line element other than ItemName and ItemId).

You may use this config in conjunction with the PurchaseOrder component's LinkToTxnId property as long as these do NOT link to the same transaction id.

The ItemLineLinkToTxnId config links this item receipt line with a PurchaseOrder transaction. The ItemLineLinkToTxnId config links to a specific line item in that PurchaseOrder. Both of these configs must be set if you wish to link a purchase order line.

Note that if you set ItemLineLinkToTxnId and ItemLineLinkToTxnLineId in an item receipt line, you may not set the ItemName or ItemId fields. ItemLineLinkToTxnId and ItemLineLinkToTxnLineId bring in all the item information you need. (You can however specify whatever Quantity or Rate that you want, or any other item line element other than ItemName and ItemId).

You may use this config in conjunction with the PurchaseOrder component's LinkToTxnId property as long as these do NOT link to the same transaction id.

The ItemLineLotNumber config provides access to the lot number for the line item specified by index.

The ItemLineSerialNumber config provides access to the serial number for the line item specified by index.

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.

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.

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:

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.

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" ?>...")

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.

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.

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.

This config setting is read-only.

This config setting is read-only.

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.

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.

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

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.

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.

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.

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.