Contract table/entity reference (Microsoft Dynamics 365)

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

Messages

The following table lists the messages for the Contract table. Messages represent operations that can be performed on the table. They may also be events.

Name
Is Event?
Web API Operation SDK for .NET
Assign
Event: True
PATCH /contracts(contractid)
Update the ownerid property.
AssignRequest
Associate
Event: True
Associate records Associate records
CancelContract
Event: True
CancelContract action CancelContractRequest
CancelSalesOrder
Event: True
CancelSalesOrder action CancelSalesOrderRequest
CloneContract
Event: True
CloneContract action CloneContractRequest
Create
Event: True
POST /contracts
See Create
Create records
CreateMultiple
Event: True
CreateMultiple CreateMultipleRequest
Delete
Event: True
DELETE /contracts(contractid)
See Delete
Delete records
Disassociate
Event: True
Disassociate records Disassociate records
GrantAccess
Event: True
GrantAccess GrantAccessRequest
ModifyAccess
Event: True
ModifyAccess ModifyAccessRequest
RenewContract
Event: False
RenewContract action RenewContractRequest
Retrieve
Event: True
GET /contracts(contractid)
See Retrieve
Retrieve records
RetrieveMultiple
Event: True
GET /contracts
See Query data
Query data
RetrievePrincipalAccess
Event: True
RetrievePrincipalAccess RetrievePrincipalAccessRequest
RetrieveSharedPrincipalsAndAccess
Event: True
RetrieveSharedPrincipalsAndAccess RetrieveSharedPrincipalsAndAccessRequest
RevokeAccess
Event: True
RevokeAccess RevokeAccessRequest
Rollup
Event: False
Rollup RollupRequest
SetState
Event: True
PATCH /contracts(contractid)
Update the statecode and statuscode properties.
SetStateRequest
Update
Event: True
PATCH /contracts(contractid)
See Update
Update records
UpdateMultiple
Event: True
UpdateMultiple UpdateMultipleRequest
Upsert
Event: False
PATCH /contracts(contractid)
See Upsert a table row
UpsertRequest
UpsertMultiple
Event: False
UpsertMultiple UpsertMultipleRequest

Properties

The following table lists selected properties for the Contract table.

Property Value
DisplayName Contract
DisplayCollectionName Contracts
SchemaName Contract
CollectionSchemaName Contracts
EntitySetName contracts
LogicalName contract
LogicalCollectionName contracts
PrimaryIdAttribute contractid
PrimaryNameAttribute title
TableType Standard
OwnershipType UserOwned

Writable columns/attributes

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

ActiveOn

Property Value
Description Enter the date when the contract becomes active.
DisplayName Contract Start Date
IsValidForForm True
IsValidForRead True
LogicalName activeon
RequiredLevel SystemRequired
Type DateTime
CanChangeDateTimeBehavior False
DateTimeBehavior UserLocal
Format DateOnly
ImeMode Inactive
SourceTypeMask 0

AllotmentTypeCode

Property Value
Description Type of allotment that the contract supports.
DisplayName Allotment Type
IsValidForForm False
IsValidForRead True
LogicalName allotmenttypecode
RequiredLevel None
Type Picklist
DefaultFormValue -1
GlobalChoiceName contract_allotmenttypecode

AllotmentTypeCode Choices/Options

Value Label
1 Number of Cases
2 Time
3 Coverage Dates

BillingCustomerId

Property Value
Description Select the customer account or contact to which the contract should be billed to provide a quick link to address and other customer details.
DisplayName Bill To Customer
IsValidForForm True
IsValidForRead True
LogicalName billingcustomerid
RequiredLevel SystemRequired
Type Customer
Targets account, contact

BillingCustomerIdType

Property Value
Description
DisplayName Bill To Customer Type
IsValidForForm False
IsValidForRead True
LogicalName billingcustomeridtype
RequiredLevel ApplicationRequired
Type EntityName

BillingEndOn

