SalesOrder (Order) Entity Metadata

  • Article

[Applies to: Microsoft Dynamics CRM 2011]

The following information is for the sales order (order) entity in a default, uncustomized installation of Microsoft Dynamics CRM. The schema name and early bound class for this entity is SalesOrder.

To view the entity metadata for your organization, install the Metadata Browser solution described in Browse the Metadata for Your Organization.

In This Topic

Entity Metadata

Entity Metadata

The following table shows the metadata for the sales order (order) entity.

Entity metadata property Value

EntityLogicalName

salesorder

DisplayName

Order

DisplayCollectionName

Orders

OTC

1088

OwnershipType

UserOwned

IsCustomizable

True

IsAvailableOffline

True

AutoRouteToOwnerQueue

False

CanBeInManyToMany

True

CanBePrimaryEntityInRelationship

True

CanBeRelatedEntityInRelationship

True

CanCreateAttributes

True

CanCreateCharts

True

CanCreateForms

True

CanCreateViews

True

CanModifyAdditionalSettings

True

CanTriggerWorkflow

True

IsActivity

False

IsActivityParty

True

IsAuditEnabled

False

IsChildEntity

False

IsConnectionsEnabled

canmodifyconnectionsettings

IsCustomEntity

False

IsDocumentManagementEnabled

False

IsDuplicateDetectionEnabled

False

IsEnabledForCharts

True

IsImportable

True

IsIntersect

False

IsMailMergeEnabled

False

IsManaged

True

IsMappable

True

IsReadingPaneEnabled

True

IsRenameable

True

IsValidForAdvancedFind

True

IsValidForQueue

False

IsVisibleInMobile

False

PrimaryIdAttribute

salesorderid

PrimaryNameAttribute

name

ReportViewName

FilteredSalesOrder

RecurrenceBaseEntityLogicalName

Description

Quote that has been accepted.

Privilege Metadata

The following table shows the privilege metadata for the sales order (order) entity.

PrivilegeName Id Type CanBeBasic CanBeDeep CanBeGlobal CanBeLocal

prvAppendOrder

1dcf75fe-3540-4f93-84bb-d1e8eec6c8d9

Append

True

True

True

True

prvAppendToOrder

45b189d7-adb7-474b-857b-98783812f7f6

AppendTo

True

True

True

True

prvAssignOrder

f9388c46-82ac-455c-8fcf-628351169404

Assign

True

True

True

True

prvCreateOrder

83f518e2-f311-4bb4-894f-a7ee55e558a7

Create

True

True

True

True

prvDeleteOrder

ceb5cfae-f745-4a60-8023-b5b203c72e34

Delete

True

True

True

True

prvOverridePriceEngineOrder

0186f903-2b6a-4230-9838-0b64080a7568

None

True

True

True

True

prvReadOrder

6f81b089-36d1-476e-8519-33df34aefe11

Read

True

True

True

True

prvShareOrder

7bb2363e-aeae-44c9-adc9-d1f13fc355c1

Share

True

True

True

True

prvWriteOrder

13121f22-3211-44d5-ab17-adcf699cf0eb

Write

True

True

True

True

Attribute Metadata

The following table shows the attribute metadata for the sales order entity.

LogicalName SchemaName DisplayName Type RequiredLevel IsValidForCreate IsValidForRead IsValidForUpdate CanBeSecuredForCreate CanBeSecuredForRead CanBeSecuredForUpdate IsAuditEnabled IsCustomAttribute IsCustomizable IsManaged IsPrimaryId IsPrimaryName IsRenameable IsSecured IsValidForAdvancedFind Description DeprecatedVersion

accountid

AccountId

Account

Lookup

None

False

True

False

False

False

False

True

False

True

True

False

False

False

False

False

Unique identifier of the account associated with the order.

billto_addressid

BillTo_AddressId

Bill To Address ID

Uniqueidentifier

None

True

True

True

False

False

False

False

False

False

True

False

False

False

False

False

Unique identifier of the billing address.

billto_city

BillTo_City

Bill To City

String

None

True

True

True

False

False

False

True

False

True

True

False

False

True

False

True

City name in the billing address.

billto_contactname

BillTo_ContactName

Bill To Contact Name

String

None

True

True

True

False

False

False

True

False

True

True

False

False

True

False

True

Contact name for the billing address.

billto_country

BillTo_Country

Bill To Country/Region

String

None

True

True

True

False

False

False

True

False

True

True

False

False

True

False

