Editar

Compartilhar via


Order (SalesOrder) table/entity reference

Note

Unsure about table vs. entity? See Developers: Understand terminology in Microsoft Dataverse.

Quote that has been accepted.

Added by: Sales Solution

Messages

Message Web API Operation SDK class or method
Assign PATCH /salesorders(salesorderid)
Update ownerid property.
AssignRequest
Associate Associate and disassociate entities AssociateRequest or
Associate
CalculatePrice This message is to be executed only by Dataverse to trigger registered plug-ins and flows.
CancelContract CancelContractRequest
CancelSalesOrder CancelSalesOrderRequest
ConvertSalesOrderToInvoice ConvertSalesOrderToInvoiceRequest
Create POST /salesorders
See Create
CreateRequest or
Create
CreateMultiple CreateMultiple CreateMultipleRequest
Delete DELETE /salesorders(salesorderid)
See Delete
DeleteRequest or
Delete
Disassociate Associate and disassociate entities DisassociateRequest or
Disassociate
FulfillSalesOrder FulfillSalesOrderRequest
GenerateSalesOrderFromOpportunity GenerateSalesOrderFromOpportunityRequest
GetQuantityDecimal GetQuantityDecimalRequest
GetSalesOrderProductsFromOpportunity GetSalesOrderProductsFromOpportunityRequest
GrantAccess GrantAccess GrantAccessRequest
LockSalesOrderPricing LockSalesOrderPricingRequest
ModifyAccess ModifyAccess ModifyAccessRequest
Retrieve GET /salesorders(salesorderid)
See Retrieve
RetrieveRequest or
Retrieve
RetrieveMultiple GET /salesorders
See Query Data
RetrieveMultipleRequest or
RetrieveMultiple
RetrievePrincipalAccess RetrievePrincipalAccess RetrievePrincipalAccessRequest
RetrieveSharedPrincipalsAndAccess RetrieveSharedPrincipalsAndAccess RetrieveSharedPrincipalsAndAccessRequest
RevokeAccess RevokeAccess RevokeAccessRequest
Rollup Rollup RollupRequest
SetState PATCH /salesorders(salesorderid)
Update statecode and statuscode properties.
SetStateRequest
Update PATCH /salesorders(salesorderid)
See Update
UpdateRequest or
Update
UpdateMultiple UpdateMultiple UpdateMultipleRequest

Properties

Property Value
CollectionSchemaName SalesOrders
DisplayCollectionName Orders
DisplayName Order
EntitySetName salesorders
IsBPFEntity False
LogicalCollectionName salesorders
LogicalName salesorder
OwnershipType UserOwned
PrimaryIdAttribute salesorderid
PrimaryNameAttribute name
SchemaName SalesOrder

Writable columns/attributes

These columns/attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.

BillTo_AddressId

Property Value
Description Unique identifier of the billing address.
DisplayName Bill To Address ID
IsValidForForm False
IsValidForRead True
LogicalName billto_addressid
RequiredLevel None
Type Uniqueidentifier

BillTo_City

Property Value
Description Type the city for the customer's billing address.
DisplayName Bill To City
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName billto_city
MaxLength 80
RequiredLevel None
Type String

BillTo_ContactName

Property Value
Description Type the primary contact name at the customer's billing address.
DisplayName Bill To Contact Name
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName billto_contactname
MaxLength 150
RequiredLevel None
Type String

BillTo_Country

Property Value
Description Type the country or region for the customer's billing address.
DisplayName Bill To Country/Region
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName billto_country
MaxLength 80
RequiredLevel None
Type String

BillTo_Fax

Property Value
Description Type the fax number for the customer's billing address.
DisplayName Bill To Fax
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName billto_fax
MaxLength 50
RequiredLevel None
Type String

BillTo_Line1

Property Value
Description Type the first line of the customer's billing address.
DisplayName Bill To Street 1
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName billto_line1
MaxLength 250
RequiredLevel None
Type String

BillTo_Line2

Property Value
Description Type the second line of the customer's billing address.
DisplayName Bill To Street 2
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName billto_line2
MaxLength 250
RequiredLevel None
Type String

BillTo_Line3

Property Value
Description Type the third line of the billing address.
DisplayName Bill To Street 3
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName billto_line3
MaxLength 250
RequiredLevel None
Type String

BillTo_Name

Property Value
Description Type a name for the customer's billing address, such as "Headquarters" or "Field office", to identify the address.
DisplayName Bill To Name
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName billto_name
MaxLength 200
RequiredLevel None
Type String

BillTo_PostalCode

Property Value
Description Type the ZIP Code or postal code for the billing address.
DisplayName Bill To ZIP/Postal Code
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName billto_postalcode
MaxLength 20
RequiredLevel None
Type String

