SalesOrder Control

Properties Methods Events Config Settings Errors

A SalesOrder is used in place of an INVOICE when not all goods have been shipped.

Syntax

SalesOrder

Remarks

This functionality requires a U.S. version of QuickBooks 2003, with the most recent updates from Intuit. The default value for QBXMLVersion for this component is "2.1". If your version of QuickBooks does not support QBXML version 2.1, the control will fail with an error.

Moreover, adding new Sales Orders is a feature of QuickBooks Premier and above; it is not supported in QuickBooks Pro.

A SalesOrder tracks inventory that is on back order for a customer. The operation of the control is similar to that of the Invoice Control.

Required Fields (Add): Customer*, Items

Supported Methods: Add, Get (Id), Delete

Example SalesOrder1.CustomerName = "John Q. Customer" '* SalesOrder1.TransactionDate = "1/17/03" SalesOrder1.ItemCount = 1 SalesOrder1.ItemName(0) = "Our Company's Product" '* SalesOrder1.ItemAmount(0) = "140.00" SalesOrder1.Add() '*: Item must already exist 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 ordering of goods or services. To add item lines to the transaction, first set the ItemCount. This will initialize the Items array. For each item you add, set the Item Id (or Name) to an item that has been defined in QuickBooks. The Item Rate/RatePercent, Quantity, Description, Class, TaxCode, and Amount properties may be optionally set for each item as well.

The control supports a variety of other operations as well. The control's Get and Delete methods may be used to retrieve and delete SalesOrders, respectively. The ObjSearch Control may be used to search for SalesOrders in the QuickBooks database.

Property List

The following is the full list of the properties of the control with short descriptions. Click on the links for further details.


Amount	Amount of transaction.
BillingAddress	Address to bill to.
CustomerId	A reference to the customer or customer job.
CustomerMessageId	Reference to message to appear to customer.
CustomerMessageName	Reference to message to appear to customer.
CustomerName	A reference to the customer or customer job.
DueDate	Date when payment is due.
IncludeLinkedTxns	Indicates whether to include linked transactions in the response.
IsFullyInvoiced	Whether the sales order is fully invoiced.
IsToBePrinted	Whether this transaction is to be printed.
ItemCount	The number of records in the Item arrays.
ItemAggregate	Contains an XML aggregate of the line item.
ItemAmount	Line item property: the total amount of this item.
ItemClassId	Line item property: Reference to the class of the item.
ItemClassName	Line item property: Reference to the class of the item.
ItemDescription	Line item property: Description of item.
ItemGroupId	Reference to a group of line items.
ItemGroupName	Reference to a group of line items.
ItemInvoicedAmount	The amount of this sales order line that has been invoiced.
ItemId	Line item property: Reference to the kind of item.
ItemName	Line item property: Reference to the kind of item.
ItemLineId	Identification number of the transaction line, used for Updates.
ItemManuallyClosed	Indicates if the line item has been manually closed.
ItemOther1	Standard QuickBooks Custom Field available for transaction line items.
ItemOther2	Standard QuickBooks Custom Field available for transaction line items.
ItemPriceLevelId	Line Item property: Used to specify custom pricing for specific customers.
ItemPriceLevelName	Line Item property: Specify custom pricing for specific customers.
ItemQuantity	Line item property: Quantity of item or item group.
ItemRate	Unit rate of item.
ItemRatePercent	Line item property: A markup or discount percentage.
ItemTaxCodeId	Line item property: Sales tax information for this item.
ItemTaxCodeName	Line item property: Sales tax information for this item.
ItemUnitOfMeasure	Unit of measure describing the Quantity .
LinkedTxnCount	The number of records in the LinkedTxn arrays.
LinkedTxnAmount	The amount of the linked transaction.
LinkedTxnDate	The date of the linked transaction.
LinkedTxnLinkType	Indicates the nature of the link between the transactions.
LinkedTxnRefNumber	This is the reference number assigned to the linked transaction.
LinkedTxnId	This property can be used by another control to reference the original transaction which is linked to the current response.
LinkedTxnType	This property indicates which type of linked transaction has been returned.
ManuallyClosed	Whether the sales order is manually closed.
Memo	Memo to appear on internal reports only.
Other	Pre-defined QuickBooks Custom Field.
PONumber	P.O. number.
QBConnectionMode	The mode of connection to QuickBooks.
QBConnectionString	An aggregate consisting of various QuickBooks connection properties.
QBOpenCompanyFile	The file currently open in QuickBooks.
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.
SalesRepId	Reference to (initials of) sales rep.
SalesRepName	Reference to (initials of) sales rep.
SalesTaxTotal	Total amount of sales tax.
ShipDate	Date of shipping.
ShipMethodId	Reference to preferred method of shipping.
ShipMethodName	Reference to preferred method of shipping.
ShippingAddress	Address to ship to.
Subtotal	Gross subtotal; doesn't count taxes/amount already paid.
TaxItemId	Reference to detailed taxation information.
TaxItemName	Reference to detailed taxation information.
TermsId	Reference to terms of payment.
TermsName	Reference to terms of payment.
TransactionDate	Date of transaction.

Method List

The following is the full list of the methods of the control 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 sales order in QuickBooks.

Event List

The following is the full list of the events fired by the control 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 control with short descriptions. Click on the links for further details.


