Contract Entity Metadata

  • Article

[Applies to: Microsoft Dynamics CRM 2011]

The following information is for the contract entity in a default, uncustomized installation of Microsoft Dynamics CRM. The schema name and early bound class for this entity is Contract.

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

Privilege Metadata

Attribute Metadata

One-to-Many Relationships

Many-to-Many Relationships

Many-to-One Relationships

Entity Metadata

The following table shows the metadata for the contract entity.

Entity metadata property Value

OTC

1010

EntityLogicalName

contract

DisplayName

Contract

DisplayCollectionName

Contracts

IsCustomizable

True

OwnershipType

UserOwned

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

IsAvailableOffline

True

IsChildEntity

False

IsConnectionsEnabled

canmodifyconnectionsettings

IsCustomEntity

False

IsDocumentManagementEnabled

False

IsDuplicateDetectionEnabled

True

IsEnabledForCharts

True

IsImportable

True

IsIntersect

False

IsMailMergeEnabled

False

IsManaged

True

IsMappable

True

IsReadingPaneEnabled

True

IsRenameable

True

IsValidForAdvancedFind

True

IsValidForQueue

False

IsVisibleInMobile

False

PrimaryIdAttribute

contractid

PrimaryNameAttribute

title

ReportViewName

FilteredContract

Description

Agreement to provide customer service during a specified amount of time or number of cases.

Privilege Metadata

The following table shows the privilege metadata for the contract entity.

PrivilegeName Id Type CanBeBasic CanBeDeep CanBeGlobal CanBeLocal

prvAppendContract

36a31103-a2dd-4fea-98c9-824124e7ccde

Append

True

True

True

True

prvAppendToContract

164e417a-54a6-4180-b772-08f221e751c8

AppendTo

True

True

True

True

prvAssignContract

0dddb95f-986b-48c2-9ed5-de5f9a4a0344

Assign

True

True

True

True

prvCreateContract

789b28f6-e8e6-4827-a7e9-30d69d8d4929

Create

True

True

True

True

prvDeleteContract

fe42dbbc-5804-4034-9b3e-b0a9b6c7f564

Delete

True

True

True

True

prvReadContract

8022a167-ea97-4c91-a41c-b77c083f7113

Read

True

True

True

True

prvShareContract

af754edd-7d79-42ef-b31f-7008662f301b

Share

True

True

True

True

prvWriteContract

7b269b20-f381-41b2-96fb-912786fc398f

Write

True

True

True

True

Attribute Metadata

The following table shows the attribute metadata for the contract entity.

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

accountid

AccountId

Lookup

None

False

True

False

False

False

False

True

True

True

False

False

False

False

False

Account

Unique identifier of the account with which the contract is associated.

activeon

ActiveOn

DateTime

SystemRequired

True

True

True

False

False

False

True

True

True

False

False

True

False

True

Contract Start Date

Date and time when the contract becomes active.

allotmenttypecode

AllotmentTypeCode

Picklist

None

True

True

True

False

False

False

True

True

True

False

False

True

False

True

Allotment Type

Type of allotment that the contract supports.

billingaccountid

BillingAccountId

Lookup

None

False

True

False

False

False

False

True

True

True

False

False

False

False

False

Billing Account

Unique identifier of the account to which the contract is to be billed.

billingcontactid

BillingContactId

Lookup

None

False

True

False

False

False

False

True

True

True

False

False

False

False

False

Billing Contact

Unique identifier of the contact to whom the contract is to be billed.

billingcustomerid

BillingCustomerId

Customer

SystemRequired

True

True

True

False

False

False

True

True

True

False

False

True

False

True

Bill To Customer

Unique identifier of the account or contact to which the contract is to be billed.

billingendon

BillingEndOn

DateTime

None

True

True

True

False

False

False

True

True

True

False

False

True

False

True

Billing End Date

Date and time when the billing period ends.

billingfrequencycode

BillingFrequencyCode

Picklist

None

True

True

True

False

False

False

True

True

True

False

False

True

False

True

Billing Frequency

How often the customer or account is to be billed.

billingstarton

BillingStartOn

DateTime

None

True

True

True

False

False

False

True

True

True

False

False

True

False

True

Billing Start Date

Date and time when the billing period begins.

billtoaddress

BillToAddress

Lookup

None

True

True

True

False

False

False

True

True

True

False

False

True

False

True

Bill To Address

Address to bill for contract charges.

cancelon

CancelOn

DateTime

None

False

True

False

False

False

False

True

True

True

False

False

True

False

True

Cancellation Date

Date when the contract was canceled.

contactid

ContactId

Lookup

None

False

True

False

False

False

False

True

True

True

False

False

False

False

False

Contact

Unique identifier of the contact specified for the contract.

