SalesOrder

Namespace: urn:sales.transactions.webservices.netsuite.com

Fields

NameTypeCardinalityLabelRequiredHelp
accountingBookDetailList AccountingBookDetailList 0..1
actualShipDate dateTime 0..1 Actual Shipping Date F The actual shipment date.
altHandlingCost double 0..1 Handling Cost F The handling cost automatically calculates depending on the shipping method you select in the Ship Via field. To change the cost of handling, go to Lists > Shipping Items and select the shipping method with the handling cost you want to change.
altSalesTotal double 0..1 Alt. Sales Total F The Alternate Sales Amount feature must be enabled in your account in order to populate this field. The value entered sets an Alternate Sales Amount for line items on the sales order. This value can then be used for commission calculations.
altShippingCost double 0..1 Shipping Cost F This is a read-only field that returns the shipping costs based on the shipping method selected in shipMethod.
authCode string 0..1 Auth. Code F Sets the authorization code for the transaction. If getAuth is set to true, this is a ready only field that returns the Authorization code when authorization has been requested for the sales order.
balance double 0..1 F The balance owed by this customer.
billAddressList RecordRef 0..1 Bill To Select F Sets the billing address for this transaction. This field defaults to the default Billing Address set on the associated Customer record. Use CustomerAddressBookList on the Customer Record to retrieve a list of currently defined addresses for a specific customer. If an address has NOT been defined, you must first define an address on the Customer record in order to set a billing addess for this transaction.
billingAddress Address 0..1 Billing Address F
billingSchedule RecordRef 0..1 Billing Schedule F Allows users to reference default Billing Schedules for items. In order to retrieve a list of available values for this field, use the GetSelectValue operation.
canHaveStackable boolean 0..1 Can Stack Promotions F
ccApproved boolean 0..1 Credit Card Approved F Sets the status of the credit card to approved.
ccAvsStreetMatch AvsMatchCode 0..1 AVS Street Match F References a value in a system list. This value sets the Address Verification Services (AVS) result code returned to the credit card processor when a credit card transaction takes place. Possible values include _Y, _N _X. The possible values include: _Y - The address information submitted did match. _N - The address information submitted did not match. _X - The credit card company does not support AVS, or no information was returned. If getAuth is set to True, this value can NOT be set.
ccAvsZipMatch AvsMatchCode 0..1 AVS Zip Match F References a value in a system list. This value sets the Address Verification Services (AVS) result code returned to credit card processor when a credit card transaction takes place. Possible values include _Y, _N _X. The possible values include: _Y - The address information submitted did match. _N - The address information submitted did not match. _X - The credit card company does not support AVS, or no information was returned. If getAuth is set to True, this value can NOT be set.
ccExpireDate dateTime 0..1 Expires (MM/YYYY) F Sets the credit card expiration date.
ccName string 0..1 Name on Card F Defaults to the cardholder name from the default credit card on the customer's record. If the default credit card is not selected in creditCard, you must provide this value.
ccNumber string 0..1 Credit Card # F Use this field to set the credit card number. Enter numbers only, without spaces. Partially masked values are not accepted. Only a 16-digit number is accepted. On a get, this value is masked. When searching on this field, you can use only the empty and notEmpty operators.
ccSecurityCode string 0..1 CSC F Settable only if the Use Card Security Code for Credit Card Transactions company preference is enabled at Set Up > Accounting > Accounting Preferences.
ccSecurityCodeMatch AvsMatchCode 0..1 CSC Match F References a value in a system list. Possible values include: _Y - The security code information submitted did match. _N - The security code information submitted did not match. _X - The credit card company does not support security codes.
ccStreet string 0..1 Card Street F Defaults to the street address from the customer's billing address.
ccZipCode string 0..1 Card Zip Code F Defaults to the zip or postal code from the customer's billing address.
checkNumber string 0..1 Check # F
class RecordRef 0..1 Class F References a value from a user defined list at Setup > Company > Classifications > Classes. This field is required when Make Classes Mandatory is enabled at Setup > Accounting > Accounting Preferences. In order to retrieve a list of available values for this field, use the GetSelectValue operation.
contribPct string 0..1 Contribution Percentage F
createdDate dateTime 0..1 Date Created F
createdFrom RecordRef 0..1 Created From F In order to retrieve a list of available values for this field, use the GetSelectValue operation.
creditCard RecordRef 0..1 Cards on File F References the credit card records associated with the customer record.
creditCardProcessor RecordRef 0..1 Payment Processing Profile F References a user-defined Credit Card Processor record at Setup > Company > Credit Card Processors. In order to retrieve a list of available values for this field, use the GetSelectValue operation.
currency RecordRef 0..1 Currency F If you do not use the Multi-Currency Customers feature, the currency of the customer you are creating this transaction for is shown here. If you use the Multi-Currency Customers feature, select the transaction currency you want to create this transaction in. This customer's primary currency is selected by default. If you have already selected items on this transaction, selecting a new currency refreshes them to show the price in the new currency (except for items you entered custom prices for) and recalculates tax and gross profit.
currencyName string 0..1 Currency F A read only field that defaults to the currency associated with the customer referenced by the entity field.
customFieldList CustomFieldList 0..1
customForm RecordRef 0..1 Custom Form F References an existing custom form for this record type. To ensure that field relationships defined within a desired custom form are maintained, you must provide the customForm value. Also, if defaults are off, then customForm is required, if defaults are on then the default form is used. Internal ID values for existing forms can be found at Setup > Customization > Entry Forms. In order to retrieve a list of available values for this field, use the GetSelectValue operation.
debitCardIssueNo string 0..1 Issue No. F Sets the debit card authorization number for UK accounts only. The debit card authorization number is printed on the card. Required for users of SecPay or WorldPay.
deferredRevenue double 0..1 Deferred Revenue F Deferred Revenue: amount of revenue deferred on this transaction
department RecordRef 0..1 Department F References a value from a user defined list at Setup > Company > Departments. This field is required when the Make Departments Mandatory preference is enabled at Setup > Accounting > Accounting Preferences. In order to retrieve a list of available values for this field, use the GetSelectValue operation.
discountItem RecordRef 0..1 Discount Item F References a value in a user defined discount list. To create new values, click Lists > Accounting > Items > New > Discount. In order to retrieve a list of available values for this field, use the GetSelectValue operation.
discountRate string 0..1 Rate F If the value entered here includes the percent sign, the discount rate applied to the item is calculated as a percent. If the value entered here does not include the percent sign, the discount rate is applied as an absolute discount value. For example, 10% would result in a ten percent discount on the item whereas 10 would result in a ten dollar discount on the item.
discountTotal double 0..1 Discount Total F This is a read-only field that returns the amount discounted on this sales order.
drAccount RecordRef 0..1 Deferred Revenue Reclassification Account F This field applies to the Revenue Commitment feature only. After you enable Advanced Revenue Management, this field is ignored in new sales orders. Select the deferred revenue account to post revenue reclassification amounts generated by revenue reclassification journal entries.
dynamicDescriptor string 0..1 Soft Descriptor F
email string 0..1 Email F
endDate dateTime 0..1 End Date F Sets the date for the last invoice. This should only be set if Advanced Billing is being used.
entity RecordRef 0..1 Customer T Sets the customer this sales order is associated with. In order to retrieve a list of available values for this field, use the GetSelectValue operation.
entityTaxRegNum RecordRef 0..1 Customer Tax Reg. Number F Select the customer's tax registration number associated with this sales order.
estGrossProfit double 0..1 Est. Gross Profit F Estimated Gross Profit: Read-only field that equals the revenue amount minus the Est. Cost. At the transaction level, it equals the gross profit of all lines, factoring transaction-level discounts and markups.
estGrossProfitPercent double 0..1 Est. Gross Profit Percent F Estimated Gross Profit Margin, as a percentage: Read-only field that equals the Est. Gross Profit divided by revenue, expressed as a percentage. At the transaction level, it equals the gross profit percent of all lines, factoring transaction-level discounts and markups.
exchangeRate double 0..1 Exchange Rate T Defaults to the current currency exchange rate as defined in the currency record. This is only settable on an Add.
excludeCommission boolean 0..1 Exclude Commissions F If True, the sales order does NOT generate a commission amount. The Commissions feature must be enabled in your account to set this field.
fax string 0..1 Fax F
fob string 0..1 FOB F Sets the location where the customers technically acquire ownership.
fxAccount RecordRef 0..1 Foreign Currency Adjustment Revenue Account F This field applies to the Revenue Commitment feature only. After you enable Advanced Revenue Management, this field is ignored in new sales orders. Select the revenue account to use to post foreign currency adjustments that result when exchange rates are different for billing and revenue postings for this transaction. You must select an income account.
getAuth boolean 0..1 Get Authorization F If set to true, NetSuite your payment gateway to process the request according to the processing profile settings.
giftCertApplied double 0..1 Gift Certificate F
giftCertRedemptionList GiftCertRedemptionList 0..1
handlingCost double 0..1 Handling Cost F The handling costs displayed in this field are calculated by applying the values pre-defined in the selected Shipping Method. For example you may have a flat rate handling charge for all items sent by US Mail of $1.50. To change handling rates, go to Shipping > Lists > Shipping Items, and select the required shipping method. Click on the Handling Rate subtab.
handlingMode SalesOrderHandlingMode 0..1 Handling Mode T
handlingTax1Rate double 0..1 Tax Rate F This field shows that tax rate for the handling tax code selected.
handlingTax2Rate string 0..1 Tax Rate F
handlingTaxCode RecordRef 0..1 Handling Tax Code F Select the tax code that should apply to any handling charges on this order.
ignoreAvs boolean 0..1 Ignore AVS F
inputAuthCode string 0..1 Input Auth. Code F
inputReferenceCode string 0..1 Input P/N Ref. T
intercoStatus IntercoStatus 0..1 Intercompany Status F Intercompany Transaction Status can be: * Linked - intercompany order has been paired with an intercompany order in another subsidiary. * Pending - iintercompany order has not been paired with a corresponding order in another subsidiary. * Rejected - intercompany purchase order or vendor return authorization cannot be paired with a sales order or return authorization because it contains incorrect information, such as subsidiary, currency, amount, or other detail.
intercoTransaction RecordRef 0..1 Paired Intercompany Transaction F Identifies the intercompany order in another subsidiary that this order is paired with. Order pairs include Sales Order/Purchase Order and Vendor Return Authorization/Return Authorization.
isMultiShipTo boolean 0..1 Enable Item Line Shipping F Check this box to enter multiple shipping routes on this order. In the Ship To field, select a shipping address for the customer. The Default Billing address, from the customer record, is automatically displayed in the field. You can add a New address which is saved to the customer record, or enter a Custom address, which only stays on the transaction, and is not saved to the customer record. In the Ship Via field, select the shipping method you want to use for that address.
isRecurringPayment boolean 0..1 Recurring Payment F This box is checked if this cash sale was generated from a sales order for a recurring payment. Payments marked as recurring can be successfully processed even if the credit card expires during the billing schedule. You should not check this box for standalone cash sales. You should only check this box for transactions with recurring payments. It can be used for cash sale sales orders with billing schedules or memorized cash sale sales order.
isTaxable boolean 0..1 Taxable F If set to true, the entire order is taxable.
itemList SalesOrderItemList 0..1
job RecordRef 0..1 Project F Select the project associated with this sale.
lastModifiedDate dateTime 0..1 Date Last Modified F
leadSource RecordRef 0..1 Lead Source F Defaults to the lead source associated with the entity set in the entity field. If a lead source is not associated with the entity, and a default lead source has been set up, the field defaults to the value set at Setup > Marketing > Set Up Marketing. The lead source can reference either of the following: If marketing automation is NOT enabled, this field references a value in a user-defined list at Setup > Sales > Setup Tasks > CRM Lists. If marketing automation IS enabled, this field references a value in the campaign list at Lists > Marketing > Campaigns. In order to retrieve a list of available values for this field, use the GetSelectValue operation.
linkedTrackingNumbers string 0..1 Linked Tracking Numbers F
location RecordRef 0..1 Location F References a value in a user-defined list at Setup > Company > Classifications > Locations. This field is required when Make Locations Mandatory is enabled at Setup > Accounting > Accounting Preferences. In order to retrieve a list of available values for this field, use the GetSelectValue operation..
memo string 0..1 Memo F Sets a description for the sales order.
message string 0..1 Customer Message F Defaults to the text entered in the messageSel field.
messageSel RecordRef 0..1 Select Message F Sets the message to display on the form. To create new messages, go to Setup > Accounting > Setup Tasks > Accounting Lists > New > Customer Message. In order to retrieve a list of available values for this field, use the GetSelectValue operation.
nextBill dateTime 0..1 Next Bill Date F
nexus RecordRef 0..1 Nexus F This field shows the nexus of the transaction. NetSuite automatically populates this field based on the nexus lookup logic. You can override the transaction nexus and tax registration number that NetSuite automatically selects by checking the Nexus Override box. When you select a different nexus in the dropdown list, the corresponding tax registration number is automatically selected in the Subsidiary Tax Reg. Number field.
oneTime double 0..1 One Time F
opportunity RecordRef 0..1 Opportunity F Associates the sales order with an opportunity. In order to retrieve a list of available values for this field, use the GetSelectValue operation.
orderStatus SalesOrderOrderStatus 0..1 Order Status F This field contains the default status for your sales orders, as specified on the Company Preference page. If your company uses the approval process for sales orders, Pending Approval is your default. If your company does not use the approval process, Pending Fulfillment is your default. You can change the status for each sales order here if needed. Available values are: _pendingApproval _pendingFulfillment Important: You cannot set orderStatus to _closed if you want to close a sales order. Instead, you must close all the line items on the sales order. The order status of the sales order will then change to closed.
otherRefNum string 0..1 PO/Check Number F Sets the payment reference number. Set to the check number if your customer is paying by check, or, if your customer is issuing a purchase order, set to the PO number.
outputAuthCode string 0..1 Auth. Code F
outputReferenceCode string 0..1 P/N Ref. F
partner RecordRef 0..1 Partner F Sets the partner associated with this sales order. Existing partners can be viewed at Lists > Relationships > Partners. In order to retrieve a list of available values for this field, use the GetSelectValue operation.
partnersList SalesOrderPartnersList 0..1
paymentCardCsc string 0..1 CSC F
paymentEventDate dateTime 0..1 F
paymentEventHoldReason TransactionPaymentEventHoldReason 0..1 Reason F
paymentEventResult TransactionPaymentEventResult 0..1 Status F
paymentEventType TransactionPaymentEventType 0..1 F
paymentEventUpdatedBy string 0..1 F
paymentMethod RecordRef 0..1 Payment Method F Reference to a value in a user-defined list at Setup > Accounting > Setup Tasks > Accounting Lists > New > Payment Method. This value sets the type of card. In order to retrieve a list of available values for this field, use the GetSelectValue operation.
paymentOperation SalesOrderPaymentOperation 0..1 Payment Operation F
paymentOption RecordRef 0..1 Payment Option F
paymentProcessingProfile RecordRef 0..1 Payment Processing Profile T
paypalAuthId string 0..1 Authorization ID F
paypalProcess boolean 0..1 Process PayPal Payment F
payPalStatus string 0..1 PayPal Status F
payPalTranId string 0..1 PayPal Tran. ID F
pnRefNum string 0..1 P/N Ref. F Available only if Verisign Integration is set up. Sets VeriSign's unique identifier for every transaction they commit. This is useful when the client uses an external application to verify the Credit Card and then supplies the PNRef to NetSuite.
promoCode RecordRef 0..1 Promotion F Sets a promotion code to apply to this transaction. Defaults to the default promotion code (if defined) at Setup > Marketing > Marketing Preferences. Customers associated with a partner can only use that partner's promotion codes. If you select a promotion code associated with a partner, this transaction is attributed to that partner for reporting purposes. To view existing Promotion Codes, go to Lists > Marketing > Promotion Codes. In order to retrieve a list of available values for this field, use the GetSelectValue operation.
promotionsList PromotionsList 0..1
recognizedRevenue double 0..1 Recognized Revenue F Recognized Revenue: cumulative amount of revenue recognized for this transaction
recurAnnually double 0..1 Annually F
recurMonthly double 0..1 Monthly F
recurQuarterly double 0..1 Quarterly F
recurWeekly double 0..1 Weekly F
revCommitStatus RevenueCommitStatus 0..1 Revenue Commitment Status F This field provides information about Revenue Commitment(s) in the case of a Sales Order or Revenue Commitment Reversal(s) in the case of a Return Authorization. If you uncheck the Rev Rec on Rev Commit. Field, the Rev. Commit. Status field displays information about the related Invoice(s) or Credit Memo(s). The possible values for this field and definitions are as follows: 1. Pending Commitment - No related revenue transactions have been created. 2. Partially Committed - Some related revenue transactions have been created. 3. Committed - All related revenue transactions have been created.
revenueStatus RevenueStatus 0..1 Revenue Status F The possible values for this field are: 1. Pending: indicates that no recognition has occurred. All revenue is still deferred. 2. In Progress: indicates that some recognition has occurred. 3. Completed: indicates that all recognition has occurred. No deferred revenue remains.
revRecEndDate dateTime 0..1 Rev. Rec. End Date F
revRecOnRevCommitment boolean 0..1 Rev Rec on Rev Commit. F Check this check box to create a Revenue Commitment or Revenue Commitment Reversal. * On a Sales Order, the Revenue Commitment replaces an invoice * On a Return Authorization, the Revenue Commitment Reversal replaces a credit memo. NetSuite creates all applicable Revenue Recognition schedules the Revenue Commitment or Revenue Commitment Reversal.
revRecSchedule RecordRef 0..1 Rev. Rec. Schedule F
revRecStartDate dateTime 0..1 Rev. Rec. Start Date F
salesEffectiveDate dateTime 0..1 Sales Effective Date F You can change the sales effective date for this transaction. The sales effective date determines which commission plan and historical sales team this transaction applies to.
salesGroup RecordRef 0..1 When team selling is enabled, this references a user defined sales team group at Lists > Relationships > Groups. In order to retrieve a list of available values for this field, use the GetSelectValue operation.
salesRep RecordRef 0..1 Sales Rep F Defaults to the sales representative associated with the customer referenced by the entity field. In order to retrieve a list of available values for this field, use the GetSelectValue operation.
salesTeamList SalesOrderSalesTeamList 0..1
saveOnAuthDecline boolean 0..1 F
shipAddressList RecordRef 0..1 Ship To Select F Sets the shipping address for this transaction. This field defaults to the default Shipping Address set on the associated Customer record. Use CustomerAddressBookList on the Customer Record to retrieve a list of currently defined addresses for a specific customer. If an address has NOT been defined, you must first define an address on the Customer record in order to set a billing addess for this transaction.
shipComplete boolean 0..1 Ship Complete F Check this box if you want to ship this order only when complete. This will prevent multiple shipments of part-orders. When fulfilling orders in bulk, you can filter the list to include those orders marked Ship Complete that can be completely fulfilled by selecting Respect Ship Complete in the Filter By field.
shipDate dateTime 0..1 Ship Date F Sets the ship date for this transaction.
shipGroupList SalesOrderShipGroupList 0..1
shipIsResidential boolean 0..1 Shipping address is residential F
shipMethod RecordRef 0..1 Ship Via F References a value in a user-defined list at Lists > Accounting > Shipping Items. Sets the ship method for this transaction. In order to retrieve a list of available values for this field, use the GetSelectValue operation.
shippingAddress Address 0..1 Shipping Address F
shippingCost double 0..1 Shipping Cost F Sets the shipping cost for this transaction. If your account is set up to automatically charge for shipping, this defaults to the value that corresponds to the shipping method selected. Shipping items can be added at Lists > Accounting > Shipping Items. Note that in Web services, whenever an update occurs to quantity or another field that impacts shipping cost, this field's value is automatically recalculated. To prevent this recalculation, submit the shipping cost with your update.
shippingTax1Rate double 0..1 Tax Rate F This field shows the tax rate for the shipping tax code selected.
shippingTax2Rate string 0..1 Tax Rate F
shippingTaxCode RecordRef 0..1 Shipping Tax Code F Select the tax code that should apply to shipping for this order. The tax rate for this code shows below.
shopperIpAddress string 0..1 F
source string 0..1 Source F The role and location associated with the transaction.
startDate dateTime 0..1 Start Date F Sets the date for creating the first invoice. This should only be set if Advanced Billing is being used.
status string 0..1 Status F
subsidiary RecordRef 0..1 Subsidiary F This field displays the subsidiary associated with this transaction.
subsidiaryTaxRegNum RecordRef 0..1 Subsidiary Tax Reg. Number F This field shows the tax registration number of the transaction nexus. NetSuite automatically populates this field based on the nexus lookup logic. You can override the transaction nexus and tax registration number that NetSuite automatically selects by checking the Nexus Override box. When you select a different tax registration number in the dropdown list, the corresponding nexus is automatically selected in the Nexus field.
subTotal double 0..1 Subtotal F This is a read-only field that returns the total before any discounts, shipping cost, handling cost or tax is added to the order.
syncPartnerTeams boolean 0..1 Check this box if you want to update the sales team on the customer's record with changes you make here.
syncSalesTeams boolean 0..1 Check this box if you want to update the sales team on the customer's record with changes you make here.
tax2Total double 0..1 PST F This is a calculated field.
taxDetailsList TaxDetailsList 0..1
taxDetailsOverride boolean 0..1 Tax Details Override F Check this box to override the tax information on the Tax Details subtab of the transaction. Only roles with at least the Edit level of the Tax Details Tab permission can override the tax details.
taxItem RecordRef 0..1 Tax F References a value in a user-defined sales tax item list at Lists > Accounting > Sales Tax Items. In order to retrieve a list of available values for this field, use the GetSelectValue operation.
taxPointDate dateTime 0..1 Tax Point Date F Tax point date is a legal requirement in many countries. It is the date of transaction that determines the taxability. It may be different from the transaction date that determines the GL impact. Specific rules then consider the reporting of transactions based on tax point date and other factors.
taxRate double 0..1 Tax % F This field defaults to the tax rate associated with the taxItem entered but can be modified.
taxRegOverride boolean 0..1 Tax Registration Override F Check this box to override the values in the Nexus and Subsidiary Tax Reg. Number fields. Only roles with at least the Edit level of the Tax Details Tab permission can override the values that NetSuite automatically selects in these fields.
taxTotal double 0..1 Tax F This is a read-only field that returns the result of the the tax rate multiplied by the taxable total of line items for the transaction.
terms RecordRef 0..1 Terms F References a value in a user-defined list at Setup > Accounting > Setup Tasks > Accounting Lists > New > Term. In order to retrieve a list of available values for this field, use the GetSelectValue operation.
threeDStatusCode string 0..1 Payer Authentication Status F
toBeEmailed boolean 0..1 To Be Emailed F Causes the sales order to be mailed to all email addresses included in the email field.
toBeFaxed boolean 0..1 To Be Faxed F Causes the sales order to be faxed to the fax number included in the fax field.
toBePrinted boolean 0..1 To Be Printed F If enabled, this order is saved in a queue of sales orders and picking tickets that can be printed at a later date.
total double 0..1 Total F This is a read-only field that returns the total of line items, tax and shipping costs.
totalCostEstimate double 0..1 Est. Cost F Estimated Cost: Estimated cost of the specific number of items; estimated rate x quantity = estimated cost.
trackingNumbers string 0..1 This field is read-only. The numbers are links (for convenience) in the UI, and link to the ItemFulfillment associated with the invoice, sales order, etc. If you want to set item tracking information, do so on the Item Fulfillment record.
tranDate dateTime 0..1 Date T Defaults to the current date.
tranId string 0..1 Order # F Defaults to the largest sales order number incremented by one. You can overwrite with another number.
tranIsVsoeBundle boolean 0..1 Transaction Is VSOE Bundle F Check this box to include all items on this transaction as a VSOE bundle. Note: If Rev Rec Dates Specified on Sales Order is the Revenue Recognition Template term source used to allocate revenue, then NetSuite uses the Start and End Dates from the sales order to calculate the Revenue Recognition Schedule.
validFrom dateTime 0..1 Valid From / Start Date (MM/YYYY) F Enter the date when this card first became valid. Use the format MM/YYYY.
vatRegNum string 0..1 VAT Registration F
vsoeAutoCalc boolean 0..1 Auto Calculate VSOE Allocation F Check this box to automatically calculate allocation amounts when you save the transaction. Allocation determines the revenue amount for individual transaction lines.

Attributes

NameType
externalId string
internalId string

Related Searches

Name
TransactionSearch
TransactionSearchAdvanced
TransactionSearchBasic
TransactionSearchRow
TransactionSearchRowBasic