AppendAfter	Appends an XML tag after the specified QBXML element.
AuthFlags	Connection Flags (use for QuickBooks Simple Start).
ClassId	A reference to the class of transaction.
ClassName	A reference to the class of transaction.
CurrencyId	Id of the currency code used for this invoice.
CurrencyName	Name of the currency code used for this invoice.
CustomerSalesTaxId	Reference to sales tax information for the CUSTOMER.
CustomerSalesTaxName	Reference to sales tax information for the CUSTOMER.
EditSequence	An identifier for this copy of the object.
EnforceMaxLength	Indicates whether to enforce max lengths for QB Fields.
ExchangeRate	Currency exchange rate for this invoice.
ExchangeRate	Indicates the exchange rate for the transaction.
FOB	Freight On Board: the place from where shipped.
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.
IsTaxIncluded	Determines if tax is included in the transaction amount.
IsToBeEmailed	When true, if no email address is on file for the customer the transaction will fail.
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.
SalesTaxPercentage	Percent paid as sales tax.
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.
TemplateId	The ID of an existing template to apply to the transaction.
TemplateName	The name of an existing template to apply to the transaction.
TimeCreated	The time the object was created.
TimeModified	The time the object was created.
TotalAmountInHomeCurrency	Returned for transactions in currencies different from the merchant's home currency.
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.
CodePage	The system code page used for Unicode to Multibyte translations.
MaskSensitive	Whether sensitive data is masked in log messages.
UseInternalSecurityAPI	Tells the control whether or not to use the system security libraries or an internal implementation.

Amount Property (SalesOrder Control)

Amount of transaction.

Syntax

salesordercontrol.Amount

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.

Data Type

String

BillingAddress Property (SalesOrder Control)

Address to bill to.

Syntax

salesordercontrol.BillingAddress[=string]

Default Value

Remarks

The address to bill to.

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 control 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>

Data Type

String

CustomerId Property (SalesOrder Control)

A reference to the customer or customer job.

Syntax

salesordercontrol.CustomerId[=string]

Default Value

Remarks

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

Id/Name Reference Properties

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

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

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

Either CustomerId or CustomerName is required.

Data Type

String

CustomerMessageId Property (SalesOrder Control)

Reference to message to appear to customer.

Syntax

salesordercontrol.CustomerMessageId[=string]

Default Value

Remarks

A reference to a predefined message that will appear to the customer.

Id/Name Reference Properties

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

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

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

Data Type

String

CustomerMessageName Property (SalesOrder Control)

Reference to message to appear to customer.

Syntax

salesordercontrol.CustomerMessageName[=string]

Default Value

Remarks

A reference to a predefined message that will appear to the customer.

Name/Id Reference Properties

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

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

Data Type

String

CustomerName Property (SalesOrder Control)

A reference to the customer or customer job.

Syntax

salesordercontrol.CustomerName[=string]

Default Value

Remarks

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

Name/Id Reference Properties

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

Either CustomerId or CustomerName is required.

Data Type

String

DueDate Property (SalesOrder Control)

Date when payment is due.

Syntax

salesordercontrol.DueDate[=string]

Default Value

Remarks

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

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

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

Data Type

String

IncludeLinkedTxns Property (SalesOrder Control)

Indicates whether to include linked transactions in the response.

Syntax

salesordercontrol.IncludeLinkedTxns[=boolean]

Default Value

False

Remarks

If you set IncludeLinkedTxns to true, then the returned object will include a list of all the transactions linked to the queried object (this list is similar to the History view of a transaction in the user interface, but not identical, as the SDK list contains only linked transactions, not items). Each linked transaction will be represented by a LinkedTxn aggregate, which will be parsed by the control into the following properties:

LinkedTxnCount
LinkedTxnAmount
LinkedTxnDate
LinkedTxnId
LinkedTxnLinkType
LinkedTxnRefNumber
LinkedTxnType

Data Type

Boolean

IsFullyInvoiced Property (SalesOrder Control)

Whether the sales order is fully invoiced.

Syntax

salesordercontrol.IsFullyInvoiced

Default Value

False

Remarks

If true, all line items in the sales order have been fully invoiced.

This property is read-only.

Data Type

Boolean

IsToBePrinted Property (SalesOrder Control)

Whether this transaction is to be printed.

Syntax

salesordercontrol.IsToBePrinted[=boolean]

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.

Data Type

Boolean

ItemCount Property (SalesOrder Control)

The number of records in the Item arrays.

Syntax

salesordercontrol.ItemCount[=integer]

Default Value

Remarks

This property controls the size of the following arrays:

ItemAggregate
ItemAmount
ItemClassId
ItemClassName
ItemDescription
ItemGroupId
ItemGroupName
ItemId
ItemInvoicedAmount
ItemLineId
ItemManuallyClosed
ItemName
ItemOther1
ItemOther2
ItemPriceLevelId
ItemPriceLevelName
ItemQuantity
ItemRate
ItemRatePercent
ItemTaxCodeId
ItemTaxCodeName
ItemUnitOfMeasure

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

This property is not available at design time.

Data Type

Integer

ItemAggregate Property (SalesOrder Control)

Contains an XML aggregate of the line item.

Syntax

salesordercontrol.ItemAggregate(ItemIndex)[=string]

Default Value

Remarks

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 properties the ItemAggregate property will re-generate the line item XML with the new data.

If you set the other line item properties and then query the ItemAggregate, a LineRet aggregate will be generated from the currently set properties.

