4D Accounting SDK 2020 .NET Edition

Questions / Feedback?

SalesOrder Component

Properties   Methods   Events   Configuration Settings   Errors  

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

Syntax

DPayments.DAccountingSDK.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 component 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 component is similar to that of the Invoice Component.

Required Fields (Add): Customer*, Items

Supported Methods: Add, Get (Id), Delete

Example

SalesOrder1.CustomerName = "John Q. Customer"             '*
SalesOrder1.TransactionDate = "1/17/03"
SalesOrder1.LineItems.Add(New SalesOrderItem())
SalesOrder1.LineItems(0).ItemName = "Our Company's Product"         '*
SalesOrder1.LineItems(0).Amount = "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. 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 fields may be optionally set for each item as well.

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

Property List


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

AmountAmount of transaction.
BillingAddressAddress to bill to.
CustomerIdA reference to the customer or customer job.
CustomerMessageIdReference to message to appear to customer.
CustomerMessageNameReference to message to appear to customer.
CustomerNameA reference to the customer or customer job.
DueDateDate when payment is due.
IncludeLinkedTxnsIndicates whether to include linked transactions in the response.
IsFullyInvoicedWhether the sales order is fully invoiced.
IsToBePrintedWhether this transaction is to be printed.
LineItemsCollection of line items.
LinkedTxnsInformation used to reference a transaction that is linked to the existing transaction.
ManuallyClosedWhether the sales order is manually closed.
MemoMemo to appear on internal reports only.
OtherPre-defined QuickBooks Custom Field.
PONumberP.O. number.
QBConnectionModeThe mode of connection to QuickBooks.
QBConnectionStringAn aggregate consisting of various QuickBooks connection properties.
QBOpenCompanyFileThe file currently open in QuickBooks.
QBRequestAggregateThe request aggregate.
QBRequestIdThe Id of the next message to be sent to QuickBooks.
QBRequestModeDefines whether the request is made online or stored offline.
QBResponseAggregateThe last QBXML response aggregate received from QuickBooks.
QBXMLVersionThe version of QBXML used in the outgoing message.
RefIdAn alphanumerical identifier generated by the server.
RefNumberReference number for the transaction.
SalesRepIdReference to (initials of) sales rep.
SalesRepNameReference to (initials of) sales rep.
SalesTaxTotalTotal amount of sales tax.
ShipDateDate of shipping.
ShipMethodIdReference to preferred method of shipping.
ShipMethodNameReference to preferred method of shipping.
ShippingAddressAddress to ship to.
SubtotalGross subtotal; doesn't count taxes/amount already paid.
TaxItemIdReference to detailed taxation information.
TaxItemNameReference to detailed taxation information.
TermsIdReference to terms of payment.
TermsNameReference to terms of payment.
TransactionDateDate of transaction.

Method List


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

AddAdds the record into QuickBooks.
CancelCancels (voids) the transaction.
CheckRequestStatusChecks whether or not the specified request was processed by QuickBooks.
CloseQBConnectionCloses a persistent connection to QuickBooks.
ConfigSets or retrieves a configuration setting.
DeleteDeletes the record from QuickBooks.
GetGets a single record from QuickBooks.
GetCustomFieldGets a custom field value from QuickBooks.
ImportQBXMLImports a QBXML response aggregate.
OpenQBConnectionOpens a persistent connection to QuickBooks.
ResetResets all properties to their defaults.
SetCustomFieldSets 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 component with short descriptions. Click on the links for further details.

ErrorInformation about errors during data delivery.
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusShows the progress of the secure connection.
StatusShows the progress of the QuickBooks connection.
WarningFired when a warning occurs.

Configuration Settings


The following is a list of configuration settings for the component 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.
GUIAvailableTells the component whether or not a message loop is available for processing events.
LicenseInfoInformation about the current license.
UseInternalSecurityAPITells the component whether or not to use the system security libraries or an internal implementation.

 
 
Copyright (c) 2021 4D Payments Inc. - All rights reserved.
4D Accounting SDK 2020 .NET Edition - Version 20.0 [Build 7887]