Property Value
Description Enter the end date for the contract's billing period to indicate the period for which the customer must pay for a service.
DisplayName Billing End Date
IsValidForForm True
IsValidForRead True
LogicalName billingendon
RequiredLevel None
Type DateTime
CanChangeDateTimeBehavior False
DateTimeBehavior UserLocal
Format DateOnly
ImeMode Inactive
SourceTypeMask 0

BillingFrequencyCode

Property Value
Description Select the billing schedule of the contract to indicate how often the customer should be invoiced.
DisplayName Billing Frequency
IsValidForForm True
IsValidForRead True
LogicalName billingfrequencycode
RequiredLevel None
Type Picklist
DefaultFormValue 1
GlobalChoiceName contract_billingfrequencycode

BillingFrequencyCode Choices/Options

Value Label
1 Monthly
2 Bimonthly
3 Quarterly
4 Semiannually
5 Annually

BillingStartOn

Property Value
Description Enter the start date for the contract's billing period to indicate the period for which the customer must pay for a service. This defaults to the same date that is selected in the Contract Start Date field.
DisplayName Billing Start Date
IsValidForForm True
IsValidForRead True
LogicalName billingstarton
RequiredLevel None
Type DateTime
CanChangeDateTimeBehavior False
DateTimeBehavior UserLocal
Format DateOnly
ImeMode Inactive
SourceTypeMask 0

BillToAddress

Property Value
Description Choose which address to send the invoice to.
DisplayName Bill To Address
IsValidForForm True
IsValidForRead True
LogicalName billtoaddress
RequiredLevel None
Type Lookup
Targets customeraddress

ContractId

Property Value
Description Unique identifier of the contract.
DisplayName Contract
IsValidForForm False
IsValidForRead True
LogicalName contractid
RequiredLevel SystemRequired
Type Uniqueidentifier

ContractLanguage

Property Value
Description Type additional information about the contract, such as the products or services provided to the customer.
DisplayName Description
IsValidForForm True
IsValidForRead True
LogicalName contractlanguage
RequiredLevel None
Type Memo
Format TextArea
FormatName TextArea
ImeMode Auto
IsLocalizable False
MaxLength 2000

ContractNumber

Property Value
Description Shows the number for the contract for customer reference and searching capabilities. You cannot modify this number.
DisplayName Contract ID
IsValidForForm True
IsValidForRead True
LogicalName contractnumber
RequiredLevel None
Type String
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 100

ContractServiceLevelCode

Property Value
Description Select the level of service that should be provided for the contract based on your company's definition of bronze, silver, or gold.
DisplayName Service Level
IsValidForForm True
IsValidForRead True
LogicalName contractservicelevelcode
RequiredLevel None
Type Picklist
DefaultFormValue 1
GlobalChoiceName contract_contractservicelevelcode

ContractServiceLevelCode Choices/Options

Value Label
1 Gold
2 Silver
3 Bronze

ContractTemplateId

Property Value
Description Choose the contract template that should be used to determine the terms of the contract, such as allotment type, available hours, and billing frequency.
DisplayName Contract Template
IsValidForForm True
IsValidForRead True
LogicalName contracttemplateid
RequiredLevel SystemRequired
Type Lookup
Targets contracttemplate

CustomerId

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

CustomerIdType

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

EffectivityCalendar

Property Value
Description Days of the week and times during which customer service support is available for the duration of the contract.
DisplayName Support Calendar
IsValidForForm False
IsValidForRead True
LogicalName effectivitycalendar
RequiredLevel None
Type String
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 168

EmailAddress

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

EntityImage

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

ExpiresOn

Property Value
Description Enter the date when the contract expires.
DisplayName Contract End Date
IsValidForForm True
IsValidForRead True
LogicalName expireson
RequiredLevel SystemRequired
Type DateTime
CanChangeDateTimeBehavior False
DateTimeBehavior UserLocal
Format DateOnly
ImeMode Inactive
SourceTypeMask 0

ImportSequenceNumber

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

OriginatingContract

Property Value
Description Choose the original contract that this contract was created from. This information is used to track renewal history.
DisplayName Originating Contract
IsValidForForm True
IsValidForRead True
LogicalName originatingcontract
RequiredLevel None
Type Lookup
Targets contract