You may set this property with raw xml. So long as you do not modify any other properties (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 property. When setting this property manually, the control 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 ItemAggregate field with your own custom XML, all of this will be taken care of you automatically by the control.

The ItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

String

ItemAmount Property (SalesOrder Control)

Line item property: the total amount of this item.

Syntax

salesordercontrol.ItemAmount(ItemIndex)[=string]

Default Value

Remarks

Line item property: the total amount of this item.

This property represents the total amount of a transaction line. If ItemRate, ItemCost and/or ItemQuantity are specified the ItemAmount will be automatically computed by QuickBooks.

Whether ItemRate or ItemCost is used will depend on the transaction type. ItemRate is available for CreditMemo, Estimate, Invoice, PurchaseOrder, SalesOrder, and SalesReceipt transactions while ItemCost is available for Bill, CCCharge, CCCredit, Check, ItemReceipt, and VendorCredit transactions.

The amount should be formatted as a string in dollars.

The ItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

String

ItemClassId Property (SalesOrder Control)

Line item property: Reference to the class of the item.

Syntax

salesordercontrol.ItemClassId(ItemIndex)[=string]

Default Value

Remarks

Line item property: 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.

The ItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

String

ItemClassName Property (SalesOrder Control)

Line item property: Reference to the class of the item.

Syntax

salesordercontrol.ItemClassName(ItemIndex)[=string]

Default Value

Remarks

Line item property: Reference to the class of the item.

Name/Id Reference Properties

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

The ItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

String

ItemDescription Property (SalesOrder Control)

Line item property: Description of item.

Syntax

salesordercontrol.ItemDescription(ItemIndex)[=string]

Default Value

Remarks

Line item property: Description of item.

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

The ItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

String

ItemGroupId Property (SalesOrder Control)

Reference to a group of line items.

Syntax

salesordercontrol.ItemGroupId(ItemIndex)[=string]

Default Value

Remarks

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 properties (total ItemAmount, ItemQuantity, and ItemDescription), 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 ItemAggregate property to the LineItemGroups control. You may use the LineItemGroups control to view or change the contents of the line items, and then pass the xml aggregate generated by the control back to the ItemAggregate field to use in an Update transaction.

The ItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

String

ItemGroupName Property (SalesOrder Control)

Reference to a group of line items.

Syntax

salesordercontrol.ItemGroupName(ItemIndex)[=string]

Default Value

Remarks

Reference to a group of line items.

The ItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

String

ItemInvoicedAmount Property (SalesOrder Control)

The amount of this sales order line that has been invoiced.

Syntax

salesordercontrol.ItemInvoicedAmount(ItemIndex)

Default Value

Remarks

The amount of this sales order line that has been invoiced. The amount should be formatted as a string in dollars.

The ItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

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

Data Type

String

ItemId Property (SalesOrder Control)

Line item property: Reference to the kind of item.

Syntax

salesordercontrol.ItemId(ItemIndex)[=string]

Default Value

Remarks

Line item property: 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 controls for details). Properties such as ItemQuantity and ItemDescription 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 ItemDescription, etc., and if only Item is set when adding a record to QuickBooks, the other properties will be set automatically.

This control is used to create a single item. However, any InQB control 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 control.

The ItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

String

ItemName Property (SalesOrder Control)

Line item property: Reference to the kind of item.

Syntax

salesordercontrol.ItemName(ItemIndex)[=string]

Default Value

Remarks

Line item property: Reference to the kind of item.

Line items represent goods or services bought in a QuickBooks transaction.

This control is used to create a single item. However, any InQB control may be set with an unlimited number of these items. For example:

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

The ItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

String

ItemLineId Property (SalesOrder Control)

Identification number of the transaction line, used for Updates.

Syntax

salesordercontrol.ItemLineId(ItemIndex)[=string]

Default Value

Remarks

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 ItemLineId to -1.

The ItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

String

ItemManuallyClosed Property (SalesOrder Control)

Indicates if the line item has been manually closed.

Syntax

salesordercontrol.ItemManuallyClosed(ItemIndex)[=integer]

Possible Values

mcNotSet(0), 
mcManuallyClosed(1), 
mcNotManuallyClosed(2)

Default Value

Remarks

Indicates if the line item has been manually closed.

If ItemManuallyClosed is mcManuallyClosed, the purchase order line has been closed, even if this item has not been received or its sale canceled. If all the purchase order lines are marked as closed, the purchase order itself is marked as closed as well. You cannot change ItemManuallyClosed to mcNotManuallyClosed after the purchase order line has been fully received. If set to mcNotSet the field is not sent in the request.

Only applicable to Update transactions.

The ItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

Integer

ItemOther1 Property (SalesOrder Control)

Standard QuickBooks Custom Field available for transaction line items.

Syntax

salesordercontrol.ItemOther1(ItemIndex)[=string]

Default Value

Remarks

Standard QuickBooks Custom Field available for transaction line items.

The ItemOther1 and ItemOther2 custom fields are available for immediate use: you don't need to enable these in the transaction template to be able to access them via SDK. (However, those ItemOther1 and ItemOther2 fields and their values are viewable and printable in QuickBooks only if the transaction template has these enabled!). QBXMLVersion 6.0 or higher is required to use this property.

The ItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

String

ItemOther2 Property (SalesOrder Control)

Standard QuickBooks Custom Field available for transaction line items.

Syntax

salesordercontrol.ItemOther2(ItemIndex)[=string]

Default Value

Remarks

Standard QuickBooks Custom Field available for transaction line items.

The ItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

String

ItemPriceLevelId Property (SalesOrder Control)

Line Item property: Used to specify custom pricing for specific customers.

Syntax

salesordercontrol.ItemPriceLevelId(ItemIndex)[=string]

Default Value

Remarks

Line Item property: Used to specify custom pricing for specific customers.

Id for the PriceLevel selected for this transaction.

If ItemPriceLevelId and/or ItemPriceLevelName are specified, then ItemAmount will be calculated automatically and should not be specified.

Note that ItemPriceLevelId and ItemPriceLevelName, OR ItemRate OR ItemRatePercent may be specified. ItemPriceLevelId and ItemPriceLevelName are ONLY available for QBXMLVersions 4.0 and above.

You can use price levels to specify custom pricing for specific customers. Once you create a price level for a customer, QuickBooks will automatically use the custom price in new invoices, sales receipts, sales orders or credit memos for that customer. You can override this automatic feature, however, when you create the invoices, sales receipts, etc.)