True

Country/region name in the billing address.

billto_fax

BillTo_Fax

Bill To Fax

String

None

True

True

True

False

False

False

True

False

True

True

False

False

True

False

True

Fax number for the billing address.

billto_line1

BillTo_Line1

Bill To Street 1

String

None

True

True

True

False

False

False

True

False

True

True

False

False

True

False

True

First line for entering billing address information.

billto_line2

BillTo_Line2

Bill To Street 2

String

None

True

True

True

False

False

False

True

False

True

True

False

False

True

False

True

Second line for entering billing address information.

billto_line3

BillTo_Line3

Bill To Street 3

String

None

True

True

True

False

False

False

True

False

True

True

False

False

True

False

True

Third line for entering billing address information.

billto_name

BillTo_Name

Bill To Name

String

None

True

True

True

False

False

False

True

False

True

True

False

False

True

False

True

Name to enter for the billing address.

billto_postalcode

BillTo_PostalCode

Bill To ZIP/Postal Code

String

None

True

True

True

False

False

False

True

False

True

True

False

False

True

False

True

ZIP Code or postal code in the billing address.

billto_stateorprovince

BillTo_StateOrProvince

Bill To State/Province

String

None

True

True

True

False

False

False

True

False

True

True

False

False

True

False

True

State or province in the billing address.

billto_telephone

BillTo_Telephone

Bill To Phone

String

None

True

True

True

False

False

False

True

False

True

True

False

False

True

False

True

Telephone number associated with the billing address.

campaignid

CampaignId

Source Campaign

Lookup

None

True

True

True

False

False

False

True

False

True

True

False

False

True

False

True

Unique identifier of the source campaign associated with the order.

contactid

ContactId

Contact

Lookup

None

False

True

False

False

False

False

True

False

True

True

False

False

False

False

False

Unique identifier of the contact associated with the order.

createdby

CreatedBy

Created By

Lookup

None

False

True

False

False

False

False

False

False

True

True

False

False

True

False

True

Unique identifier of the user who created the order.

createdon

CreatedOn

Created On

DateTime

None

False

True

False

False

False

False

False

False

True

True

False

False

True

False

True

Date and time when the order was created.

createdonbehalfby

CreatedOnBehalfBy

Created By (Delegate)

Lookup

None

False

True

False

False

False

False

False

False

True

True

False

False

True

False

True

Unique identifier of the delegate user who created the salesorder.

customerid

CustomerId

Customer

Customer

SystemRequired

True

True

True

False

False

False

True

False

True

True

False

False

True

False

True

Unique identifier for the account or contact associated with the order.

datefulfilled

DateFulfilled

Date Fulfilled

DateTime

None

True

True

True

False

False

False

True

False

True

True

False

False

True

False

True

Date on which the order was fulfilled.

description

Description

Description

Memo

None

True

True

True

False

False

False

True

False

True

True

False

False

True

False

True

Description of the order.

discountamount

DiscountAmount

Order Discount Amount

Money

None

True

True

True

False

False

False

True

False

True

True

False

False

True

False

True

Discount specified as a monetary amount for the order.

discountamount_base

DiscountAmount_Base

Order Discount Amount (Base)

Money

None

False

True

False

False

False

False

True

False

True

True

False

False

True

False

True

Base currency equivalent of the discount specified as a monetary amount for the order.

discountpercentage

DiscountPercentage

Order Discount (%)

Decimal

None

True

True

True

False

False

False

True

False

True

True

False

False

True

False

True

Discount specified as a percentage for the order.

exchangerate

ExchangeRate

Exchange Rate

Decimal

None

False

True

False

False

False

False

True

False

True

True

False

False

True

False

True

Exchange rate for the currency associated with the sales order with respect to the base currency.

freightamount

FreightAmount

Freight Amount

Money

None

True

True

True

False

False

False

True

False

True

True

False

False

True

False

True

Cost of freight for the order.

freightamount_base

FreightAmount_Base

Freight Amount (Base)

Money

None

False

True

False

False

False

False

True

False

True

True

False

False

True

False

True

Base currency equivalent of the cost of freight for the order.

freighttermscode

FreightTermsCode

Freight Terms

Picklist

None

True

True

True

False

False

False

True

False

True

True

False

False

True

False

True

Freight terms for the order.

importsequencenumber

ImportSequenceNumber

Import Sequence Number

Integer

None

True

True

False

False

False

False

True

False

True

True

False

False

True

False

True