OverriddenCreatedOn

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

OwnerId

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

OwnerIdType

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

ServiceAddress

Property Value
Description Choose the address for the customer account or contact where the services are provided.
DisplayName Contract Address
IsValidForForm True
IsValidForRead True
LogicalName serviceaddress
RequiredLevel None
Type Lookup
Targets customeraddress

StateCode

Property Value
Description Shows whether the contract is in draft, invoiced, active, on hold, canceled, or expired. You can edit only the contracts that are in draft status.
DisplayName Status
IsValidForForm True
IsValidForRead True
LogicalName statecode
RequiredLevel SystemRequired
Type State
DefaultFormValue 0
GlobalChoiceName contract_statecode

StateCode Choices/Options

Value Details
0 Label: Draft
DefaultStatus: 1
InvariantName: Draft
1 Label: Invoiced
DefaultStatus: 2
InvariantName: Invoiced
2 Label: Active
DefaultStatus: 3
InvariantName: Active
3 Label: On Hold
DefaultStatus: 4
InvariantName: On Hold
4 Label: Canceled
DefaultStatus: 5
InvariantName: Canceled
5 Label: Expired
DefaultStatus: 6
InvariantName: Expired

StatusCode

Property Value
Description Select the contract's status.
DisplayName Status Reason
IsValidForForm True
IsValidForRead True
LogicalName statuscode
RequiredLevel None
Type Status
DefaultFormValue -1
GlobalChoiceName contract_statuscode

StatusCode Choices/Options

Value Details
1 Label: Draft
State:0
TransitionData: None
2 Label: Invoiced
State:1
TransitionData: None
3 Label: Active
State:2
TransitionData: None
4 Label: On Hold
State:3
TransitionData: None
5 Label: Canceled
State:4
TransitionData: None
6 Label: Expired
State:5
TransitionData: None

TimeZoneRuleVersionNumber

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

Title

Property Value
Description Type a title or name for the contract that indicates the purpose of the contract.
DisplayName Contract Name
IsValidForForm True
IsValidForRead True
LogicalName title
RequiredLevel ApplicationRequired
Type String
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 100

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
LogicalName transactioncurrencyid
RequiredLevel ApplicationRequired
Type Lookup
Targets transactioncurrency

UseDiscountAsPercentage

Property Value
Description Select whether the discounts entered on contract lines for this contract should be entered as a percentage or a fixed dollar value.
DisplayName Discount
IsValidForForm True
IsValidForRead True
LogicalName usediscountaspercentage
RequiredLevel None
Type Boolean
GlobalChoiceName contract_usediscountaspercentage
DefaultValue False
True Label Percentage
False Label Amount

UTCConversionTimeZoneCode

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

Read-only columns/attributes

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

AccountId

Property Value
Description Unique identifier of the account with which the contract is associated.
DisplayName Account
IsValidForForm False
IsValidForRead True
LogicalName accountid
RequiredLevel None
Type Lookup
Targets account

BillingAccountId

Property Value
Description Unique identifier of the account to which the contract is to be billed.
DisplayName Billing Account
IsValidForForm False
IsValidForRead True
LogicalName billingaccountid
RequiredLevel None
Type Lookup
Targets account

BillingContactId

Property Value
Description Unique identifier of the contact to whom the contract is to be billed.
DisplayName Billing Contact
IsValidForForm False
IsValidForRead True
LogicalName billingcontactid
RequiredLevel None
Type Lookup
Targets contact

BillingCustomerIdName

Property Value
Description
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName billingcustomeridname
RequiredLevel ApplicationRequired
Type String
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 160

BillingCustomerIdYomiName

Property Value
Description
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName billingcustomeridyominame
RequiredLevel ApplicationRequired
Type String
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 450

CancelOn

Property Value
Description Shows the date and time when the contract was canceled.
DisplayName Cancellation Date
IsValidForForm True
IsValidForRead True
LogicalName cancelon
RequiredLevel None
Type DateTime
CanChangeDateTimeBehavior False
DateTimeBehavior UserLocal
Format DateOnly
ImeMode Inactive
SourceTypeMask 0