BillTo_StateOrProvince

Property Value
Description Type the state or province for the billing address.
DisplayName Bill To State/Province
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName billto_stateorprovince
MaxLength 50
RequiredLevel None
Type String

BillTo_Telephone

Property Value
Description Type the phone number for the customer's billing address.
DisplayName Bill To Phone
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName billto_telephone
MaxLength 50
RequiredLevel None
Type String

CampaignId

Added by: Marketing Sales Solution

Property Value
Description Shows the campaign that the order was created from.
DisplayName Source Campaign
IsValidForForm True
IsValidForRead True
LogicalName campaignid
RequiredLevel None
Targets campaign
Type Lookup

CustomerId

Property Value
Description Select the customer account or contact to provide a quick link to additional customer details, such as account information, activities, and opportunities.
DisplayName Customer
IsValidForForm True
IsValidForRead True
LogicalName customerid
RequiredLevel ApplicationRequired
Targets account,contact
Type Customer

CustomerIdType

Added by: Active Solution Solution

Property Value
Description
DisplayName Customer Type
IsValidForForm False
IsValidForRead True
LogicalName customeridtype
RequiredLevel ApplicationRequired
Type EntityName

DateFulfilled

Property Value
DateTimeBehavior UserLocal
Description Enter the date that all or part of the order was shipped to the customer.
DisplayName Date Fulfilled
Format DateOnly
IsValidForForm True
IsValidForRead True
LogicalName datefulfilled
RequiredLevel None
Type DateTime

Description

Property Value
Description Type additional information to describe the order, such as the products or services offered or details about the customer's product preferences.
DisplayName Description
Format Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName description
MaxLength 2000
RequiredLevel None
Type Memo

DiscountAmount

Property Value
Description Type the discount amount for the order if the customer is eligible for special savings.
DisplayName Order Discount Amount
IsValidForForm True
IsValidForRead True
LogicalName discountamount
MaxValue 1000000000000
MinValue 0
Precision 2
PrecisionSource 2
RequiredLevel None
Type Money

DiscountPercentage

Property Value
Description Type the discount rate that should be applied to the Detail Amount field to include additional savings for the customer in the order.
DisplayName Order Discount (%)
IsValidForForm True
IsValidForRead True
LogicalName discountpercentage
MaxValue 100
MinValue 0
Precision 2
RequiredLevel None
Type Decimal

EmailAddress

Property Value
Description The primary email address for the entity.
DisplayName Email Address
FormatName Email
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName emailaddress
MaxLength 100
RequiredLevel None
Type String

EntityImage

Added by: Active Solution Solution

Property Value
Description The default image for the entity.
DisplayName Entity Image
IsPrimaryImage True
IsValidForForm False
IsValidForRead True
LogicalName entityimage
MaxHeight 144
MaxWidth 144
RequiredLevel None
Type Image

FreightAmount

Property Value
Description Type the cost of freight or shipping for the products included in the order for use in calculating the Total Amount field.
DisplayName Freight Amount
IsValidForForm True
IsValidForRead True
LogicalName freightamount
MaxValue 1000000000000
MinValue 0
Precision 2
PrecisionSource 2
RequiredLevel None
Type Money

FreightTermsCode

Property Value
Description Select the freight terms to make sure shipping charges are processed correctly.
DisplayName Freight Terms
IsValidForForm True
IsValidForRead True
LogicalName freighttermscode
RequiredLevel None
Type Picklist

FreightTermsCode Choices/Options

Value Label Description
1 FOB
2 No Charge

ImportSequenceNumber

Property Value
Description Sequence number of the import that created this record.
DisplayName Import Sequence Number
Format None
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName importsequencenumber
MaxValue 2147483647
MinValue -2147483648
RequiredLevel None
Type Integer

IsPriceLocked

Property Value
Description Select whether prices specified on the invoice are locked from any further updates.
DisplayName Prices Locked
IsValidForCreate False
IsValidForForm True
IsValidForRead True
LogicalName ispricelocked
RequiredLevel ApplicationRequired
Type Boolean

IsPriceLocked Choices/Options

Value Label Description
1 Yes
0 No

DefaultValue: 0

LastBackofficeSubmit

Property Value
DateTimeBehavior UserLocal
Description Enter the date and time when the order was last submitted to an accounting or ERP system for processing.
DisplayName Last Submitted to Back Office
Format DateOnly
IsValidForForm True
IsValidForRead True
LogicalName lastbackofficesubmit
RequiredLevel None
Type DateTime

LastOnHoldTime

Property Value
DateTimeBehavior UserLocal
Description Contains the date time stamp of the last on hold time.
DisplayName Last On Hold Time
Format DateAndTime
IsValidForForm True
IsValidForRead True
LogicalName lastonholdtime
RequiredLevel None
Type DateTime