Unique identifier of the data import or data migration that created this record.

ispricelocked

IsPriceLocked

Prices Locked

Boolean

ApplicationRequired

False

True

False

False

False

False

True

False

True

True

False

False

True

False

True

Information that specifies whether the order pricing is locked.

lastbackofficesubmit

LastBackofficeSubmit

Last Submitted to Backoffice

DateTime

None

True

True

True

False

False

False

True

False

True

True

False

False

True

False

True

Date and time when the order was last submitted to Microsoft Great Plains.

modifiedby

ModifiedBy

Modified By

Lookup

None

False

True

False

False

False

False

False

False

True

True

False

False

True

False

True

Unique identifier of the user who last modified the order.

modifiedon

ModifiedOn

Modified On

DateTime

None

False

True

False

False

False

False

False

False

True

True

False

False

True

False

True

Date and time when the order was last modified.

modifiedonbehalfby

ModifiedOnBehalfBy

Modified By (Delegate)

Lookup

None

False

True

False

False

False

False

False

False

True

True

False

False

True

False

True

Unique identifier of the delegate user who last modified the salesorder.

name

Name

Name

String

ApplicationRequired

True

True

True

False

False

False

True

False

True

True

False

True

True

False

True

Name of the order.

opportunityid

OpportunityId

Opportunity

Lookup

None

True

True

True

False

False

False

True

False

True

True

False

False

True

False

True

Unique identifier of the opportunity with which the order is associated.

ordernumber

OrderNumber

Order ID

String

SystemRequired

True

True

False

False

False

False

True

False

True

True

False

False

True

False

True

Order number.

overriddencreatedon

OverriddenCreatedOn

Record Created On

DateTime

None

True

True

False

False

False

False

True

False

True

True

False

False

True

False

True

Date and time that the record was migrated.

ownerid

OwnerId

Owner

Owner

SystemRequired

True

True

False

False

False

False

True

False

True

True

False

False

True

False

True

Unique identifier of the user or team who owns the order.

owningbusinessunit

OwningBusinessUnit

Owning Business Unit

Lookup

None

False

True

False

False

False

False

False

False

True

True

False

False

False

False

False

Unique identifier of the business unit that owns the order.

owningteam

OwningTeam

Owning Team

Lookup

None

False

True

False

False

False

False

False

False

True

True

False

False

False

False

False

Unique identifier of the team who owns the order.

owninguser

OwningUser

Owning User

Lookup

None

False

True

False

False

False

False

False

False

True

True

False

False

False

False

False

Unique identifier of the user who owns the order.

paymenttermscode

PaymentTermsCode

Payment Terms

Picklist

None

True

True

True

False

False

False

True

False

True

True

False

False

True

False

True

Payment terms for the order.

pricelevelid

PriceLevelId

Price List

Lookup

ApplicationRequired

True

True

True

False

False

False

True

False

True

True

False

False

True

False

True

Unique identifier of the price list associated with the order.

pricingerrorcode

PricingErrorCode

Pricing Error

Picklist

None

True

True

True

False

False

False

True

False

True

True

False

False

False

False

False

Pricing error for the order.

prioritycode

PriorityCode

Priority

Picklist

None

True

True

True

False

False

False

True

False

True

True

False

False

True

False

False

Priority of the order.

quoteid

QuoteId

Quote

Lookup

None

True

True

True

False

False

False

True

False

True

True

False

False

True

False

True

Unique identifier of the quote from which the order was created.

requestdeliveryby

RequestDeliveryBy

Requested Delivery Date

DateTime

None

True

True

True

False

False

False

True

False

True

True

False

False

True

False

True

Requested delivery date for the order.

salesorderid

SalesOrderId

Order

Uniqueidentifier

SystemRequired

True

True

False

False

False

False

False

False

True

True

True

False

True

False

True

Unique identifier of the order.

shippingmethodcode

ShippingMethodCode

Shipping Method

Picklist

None

True

True

True

False

False

False

True

False

True

True

False

False

True

False

True

Method of shipment for the order.

shipto_addressid

ShipTo_AddressId

Ship To Address ID

Uniqueidentifier

None

True

True

True

False

False

False

False

False

False

True

False

False

False

False

False

Unique identifier of the shipping address.

shipto_city

ShipTo_City

Ship To City

String

None

True

True

True

False

False

False

True

False

True

True

False

False

True

False

True

City name in the shipping address.

shipto_contactname

ShipTo_ContactName

Ship To Contact Name

