SalesOrder Class
Properties Methods Events Configuration 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 class 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 class is similar to that of the Invoice Class.
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 class supports a variety of other operations as well. The class's Get and Delete methods may be used to retrieve and delete SalesOrders, respectively. The ObjSearch Class may be used to search for SalesOrders in the QuickBooks database.
Property List
The following is the full list of the properties of the class 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 class 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 class 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 class 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. |
Configuration Settings
The following is a list of configuration settings for the class 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 Remote Connector. |
SSLAcceptServerCertFile | The SSL certificate file being used by the 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. |
BuildInfo | Information about the product's build. |
CodePage | The system code page used for Unicode to Multibyte translations. |
LicenseInfo | Information about the current license. |
UseInternalSecurityAPI | Tells the class whether or not to use the system security libraries or an internal implementation. |