Name

Property Value
Description Type a descriptive name for the order.
DisplayName Name
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName name
MaxLength 300
RequiredLevel ApplicationRequired
Type String

OpportunityId

Property Value
Description Choose the related opportunity so that the data for the order and opportunity are linked for reporting and analytics.
DisplayName Opportunity
IsValidForForm True
IsValidForRead True
LogicalName opportunityid
RequiredLevel None
Targets opportunity
Type Lookup

OrderCreationMethod

Added by: Sales Patch Version 3 Solution

Property Value
Description
DisplayName Creation Method
IsValidForForm True
IsValidForRead True
LogicalName ordercreationmethod
RequiredLevel None
Type Picklist

OrderCreationMethod Choices/Options

Value Label Description
776160000 Unknown
776160001 Win Quote

OrderNumber

Property Value
Description Shows the order number for customer reference and to use in search. The number cannot be modified.
DisplayName Order ID
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
IsValidForUpdate False
LogicalName ordernumber
MaxLength 100
RequiredLevel SystemRequired
Type String

OverriddenCreatedOn

Property Value
DateTimeBehavior UserLocal
Description Date and time that the record was migrated.
DisplayName Record Created On
Format DateOnly
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName overriddencreatedon
RequiredLevel None
Type DateTime

OwnerId

Property Value
Description Owner Id
DisplayName Owner
IsValidForForm True
IsValidForRead True
LogicalName ownerid
RequiredLevel SystemRequired
Targets systemuser,team
Type Owner

OwnerIdType

Added by: Active Solution Solution

Property Value
Description Owner Id Type
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName owneridtype
RequiredLevel SystemRequired
Type EntityName

PaymentTermsCode

Property Value
Description Select the payment terms to indicate when the customer needs to pay the total amount.
DisplayName Payment Terms
IsValidForForm True
IsValidForRead True
LogicalName paymenttermscode
RequiredLevel None
Type Picklist

PaymentTermsCode Choices/Options

Value Label Description
1 Net 30
2 2% 10, Net 30
3 Net 45
4 Net 60

PriceLevelId

Property Value
Description Choose the price list associated with this record to make sure the products associated with the campaign are offered at the correct prices.
DisplayName Price List
IsValidForForm True
IsValidForRead True
LogicalName pricelevelid
RequiredLevel ApplicationRequired
Targets pricelevel
Type Lookup

PricingErrorCode

Property Value
Description Select the type of pricing error, such as a missing or invalid product, or missing quantity.
DisplayName Pricing Error
IsValidForForm False
IsValidForRead True
LogicalName pricingerrorcode
RequiredLevel None
Type Picklist

PricingErrorCode Choices/Options

Value Label Description
0 None
1 Detail Error
2 Missing Price Level
3 Inactive Price Level
4 Missing Quantity
5 Missing Unit Price
6 Missing Product
7 Invalid Product
8 Missing Pricing Code
9 Invalid Pricing Code
10 Missing UOM
11 Product Not In Price Level
12 Missing Price Level Amount
13 Missing Price Level Percentage
14 Missing Price
15 Missing Current Cost
16 Missing Standard Cost
17 Invalid Price Level Amount
18 Invalid Price Level Percentage
19 Invalid Price
20 Invalid Current Cost
21 Invalid Standard Cost
22 Invalid Rounding Policy
23 Invalid Rounding Option
24 Invalid Rounding Amount
25 Price Calculation Error
26 Invalid Discount Type
27 Discount Type Invalid State
28 Invalid Discount
29 Invalid Quantity
30 Invalid Pricing Precision
31 Missing Product Default UOM
32 Missing Product UOM Schedule
33 Inactive Discount Type
34 Invalid Price Level Currency
35 Price Attribute Out Of Range
36 Base Currency Attribute Overflow
37 Base Currency Attribute Underflow
38 Transaction currency is not set for the product price list item

PriorityCode

Property Value
Description Select the priority so that preferred customers or critical issues are handled quickly.
DisplayName Priority
IsValidForForm True
IsValidForRead True
LogicalName prioritycode
RequiredLevel None
Type Picklist

PriorityCode Choices/Options

Value Label Description
1 Default Value

ProcessId

Property Value
Description Contains the id of the process associated with the entity.
DisplayName Process Id
IsValidForForm False
IsValidForRead True
LogicalName processid
RequiredLevel None
Type Uniqueidentifier

QuoteId

Property Value
Description Choose the related quote so that order data and quote data are linked for reporting and analytics.
DisplayName Quote
IsValidForForm True
IsValidForRead True
LogicalName quoteid
RequiredLevel None
Targets quote
Type Lookup

