Click or drag to resize
SalesOrder Properties

The SalesOrder type exposes the following members.

Properties
  NameDescription
Public propertyAnyIntuitObject (Inherited from SalesTransaction.)
Public propertyApplyTaxAfterDiscount
Product: QBO Description: If false or null, calculate the sales tax first, and then apply the discount. If true, subtract the discount first and then calculate the sales tax.
(Inherited from SalesTransaction.)
Public propertyApplyTaxAfterDiscountSpecified (Inherited from SalesTransaction.)
Public propertyARAccountRef
Product: QBW Description: Reference to the ARAccount (accounts receivable account) associated with the transaction. InputType: ReadWrite
(Inherited from SalesTransaction.)
Public propertyAttachableRef
Specifies entity name of the attachment from where the attachment was requested
(Inherited from IntuitEntity.)
Public propertyAutoDocNumber
Product: QBO Description: If AutoDocNumber is true, DocNumber is generated automatically. If false or null, the DocNumber is generated based on preference of the user.
(Inherited from SalesTransaction.)
Public propertyAutoDocNumberSpecified (Inherited from SalesTransaction.)
Public propertyBalance
Product: QBO Description: The balance reflecting any payments made against the transaction. Initially this will be equal to the TotalAmt. Product: QBW Description: Indicates the unpaid amount of the transaction. Filterable: ALL Sortable: QBW InputType: ReadOnly
(Inherited from SalesTransaction.)
Public propertyBalanceSpecified (Inherited from SalesTransaction.)
Public propertyBillAddr
Product: ALL Description: QBO: Bill-to address of the Invoice.[br]See [a href="http://ipp.developer.intuit.com/0010_Intuit_Partner_Platform/0060_Financial_Management_Services_(v3)/01000_Using_Data_Service_Entities#Addresses"]Addresses[/a] Description: QBW: The physical (postal) address where the bill or invoice is sent.[br]See [a href="http://ipp.developer.intuit.com/0010_Intuit_Partner_Platform/0060_Financial_Management_Services_(v3)/01000_Using_Data_Service_Entities#Addresses"]Addresses[/a] InputType: ReadWrite
(Inherited from SalesTransaction.)
Public propertyBillEmail
Product: QBO Description: Identifies the e-mail address where the invoice is sent. At present, you can provide only one e-mail address.[br /]If the ToBeEmailed attribute is true and the BillEmail attribute contains an e-mail address, the user can send an e-mail message to the e-mail address that is specified in the BillEmail attribute.[br /]If the BillEmail attribute contains an invalid e-mail address, QBO does not send the e-mail message to the invalid e-mail address. QBO also does not return any error message to indicate that the e-mail address is invalid.[br /]The maximum length for BillEmail is 100 characters. Product: QBW Description: Identifies the email address where the bill or invoice is sent. [br /]UNSUPPORTED FIELD.
(Inherited from SalesTransaction.)
Public propertyBillEmailBcc
Product: QBO Description: Identifies the bcc e-mail address where the invoice is sent. If the ToBeEmailed attribute is true and the BillEmailBcc attribute contains an e-mail address, the user can send an e-mail message to the e-mail address that is specified in the BillEmailBcc attribute.[br /] If the BillEmailCc attribute contains an invalid bcc e-mail address, QBO does not send the e-mail message to the invalid bcc e-mail address. [br /]The maximum length for BillEmailBcc is 200 characters. Product: QBW Description: Identifies the bcc email address where the bill or invoice is sent as bcc. [br /]
(Inherited from SalesTransaction.)
Public propertyBillEmailCc
Product: QBO Description: Identifies the cc e-mail address where the invoice is sent. If the ToBeEmailed attribute is true and the BillEmailCc attribute contains an e-mail address, the user can send an e-mail message to the e-mail address that is specified in the BillEmailCc attribute.[br /] If the BillEmailCc attribute contains an invalid e-mail address, QBO does not send the e-mail message to the invalid cc e-mail address. [br /]The maximum length for BillEmailCc is 200 characters. Product: QBW Description: Identifies the cc email address where the bill or invoice is sent. [br /]
(Inherited from SalesTransaction.)
Public propertyClassRef
Product: QBW Description: Reference to the Class associated with the transaction. InputType: ReadWrite
(Inherited from SalesTransaction.)
Public propertyCurrencyRef
Product: ALL Description: Reference to the Currency in which all amounts on the associated transaction are expressed.[br /] InputType: ReadWrite
(Inherited from Transaction.)
Public propertyCustomerMemo
Product: ALL Description: QBO: For an Invoice, this is the user-entered message to the customer that does appear in the invoice, and does appear in the printed invoice. The maximum length for Invoice Msg is 1000 characters.[br /]For a Bill, this is the memo of the transaction to provide more detail, and does not appear in the printed message of the bill. The maximum length for Bill Msg is 4000 characters.[br /]For a CreditCardCharge, this message appears in the printed record; maximum length is 4000 characters.[br /]Not supported for BillPayment, JournalEntry or Payment. Description: QBW: User-entered message to the customer; this message will be visible to end user on their transactions. InputType: ReadWrite
(Inherited from SalesTransaction.)
Public propertyCustomerRef
Product: ALL Description: Reference to a Customer or job. Filterable: QBW InputType: ReadWrite BusinessRules: QBW: CustomerRef is mandatory for some SalesTransactions like Invoice
(Inherited from SalesTransaction.)
Public propertyCustomField
Product: QBW Description: Custom field (or data extension). Filterable: QBW
(Inherited from IntuitEntity.)
Public propertyDeliveryInfo
Product: QBO Description: Last delivery info of this transaction.
(Inherited from SalesTransaction.)
Public propertyDepartmentRef
Product: QBO Description: Location of the transaction, as defined using location tracking in QuickBooks Online.
(Inherited from Transaction.)
Public propertyDepositToAccountRef
Product: ALL Description: QBW: Reference to the DepositToAccount entity. If not specified, the Undeposited Funds account will be used. Description: QBO: Asset account where the payment money is deposited. If you do not specify this account, QBO uses the Undeposited Funds account. Supported for Payment and SalesReceipt only. NotApplicableTo: QBW: Estimate, SalesOrder
(Inherited from SalesTransaction.)
Public propertyDiscountAmt
Product: QBO Description: Indicates the discount amount that is applied on the transaction as a whole. This will be pro-rated through item lines for tax calculation.
(Inherited from SalesTransaction.)
Public propertyDiscountAmtSpecified (Inherited from SalesTransaction.)
Public propertyDiscountRate
Product: QBO Description: Indicates the discount rate that is applied on the transaction as a whole. This will be pro-rated through item lines for tax calculation.
(Inherited from SalesTransaction.)
Public propertyDiscountRateSpecified (Inherited from SalesTransaction.)
Public propertyDocNumber
Product: ALL Description: QBO: Reference number for the transaction. If DocNumber is not provided, and the Custom Transaction Number is set to "Off", QBO assigns a document number using the next-in-sequence algorithm for Sales transactions. Otherwise the value will remaing null. Alternatively, you can also pass in "AUTO_GENERATE" in this field to force QBO to auto-sequence the document number for Invoices, Estimates and Sales Receipt.[br /]The maximum length for DocNumber is 21 characters. The default value is an empty String. Filter support not provided for Payment. Description: QBW: The primary document number for this transaction. DocNumber is exposed to end users.[br /]If it is not provided, QuickBooks business logic will assign the document number using the "next in sequence" algorithm.[br /]Max. length is 11 characters for Payment, Bill, ItemReceipt and VendorCredit. Max. length is 20 characters for other entities. Filterable: QBO InputType: ReadWrite ValidRange: QBW: max=11 ValidRange: QBO: max=21
(Inherited from Transaction.)
Public propertydomain
Product: ALL Description: Domain in which the entity belongs.
(Inherited from IntuitEntity.)
Public propertyDueDate
Product: ALL Description: QBW: Date when the payment of the transaction is due. Description: QBO: Date when the invoice is to be paid, not including any early-payment discount incentives, or late payment penalties. If the date is not supplied, the current date on the server is used. Filterable: QBW InputType: ReadWrite BusinessRules: QBW: Following are the BusinessRules regarding DueDate of transaction
(Inherited from SalesTransaction.)
Public propertyDueDateSpecified (Inherited from SalesTransaction.)
Public propertyEmailStatus
Product: ALL Description: Email status of the invoice.[br /] InputType: ReadWrite
(Inherited from SalesTransaction.)
Public propertyEmailStatusSpecified (Inherited from SalesTransaction.)
Public propertyExchangeRate
Product: ALL Description: Currency exchange rate. Valid only if the company file is set up to use Multi-Currency feature. In QuickBooks, exchange rates are always recorded as the number of home currency units it takes to equal one foreign currency unit. The foreign unit is always 1 and the amount of home units that equal that 1 foreign unit is what QuickBooks uses as the exchange rate. InputType: ReadWrite
(Inherited from Transaction.)
Public propertyExchangeRateSpecified (Inherited from Transaction.)
Public propertyFinanceCharge
Product: ALL Description: Indicates whether the transaction is a finance charge. InputType: ReadWrite
(Inherited from SalesTransaction.)
Public propertyFinanceChargeSpecified (Inherited from SalesTransaction.)
Public propertyFOB
Product: ALL Description: "Free On Board", the terms between buyer and seller regarding transportation costs; does not have any bookkeeping implications. Description: "Free On Board", the terms between buyer and seller regarding transportation costs; does not have any bookkeeping implications. ValidRange: QBW: max=13 ValidRange: QBO: max=15
(Inherited from SalesTransaction.)
Public propertyGlobalTaxCalculation
Product: QBO Description: Indicates the GlobalTax model if the model inclusive of tax, exclusive of taxes or not applicable
(Inherited from SalesTransaction.)
Public propertyGlobalTaxCalculationSpecified (Inherited from SalesTransaction.)
Public propertyGovtTxnRefIdentifier
Product: QBO Description: this is the reference to the NotaFiscal created for the salesTransaction. ValidRange: QBO: max=30
(Inherited from SalesTransaction.)
Public propertyHeaderFull
Property used for Select clauses. This property is not used for entity operation and Where and orderBy clauses.
(Inherited from IntuitEntity.)
Public propertyHeaderLite
Property used for Select clauses. This property is not used for entity operation and Where and orderBy clauses.
(Inherited from IntuitEntity.)
Public propertyHomeBalance
Product: QBO Description: The balance reflecting any payments made against the transaction in home currency. Initially this will be equal to the HomeTotalAmt.[br /]Read-only field. Product: QBW Description: Indicates the unpaid amount of the transaction in home currency.[br /]Cannot be written to QuickBooks. Filterable: ALL Sortable: QBW
(Inherited from SalesTransaction.)
Public propertyHomeBalanceSpecified (Inherited from SalesTransaction.)
Public propertyHomeTotalAmt
Product: ALL Description: QBW: Total amount of the transaction in the home currency for multi-currency enabled companies. Single currency companies will not have this field. Includes the total of all the charges, allowances and taxes. Calculated by QuickBooks business logic. Cannot be written to QuickBooks. InputType: QBW: ReadOnly
(Inherited from SalesTransaction.)
Public propertyHomeTotalAmtSpecified (Inherited from SalesTransaction.)
Public propertyId
Product: ALL Description: Unique Identifier for an Intuit entity (object). [br /]Required for the update operation. Required: ALL Filterable: ALL
(Inherited from IntuitEntity.)
Public propertyLine
Product: QBW Description: A line item of a transaction. Product: QBO Description: A line item of a transaction. QuickBooks Online does not support tax lines in the main transaction body, only in the TxnTaxDetail section.
(Inherited from Transaction.)
Public propertyLinkedTxn
Product: ALL Description: A linked (related) transaction. More than one transaction can be linked.
(Inherited from Transaction.)
Public propertyManuallyClosed
Product: QBW Description: The entire transaction, or individual items are maually closed, i.e. not invoiced.
Public propertyManuallyClosedSpecified
Public propertyMetaData
Product: ALL Description: Descriptive information about the entity. The MetaData values are set by Data Services and are read only for all applications.
(Inherited from IntuitEntity.)
Public propertyNameAndId
Property used for Select clauses. This property is not used for entity operation and Where and orderBy clauses.
(Inherited from IntuitEntity.)
Public propertyOverview
Property used for Select clauses. This property is not used for entity operation and Where and orderBy clauses.
(Inherited from IntuitEntity.)
Public propertyPaymentMethodRef
Product: ALL Description: Reference to the PaymentMethod. InputType: ReadWrite
(Inherited from SalesTransaction.)
Public propertyPaymentRefNum
Product: QBO Description: The reference number for the payment received (I.e. Check # for a check, envelope # for a cash donation, CreditCardTransactionID for a credit card payment)
(Inherited from SalesTransaction.)
Public propertyPaymentType
Product: QBO Description: Valid values are Cash, Check, CreditCard, or Other. No defaults. Cash based expense is not supported by QuickBooks Windows. NotApplicableTo: Estimate, SalesOrder
(Inherited from SalesTransaction.)
Public propertyPaymentTypeSpecified (Inherited from SalesTransaction.)
Public propertyPONumber
Product: ALL Description: Purchase Order number. ValidRange: QBW: max=25 ValidRange: QBO: max=15
(Inherited from SalesTransaction.)
Public propertyPrintStatus
Product: ALL Description: Printing status of the invoice.[br /] InputType: ReadWrite
(Inherited from SalesTransaction.)
Public propertyPrintStatusSpecified (Inherited from SalesTransaction.)
Public propertyPrivateNote
Product: ALL Description: User entered, organization-private note about the transaction. This note will not appear on the transaction records by default. InputType: ReadWrite
(Inherited from Transaction.)
Public propertyRemitToRef
Product: QBW Description: Reference to the party receiving payment. InputType: ReadOnly
(Inherited from SalesTransaction.)
Public propertySalesOrderEx
Internal use only: extension place holder for SalesOrder
Public propertySalesRepRef
Product: QBW Description: Reference to the SalesRep associated with the transaction. InputType: ReadWrite
(Inherited from SalesTransaction.)
Public propertySalesTermRef
Product: QBW Description: Reference to the SalesTerm associated with the transaction. InputType: ReadWrite
(Inherited from SalesTransaction.)
Public propertyShipAddr
Product: ALL Description: QBO: Shipping address of the Invoice.[br]See [a href="http://ipp.developer.intuit.com/0010_Intuit_Partner_Platform/0060_Financial_Management_Services_(v3)/01000_Using_Data_Service_Entities#Addresses"]Addresses[/a] Description: QBW: Identifies the address where the goods must be shipped. [br /]QuickBooks Note: If ShipAddr is not specified, and a default ship-to address is specified in QuickBooks for this customer, the default ship-to address will be used by QuickBooks.[br]See [a href="http://ipp.developer.intuit.com/0010_Intuit_Partner_Platform/0060_Financial_Management_Services_(v3)/01000_Using_Data_Service_Entities#Addresses"]Addresses[/a]
(Inherited from SalesTransaction.)
Public propertyShipDate
Product: QBW Description: Date for delivery of goods or services. InputType: ReadWrite
(Inherited from SalesTransaction.)
Public propertyShipDateSpecified (Inherited from SalesTransaction.)
Public propertyShipMethodRef
Product: QBW Description: Reference to the ShipMethod associated with the transaction. InputType: ReadWrite
(Inherited from SalesTransaction.)
Public propertysparse
Product: ALL Description: True if the entity representation has a partial set of elements. Output only field.
(Inherited from IntuitEntity.)
Public propertysparseSpecified (Inherited from IntuitEntity.)
Public propertystatus
Product: ALL Description: System status of the entity. Output only field.[br /] Filterable: ALL
(Inherited from IntuitEntity.)
Public propertystatusSpecified (Inherited from IntuitEntity.)
Public propertySyncToken
Product: ALL Description: Version number of the entity. The SyncToken is used to lock the entity for use by one application at a time. As soon as an application modifies an entity, its SyncToken is incremented; another application's request to modify the entity with the same SyncToken will fail. Only the latest version of the entity is maintained by Data Services. An attempt to modify an entity specifying an older SyncToken will fail. [br /]Required for the update operation. Required: ALL
(Inherited from IntuitEntity.)
Public propertyTaxFormNum
Description: Tax Form Num holds data related to Tax Information based on Regional compliance laws.This is applicable for IN region and can be extended to other regions in future.
(Inherited from Transaction.)
Public propertyTaxFormType
Description: refer TaxFormTypeEnum. Tax Form Type holds data related to Tax Information, values based on regional compliance laws. Applicable for IN Region and can be extended for other Regions.
(Inherited from Transaction.)
Public propertyTemplateRef
Product: QBW Description: Reference to the Template for the invoice form. InputType: ReadWrite
(Inherited from SalesTransaction.)
Public propertyTotalAmt
Product: All Description: QBO: Indicates the total amount of the transaction. This includes the total of all the charges, allowances and taxes. By default, this is recalculated based on sub items total and overridden. Description: QBW: Indicates the total amount of the transaction. This includes the total of all the charges, allowances and taxes.[br /]Calculated by QuickBooks business logic; cannot be written to QuickBooks. Filterable: QBW Sortable: QBW InputType: QBW: OverrideOnSync
(Inherited from SalesTransaction.)
Public propertyTotalAmtSpecified (Inherited from SalesTransaction.)
Public propertyTrackingNum
Product: QBW Description: Shipping provider's tracking number for the delivery of the goods associated with the transaction.
(Inherited from SalesTransaction.)
Public propertyTransactionLocationType
Product: QBO Description: Location of the purchase or sale transaction. The applicable values are those exposed through the TransactionLocationTypeEnum. This is currently applicable only for the FR region.
(Inherited from Transaction.)
Public propertyTxnDate
Product: ALL Description: QBO: The date entered by the user when this transaction occurred. [br /]Often, it is the date when the transaction is created in the system. [br /]For "posting" transactions, this is the posting date that affects the financial statements. If the date is not supplied, the current date on the server is used. Description: QBW: The nominal, user entered, date of the transaction. [br /]Often, but not required to be, the date the transaction was created in the system. [br /]For "posting" transactions, this is the posting date that affects financial statements. Filterable: ALL Sortable: ALL InputType: ReadWrite
(Inherited from Transaction.)
Public propertyTxnDateSpecified (Inherited from Transaction.)
Public propertyTxnSource
Product: QBO Description: Originating source of the Transaction. Valid values are defined in TxnSourceEnum: QBMobile.
(Inherited from Transaction.)
Public propertyTxnStatus
Product: ALL Description: QBW: The status of the transaction. Depending on the transaction type it may have different values.[br /]For Sales Transactions acceptable values are defined in PaymentStatusEnum. For Estimate, the values accepted are defined in EstimateStatusEnum. Description: QBO: The status of the transaction. Depending on the transaction type it may have different values.[br /]For Sales Transactions acceptable values are defined in PaymentStatusEnum. For Estimate, the values accepted are defined in QboEstimateStatusEnum. Filterable:QBW
(Inherited from Transaction.)
Public propertyTxnTaxDetail
Product: ALL Description: Details of taxes charged on the transaction as a whole. For US versions of QuickBooks, tax rates used in the detail section must not be used in any tax line appearing in the main transaction body. For international versions of QuickBooks, the TxnTaxDetail should provide the details of all taxes (sales or purchase) calculated for the transaction based on the tax codes referenced by the transaction. This can be calculated by QuickBooks business logic or you may supply it when adding a transaction. For US versions of QuickBooks you need only supply the tax code for the customer and the tax code (in the case of multiple rates) or tax rate (for a single rate) to apply for the transaction as a whole.[br]See [a href="http://ipp.developer.intuit.com/0010_Intuit_Partner_Platform/0060_Financial_Management_Services_(v3)/01100_Global_Tax_Model"]Global Tax Model[/a].
(Inherited from Transaction.)
Top
See Also