ContactId

Property Value
Description Unique identifier of the contact specified for the contract.
DisplayName Contact
IsValidForForm False
IsValidForRead True
LogicalName contactid
RequiredLevel None
Type Lookup
Targets contact

ContractTemplateAbbreviation

Property Value
Description Shows the abbreviation of the contract template selected when the contract is created.
DisplayName Template Abbreviation
IsValidForForm True
IsValidForRead True
LogicalName contracttemplateabbreviation
RequiredLevel SystemRequired
Type String
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 20

CreatedBy

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

CreatedOn

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

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
Type Lookup
Targets systemuser

CustomerIdName

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

CustomerIdYomiName

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

Duration

Property Value
Description Shows for the duration of the contract, in days, based on the contract start and end dates.
DisplayName Duration
IsValidForForm True
IsValidForRead True
LogicalName duration
RequiredLevel None
Type Integer
MaxValue 2147483647
MinValue 0

EntityImage_Timestamp

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

EntityImage_URL

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

EntityImageId

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

ExchangeRate

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
RequiredLevel None
Type Decimal
ImeMode Disabled
MaxValue 100000000000
MinValue 1E-12
Precision 12
SourceTypeMask 0

ModifiedBy

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

ModifiedOn

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

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
Type Lookup
Targets systemuser

NetPrice

Property Value
Description Shows the total charge to the customer for the service contract, calculated as the sum of values in the Net field for each existing contract line related to the contract.
DisplayName Net Price
IsValidForForm True
IsValidForRead True
LogicalName netprice
RequiredLevel None
Type Money
ImeMode Disabled
IsBaseCurrency False
MaxValue 100000000000000
MinValue 0
Precision 2
PrecisionSource 2 (TransactionCurrency.CurrencyPrecision)

NetPrice_Base

Property Value
Description Value of the Net Price in base currency.
DisplayName Net Price (Base)
IsValidForForm True
IsValidForRead True
LogicalName netprice_base
RequiredLevel None
Type Money
ImeMode Disabled
IsBaseCurrency True
MaxValue 922337203685477
MinValue -922337203685477
Precision 4
PrecisionSource 2 (TransactionCurrency.CurrencyPrecision)

OwnerIdName

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

OwnerIdYomiName

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

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
Type Lookup
Targets businessunit

OwningTeam

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

OwningUser

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

TotalDiscount

Property Value
Description Shows the total discount applied to the contract's service charges, calculated as the sum of values in the Discount fields for each existing contract line related to the contract.
DisplayName Total Discount
IsValidForForm True
IsValidForRead True
LogicalName totaldiscount
RequiredLevel None
Type Money
ImeMode Disabled
IsBaseCurrency False
MaxValue 100000000000000
MinValue 0
Precision 2
PrecisionSource 2 (TransactionCurrency.CurrencyPrecision)

TotalDiscount_Base

Property Value
Description Value of the Total Discount in base currency.
DisplayName Total Discount (Base)
IsValidForForm True
IsValidForRead True
LogicalName totaldiscount_base
RequiredLevel None
Type Money
ImeMode Disabled
IsBaseCurrency True
MaxValue 922337203685477
MinValue -922337203685477
Precision 4
PrecisionSource 2 (TransactionCurrency.CurrencyPrecision)

TotalPrice

Property Value
Description Shows the total service charge for the contract, before any discounts are credited. This is calculated as the sum of values in the Total Price field for each existing contract line related to the contract.
DisplayName Total Price
IsValidForForm True
IsValidForRead True
LogicalName totalprice
RequiredLevel None
Type Money
ImeMode Disabled
IsBaseCurrency False
MaxValue 100000000000000
MinValue 0
Precision 2
PrecisionSource 2 (TransactionCurrency.CurrencyPrecision)

TotalPrice_Base