RequestDeliveryBy

Property Value
DateTimeBehavior UserLocal
Description Enter the delivery date requested by the customer for all products in the order.
DisplayName Requested Delivery Date
Format DateOnly
IsValidForForm True
IsValidForRead True
LogicalName requestdeliveryby
RequiredLevel None
Type DateTime

SalesOrderId

Property Value
Description Unique identifier of the order.
DisplayName Order
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName salesorderid
RequiredLevel SystemRequired
Type Uniqueidentifier

ShippingMethodCode

Property Value
Description Select a shipping method for deliveries sent to this address.
DisplayName Shipping Method
IsValidForForm True
IsValidForRead True
LogicalName shippingmethodcode
RequiredLevel None
Type Picklist

ShippingMethodCode Choices/Options

Value Label Description
1 Airborne
2 DHL
3 FedEx
4 UPS
5 Postal Mail
6 Full Load
7 Will Call

ShipTo_AddressId

Property Value
Description Unique identifier of the shipping address.
DisplayName Ship To Address ID
IsValidForForm False
IsValidForRead True
LogicalName shipto_addressid
RequiredLevel None
Type Uniqueidentifier

ShipTo_City

Property Value
Description Type the city for the customer's shipping address.
DisplayName Ship To City
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName shipto_city
MaxLength 80
RequiredLevel None
Type String

ShipTo_ContactName

Property Value
Description Type the primary contact name at the customer's shipping address.
DisplayName Ship To Contact Name
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName shipto_contactname
MaxLength 150
RequiredLevel None
Type String

ShipTo_Country

Property Value
Description Type the country or region for the customer's shipping address.
DisplayName Ship To Country/Region
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName shipto_country
MaxLength 80
RequiredLevel None
Type String

ShipTo_Fax

Property Value
Description Type the fax number for the customer's shipping address.
DisplayName Ship to Fax
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName shipto_fax
MaxLength 50
RequiredLevel None
Type String

ShipTo_FreightTermsCode

Property Value
Description Select the freight terms to make sure shipping orders are processed correctly.
DisplayName Ship To Freight Terms
IsValidForForm True
IsValidForRead True
LogicalName shipto_freighttermscode
RequiredLevel None
Type Picklist

ShipTo_FreightTermsCode Choices/Options

Value Label Description
1 Default Value

ShipTo_Line1

Property Value
Description Type the first line of the customer's shipping address.
DisplayName Ship To Street 1
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName shipto_line1
MaxLength 250
RequiredLevel None
Type String

ShipTo_Line2

Property Value
Description Type the second line of the customer's shipping address.
DisplayName Ship To Street 2
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName shipto_line2
MaxLength 250
RequiredLevel None
Type String

ShipTo_Line3

Property Value
Description Type the third line of the shipping address.
DisplayName Ship To Street 3
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName shipto_line3
MaxLength 250
RequiredLevel None
Type String

ShipTo_Name

Property Value
Description Type a name for the customer's shipping address, such as "Headquarters" or "Field office", to identify the address.
DisplayName Ship To Name
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName shipto_name
MaxLength 200
RequiredLevel None
Type String

ShipTo_PostalCode

Property Value
Description Type the ZIP Code or postal code for the shipping address.
DisplayName Ship To ZIP/Postal Code
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName shipto_postalcode
MaxLength 20
RequiredLevel None
Type String

ShipTo_StateOrProvince

Property Value
Description Type the state or province for the shipping address.
DisplayName Ship To State/Province
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName shipto_stateorprovince
MaxLength 50
RequiredLevel None
Type String

ShipTo_Telephone

Property Value
Description Type the phone number for the customer's shipping address.
DisplayName Ship To Phone
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName shipto_telephone
MaxLength 50
RequiredLevel None
Type String

SkipPriceCalculation

Added by: Sales Patch Solution

Property Value
Description Skip Price Calculation
DisplayName Skip Price Calculation (For Internal Use)
IsValidForForm False
IsValidForRead True
LogicalName skippricecalculation
RequiredLevel None
Type Picklist

SkipPriceCalculation Choices/Options

Value Label Description
0 DoPriceCalcAlways
1 SkipPriceCalcOnRetrieve

SLAId

Property Value
Description Choose the service level agreement (SLA) that you want to apply to the sales order record.
DisplayName SLA
IsValidForForm True
IsValidForRead True
LogicalName slaid
RequiredLevel None
Targets sla
Type Lookup

StageId

Property Value
Description Contains the id of the stage where the entity is located.
DisplayName (Deprecated) Stage Id
IsValidForForm False
IsValidForRead True
LogicalName stageid
RequiredLevel None
Type Uniqueidentifier

StateCode

