QuickBooks Integrator 2020 Python Edition

Questions / Feedback?

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

class inqb.SalesOrder

Remarks

This functionality requires a U.S. version of QuickBooks 2003, with the most recent updates from Intuit. The default value for qbxml_version 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.

amountAmount of transaction.
billing_addressAddress to bill to.
customer_idA reference to the customer or customer job.
customer_message_idReference to message to appear to customer.
customer_message_nameReference to message to appear to customer.
customer_nameA reference to the customer or customer job.
due_dateDate when payment is due.
include_linked_txnsIndicates whether to include linked transactions in the response.
is_fully_invoicedWhether the sales order is fully invoiced.
is_to_be_printedWhether this transaction is to be printed.
item_countThe number of records in the Item arrays.
item_aggregateContains an XML aggregate of the line item.
item_amountLine item property: the total amount of this item.
item_class_idLine item property: Reference to the class of the item.
item_class_nameLine item property: Reference to the class of the item.
item_descriptionLine item property: Description of item.
item_group_idReference to a group of line items.
item_group_nameReference to a group of line items.
item_invoiced_amountThe amount of this sales order line that has been invoiced.
item_idLine item property: Reference to the kind of item.
item_nameLine item property: Reference to the kind of item.
item_line_idIdentification number of the transaction line, used for Updates.
item_manually_closedIndicates if the line item has been manually closed.
item_other1Standard QuickBooks Custom Field available for transaction line items.
item_other2Standard QuickBooks Custom Field available for transaction line items.
item_price_level_idLine Item property: Used to specify custom pricing for specific customers.
item_price_level_nameLine Item property: Specify custom pricing for specific customers.
item_quantityLine item property: Quantity of item or item group.
item_rateUnit rate of item.
item_rate_percentLine item property: A markup or discount percentage.
item_tax_code_idLine item property: Sales tax information for this item.
item_tax_code_nameLine item property: Sales tax information for this item.
item_unit_of_measureUnit of measure describing the Quantity .
linked_txn_countThe number of records in the LinkedTxn arrays.
linked_txn_amountThe amount of the linked transaction.
linked_txn_dateThe date of the linked transaction.
linked_txn_link_typeIndicates the nature of the link between the transactions.
linked_txn_ref_numberThis is the reference number assigned to the linked transaction.
linked_txn_idThis property can be used by another class to reference the original transaction which is linked to the current response.
linked_txn_typeThis property indicates which type of linked transaction has been returned.
manually_closedWhether the sales order is manually closed.
memoMemo to appear on internal reports only.
otherPre-defined QuickBooks Custom Field.
po_numberP.O. number.
qb_connection_modeThe mode of connection to QuickBooks.
qb_connection_stringAn aggregate consisting of various QuickBooks connection properties.
qb_open_company_fileThe file currently open in QuickBooks.
qb_request_aggregateThe request aggregate.
qb_request_idThe Id of the next message to be sent to QuickBooks.
qb_request_modeDefines whether the request is made online or stored offline.
qb_response_aggregateThe last QBXML response aggregate received from QuickBooks.
qbxml_versionThe version of QBXML used in the outgoing message.
ref_idAn alphanumerical identifier generated by the server.
ref_numberReference number for the transaction.
sales_rep_idReference to (initials of) sales rep.
sales_rep_nameReference to (initials of) sales rep.
sales_tax_totalTotal amount of sales tax.
ship_dateDate of shipping.
ship_method_idReference to preferred method of shipping.
ship_method_nameReference to preferred method of shipping.
shipping_addressAddress to ship to.
subtotalGross subtotal; doesn't count taxes/amount already paid.
tax_item_idReference to detailed taxation information.
tax_item_nameReference to detailed taxation information.
terms_idReference to terms of payment.
terms_nameReference to terms of payment.
transaction_dateDate 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.

addAdds the record into QuickBooks.
cancelCancels (voids) the transaction.
check_request_statusChecks whether or not the specified request was processed by QuickBooks.
close_qb_connectionCloses a persistent connection to QuickBooks.
configSets or retrieves a configuration setting.
deleteDeletes the record from QuickBooks.
getGets a single record from QuickBooks.
get_custom_fieldGets a custom field value from QuickBooks.
import_qbxmlImports a QBXML response aggregate.
open_qb_connectionOpens a persistent connection to QuickBooks.
resetResets all properties to their defaults.
set_custom_fieldSets a custom field value within QuickBooks.
updateUpdates 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.

on_errorInformation about errors during data delivery.
on_ssl_server_authenticationFired after the server presents its certificate to the client.
on_ssl_statusShows the progress of the secure connection.
on_statusShows the progress of the QuickBooks connection.
on_warningFired 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.

AppendAfterAppends an XML tag after the specified QBXML element.
AuthFlagsConnection Flags (use for QuickBooks Simple Start).
ClassIdA reference to the class of transaction.
ClassNameA reference to the class of transaction.
CurrencyIdId of the currency code used for this invoice.
CurrencyNameName of the currency code used for this invoice.
CustomerSalesTaxIdReference to sales tax information for the CUSTOMER.
CustomerSalesTaxNameReference to sales tax information for the CUSTOMER.
EditSequenceAn identifier for this copy of the object.
EnforceMaxLengthIndicates whether to enforce max lengths for QB Fields.
ExchangeRateCurrency exchange rate for this invoice.
ExchangeRateIndicates the exchange rate for the transaction.
FOBFreight On Board: the place from where shipped.
GetHighestVersionHighest QBXMLVersion supported by the installed instance of QuickBooks.
GetRequestProcessorDLLVersionReturns the version of the QB Request Processor that is installed on your system.
GetSupportedVersionsReturns a list of QBXMLVersions that are supported by QuickBooks.
IsReadOnlyThis causes the QuickBooks authorization dialog to display text informing the user that its access will be read-only.
IsTaxIncludedDetermines if tax is included in the transaction amount.
IsToBeEmailedWhen true, if no email address is on file for the customer the transaction will fail.
PersonalDataPrefWhether the connecting application will require access to personal data such as SSN or credit card information.
QBConnectionModeThe mode of connection to QuickBooks.
QBFileStatusThe status of the company file as it pertains to accepting connections.
QBOpenCompanyFileThe file currently open in QuickBooks.
SalesTaxPercentagePercent paid as sales tax.
SendRawXMLSends specified XML to quickbooks without modification.
SSLAcceptServerCertThe SSL certificate being used by the Remote Connector.
SSLAcceptServerCertFileThe SSL certificate file being used by the Remote Connector.
StopOnErrorSpecifies how QuickBooks is to proceed if an error occurs in processing of the current request.
Tax1TotalCanadian field used for Goods and Services Tax, or GST.
Tax2TotalCanadian field used for Provincial Sales Taxes, or PST.
TemplateIdThe ID of an existing template to apply to the transaction.
TemplateNameThe name of an existing template to apply to the transaction.
TimeCreatedThe time the object was created.
TimeModifiedThe time the object was created.
TotalAmountInHomeCurrencyReturned for transactions in currencies different from the merchant's home currency.
UnattendedModePrefWhether connecting while QuickBooks is closed is required or optional for the user.
WarningCodesA comma-separated list of QuickBooks warning codes that should not result in an exception.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
ProcessIdleEventsWhether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillisThe length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseInternalSecurityAPITells the class whether or not to use the system security libraries or an internal implementation.

Copyright (c) 2021 /n software inc. - All rights reserved.
QuickBooks Integrator 2020 Python Edition - Version 20.0 [Build 7941]