Property Value
Description Value of the Total Price in base currency.
DisplayName Total Price (Base)
IsValidForForm True
IsValidForRead True
LogicalName totalprice_base
RequiredLevel None
Type Money
ImeMode Disabled
IsBaseCurrency True
MaxValue 922337203685477
MinValue -922337203685477
Precision 4
PrecisionSource 2 (TransactionCurrency.CurrencyPrecision)

VersionNumber

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

Many-to-One relationships

These relationships are many-to-one. Listed by SchemaName.

business_unit_service_contracts

One-To-Many Relationship: businessunit business_unit_service_contracts

Property Value
ReferencedEntity businessunit
ReferencedAttribute businessunitid
ReferencingAttribute owningbusinessunit
ReferencingEntityNavigationPropertyName owningbusinessunit
IsHierarchical
CascadeConfiguration Archive: Restrict
Assign: NoCascade
Delete: Restrict
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

contract_billingcustomer_accounts

One-To-Many Relationship: account contract_billingcustomer_accounts

Property Value
ReferencedEntity account
ReferencedAttribute accountid
ReferencingAttribute billingcustomerid
ReferencingEntityNavigationPropertyName billingcustomerid_account
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: Restrict
Merge: Cascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

contract_billingcustomer_contacts

One-To-Many Relationship: contact contract_billingcustomer_contacts

Property Value
ReferencedEntity contact
ReferencedAttribute contactid
ReferencingAttribute billingcustomerid
ReferencingEntityNavigationPropertyName billingcustomerid_contact
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: Restrict
Merge: Cascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

contract_customer_accounts

One-To-Many Relationship: account contract_customer_accounts

Property Value
ReferencedEntity account
ReferencedAttribute accountid
ReferencingAttribute customerid
ReferencingEntityNavigationPropertyName customerid_account
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: Cascade
Delete: Cascade
Merge: Cascade
Reparent: Cascade
RollupView: NoCascade
Share: Cascade
Unshare: Cascade

contract_customer_contacts

One-To-Many Relationship: contact contract_customer_contacts

Property Value
ReferencedEntity contact
ReferencedAttribute contactid
ReferencingAttribute customerid
ReferencingEntityNavigationPropertyName customerid_contact
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: Cascade
Delete: Cascade
Merge: Cascade
Reparent: Cascade
RollupView: NoCascade
Share: Cascade
Unshare: Cascade

contract_originating_contract

One-To-Many Relationship: contract contract_originating_contract

Property Value
ReferencedEntity contract
ReferencedAttribute contractid
ReferencingAttribute originatingcontract
ReferencingEntityNavigationPropertyName originatingcontract
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: Restrict
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

contract_template_contracts

One-To-Many Relationship: contracttemplate contract_template_contracts

Property Value
ReferencedEntity contracttemplate
ReferencedAttribute contracttemplateid
ReferencingAttribute contracttemplateid
ReferencingEntityNavigationPropertyName contracttemplateid
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: Restrict
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

customer_address_contracts_as_billing_address

One-To-Many Relationship: customeraddress customer_address_contracts_as_billing_address

Property Value
ReferencedEntity customeraddress
ReferencedAttribute customeraddressid
ReferencingAttribute billtoaddress
ReferencingEntityNavigationPropertyName billtoaddress
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: Restrict
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

customer_address_contracts_as_service_address

One-To-Many Relationship: customeraddress customer_address_contracts_as_service_address

Property Value
ReferencedEntity customeraddress
ReferencedAttribute customeraddressid
ReferencingAttribute serviceaddress
ReferencingEntityNavigationPropertyName serviceaddress
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: Restrict
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

lk_contract_createdonbehalfby

One-To-Many Relationship: systemuser lk_contract_createdonbehalfby

Property Value
ReferencedEntity systemuser
ReferencedAttribute systemuserid
ReferencingAttribute createdonbehalfby
ReferencingEntityNavigationPropertyName createdonbehalfby
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

lk_contract_modifiedonbehalfby

One-To-Many Relationship: systemuser lk_contract_modifiedonbehalfby

Property Value
ReferencedEntity systemuser
ReferencedAttribute systemuserid
ReferencingAttribute modifiedonbehalfby
ReferencingEntityNavigationPropertyName modifiedonbehalfby
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