The user can now specify a price level on line items in the following supported sales transactions: invoices, sales receipts, credit memos, and sales orders.

Notice that the response data for the affected sales transaction does not list the price level that was used. The response simply lists the ItemRate, which was set using the price level.

The ItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

String

ItemPriceLevelName Property (SalesOrder Control)

Line Item property: Specify custom pricing for specific customers.

Syntax

salesordercontrol.ItemPriceLevelName(ItemIndex)[=string]

Default Value

Remarks

Line Item property: Specify custom pricing for specific customers.

Id for the PriceLevel selected for this transaction.

If ItemPriceLevelId and/or ItemPriceLevelName are specified, then ItemAmount will be calculated automatically and should not be specified.

Note that ItemPriceLevelId and ItemPriceLevelName, OR ItemRate OR ItemRatePercent may be specified. ItemPriceLevelId and ItemPriceLevelName are ONLY available for QBXMLVersions 4.0 and above.

The user can now specify a price level on line items in the following supported sales transactions: invoices, sales receipts, credit memos, and sales orders.

Notice that the response data for the affected sales transaction does not list the price level that was used. The response simply lists the ItemRate, which was set using the price level.

The ItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

String

ItemQuantity Property (SalesOrder Control)

Line item property: Quantity of item or item group.

Syntax

salesordercontrol.ItemQuantity(ItemIndex)[=string]

Default Value

Remarks

Line item property: Quantity of item or item group.

The quantity of the Item specified in this line.

If ItemQuantity and only one of ItemCost, ItemRate, or ItemAmount are specified, QuickBooks will automatically calculate the other.

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

control.Quantity = "3.5"

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

The ItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

String

ItemRate Property (SalesOrder Control)

Unit rate of item.

Syntax

salesordercontrol.ItemRate(ItemIndex)[=string]

Default Value

Remarks

Unit rate of item.

The unit rate charged for this item.

If ItemAmount is specified, then ItemRate will be calculated automatically and should not be specified.

The amount should be formatted as a string in dollars.

The ItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

String

ItemRatePercent Property (SalesOrder Control)

Line item property: A markup or discount percentage.

Syntax

salesordercontrol.ItemRatePercent(ItemIndex)[=string]

Default Value

Remarks

Line item property: A markup or discount percentage.

If ItemRatePercent is specified instead of ItemRate, then this line item represents a percentage markup or discount, to be applied to the previous Item or Item group.

ItemRatePercent should be formatted as a positive or negative integer; a positive value indicates a markup.

Only one of ItemRatePercent and ItemRate may be specified. If ItemRatePercent is set, then ItemRate will be set to its default.

The ItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

String

ItemTaxCodeId Property (SalesOrder Control)

Line item property: Sales tax information for this item.

Syntax

salesordercontrol.ItemTaxCodeId(ItemIndex)[=string]

Default Value

Remarks

Line item property: 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.

The ItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

String

ItemTaxCodeName Property (SalesOrder Control)

Line item property: Sales tax information for this item.

Syntax

salesordercontrol.ItemTaxCodeName(ItemIndex)[=string]

Default Value

Remarks

Line item property: 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

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

The ItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

String

ItemUnitOfMeasure Property (SalesOrder Control)

Unit of measure describing the Quantity .

Syntax

salesordercontrol.ItemUnitOfMeasure(ItemIndex)[=string]

Default Value

Remarks

Unit of measure describing the ItemQuantity.

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 property is only available for QBXMLVersion 7.0 and higher.

The ItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

String

LinkedTxnCount Property (SalesOrder Control)

The number of records in the LinkedTxn arrays.

Syntax

salesordercontrol.LinkedTxnCount

Default Value

Remarks

This property controls the size of the following arrays:

LinkedTxnAmount
LinkedTxnDate
LinkedTxnId
LinkedTxnLinkType
LinkedTxnRefNumber
LinkedTxnType

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

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

Data Type

Integer

LinkedTxnAmount Property (SalesOrder Control)

The amount of the linked transaction.

Syntax

salesordercontrol.LinkedTxnAmount(LinkedTxnIndex)

Default Value

Remarks

The amount of the linked transaction.

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

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

Data Type

String

LinkedTxnDate Property (SalesOrder Control)

The date of the linked transaction.

Syntax

salesordercontrol.LinkedTxnDate(LinkedTxnIndex)

Default Value

Remarks

The date of the linked transaction.

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

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

Data Type

String

LinkedTxnLinkType Property (SalesOrder Control)

Indicates the nature of the link between the transactions.

Syntax

salesordercontrol.LinkedTxnLinkType(LinkedTxnIndex)

Default Value

Remarks

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


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

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

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

Data Type

String

LinkedTxnRefNumber Property (SalesOrder Control)

This is the reference number assigned to the linked transaction.

Syntax

salesordercontrol.LinkedTxnRefNumber(LinkedTxnIndex)

Default Value

Remarks

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

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

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

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

Data Type

String

LinkedTxnId Property (SalesOrder Control)

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

Syntax

salesordercontrol.LinkedTxnId(LinkedTxnIndex)

Default Value

Remarks

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

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

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

Data Type

String

LinkedTxnType Property (SalesOrder Control)

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

Syntax

salesordercontrol.LinkedTxnType(LinkedTxnIndex)

Default Value

Remarks

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

Valid values include:


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

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

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

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

Data Type

String

ManuallyClosed Property (SalesOrder Control)

Whether the sales order is manually closed.

Syntax

salesordercontrol.ManuallyClosed[=integer]

Possible Values

mcNotSet(0), 
mcManuallyClosed(1), 
mcNotManuallyClosed(2)

Default Value

Remarks

If true, the sales order is manually closed, even if not all of its line items have been invoiced.

This may also be set for individual line items via ItemManuallyClosed.