Property Value
Description Shows whether the order is active, submitted, fulfilled, canceled, or invoiced. Only active orders can be edited.
DisplayName Status
IsValidForCreate False
IsValidForForm True
IsValidForRead True
LogicalName statecode
RequiredLevel SystemRequired
Type State

StateCode Choices/Options

Value Label DefaultStatus InvariantName
0 Active 1 Active
1 Submitted 3 Submitted
2 Canceled 4 Canceled
3 Fulfilled 100001 Fulfilled
4 Invoiced 100003 Invoiced

StatusCode

Property Value
Description Select the order's status.
DisplayName Status Reason
IsValidForForm True
IsValidForRead True
LogicalName statuscode
RequiredLevel None
Type Status

StatusCode Choices/Options

Value Label State
1 New 0
2 Pending 0
3 In Progress 1
4 No Money 2
100001 Complete 3
100002 Partial 3
100003 Invoiced 4

SubmitDate

Property Value
DateTimeBehavior UserLocal
Description Enter the date when the order was submitted to the fulfillment or shipping center.
DisplayName Date Submitted
Format DateOnly
IsValidForForm True
IsValidForRead True
LogicalName submitdate
RequiredLevel None
Type DateTime

SubmitStatus

Property Value
Description Type the code for the submitted status in the fulfillment or shipping center system.
DisplayName Submitted Status
Format None
IsValidForForm True
IsValidForRead True
LogicalName submitstatus
MaxValue 1000000000
MinValue 0
RequiredLevel None
Type Integer

SubmitStatusDescription

Property Value
Description Type additional details or notes about the order for the fulfillment or shipping center.
DisplayName Submitted Status Description
Format Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName submitstatusdescription
MaxLength 2000
RequiredLevel None
Type Memo

TimeZoneRuleVersionNumber

Property Value
Description For internal use only.
DisplayName Time Zone Rule Version Number
Format None
IsValidForForm False
IsValidForRead True
LogicalName timezoneruleversionnumber
MaxValue 2147483647
MinValue -1
RequiredLevel None
Type Integer

TotalAmount

Property Value
Description Shows the total amount due, calculated as the sum of the products, discounts, freight, and taxes for the order.
DisplayName Total Amount
IsValidForCreate False
IsValidForForm True
IsValidForRead True
LogicalName totalamount
MaxValue 922337203685477
MinValue -922337203685477
Precision 2
PrecisionSource 2
RequiredLevel None
Type Money

TotalAmountLessFreight

Property Value
Description Shows the total product amount for the order, minus any discounts. This value is added to freight and tax amounts in the calculation for the total amount due for the order.
DisplayName Total Pre-Freight Amount
IsValidForCreate False
IsValidForForm True
IsValidForRead True
LogicalName totalamountlessfreight
MaxValue 922337203685477
MinValue -922337203685477
Precision 2
PrecisionSource 2
RequiredLevel None
Type Money

TotalDiscountAmount

Property Value
Description Shows the total discount amount, based on the discount price and rate entered on the order.
DisplayName Total Discount Amount
IsValidForCreate False
IsValidForForm True
IsValidForRead True
LogicalName totaldiscountamount
MaxValue 922337203685477
MinValue -922337203685477
Precision 2
PrecisionSource 2
RequiredLevel None
Type Money

TotalLineItemAmount

Property Value
Description Shows the sum of all existing and write-in products included on the order, based on the specified price list and quantities.
DisplayName Total Detail Amount
IsValidForCreate False
IsValidForForm True
IsValidForRead True
LogicalName totallineitemamount
MaxValue 922337203685477
MinValue -922337203685477
Precision 2
PrecisionSource 2
RequiredLevel None
Type Money

TotalLineItemDiscountAmount

Property Value
Description Shows the total of the Manual Discount amounts specified on all products included in the order. This value is reflected in the Detail Amount field on the order and is added to any discount amount or rate specified on the order.
DisplayName Total Line Item Discount Amount
IsValidForCreate False
IsValidForForm True
IsValidForRead True
LogicalName totallineitemdiscountamount
MaxValue 922337203685477
MinValue -922337203685477
Precision 2
PrecisionSource 2
RequiredLevel None
Type Money

TotalTax

Property Value
Description Shows the Tax amounts specified on all products included in the order, included in the Total Amount due calculation for the order.
DisplayName Total Tax
IsValidForCreate False
IsValidForForm True
IsValidForRead True
LogicalName totaltax
MaxValue 922337203685477
MinValue -922337203685477
Precision 2
PrecisionSource 2
RequiredLevel None
Type Money

TransactionCurrencyId

Property Value
Description Choose the local currency for the record to make sure budgets are reported in the correct currency.
DisplayName Currency
IsValidForForm True
IsValidForRead True
IsValidForUpdate False
LogicalName transactioncurrencyid
RequiredLevel ApplicationRequired
Targets transactioncurrency
Type Lookup