contractid

ContractId

Uniqueidentifier

SystemRequired

True

True

False

False

False

False

True

False

True

True

False

True

False

True

Contract

Unique identifier of the contract.

contractlanguage

ContractLanguage

Memo

None

True

True

True

False

False

False

True

True

True

False

False

True

False

True

Description

Description of the contract.

contractnumber

ContractNumber

String

None

True

True

False

False

False

False

True

True

True

False

False

True

False

True

Contract ID

System-generated contract identification number.

contractservicelevelcode

ContractServiceLevelCode

Picklist

None

True

True

True

False

False

False

True

True

True

False

False

True

False

True

Service Level

Response level or level of service specified for the contract.

contracttemplateabbreviation

ContractTemplateAbbreviation

String

SystemRequired

False

True

False

False

False

False

True

True

True

False

False

True

False

True

Template Abbreviation

Abbreviation of the contract template name.

contracttemplateid

ContractTemplateId

Lookup

SystemRequired

True

True

True

False

False

False

True

True

True

False

False

True

False

True

Contract Template

Unique identifier of the template associated with the contract.

createdby

CreatedBy

Lookup

None

False

True

False

False

False

False

True

False

True

False

False

True

False

True

Created By

Unique identifier of the user who created the contract.

createdon

CreatedOn

DateTime

None

False

True

False

False

False

False

True

False

True

False

False

True

False

True

Created On

Date and time when the contract was created.

createdonbehalfby

CreatedOnBehalfBy

Lookup

None

False

True

False

False

False

False

True

False

True

False

False

True

False

True

Created By (Delegate)

Unique identifier of the delegate user who created the contract.

customerid

CustomerId

Customer

SystemRequired

True

True

True

False

False

False

True

True

True

False

False

True

False

True

Customer

Unique identifier of the account or contact associated with the contract.

duration

Duration

Integer

None

False

True

False

False

False

False

True

True

True

False

False

True

False

True

Duration

Calculated duration of time that the contract spans.

effectivitycalendar

EffectivityCalendar

String

None

True

True

True

False

False

False

False

False

True

False

False

False

False

False

Support Calendar

Days of the week and times during which customer service support is available for the duration of the contract.

exchangerate

ExchangeRate

Decimal

None

False

True

False

False

False

False

True

True

True

False

False

True

False

True

Exchange Rate

Exchange rate for the currency associated with the contract with respect to the base currency.

expireson

ExpiresOn

DateTime

SystemRequired

True

True

True

False

False

False

True

True

True

False

False

True

False

True

Contract End Date

Date when the contract expires.

importsequencenumber

ImportSequenceNumber

Integer

None

True

True

False

False

False

False

True

True

True

False

False

True

False

True

Import Sequence Number

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

modifiedby

ModifiedBy

Lookup

None

False

True

False

False

False

False

True

False

True

False

False

True

False

True

Modified By

Unique identifier of the user who last modified the contract.

modifiedon

ModifiedOn

DateTime

None

False

True

False

False

False

False

True

False

True

False

False

True

False

True

Modified On

Date and time when the contract was last modified.

modifiedonbehalfby

ModifiedOnBehalfBy

Lookup

None

False

True

False

False

False

False

True

False

True

False

False

True

False

True

Modified By (Delegate)

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

netprice

NetPrice

Money

None

False

True

False

False

False

False

True

True

True

False

False

True

False

True

Net Price

Sum of all net values calculated on the contract lines.

netprice_base

NetPrice_Base

Money

None

False

True

False

False

False

False

True

True

True

False

False

True

False

True

Net Price (Base)

Base currency equivalent of the sum of all net values calculated on the contract lines.

originatingcontract

OriginatingContract

Lookup

None

True

True

False

False

False

False

True

True

True

False

False

True

False

True

Originating Contract

Unique identifier of the original contract from which this current contract was derived.

overriddencreatedon

OverriddenCreatedOn

DateTime

None

True

True

False

False

False

False

True

True

True

False

False

True

False

True

Record Created On

Date and time that the record was migrated.

ownerid

OwnerId

Owner

SystemRequired

True

True

False

False

False

False

True

True

True

False

False

True

False

True

Owner

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

owningbusinessunit

OwningBusinessUnit

Lookup

None

False

True

False

False

False

False

True

False

True

False

False

False

False

False

Owning Business Unit

Unique identifier of the business unit that owns the contract.

owningteam

OwningTeam

Lookup

None

False

True

False

False

False

False

True

False

True

False

False

False

False

False

Owning Team

Unique identifier of the team who owns the contract.

owninguser

OwningUser

Lookup

None

False

True

False

False

False

False

True

False

True

False

False

False

False

False

Owning User

Unique identifier of the user who owns the contract.