Data Type

Integer

Memo Property (SalesOrder Control)

Memo to appear on internal reports only.

Syntax

salesordercontrol.Memo[=string]

Default Value

Remarks

A memo to appear on internal reports. Will not appear to customers, vendors, etc.

Data Type

String

Other Property (SalesOrder Control)

Pre-defined QuickBooks Custom Field.

Syntax

salesordercontrol.Other[=string]

Default Value

Remarks

The Other property is a transaction-level field, like the FOB field, PO Number field, and so forth. This property appears only once for the transaction: you can write to it and modify it. QBXMLVersion 6.0 or higher is required to use this property.

Data Type

String

PONumber Property (SalesOrder Control)

P.O. number.

Syntax

salesordercontrol.PONumber[=string]

Default Value

Remarks

The P.O. number for this invoice or credit memo.

Data Type

String

QBConnectionMode Property (SalesOrder Control)

The mode of connection to QuickBooks.

Syntax

salesordercontrol.QBConnectionMode[=integer]

Possible Values

cmDontCare(0), 
cmSingleUserMode(1), 
cmMultiUserMode(2)

Default Value

Remarks

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:


cmDontCare	0
cmSingleUserMode	1
cmMultiUserMode	2

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.

Data Type

Integer

QBConnectionString Property (SalesOrder Control)

An aggregate consisting of various QuickBooks connection properties.

Syntax

salesordercontrol.QBConnectionString[=string]

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 control 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 control'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 control 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 control fails with an error.
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 control fails with an error.
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 control binds.
UseRDS	Whether to connect using Remote Data Sharing (RDS). If set to True, the control will attempt to connect using the RDS client installed on the machine. The RDS client and server must be configured separately. The default value is False.

Data Type

String

QBOpenCompanyFile Property (SalesOrder Control)

The file currently open in QuickBooks.

Syntax

salesordercontrol.QBOpenCompanyFile

Default Value

Remarks

The name of the file currently open in QuickBooks, specified completely with the path.

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 control may interact exclusively with the open file.

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

Data Type

String

QBRequestAggregate Property (SalesOrder Control)

The request aggregate.

Syntax

salesordercontrol.QBRequestAggregate[=string]

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 control to generate requests to be sent to QuickBooks Web Connector.

This property is not available at design time.

Data Type

String

QBRequestId Property (SalesOrder Control)

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

Syntax

salesordercontrol.QBRequestId[=string]

Default Value

Remarks

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

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

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

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

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

This property is not available at design time.

Data Type

String

QBRequestMode Property (SalesOrder Control)

Defines whether the request is made online or stored offline.

Syntax

salesordercontrol.QBRequestMode[=integer]

Possible Values

rmOnline(0), 
rmOffline(1)

Default Value

Remarks

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


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

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

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

Data Type

Integer

QBResponseAggregate Property (SalesOrder Control)

The last QBXML response aggregate received from QuickBooks.

Syntax

salesordercontrol.QBResponseAggregate[=string]

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 control will parse the response as if it had been received directly from QuickBooks and the applicable properties will be updated.

This property is not available at design time.

Data Type

String

QBXMLVersion Property (SalesOrder Control)

The version of QBXML used in the outgoing message.

Syntax

salesordercontrol.QBXMLVersion[=string]

Default Value

"3.0"

Remarks

The SalesOrder prodtype; requires the use of QBXML version 2.1 or above. In particular, a U.S. version of QuickBooks 2003 or higher is required, and all software updates to QuickBooks must be downloaded from Intuit.

If the property is set to a value such as "1.1", "CA2.0", etc., the control will fail with an error. Currently sales orders cannot be added to Canadian editions of QuickBooks, although future versions of QuickBooks and QBXML might support this.

This property is not available at design time.

Data Type

String

RefId Property (SalesOrder Control)

An alphanumerical identifier generated by the server.

Syntax

salesordercontrol.RefId

Default Value

Remarks

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

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

Data Type

String

RefNumber Property (SalesOrder Control)

Reference number for the transaction.

Syntax

salesordercontrol.RefNumber[=string]

Default Value

Remarks

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

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

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

Data Type

String

SalesRepId Property (SalesOrder Control)

Reference to (initials of) sales rep.

Syntax

salesordercontrol.SalesRepId[=string]

Default Value

Remarks

A reference to a sales rep for the Customer. Sales reps should be referred to by their initials rather than their name.

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 appears in the Customer control as well as some transaction controls. When found in a Customer control this property is unsupported for Update operations.

Data Type

String

SalesRepName Property (SalesOrder Control)

Reference to (initials of) sales rep.

Syntax

salesordercontrol.SalesRepName[=string]

Default Value

Remarks

A reference to a sales rep for the Customer. Sales reps should be referred to by their initials rather than their name.

Name/Id Reference Properties

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

This property appears in the Customer control as well as some transaction controls. When found in a Customer control this property is unsupported for Update operations.

Data Type

String

SalesTaxTotal Property (SalesOrder Control)

Total amount of sales tax.

Syntax

salesordercontrol.SalesTaxTotal

Default Value

Remarks

The total amount of sales tax charged in this transaction.

Not used with Canadian editions of QuickBooks.

The amount should be formatted as a string in dollars.

This property is read-only.

Data Type

String

ShipDate Property (SalesOrder Control)

Date of shipping.

Syntax

salesordercontrol.ShipDate[=string]

Default Value

Remarks

The date when goods were, or will be, shipped to the Customer.

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.

Data Type

String

ShipMethodId Property (SalesOrder Control)

Reference to preferred method of shipping.

Syntax

salesordercontrol.ShipMethodId[=string]

Default Value

Remarks

Reference to the preferred method of shipping, e.g., UPS.