TraversedPath

Property Value
Description A comma separated list of string values representing the unique identifiers of stages in a Business Process Flow Instance in the order that they occur.
DisplayName (Deprecated) Traversed Path
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName traversedpath
MaxLength 1250
RequiredLevel None
Type String

UTCConversionTimeZoneCode

Property Value
Description Time zone code that was in use when the record was created.
DisplayName UTC Conversion Time Zone Code
Format None
IsValidForForm False
IsValidForRead True
LogicalName utcconversiontimezonecode
MaxValue 2147483647
MinValue -1
RequiredLevel None
Type Integer

WillCall

Property Value
Description Select whether the products included in the order should be shipped to the specified address or held until the customer calls with further pick-up or delivery instructions.
DisplayName Ship To
IsValidForForm True
IsValidForRead True
LogicalName willcall
RequiredLevel None
Type Boolean

WillCall Choices/Options

Value Label Description
1 Will Call
0 Address

DefaultValue: 0

Read-only columns/attributes

These columns/attributes return false for both IsValidForCreate or IsValidForUpdate. Listed by SchemaName.

AccountId

Property Value
Description Shows the parent account related to the record. This information is used to link the sales order to the account selected in the Customer field for reporting and analytics.
DisplayName Account
IsValidForForm False
IsValidForRead True
LogicalName accountid
RequiredLevel None
Targets account
Type Lookup

AccountIdName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName accountidname
MaxLength 100
RequiredLevel None
Type String

AccountIdYomiName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName accountidyominame
MaxLength 100
RequiredLevel None
Type String

BillTo_Composite

Property Value
Description Shows the complete Bill To address.
DisplayName Bill To Address
Format TextArea
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName billto_composite
MaxLength 1000
RequiredLevel None
Type Memo

CampaignIdName

Added by: Marketing Sales Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName campaignidname
MaxLength 100
RequiredLevel None
Type String

ContactId

Property Value
Description Shows the parent contact related to the record. This information is used to link the contract to the contact selected in the Customer field for reporting and analytics.
DisplayName Contact
IsValidForForm False
IsValidForRead True
LogicalName contactid
RequiredLevel None
Targets contact
Type Lookup

ContactIdName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName contactidname
MaxLength 100
RequiredLevel None
Type String

ContactIdYomiName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName contactidyominame
MaxLength 100
RequiredLevel None
Type String

CreatedBy

Property Value
Description Shows who created the record.
DisplayName Created By
IsValidForForm True
IsValidForRead True
LogicalName createdby
RequiredLevel None
Targets systemuser
Type Lookup

CreatedByName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdbyname
MaxLength 100
RequiredLevel None
Type String

CreatedByYomiName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdbyyominame
MaxLength 100
RequiredLevel None
Type String

CreatedOn

Property Value
DateTimeBehavior UserLocal
Description Date and time when the record was created.
DisplayName Created On
Format DateAndTime
IsValidForForm True
IsValidForRead True
LogicalName createdon
RequiredLevel None
Type DateTime

CreatedOnBehalfBy

Property Value
Description Shows who created the record on behalf of another user.
DisplayName Created By (Delegate)
IsValidForForm True
IsValidForRead True
LogicalName createdonbehalfby
RequiredLevel None
Targets systemuser
Type Lookup

CreatedOnBehalfByName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdonbehalfbyname
MaxLength 100
RequiredLevel None
Type String

CreatedOnBehalfByYomiName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdonbehalfbyyominame
MaxLength 100
RequiredLevel None
Type String

CustomerIdName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName customeridname
MaxLength 160
RequiredLevel ApplicationRequired
Type String

CustomerIdYomiName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName customeridyominame
MaxLength 450
RequiredLevel ApplicationRequired
Type String

DiscountAmount_Base

Property Value
Description Value of the Order Discount Amount in base currency.
DisplayName Order Discount Amount (Base)
IsValidForForm True
IsValidForRead True
LogicalName discountamount_base
MaxValue 922337203685477
MinValue -922337203685477
Precision 4
PrecisionSource 2
RequiredLevel None
Type Money

EntityImage_Timestamp

Property Value
Description
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName entityimage_timestamp
MaxValue 9223372036854775807
MinValue -9223372036854775808
RequiredLevel None
Type BigInt

EntityImage_URL

Property Value
Description
DisplayName
FormatName Url
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName entityimage_url
MaxLength 200
RequiredLevel None
Type String

EntityImageId

Property Value
Description
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName entityimageid
RequiredLevel None
Type Uniqueidentifier

ExchangeRate

Added by: Active Solution Solution