serviceaddress

ServiceAddress

Lookup

None

True

True

True

False

False

False

True

True

True

False

False

True

False

True

Contract Address

Unique identifier of the address at which service is to be provided.

statecode

StateCode

State

SystemRequired

False

True

False

False

False

False

True

True

True

False

False

True

False

True

Status

Status of the contract.

statuscode

StatusCode

Status

None

True

True

True

False

False

False

True

True

True

False

False

True

False

True

Status Reason

Reason for the status of the contract.

timezoneruleversionnumber

TimeZoneRuleVersionNumber

Integer

None

True

True

True

False

False

False

True

False

True

False

False

False

False

False

Time Zone Rule Version Number

For internal use only.

title

Title

String

ApplicationRequired

True

True

True

False

False

False

True

True

True

False

True

True

False

True

Contract Name

Title of the contract.

totaldiscount

TotalDiscount

Money

None

False

True

False

False

False

False

True

True

True

False

False

True

False

True

Total Discount

Total of all discounts specified on the contract lines.

totaldiscount_base

TotalDiscount_Base

Money

None

False

True

False

False

False

False

True

True

True

False

False

True

False

True

Total Discount (Base)

Base currency equivalent of the total of all discounts specified on the contract lines.

totalprice

TotalPrice

Money

None

False

True

False

False

False

False

True

True

True

False

False

True

False

True

Total Price

Total price of the contract.

totalprice_base

TotalPrice_Base

Money

None

False

True

False

False

False

False

True

True

True

False

False

True

False

True

Total Price (Base)

Base currency equivalent of the total price of the contract.

transactioncurrencyid

TransactionCurrencyId

Lookup

ApplicationRequired

True

True

False

False

False

False

True

True

True

False

False

True

False

True

Currency

Unique identifier of the currency associated with the contract.

usediscountaspercentage

UseDiscountAsPercentage

Boolean

None

True

True

False

False

False

False

True

True

True

False

False

True

False

True

Discount

Information about whether the discount is a percentage or a monetary amount.

utcconversiontimezonecode

UTCConversionTimeZoneCode

Integer

None

True

True

True

False

False

False

True

False

True

False

False

False

False

False

UTC Conversion Time Zone Code

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

versionnumber

VersionNumber

BigInt

None

False

True

False

False

False

False

False

False

True

False

False

False

False

False

Version Number

Version number of the contract.

One-to-Many Relationships

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

Relationship schema name Referencing entity

contract_activity_parties

activityparty

Contract_ActivityPointers

activitypointer

Contract_Annotation

annotation

Contract_Appointments

appointment

Contract_AsyncOperations

asyncoperation

Contract_BulkDeleteFailures

bulkdeletefailure

contract_connections1

connection

contract_connections2

connection

contract_originating_contract

contract

contract_line_items

contractdetail

Contract_DuplicateBaseRecord

duplicaterecord

Contract_DuplicateMatchingRecord

duplicaterecord

Contract_Emails

email

Contract_Faxes

fax

contract_cases

incident

Contract_Letters

letter

Contract_Phonecalls

phonecall

contract_principalobjectattributeaccess

principalobjectattributeaccess

Contract_ProcessSessions

processsession

Contract_RecurringAppointmentMasters

recurringappointmentmaster

Contract_ServiceAppointments

serviceappointment

Contract_Tasks

task

userentityinstancedata_contract

userentityinstancedata

Many-to-Many Relationships

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

Relationship schema name Entity 1 Entity 2 Intersect entity name

servicecontractcontacts_association

contact

contract

servicecontractcontacts

For information about using intersect entities, see Retrieve Records for Many-To-Many Relationships Using Intersect Entities.

Many-to-One Relationships

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

Relationship schema name Referenced entity

contract_customer_accounts

account

contract_billingcustomer_accounts

account

business_unit_service_contracts

businessunit

contract_customer_contacts

contact

contract_billingcustomer_contacts

contact

contract_originating_contract

contract

contract_template_contracts

contracttemplate

customer_address_contracts_as_billing_address

customeraddress

customer_address_contracts_as_service_address

customeraddress

owner_contracts

owner

lk_contract_modifiedonbehalfby

systemuser

lk_contractbase_modifiedby

systemuser

system_user_service_contracts

systemuser

lk_contract_createdonbehalfby

systemuser

lk_contractbase_createdby

systemuser

team_service_contracts

team

transactioncurrency_contract

transactioncurrency

See Also

Reference

EntityMetadata
AttributeMetadata
OneToManyRelationshipMetadata
ManyToManyRelationshipMetadata

Concepts

Contract Entity Messages and Methods
Contract Entity OptionSet Attribute Metadata
Contract Entity Privileges

Other Resources

Contract Entities

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