Id/Name Reference Properties

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

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

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

Data Type

String

ShipMethodName Property (SalesOrder Control)

Reference to preferred method of shipping.

Syntax

salesordercontrol.ShipMethodName[=string]

Default Value

Remarks

Reference to the preferred method of shipping, e.g., UPS.

Name/Id Reference Properties

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

Data Type

String

ShippingAddress Property (SalesOrder Control)

Address to ship to.

Syntax

salesordercontrol.ShippingAddress[=string]

Default Value

Remarks

The address to whom goods were shipped, or are to be shipped.

The address is stored as a string, formatted as XML. It may be read and written directly, or with the Address component.

Data Type

String

Subtotal Property (SalesOrder Control)

Gross subtotal; doesn't count taxes/amount already paid.

Syntax

salesordercontrol.Subtotal

Default Value

Remarks

The total of the amounts in all the lines of an invoice, credit memo, or sales receipt, before taxes or payments are applied.

The amount should be formatted as a string in dollars.

This property is read-only.

Data Type

String

TaxItemId Property (SalesOrder Control)

Reference to detailed taxation information.

Syntax

salesordercontrol.TaxItemId[=string]

Default Value

Remarks

A sales tax item refers to a single sales tax that is collected at a specified rate and paid to a single agency. For example, a TaxItem might represent sales tax for a particular city.

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 appears in the Customer control as well as some transaction controls. When found in a Customer control this property is unsupported for Update operations.

Not used with Canadian editions of QuickBooks.

Data Type

String

TaxItemName Property (SalesOrder Control)

Reference to detailed taxation information.

Syntax

salesordercontrol.TaxItemName[=string]

Default Value

Remarks

A sales tax item refers to a single sales tax that is collected at a specified rate and paid to a single agency. For example, a TaxItem might represent sales tax for a particular city.

Name/Id Reference Properties

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

This property appears in the Customer control as well as some transaction controls. When found in a Customer control this property is unsupported for Update operations.

Data Type

String

TermsId Property (SalesOrder Control)

Reference to terms of payment.

Syntax

salesordercontrol.TermsId[=string]

Default Value

Remarks

A reference to terms of payment, predefined within QuickBooks. A typical example might be "2% 10 Net 60", i.e., payment due within 60 days, with a 2% discount if payment is made within 10 days.

Id/Name Reference Properties

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

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

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

Data Type

String

TermsName Property (SalesOrder Control)

Reference to terms of payment.

Syntax

salesordercontrol.TermsName[=string]

Default Value

Remarks

A reference to terms of payment, predefined within QuickBooks. A typical example might be "2% 10 Net 60", i.e., payment due within 60 days, with a 2% discount if payment is made within 10 days.

Name/Id Reference Properties

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

Data Type

String

TransactionDate Property (SalesOrder Control)

Date of transaction.

Syntax

salesordercontrol.TransactionDate[=string]

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.

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

Data Type

String

Add Method (SalesOrder Control)

Adds the record into QuickBooks.

Syntax

salesordercontrol.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 (SalesOrder Control)

Cancels (voids) the transaction.

Syntax

salesordercontrol.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 control 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 (SalesOrder Control)

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

Syntax

salesordercontrol.CheckRequestStatus RequestId

Remarks

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

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

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

See QBRequestId for more information on error recovery.

CloseQBConnection Method (SalesOrder Control)

Closes a persistent connection to QuickBooks.

Syntax

salesordercontrol.CloseQBConnection

Remarks

Invoking CloseQBConnection closes the QuickBooks connection specified in QBConnectionString. After the connection has been closed, the control 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 (SalesOrder Control)

Sets or retrieves a configuration setting.

Syntax

salesordercontrol.Config ConfigurationString

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the control, 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 (SalesOrder Control)

Deletes the record from QuickBooks.

Syntax

salesordercontrol.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 (SalesOrder Control)

Gets a single record from QuickBooks.

Syntax

salesordercontrol.Get Id

Remarks

Get may be used to retrieve a single object from QuickBooks, based on its RefId. When the method is called, a search will be initiated for the requested object. If it is found, all properties of the control 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 control, 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 control may be used.

GetCustomField Method (SalesOrder Control)

Gets a custom field value from QuickBooks.

Syntax

salesordercontrol.GetCustomField FieldName

Remarks

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

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

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

ImportQBXML Method (SalesOrder Control)

Imports a QBXML response aggregate.

Syntax

salesordercontrol.ImportQBXML XMLData

Remarks

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

OpenQBConnection Method (SalesOrder Control)

Opens a persistent connection to QuickBooks.

Syntax

salesordercontrol.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 control 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 (SalesOrder Control)

Resets all properties to their defaults.

Syntax

salesordercontrol.Reset

Remarks

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

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

SetCustomField Method (SalesOrder Control)

Sets a custom field value within QuickBooks.

Syntax

salesordercontrol.SetCustomField FieldName, FieldValue

Remarks

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

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

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

Update Method (SalesOrder Control)

Updates the sales order in QuickBooks.

Syntax

salesordercontrol.Update

Remarks

This method will update the sales order in QuickBooks.

When the method is called, an Update request will be submitted to QuickBooks. The sales order 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 sales order. Moreover, QBXMLVersion should be set to the same value when retrieving the sales order from QuickBooks (either through ObjSearch or through the Get method).

Error Event (SalesOrder Control)

Information about errors during data delivery.

Syntax

Sub salesordercontrol_Error(ErrorCode As Integer, Description As String)

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 (SalesOrder Control)

Fired after the server presents its certificate to the client.

Syntax

Sub salesordercontrol_SSLServerAuthentication(CertEncoded As String, CertSubject As String, CertIssuer As String, Status As String, Accept As Boolean)

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 (SalesOrder Control)