Property Value
Description Shows the conversion rate of the record's currency. The exchange rate is used to convert all money fields in the record from the local currency to the system's default currency.
DisplayName Exchange Rate
IsValidForForm True
IsValidForRead True
LogicalName exchangerate
MaxValue 100000000000
MinValue 0.000000000001
Precision 12
RequiredLevel None
Type Decimal

FreightAmount_Base

Property Value
Description Value of the Freight Amount in base currency.
DisplayName Freight Amount (Base)
IsValidForForm True
IsValidForRead True
LogicalName freightamount_base
MaxValue 922337203685477
MinValue -922337203685477
Precision 4
PrecisionSource 2
RequiredLevel None
Type Money

ModifiedBy

Property Value
Description Shows who last updated the record.
DisplayName Modified By
IsValidForForm True
IsValidForRead True
LogicalName modifiedby
RequiredLevel None
Targets systemuser
Type Lookup

ModifiedByName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedbyname
MaxLength 100
RequiredLevel None
Type String

ModifiedByYomiName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedbyyominame
MaxLength 100
RequiredLevel None
Type String

ModifiedOn

Property Value
DateTimeBehavior UserLocal
Description Date and time when the record was modified.
DisplayName Modified On
Format DateAndTime
IsValidForForm True
IsValidForRead True
LogicalName modifiedon
RequiredLevel None
Type DateTime

ModifiedOnBehalfBy

Property Value
Description Shows who last updated the record on behalf of another user.
DisplayName Modified By (Delegate)
IsValidForForm True
IsValidForRead True
LogicalName modifiedonbehalfby
RequiredLevel None
Targets systemuser
Type Lookup

ModifiedOnBehalfByName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedonbehalfbyname
MaxLength 100
RequiredLevel None
Type String

ModifiedOnBehalfByYomiName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedonbehalfbyyominame
MaxLength 100
RequiredLevel None
Type String

OnHoldTime

Property Value
Description Shows the duration in minutes for which the order was on hold.
DisplayName On Hold Time (Minutes)
Format None
IsValidForForm True
IsValidForRead True
LogicalName onholdtime
MaxValue 2147483647
MinValue -2147483648
RequiredLevel None
Type Integer

OpportunityIdName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName opportunityidname
MaxLength 100
RequiredLevel None
Type String

OwnerIdName

Property Value
Description Name of the owner
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName owneridname
MaxLength 100
RequiredLevel SystemRequired
Type String

OwnerIdYomiName

Property Value
Description Yomi name of the owner
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName owneridyominame
MaxLength 100
RequiredLevel SystemRequired
Type String

OwningBusinessUnit

Property Value
Description Unique identifier for the business unit that owns the record
DisplayName Owning Business Unit
IsValidForForm True
IsValidForRead True
LogicalName owningbusinessunit
RequiredLevel None
Targets businessunit
Type Lookup

OwningBusinessUnitName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName owningbusinessunitname
MaxLength 100
RequiredLevel SystemRequired
Type String

OwningTeam

Property Value
Description Unique identifier for the team that owns the record.
DisplayName Owning Team
IsValidForForm False
IsValidForRead True
LogicalName owningteam
RequiredLevel None
Targets team
Type Lookup

OwningUser

Property Value
Description Unique identifier for the user that owns the record.
DisplayName Owning User
IsValidForForm False
IsValidForRead True
LogicalName owninguser
RequiredLevel None
Targets systemuser
Type Lookup

PriceLevelIdName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName pricelevelidname
MaxLength 100
RequiredLevel SystemRequired
Type String

QuoteIdName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName quoteidname
MaxLength 100
RequiredLevel None
Type String

ShipTo_Composite

Property Value
Description Shows the complete Ship To address.
DisplayName Ship To Address
Format TextArea
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName shipto_composite
MaxLength 1000
RequiredLevel None
Type Memo

SLAInvokedId

Property Value
Description Last SLA that was applied to this sales order. This field is for internal use only.
DisplayName Last SLA applied
IsValidForForm False
IsValidForRead True
LogicalName slainvokedid
RequiredLevel None
Targets sla
Type Lookup

SLAInvokedIdName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName slainvokedidname
MaxLength 100
RequiredLevel None
Type String

SLAName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName slaname
MaxLength 100
RequiredLevel None
Type String

TotalAmount_Base

Property Value
Description Value of the Total Amount in base currency.
DisplayName Total Amount (Base)
IsValidForForm True
IsValidForRead True
LogicalName totalamount_base
MaxValue 922337203685477
MinValue -922337203685477
Precision 4
PrecisionSource 2
RequiredLevel None
Type Money

TotalAmountLessFreight_Base

