SalesOrderLineItems

Create, update, delete, and query QuickBooks Sales Order Line Items.

Table Specific Information

SalesOrders may be inserted, queried, or updated via the SalesOrders or SalesOrderLineItems table. SalesOrders may be deleted by using the SalesOrders table.

This table has a Custom Fields column. See the Custom Fields page for more information.

Select

By default, SupportEnhancedSQL is set to true, and the following will be honored if present. Other filters will be executed client side. If SupportEnhancedSQL is set to false, only the following filters will be honored.

QuickBooks allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can only be used with the equals or = comparison. The available columns for SalesOrders are Id, Date, TimeModified, ReferenceNumber, CustomerName, and CustomerId. TimeModified and Date may be used with the >, >=, <, <=, or = conditions and may be used twice to specify a range. ReferenceNumber may be used with the = or LIKE conditions to establish a starts-with, ends-with, or contains syntax. For example:

SELECT * FROM SalesOrderLineItems WHERE TimeModified > '1/1/2011' AND TimeModified < '2/1/2011' AND ReferenceNumber LIKE '%12345%'

Insert

To add a SalesOrder, specify the Customer and at least one Line Item. All Line Item columns can be used for inserting multiple Line Items for a new SalesOrder transaction. For example, the following will insert a new SalesOrder with two Line Items:

INSERT INTO SalesOrderLineItems#TEMP (CustomerName, ItemName, ItemQuantity) VALUES ('Cook, Brian', 'Repairs', 1)
INSERT INTO SalesOrderLineItems#TEMP (CustomerName, ItemName, ItemQuantity) VALUES ('Cook, Brian', 'Removal', 2)
INSERT INTO SalesOrderLineItems (CustomerName, ItemName, ItemQuantity) SELECT CustomerName, ItemName, ItemQuantity FROM SalesOrderLineItems#TEMP

Inserting Into an Existing SalesOrder

To add a SalesOrderLineItem to an existing SalesOrder, specify the SalesOrderId, the Item's name, and the Item's Quanitiy. For example:

INSERT INTO SalesOrderLineItems (SalesOrderId, ItemName, ItemQuantity) VALUES ('SalesOrderId', '01Item1', 1)

Columns