lk_contractbase_createdby

One-To-Many Relationship: systemuser lk_contractbase_createdby

Property Value
ReferencedEntity systemuser
ReferencedAttribute systemuserid
ReferencingAttribute createdby
ReferencingEntityNavigationPropertyName createdby
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

lk_contractbase_modifiedby

One-To-Many Relationship: systemuser lk_contractbase_modifiedby

Property Value
ReferencedEntity systemuser
ReferencedAttribute systemuserid
ReferencingAttribute modifiedby
ReferencingEntityNavigationPropertyName modifiedby
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

owner_contracts

One-To-Many Relationship: owner owner_contracts

Property Value
ReferencedEntity owner
ReferencedAttribute ownerid
ReferencingAttribute ownerid
ReferencingEntityNavigationPropertyName ownerid
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

system_user_service_contracts

One-To-Many Relationship: systemuser system_user_service_contracts

Property Value
ReferencedEntity systemuser
ReferencedAttribute systemuserid
ReferencingAttribute owninguser
ReferencingEntityNavigationPropertyName owninguser
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

team_service_contracts

One-To-Many Relationship: team team_service_contracts

Property Value
ReferencedEntity team
ReferencedAttribute teamid
ReferencingAttribute owningteam
ReferencingEntityNavigationPropertyName owningteam
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

transactioncurrency_contract

One-To-Many Relationship: transactioncurrency transactioncurrency_contract

Property Value
ReferencedEntity transactioncurrency
ReferencedAttribute transactioncurrencyid
ReferencingAttribute transactioncurrencyid
ReferencingEntityNavigationPropertyName transactioncurrencyid
IsHierarchical
CascadeConfiguration Archive: Restrict
Assign: NoCascade
Delete: Restrict
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

One-to-Many relationships

These relationships are one-to-many. Listed by SchemaName.

contract_activity_parties

Many-To-One Relationship: activityparty contract_activity_parties

Property Value
ReferencingEntity activityparty
ReferencingAttribute partyid
ReferencedEntityNavigationPropertyName contract_activity_parties
IsCustomizable False
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

Contract_ActivityPointers

Many-To-One Relationship: activitypointer Contract_ActivityPointers

Property Value
ReferencingEntity activitypointer
ReferencingAttribute regardingobjectid
ReferencedEntityNavigationPropertyName Contract_ActivityPointers
IsCustomizable False
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

contract_adx_inviteredemptions

Many-To-One Relationship: adx_inviteredemption contract_adx_inviteredemptions

Property Value
ReferencingEntity adx_inviteredemption
ReferencingAttribute regardingobjectid
ReferencedEntityNavigationPropertyName contract_adx_inviteredemptions
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

contract_adx_portalcomments

Many-To-One Relationship: adx_portalcomment contract_adx_portalcomments

Property Value
ReferencingEntity adx_portalcomment
ReferencingAttribute regardingobjectid
ReferencedEntityNavigationPropertyName contract_adx_portalcomments
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

Contract_Annotation

Many-To-One Relationship: annotation Contract_Annotation

Property Value
ReferencingEntity annotation
ReferencingAttribute objectid
ReferencedEntityNavigationPropertyName Contract_Annotation
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

Contract_Appointments

Many-To-One Relationship: appointment Contract_Appointments

Property Value
ReferencingEntity appointment
ReferencingAttribute regardingobjectid
ReferencedEntityNavigationPropertyName Contract_Appointments
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

Contract_AsyncOperations

Many-To-One Relationship: asyncoperation Contract_AsyncOperations

Property Value
ReferencingEntity asyncoperation
ReferencingAttribute regardingobjectid
ReferencedEntityNavigationPropertyName Contract_AsyncOperations
IsCustomizable False
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

Contract_BulkDeleteFailures

Many-To-One Relationship: bulkdeletefailure Contract_BulkDeleteFailures