Shows the progress of the secure connection.

Syntax

Sub salesordercontrol_SSLStatus(Message As String)

Remarks

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

Status Event (SalesOrder Control)

Shows the progress of the QuickBooks connection.

Syntax

Sub salesordercontrol_Status(Message As String)

Remarks

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

Warning Event (SalesOrder Control)

Fired when a warning occurs.

Syntax

Sub salesordercontrol_Warning(Code As Integer, Description As String)

Remarks

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

Warnings may be generated by QuickBooks or the control. 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.

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

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

Config Settings (SalesOrder Control)

The control 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 control, access to these internal properties is provided through the Config method.

SalesOrder Config Settings

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

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

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

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

A list of allowable AuthFlags is provided below.


"" or 0	Do not send any auth flags
0x01	Support QB Simple Start
0x02	Support QB Pro
0x04	Support QB Premier
0x08	Support QB Enterprise
0x80000000	Force Auth Dialog

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

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

ClassId: A reference to the class of transaction.

ClassName: A reference to the class of transaction.

CurrencyId: Id of the currency code used for this invoice.

This field is only supported for QBXMLVersion 8.0 and higher, and is read-only.

CurrencyName: Name of the currency code used for this invoice.

This field is only supported for QBXMLVersion 8.0 and higher, and is read-only.

CustomerSalesTaxId: Reference to sales tax information for the CUSTOMER.

CustomerSalesTaxName: Reference to sales tax information for the CUSTOMER.

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 control will no longer check (or error) when the length of a property exceeds the maximum length specified in the QuickBooks SDK.

ExchangeRate: Currency exchange rate for this invoice.

This field is only supported for QBXMLVersion 8.0 and higher.

The exchange rate is the market price for which this currency can be exchanged for the currency used by the QuickBooks company file as the "home" currency. The exchange rate should be considered a snapshot of the rates in effect at the AsOfDate.

You can update the exchange rate using the exchange rate property when you add a transaction. However, you need to obtain and supply the exchange rate. If you are using USD (United States Dollars) as the home currency and are connected to the Internet, you can download the current exchange rates for all active currencies automatically in the QuickBooks UI by selecting Lists->Currency->Activities->Download latest exchange rates. (Currently, you can't do this in the SDK.)

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)

ExchangeRate: Currency exchange rate for this invoice.

This field is only supported for QBXMLVersion 8.0 and higher.

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)

FOB: Freight On Board: the place from where shipped.

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.

IsTaxIncluded: Determines if tax is included in the transaction amount.

This field is only available when QBXMLVersion is "6.0" or higher, and only for transactions made with the International versions of QuickBooks.

IsToBeEmailed: When true, if no email address is on file for the customer the transaction will fail.

If this is set to true, at runtime the customer referenced in this transaction will be checked for a valid email address. If there is no valid email address, the request will fail. If there is a valid email address currently in QuickBooks for the customer, and the request succeeds, the transaction will be added to QuickBook's list of forms to be emailed, possibly in a batch.

Notice that setting this field to true does not actually perform the emailing. Only the QuickBooks user can do that from within QuickBooks. This cannot be done from the SDK. Setting this field to false does not prevent the QuickBooks user from emailing the transaction later. It simply results in the transaction NOT being placed in the list of transactions to be emailed.

This field is only available when QBXMLVersion is "6.0" or higher.

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.


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

The default value is pdpOptional.

QBConnectionMode: The mode of connection to QuickBooks.

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

The following values are permitted:


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

About Single-User and Multi-User Modes

About Integrated and Automatic Login

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 control will attempt to determine whether a subsequent connection using the provided QBConnectionString value would succeed. Possible return values are:


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

QBOpenCompanyFile: The file currently open in QuickBooks.

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

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

SalesTaxPercentage: Percent paid as sales tax.

This setting is read-only.

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.

TemplateId: The ID of an existing template to apply to the transaction.

TemplateName: The name of an existing template to apply to the transaction.

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.

TotalAmountInHomeCurrency: Returned for transactions in currencies different from the merchant's home currency.

This field is only available when QBXMLVersion is "8.0" or higher.

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.


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

The default value is umpOptional.

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

By default, the control 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

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

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

The following is a list of valid code page identifiers:


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

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


Identifier	Name
1	ASCII
2	NEXTSTEP
3	JapaneseEUC
4	UTF8
5	ISOLatin1
6	Symbol
7	NonLossyASCII
8	ShiftJIS
9	ISOLatin2
10	Unicode
11	WindowsCP1251
12	WindowsCP1252
13	WindowsCP1253
14	WindowsCP1254
15	WindowsCP1250
21	ISO2022JP
30	MacOSRoman
10	UTF16String
0x90000100	UTF16BigEndian
0x94000100	UTF16LittleEndian
0x8c000100	UTF32String
0x98000100	UTF32BigEndian
0x9c000100	UTF32LittleEndian
65536	Proprietary

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 to mask sensitive data. The default is .

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

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

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

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

This setting is set to by default on all platforms.

Trappable Errors (SalesOrder Control)

Errors

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

SalesOrder Errors