Name	Type	ReadOnly	References	ColumnSize	Description
ID [KEY]	String	True		255	The unique identifier in the format SalesOrderId\|ItemLineId.
SalesOrderId	String	False	SalesOrders.ID	255	The item identifier.
ReferenceNumber	String	False		21	Transaction reference number.
TxnNumber	Integer	True			The transaction number. An identifying number for the transaction, different from the QuickBooks-generated Id.
CustomerName	String	False		1000	Customer name this transaction is recorded under. This is required to have a value when inserting.
CustomerId	String	False	Customers.ID	255	Customer Id this transaction is recorded under.
Date	Date	False			Transaction date.
ShipMethod	String	False		1000	Shipping method.
ShipMethodId	String	False	ShippingMethods.ID	255	Shipping method.
ShipDate	Date	False			Shipping date.
Memo	String	False		5000	Memo regarding this transaction.
Class	String	False		1000	A reference to the class of the transaction.
ClassId	String	False	Class.ID	255	A reference to the class of the transaction.
TotalAmount	Decimal	False			Total amount for this transaction.
DueDate	Date	False			Date the payment is due.
Message	String	False		101	Message to the customer.
MessageId	String	False	CustomerMessages.ID	255	Message to the customer.
SalesRep	String	False		5	Reference to (the initials of) the sales rep.
SalesRepId	String	False	SalesReps.ID	255	Reference to the sales rep.
Template	String	False		100	The name of an existing template to apply to the transaction.
TemplateId	String	False	Templates.ID	255	The Id of an existing template to apply to the transaction.
CurrencyName	String	False		64	Name of the currency code used for this sales order.
CurrencyId	String	False	Currency.ID	255	Id of the currency code used for this sales order.
ExchangeRate	Double	False			Currency exchange rate for this sales order.
TotalAmountInHomeCurrency	Decimal	False			Returned for transactions in currencies different from the merchant's home currency.
BillingAddress	String	True			Full billing address returned by QuickBooks.
FOB	String	False		13	Freight on board: The place to ship from.
BillingLine1	String	False		500	First line of the billing address.
BillingLine2	String	False		500	Second line of the billing address.
BillingLine3	String	False		500	Third line of the billing address.
BillingLine4	String	False		500	Fourth line of the billing address.
BillingLine5	String	False		41	Fifth line of the billing address.
BillingCity	String	False		255	City name for the billing address.
BillingState	String	False		255	State name for the billing address.
BillingPostalCode	String	False		30	Postal code for the billing address.
BillingCountry	String	False		255	Country for the billing address.
BillingNote	String	False		41	Note for the billing address.
ShippingAddress	String	True			Full shipping address returned by QuickBooks.
ShippingLine1	String	False		500	First line of the shipping address.
ShippingLine2	String	False		500	Second line of the shipping address.
ShippingLine3	String	False		500	Third line of the shipping address.
ShippingLine4	String	False		500	Fourth line of the shipping address.
ShippingLine5	String	False		41	Fifth line of the shipping address.
ShippingCity	String	False		255	City name for the shipping address.
ShippingState	String	False		255	State name for the shipping address.
ShippingPostalCode	String	False		30	Postal code for the shipping address.
ShippingCountry	String	False		255	Country for the shipping address.
ShippingNote	String	False		41	Note for the shipping address.
Subtotal	Decimal	True			Gross subtotal. This does not include tax or the amount already paid.
Tax	Double	True			Total sales tax applied to this transaction.
TaxItem	String	False		100	A sales tax item refers to a single sales tax that is collected at a specified rate and paid to a single agency.
TaxItemId	String	False	SalesTaxItems.ID	255	A sales tax item refers to a single sales tax that is collected at a specified rate and paid to a single agency.
TaxPercent	Double	True			Percentage charged for sales tax.
PONumber	String	False		41	Purchase order number.
Terms	String	False		100	Payment terms.
TermsId	String	False		255	Payment terms.
ItemLineId	String	True		255	The line item identifier.
ItemLineNumber	String	True		255	The line item number.
ItemName	String	False			The item name.
ItemId	String	False	Items.ID	255	The item identifier.
ItemGroup	String	False		100	Item group name. Reference to a group of line items this item is part of.
ItemGroupId	String	False	Items.ID	255	Item group Id.
ItemDescription	String	False		5000	A description of the item.
ItemQuantity	Double	False			The quantity of the item or item group specified in this line.
ItemRate	Double	False			The unit rate charged for this item.
ItemRatePercent	Double	False			The rate percent charged for this item.
ItemTaxCode	String	False		3	Sales tax information for this item (taxable or nontaxable).
ItemTaxCodeId	String	False	SalesTaxCodes.ID	255	Sales tax information for this item (taxable or nontaxable).
ItemInvoicedAmount	Decimal	True			The amount of this sales order line that has been invoiced.
ItemUnitOfMeasure	String	False		31	In a transaction line item, the name of the unit of measure is 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. Only available in QBXML Version 7.0 and above.
ItemAmount	Decimal	False			Total amount for this item.
ItemClass	String	False		1000	The class name of the item.
ItemClassId	String	False	Class.ID	255	The class Id of the item.
ItemInventorySiteName	String	False		1000	The inventory site name of this item. This requires QBXML version at least 10.0 and the Advanced Inventory add-on.
ItemInventorySiteId	String	False	InventorySites.ID	255	The inventory site Id of this item. This requires QBXML version at least 10.0 and the Advanced Inventory add-on.
ItemSerialNumber	String	False		5000	The serial number of this item. This requires QBXML version at least 11.0 and the Advanced Inventory add-on.
ItemLotNumber	String	False		40	The lot number of this item. This requires QBXML version at least 11.0 and the Advanced Inventory add-on.
ItemIsManuallyClosed	String	False		10	Whether this sales order line is manually closed.
ItemOther1	String	False		29	The Other1 field of this line item. QBXML version must be set to 6.0 or higher.
ItemOther2	String	False		29	The Other2 field of this line item. QBXML version must be set to 6.0 or higher.
ItemCustomFields	String	False			The custom fields for this line item.
ItemUOMSetFullName	String	False		1000	Indicates the price of something as a percent.
ItemUOMSetListID	String	False	UnitOfMeasure.ID	1000	Indicates the price of something as a percent.
ItemIsGetPrintItemsInGroup	String	False		1000	If true, a list of this group's individual items their amounts will appear on printed forms.
CustomerTaxCode	String	False		3	The tax code specific to this customer.
CustomerTaxCodeId	String	False	SalesTaxCodes.ID	255	The tax code specific to this customer.
IsToBePrinted	Boolean	False			Whether this sales order is to be printed.
IsToBeEmailed	Boolean	False			When true, if no email address is on file for the customer the transaction will fail.
IsManuallyClosed	String	False		10	Whether this sales order is manually closed.
IsFullyInvoiced	Boolean	True			Whether this sales order is fully invoiced.
IsTaxIncluded	Boolean	False			Determines if tax is included in the transaction amount.
CustomFields	String	False			Custom fields returned from QuickBooks and formatted into XML.
EditSequence	String	True		16	An identifier used for versioning for this copy of the object.
TimeModified	Datetime	True			When the sales order was last modified.
TimeCreated	Datetime	True			When the sales order was created.

Pseudo-Columns

Pseudo Column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
ItemPriceLevel	String	Item price level name. QuickBooks will not return the price level.