String

None

True

True

True

False

False

False

True

False

True

True

False

False

True

False

True

Contact name for the shipping address.

shipto_country

ShipTo_Country

Ship To Country/Region

String

None

True

True

True

False

False

False

True

False

True

True

False

False

True

False

True

Country/region name in the shipping address.

shipto_fax

ShipTo_Fax

Ship to Fax

String

None

True

True

True

False

False

False

True

False

True

True

False

False

True

False

True

Fax number for the shipping address.

shipto_freighttermscode

ShipTo_FreightTermsCode

Ship To Freight Terms

Picklist

None

True

True

True

False

False

False

True

False

True

True

False

False

True

False

False

Freight terms for the shipping address.

shipto_line1

ShipTo_Line1

Ship To Street 1

String

None

True

True

True

False

False

False

True

False

True

True

False

False

True

False

True

First line for entering shipping address information.

shipto_line2

ShipTo_Line2

Ship To Street 2

String

None

True

True

True

False

False

False

True

False

True

True

False

False

True

False

True

Second line for entering shipping address information.

shipto_line3

ShipTo_Line3

Ship To Street 3

String

None

True

True

True

False

False

False

True

False

True

True

False

False

True

False

True

Third line for entering shipping address information.

shipto_name

ShipTo_Name

Ship To Name

String

None

True

True

True

False

False

False

True

False

True

True

False

False

True

False

True

Name to enter for the shipping address.

shipto_postalcode

ShipTo_PostalCode

Ship To ZIP/Postal Code

String

None

True

True

True

False

False

False

True

False

True

True

False

False

True

False

True

ZIP Code or postal code in the shipping address.

shipto_stateorprovince

ShipTo_StateOrProvince

Ship To State/Province

String

None

True

True

True

False

False

False

True

False

True

True

False

False

True

False

True

State or province in the shipping address.

shipto_telephone

ShipTo_Telephone

Ship To Phone

String

None

True

True

True

False

False

False

True

False

True

True

False

False

True

False

True

Telephone number associated with the shipping address.

statecode

StateCode

Status

State

SystemRequired

False

True

False

False

False

False

True

False

True

True

False

False

True

False

True

Status of the order.

statuscode

StatusCode

Status Reason

Status

None

True

True

True

False

False

False

True

False

True

True

False

False

True

False

True

Reason for the status of the order.

submitdate

SubmitDate

Date Submitted

DateTime

None

True

True

True

False

False

False

True

False

True

True

False

False

True

False

True

Date on which the order was submitted.

submitstatus

SubmitStatus

Submitted Status

Integer

None

True

True

True

False

False

False

True

False

True

True

False

False

True

False

True

Submittal status for the order.

submitstatusdescription

SubmitStatusDescription

Submitted Status Description

Memo

None

True

True

True

False

False

False

True

False

True

True

False

False

True

False

True

Description of the submittal status for the order.

timezoneruleversionnumber

TimeZoneRuleVersionNumber

Time Zone Rule Version Number

Integer

None

True

True

True

False

False

False

False

False

True

True

False

False

False

False

False

For internal use only.

totalamount

TotalAmount

Total Amount

Money

None

False

True

False

False

False

False

True

False

True

True

False

False

True

False

True

Total amount for the order.

totalamount_base

TotalAmount_Base

Total Amount (Base)

Money

None

False

True

False

False

False

False

True

False

True

True

False

False

True

False

True

Base currency equivalent of the total amount for the order.

totalamountlessfreight

TotalAmountLessFreight

Total Pre-Freight Amount

Money

None

False

True

False

False

False

False

True

False

True

True

False

False

True

False

True

Total amount minus the freight charges for the order.

totalamountlessfreight_base

TotalAmountLessFreight_Base

Total Pre-Freight Amount (Base)

Money

None

False

True

False

False

False

False

True

False

True

True

False

False

True

False

True

Base currency equivalent of the total amount minus the freight charges for the order.

totaldiscountamount

TotalDiscountAmount

Total Discount Amount

Money

None

False

True

False

False

False

False

True

False

True

True

False

False

True

False

True

Total discount for the order.

totaldiscountamount_base

TotalDiscountAmount_Base

Total Discount Amount (Base)

Money

None

False

True

False

False

False

False

True

False

True

True

False

False

True

False

True

Base currency equivalent of the total discount for the order.

totallineitemamount

TotalLineItemAmount

Total Detail Amount

Money

None

False

True

False

False

False