20102    String too long.
20104    Invalid date format (YYYY-MM-DD is standard).
20105    Invalid value for enumerated field.
20106    Invalid integer.
20107    Invalid dollar amount.
20108    Invalid boolean value (must be 'true' or 'false').
20109    Invalid number.
20112    Invalid special characters in string.
20113    Invalid special field syntax.
20182    Could not load certificate file.
20202    Required field unspecified.
20212    Unsupported field specified.
20302    Array line count must be nonnegative.
20303    Array index out of bounds.
20304    Invalid field index.
20402    Field not accessible as a special field.
20403    Write access attempted of readonly field.
20404    Read access attempted of writeonly field.
20422    The object cannot be modified.
20512    The QBRequestId has been previously used. Please generate a new one.
20602    Could not access QuickBooks.
20603    Could not open specified file.
20604    The version of QuickBooks currently being used is not supported.
20605    QuickBooks has not been installed properly.
20606    The specified file was of an incorrect version.
20607    Could not start QuickBooks.
20608    QuickBooks is open in a mode different than the one requested.
20609    QuickBooks cannot currently be accessed.
20610    An application name must be specified.
20611    A file name must be specified if one is not currently open in QuickBooks.
20612    Access denied.
20613    QuickBooks is busy and cannot open your application in the mode requested.
20700    The connection to QuickBooks has failed for an unknown reason.
20703    The object requested does not exist in QuickBooks.
20752    Unsupported QBXML version.
20753    The QBXMLVersion chosen is insufficient to execute the request.
20802    A QuickBooks internal error has occurred.
20803    QuickBooks is not available due to a system-related problem.
20804    The Id specified is invalid.
20805    Invalid object name.
20806    The name already exists in QuickBooks.
20808    An object could not be found in QuickBooks.
20809    A reference did not refer to an object that exists in QuickBooks.
20810    The object is currently in use by the QuickBooks end user.
20811    The object may not be added.
20812    The object may not be updated because it is obsolete.
20813    The address is invalid.
20814    Permission to perform this operation is not granted.
20815    The request has not been processed.
20816    Time creation mismatch.
20817    The feature is turned off or not enabled.
20818    Permission level configured is insufficient for access.
20819     The item specified was of an unknown type.
20820    The object may not be changed.
20821    An internal QuickBooks error has occurred.
20822    An attempt was made to use a connection that was not properly initiated.
20823    An attempt was made to use a connection that is invalid or was previously closed.
20824    Not enough memory.
20825    Unable to lock the necessary information to allow this application access to the company file. Try again later.
20851    An older version of QuickBooks 2002 is being used. Please download the latest update from Intuit.
20852    The QuickBooks request processor was not found. Check that QuickBooks Pro 2002 or higher is installed on your system.
20862    Server error on WebExport (details follow).
20863    The WebExport is impossible: an HTTP context was not found.
20872    You may not set the value of QBConnectionTicket. This value is readonly.
20881    Interrupted by the user.
20882    An error has occurred connecting to a remote machine.
20900    An unknown QuickBooks error has occurred. The message contains more details.
20902    XML Parser Error. Should not occur under normal circumstances.


	20102 String too long.
	20104 Invalid date format (YYYY-MM-DD is standard).
	20105 Invalid value for enumerated field.
	20106 Invalid integer.
	20107 Invalid dollar amount.
	20108 Invalid boolean value (must be 'true' or 'false').
	20109 Invalid number.
	20112 Invalid special characters in string.
	20113 Invalid special field syntax.
	20182 Could not load certificate file.
	20202 Required field unspecified.
	20212 Unsupported field specified.
	20302 Array line count must be nonnegative.
	20303 Array index out of bounds.
	20304 Invalid field index.
	20402 Field not accessible as a special field.
	20403 Write access attempted of readonly field.
	20404 Read access attempted of writeonly field.
	20422 The object cannot be modified.
	20512 The QBRequestId has been previously used. Please generate a new one.
	20602 Could not access QuickBooks.
	20603 Could not open specified file.
	20604 The version of QuickBooks currently being used is not supported.
	20605 QuickBooks has not been installed properly.
	20606 The specified file was of an incorrect version.
	20607 Could not start QuickBooks.
	20608 QuickBooks is open in a mode different than the one requested.
	20609 QuickBooks cannot currently be accessed.
	20610 An application name must be specified.
	20611 A file name must be specified if one is not currently open in QuickBooks.
	20612 Access denied.
	20613 QuickBooks is busy and cannot open your application in the mode requested.
	20700 The connection to QuickBooks has failed for an unknown reason.
	20703 The object requested does not exist in QuickBooks.
	20752 Unsupported QBXML version.
	20753 The QBXMLVersion chosen is insufficient to execute the request.
	20802 A QuickBooks internal error has occurred.
	20803 QuickBooks is not available due to a system-related problem.
	20804 The Id specified is invalid.
	20805 Invalid object name.
	20806 The name already exists in QuickBooks.
	20808 An object could not be found in QuickBooks.
	20809 A reference did not refer to an object that exists in QuickBooks.
	20810 The object is currently in use by the QuickBooks end user.
	20811 The object may not be added.
	20812 The object may not be updated because it is obsolete.
	20813 The address is invalid.
	20814 Permission to perform this operation is not granted.
	20815 The request has not been processed.
	20816 Time creation mismatch.
	20817 The feature is turned off or not enabled.
	20818 Permission level configured is insufficient for access.
	20819 The item specified was of an unknown type.
	20820 The object may not be changed.
	20821 An internal QuickBooks error has occurred.
	20822 An attempt was made to use a connection that was not properly initiated.
	20823 An attempt was made to use a connection that is invalid or was previously closed.
	20824 Not enough memory.
	20825 Unable to lock the necessary information to allow this application access to the company file. Try again later.
	20851 An older version of QuickBooks 2002 is being used. Please download the latest update from Intuit.
	20852 The QuickBooks request processor was not found. Check that QuickBooks Pro 2002 or higher is installed on your system.
	20862 Server error on WebExport (details follow).
	20863 The WebExport is impossible: an HTTP context was not found.
	20872 You may not set the value of QBConnectionTicket. This value is readonly.
	20881 Interrupted by the user.
	20882 An error has occurred connecting to a remote machine.
	20900 An unknown QuickBooks error has occurred. The message contains more details.
	20902 XML Parser Error. Should not occur under normal circumstances.