Property Value
Description Value of the Total Pre-Freight Amount in base currency.
DisplayName Total Pre-Freight Amount (Base)
IsValidForForm True
IsValidForRead True
LogicalName totalamountlessfreight_base
MaxValue 922337203685477
MinValue -922337203685477
Precision 4
PrecisionSource 2
RequiredLevel None
Type Money

TotalDiscountAmount_Base

Property Value
Description Value of the Total Discount Amount in base currency.
DisplayName Total Discount Amount (Base)
IsValidForForm True
IsValidForRead True
LogicalName totaldiscountamount_base
MaxValue 922337203685477
MinValue -922337203685477
Precision 4
PrecisionSource 2
RequiredLevel None
Type Money

TotalLineItemAmount_Base

Property Value
Description Value of the Total Detail Amount in base currency.
DisplayName Total Detail Amount (Base)
IsValidForForm True
IsValidForRead True
LogicalName totallineitemamount_base
MaxValue 922337203685477
MinValue -922337203685477
Precision 4
PrecisionSource 2
RequiredLevel None
Type Money

TotalLineItemDiscountAmount_Base

Property Value
Description Value of the Total Line Item Discount Amount in base currency.
DisplayName Total Line Item Discount Amount (Base)
IsValidForForm True
IsValidForRead True
LogicalName totallineitemdiscountamount_base
MaxValue 922337203685477
MinValue -922337203685477
Precision 4
PrecisionSource 2
RequiredLevel None
Type Money

TotalTax_Base

Property Value
Description Value of the Total Tax in base currency.
DisplayName Total Tax (Base)
IsValidForForm True
IsValidForRead True
LogicalName totaltax_base
MaxValue 922337203685477
MinValue -922337203685477
Precision 4
PrecisionSource 2
RequiredLevel None
Type Money

TransactionCurrencyIdName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName transactioncurrencyidname
MaxLength 100
RequiredLevel None
Type String

VersionNumber

Property Value
Description Version Number
DisplayName Version Number
IsValidForForm False
IsValidForRead True
LogicalName versionnumber
MaxValue 9223372036854775807
MinValue -9223372036854775808
RequiredLevel None
Type BigInt

One-To-Many Relationships

Listed by SchemaName.

lk_opportunitysalesprocess_salesorderid

Same as the lk_opportunitysalesprocess_salesorderid many-to-one relationship for the opportunitysalesprocess table/entity.

Property Value
ReferencingEntity opportunitysalesprocess
ReferencingAttribute salesorderid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName salesorder_opportunitysalesprocess
AssociatedMenuConfiguration Behavior: UseCollectionName
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

order_invoices

Same as the order_invoices many-to-one relationship for the invoice table/entity.

Property Value
ReferencingEntity invoice
ReferencingAttribute salesorderid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName order_invoices
AssociatedMenuConfiguration Behavior: UseCollectionName
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Restrict
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

SalesOrder_OrderClose

Same as the SalesOrder_OrderClose many-to-one relationship for the orderclose table/entity.

Property Value
ReferencingEntity orderclose
ReferencingAttribute salesorderid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName SalesOrder_OrderClose
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: Cascade
Delete: Cascade
Merge: NoCascade
Reparent: Cascade
Share: Cascade
Unshare: Cascade

order_details

Same as the order_details many-to-one relationship for the salesorderdetail table/entity.

Property Value
ReferencingEntity salesorderdetail
ReferencingAttribute salesorderid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName order_details
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

Many-To-One Relationships

Each Many-To-One relationship is defined by a corresponding One-To-Many relationship with the related table. Listed by SchemaName.

order_customer_accounts

Added by: System Solution Solution

See the order_customer_accounts one-to-many relationship for the account table/entity.

order_customer_contacts

Added by: System Solution Solution

See the order_customer_contacts one-to-many relationship for the contact table/entity.

opportunity_sales_orders

See the opportunity_sales_orders one-to-many relationship for the opportunity table/entity.

price_level_orders

Added by: Product Management Solution

See the price_level_orders one-to-many relationship for the pricelevel table/entity.

quote_orders

See the quote_orders one-to-many relationship for the quote table/entity.

campaign_orders

Added by: Marketing Solution

See the campaign_orders one-to-many relationship for the campaign table/entity.

Many-To-Many Relationships

Relationship details provided where the SalesOrder table is the first table in the relationship. Listed by SchemaName.

contactorders_association

IntersectEntityName: contactorders

Table 1

Property Value
IntersectAttribute salesorderid
IsCustomizable False
LogicalName salesorder
NavigationPropertyName contactorders_association
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:

Table 2

Property Value
LogicalName contact
IntersectAttribute contactid
NavigationPropertyName contactorders_association
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:

Dataverse table/entity reference
Web API Reference