SalesOrders

Create, update, delete, and query QuickBooks Sales Orders.

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 SalesOrders 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. The ItemAggregate column may be used to specify an XML aggregate of Line Item data. The columns that may be used in these aggregates are defined in the SalesOrderLineItems tables and it starts with Item. For example, the following will insert a new SalesOrder with two Line Items:

INSERT INTO SalesOrders (CustomerName, ItemAggregate) 
VALUES ('Cook, Brian',
'<SalesOrderLineItems>
<Row><ItemName>Repairs</ItemName><ItemQuantity>1</ItemQuantity></Row>
<Row><ItemName>Removal</ItemName><ItemQuantity>2</ItemQuantity></Row>
</SalesOrderLineItems>')

To insert subitems, set the ItemName field to the FullName of the item; for example, '<Row><ItemName>Subs:Carpet</ItemName><ItemQuantity>0</ItemQuantity></Row>'

Columns


Name	Type	ReadOnly	References	ColumnSize	Description
ID [KEY]	String	True		255	The unique 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.
FOB	String	False		13	Freight on board: The place to ship from.
BillingAddress	String	True			Full billing address returned by QuickBooks.
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.
ItemCount	Integer	True			The count of item entries for this transaction.
ItemAggregate	String	False		5000	An aggregate of the line item data which can be used for adding a SalesOrders and its Line Item data.
TransactionCount	Integer	True			The count of related transactions to the bill.
TransactionAggregate	String	True		5000	An aggregate of the linked transaction data.
CustomerTaxCode	String	False		3	The tax code specific to this customer.
CustomerTaxCodeId	String	False	SalesTaxCodes.ID	255	The tax code specific to this customer.
IsPrinted	Boolean	True			Whether this invoice is to be printed.
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.
IsToBePrinted	Boolean	False			Whether this sales order is to be printed.
IsToBeEmailed	Boolean	False			Whether this sales order is to be emailed.
Other	String	False		29	A predefined QuickBooks custom field.
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.
ShippingDetailTrackingID	Integer	True			The Tracking ID of Sales order which is already shipped.
ShippingDetailCarrierName	String	True			The Carries Name of Sales Order which is already shipped.
ShippingDetailShippingMethod	String	True			The Shipping Method of Sales Order which is already shipped.
ShippingDetailShippingCharges	Decimal	True			The Shipping Charges of Sales Order which is already shipped.
FulfillmentStatus	String	True			The Sales order Fulfillment Status details.
SOChannel	String	True			Sales Channel Name.
StoreName	String	True			Sales Store Name.
StoreType	String	True			Sales Store type.

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.