Property Value
ReferencingEntity bulkdeletefailure
ReferencingAttribute regardingobjectid
ReferencedEntityNavigationPropertyName Contract_BulkDeleteFailures
IsCustomizable False
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

contract_cases

Many-To-One Relationship: incident contract_cases

Property Value
ReferencingEntity incident
ReferencingAttribute contractid
ReferencedEntityNavigationPropertyName contract_cases
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: CRMIncident.RetrieveByObject
ViewId: 00000000-0000-0000-00aa-000010003501

contract_chats

Many-To-One Relationship: chat contract_chats

Property Value
ReferencingEntity chat
ReferencingAttribute regardingobjectid
ReferencedEntityNavigationPropertyName contract_chats
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

contract_connections1

Many-To-One Relationship: connection contract_connections1

Property Value
ReferencingEntity connection
ReferencingAttribute record1id
ReferencedEntityNavigationPropertyName contract_connections1
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: UseCollectionName
Group: Details
Label:
MenuId: null
Order: 100
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

contract_connections2

Many-To-One Relationship: connection contract_connections2

Property Value
ReferencingEntity connection
ReferencingAttribute record2id
ReferencedEntityNavigationPropertyName contract_connections2
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order: 100
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

Contract_DuplicateBaseRecord

Many-To-One Relationship: duplicaterecord Contract_DuplicateBaseRecord

Property Value
ReferencingEntity duplicaterecord
ReferencingAttribute baserecordid
ReferencedEntityNavigationPropertyName Contract_DuplicateBaseRecord
IsCustomizable False
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

Contract_DuplicateMatchingRecord

Many-To-One Relationship: duplicaterecord Contract_DuplicateMatchingRecord

Property Value
ReferencingEntity duplicaterecord
ReferencingAttribute duplicaterecordid
ReferencedEntityNavigationPropertyName Contract_DuplicateMatchingRecord
IsCustomizable False
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

Contract_Emails

Many-To-One Relationship: email Contract_Emails

Property Value
ReferencingEntity email
ReferencingAttribute regardingobjectid
ReferencedEntityNavigationPropertyName Contract_Emails
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

Contract_Faxes

Many-To-One Relationship: fax Contract_Faxes

Property Value
ReferencingEntity fax
ReferencingAttribute regardingobjectid
ReferencedEntityNavigationPropertyName Contract_Faxes
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

Contract_Letters

Many-To-One Relationship: letter Contract_Letters

Property Value
ReferencingEntity letter
ReferencingAttribute regardingobjectid
ReferencedEntityNavigationPropertyName Contract_Letters
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

contract_line_items

Many-To-One Relationship: contractdetail contract_line_items

Property Value
ReferencingEntity contractdetail
ReferencingAttribute contractid
ReferencedEntityNavigationPropertyName contract_line_items
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: CRMContractDetail.RetrieveByContract
ViewId: 2922b6fe-7578-4002-b4e1-b5189c28a37a

Contract_MailboxTrackingFolder

Many-To-One Relationship: mailboxtrackingfolder Contract_MailboxTrackingFolder

Property Value
ReferencingEntity mailboxtrackingfolder
ReferencingAttribute regardingobjectid
ReferencedEntityNavigationPropertyName Contract_MailboxTrackingFolder
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

contract_msdyn_copilottranscripts

Many-To-One Relationship: msdyn_copilottranscript contract_msdyn_copilottranscripts

Property Value
ReferencingEntity msdyn_copilottranscript
ReferencingAttribute regardingobjectid
ReferencedEntityNavigationPropertyName contract_msdyn_copilottranscripts
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

contract_msdyn_ocliveworkitems

Many-To-One Relationship: msdyn_ocliveworkitem contract_msdyn_ocliveworkitems

Property Value
ReferencingEntity msdyn_ocliveworkitem
ReferencingAttribute regardingobjectid
ReferencedEntityNavigationPropertyName contract_msdyn_ocliveworkitems
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

contract_msdyn_ocsessions

Many-To-One Relationship: msdyn_ocsession contract_msdyn_ocsessions

Property Value
ReferencingEntity msdyn_ocsession
ReferencingAttribute regardingobjectid
ReferencedEntityNavigationPropertyName contract_msdyn_ocsessions
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