False

True

False

True

True

False

False

True

False

True

Total line item amount for the order.

totallineitemamount_base

TotalLineItemAmount_Base

Total Detail Amount (Base)

Money

None

False

True

False

False

False

False

True

False

True

True

False

False

True

False

True

Base currency equivalent of the total line item amount for the order.

totallineitemdiscountamount

TotalLineItemDiscountAmount

Total Line Item Discount Amount

Money

None

False

True

False

False

False

False

True

False

True

True

False

False

True

False

True

Total line item discount for the order.

totallineitemdiscountamount_base

TotalLineItemDiscountAmount_Base

Total Line Item Discount Amount (Base)

Money

None

False

True

False

False

False

False

True

False

True

True

False

False

True

False

True

Base currency equivalent of the total line item discount for the order.

totaltax

TotalTax

Total Tax

Money

None

False

True

False

False

False

False

True

False

True

True

False

False

True

False

True

Total tax for the order.

totaltax_base

TotalTax_Base

Total Tax (Base)

Money

None

False

True

False

False

False

False

True

False

True

True

False

False

True

False

True

Base currency equivalent of the total tax for the order.

transactioncurrencyid

TransactionCurrencyId

Currency

Lookup

ApplicationRequired

True

True

False

False

False

False

True

False

True

True

False

False

True

False

True

Unique identifier of the currency associated with the sales order.

utcconversiontimezonecode

UTCConversionTimeZoneCode

UTC Conversion Time Zone Code

Integer

None

True

True

True

False

False

False

False

False

True

True

False

False

False

False

False

Time zone code that was in use when the record was created.

versionnumber

VersionNumber

Version Number

BigInt

None

False

True

False

False

False

False

False

False

False

True

False

False

False

False

False

Version number of the order.

willcall

WillCall

Ship To

Boolean

None

True

True

True

False

False

False

True

False

True

True

False

False

True

False

True

Information that specifies whether the customer will call for the ordered products or the products are to be shipped.

One-to-Many Relationships

The following table shows the entities that are the referencing entity in a one-to-many relationship with the sales order entity.

Relationship schema name Referencing entity

salesorder_activity_parties

activityparty

SalesOrder_ActivityPointers

activitypointer

SalesOrder_Annotation

annotation

SalesOrder_Appointments

appointment

SalesOrder_AsyncOperations

asyncoperation

SalesOrder_BulkDeleteFailures

bulkdeletefailure

salesorder_connections2

connection

salesorder_connections1

connection

SalesOrder_Emails

email

SalesOrder_Faxes

fax

order_invoices

invoice

SalesOrder_Letters

letter

SalesOrder_OrderClose

orderclose

SalesOrder_Phonecalls

phonecall

salesorder_principalobjectattributeaccess

principalobjectattributeaccess

SalesOrder_ProcessSessions

processsession

SalesOrder_RecurringAppointmentMasters

recurringappointmentmaster

order_details

salesorderdetail

SalesOrder_ServiceAppointments

serviceappointment

SalesOrder_Tasks

task

userentityinstancedata_salesorder

userentityinstancedata

Many-to-Many Relationships

The following table shows the many-to-many relationships for the sales order entity.

Relationship schema name Entity 1 Entity 2 Intersect entity

contactorders_association

salesorder

contact

contactorders

Many-to-One Relationships

The following table shows the entities that are the referenced entity in a many-to-one relationship with the sales order entity.

Relationship schema name Referenced entity

order_customer_accounts

account

business_unit_orders

businessunit

campaign_orders

campaign

order_customer_contacts

contact

opportunity_sales_orders

opportunity

owner_salesorders

owner

price_level_orders

pricelevel

quote_orders

quote

lk_salesorder_createdonbehalfby

systemuser

lk_salesorder_modifiedonbehalfby

systemuser

system_user_orders

systemuser

lk_salesorderbase_modifiedby

systemuser

lk_salesorderbase_createdby

systemuser

team_orders

team

transactioncurrency_salesorder

transactioncurrency

See Also

Reference

EntityMetadata
AttributeMetadata
OneToManyRelationshipMetadata
ManyToManyRelationshipMetadata

Concepts

SalesOrder (Order) Entity Messages and Methods
SalesOrder (Order) Entity OptionSet Attribute Metadata
SalesOrder (Order) Entity Privileges

Microsoft Dynamics CRM 2011
Send comments about this topic to Microsoft.
© 2013 Microsoft Corporation. All rights reserved.