contract_msfp_alerts

Many-To-One Relationship: msfp_alert contract_msfp_alerts

Property Value
ReferencingEntity msfp_alert
ReferencingAttribute regardingobjectid
ReferencedEntityNavigationPropertyName contract_msfp_alerts
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

contract_msfp_surveyinvites

Many-To-One Relationship: msfp_surveyinvite contract_msfp_surveyinvites

Property Value
ReferencingEntity msfp_surveyinvite
ReferencingAttribute regardingobjectid
ReferencedEntityNavigationPropertyName contract_msfp_surveyinvites
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

contract_msfp_surveyresponses

Many-To-One Relationship: msfp_surveyresponse contract_msfp_surveyresponses

Property Value
ReferencingEntity msfp_surveyresponse
ReferencingAttribute regardingobjectid
ReferencedEntityNavigationPropertyName contract_msfp_surveyresponses
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

contract_originating_contract

Many-To-One Relationship: contract contract_originating_contract

Property Value
ReferencingEntity contract
ReferencingAttribute originatingcontract
ReferencedEntityNavigationPropertyName contract_originating_contract
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

Contract_Phonecalls

Many-To-One Relationship: phonecall Contract_Phonecalls

Property Value
ReferencingEntity phonecall
ReferencingAttribute regardingobjectid
ReferencedEntityNavigationPropertyName Contract_Phonecalls
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

contract_principalobjectattributeaccess

Many-To-One Relationship: principalobjectattributeaccess contract_principalobjectattributeaccess

Property Value
ReferencingEntity principalobjectattributeaccess
ReferencingAttribute objectid
ReferencedEntityNavigationPropertyName contract_principalobjectattributeaccess
IsCustomizable False
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

Contract_ProcessSessions

Many-To-One Relationship: processsession Contract_ProcessSessions

Property Value
ReferencingEntity processsession
ReferencingAttribute regardingobjectid
ReferencedEntityNavigationPropertyName Contract_ProcessSessions
IsCustomizable False
AssociatedMenuConfiguration AvailableOffline: True
Behavior: UseCollectionName
Group: Details
Label:
MenuId: null
Order: 110
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

Contract_RecurringAppointmentMasters

Many-To-One Relationship: recurringappointmentmaster Contract_RecurringAppointmentMasters

Property Value
ReferencingEntity recurringappointmentmaster
ReferencingAttribute regardingobjectid
ReferencedEntityNavigationPropertyName Contract_RecurringAppointmentMasters
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

Contract_ServiceAppointments

Many-To-One Relationship: serviceappointment Contract_ServiceAppointments

Property Value
ReferencingEntity serviceappointment
ReferencingAttribute regardingobjectid
ReferencedEntityNavigationPropertyName Contract_ServiceAppointments
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

Contract_SocialActivities

Many-To-One Relationship: socialactivity Contract_SocialActivities

Property Value
ReferencingEntity socialactivity
ReferencingAttribute regardingobjectid
ReferencedEntityNavigationPropertyName Contract_SocialActivities
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

Contract_SyncErrors

Many-To-One Relationship: syncerror Contract_SyncErrors

Property Value
ReferencingEntity syncerror
ReferencingAttribute regardingobjectid
ReferencedEntityNavigationPropertyName Contract_SyncErrors
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

Contract_Tasks

Many-To-One Relationship: task Contract_Tasks

Property Value
ReferencingEntity task
ReferencingAttribute regardingobjectid
ReferencedEntityNavigationPropertyName Contract_Tasks
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

Many-to-Many relationships

These relationships are many-to-many. Listed by SchemaName.

servicecontractcontacts_association

See contact servicecontractcontacts_association Many-To-Many Relationship

Property Value
IntersectEntityName servicecontractcontacts
IsCustomizable False
SchemaName servicecontractcontacts_association
IntersectAttribute contractid
NavigationPropertyName servicecontractcontacts_association
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

See also

Dataverse table/entity reference
Dataverse Web API Reference