Share via


contractdetail EntityType

 

Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

Description: Line item in a contract that specifies the type of service a customer is entitled to.

Entity Set path:[organization URI]/api/data/v8.2/contractdetails

Base Type: crmbaseentity EntityType

Display Name: Contract Line

Primary Key: contractdetailid

Primary Name Attribute: title

Properties

Lookup Properties

Single-valued navigation properties

Collection-valued navigation properties

Properties

Properties represent fields of data stored in the entity. Some properties are read-only.

Name

Type

Details

activeon

Edm.DateTimeOffset

Description: Enter the date when the contract line becomes active.

Display Name: Start Date

allotmentsoverage

Edm.Int32

Description: Shows the number of minutes over the Total Allotments field that have been spent on resolved cases related to the contract line.

Display Name: Allotments Overage

Read-only property

allotmentsremaining

Edm.Int32

Description: Shows the number of cases or minutes remaining, based on the resolved cases logged to the contract line.

Display Name: Allotments Remaining

Read-only property

allotmentsused

Edm.Int32

Description: Shows the number of cases or minutes used in the resolved cases on the contract line.

Display Name: Allotments Used

Read-only property

contractdetailid

Edm.Guid

Description: Unique identifier of the contract line.

Display Name: Contract Line

contractstatecode

Edm.Int32

Description: Status of the contract.

Default Options:

0 : Draft
1 : Invoiced
2 : Active
3 : On Hold
4 : Canceled
5 : Expired

Display Name: Contract State

Read-only property

createdon

Edm.DateTimeOffset

Description: Shows the date and time when the record was created. The date and time are displayed in the time zone selected in Microsoft Dynamics 365 options.

Display Name: Created On

Read-only property

discount

Edm.Decimal

Description: Type the discount amount for the contract line to deduct any negotiated or other savings from the net amount due.

Display Name: Discount

discount_base

Edm.Decimal

Description: Shows the Discount field converted to the system's default base currency. The calculation uses the exchange rate specified in the Currencies area.

Display Name: Discount (Base)

Read-only property

discountpercentage

Edm.Decimal

Description: Type the discount rate that should be applied to the Total Price, for use in calculating the net amount due for the contract line.

Display Name: Discount (%)

effectivitycalendar

Edm.String

Description: Days of the week and times for which the contract line item is effective.

Display Name: Support Calendar

exchangerate

Edm.Decimal

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.

Display Name: Exchange Rate

Read-only property

expireson

Edm.DateTimeOffset

Description: Enter the date when the contract line expires. The date is automatically filled with the contract date, but you can change it if required.

Display Name: End Date

importsequencenumber

Edm.Int32

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

Display Name: Import Sequence Number

initialquantity

Edm.Int32

Description: Type the number of units of the specified product or service that are eligible for support on the contract line.

Display Name: Quantity

lineitemorder

Edm.Int32

Description: Type the line item number for the contract line to easily identify the contract line and make sure it's listed in the correct order in the parent contract.

Display Name: Line Item Order

modifiedon

Edm.DateTimeOffset

Description: Shows the date and time when the record was last updated. The date and time are displayed in the time zone selected in Microsoft Dynamics 365 options.

Display Name: Modified On

Read-only property

net

Edm.Decimal

Description: Shows the total charge to the customer for the contract line, calculated as the Total Price minus any discounts.

Display Name: Net

Read-only property

net_base

Edm.Decimal

Description: Shows the Net field converted to the system's default base currency for reporting purposes. The calculation uses the exchange rate specified in the Currencies area.

Display Name: Net (Base)

Read-only property

overriddencreatedon

Edm.DateTimeOffset

Description: Date and time that the record was migrated.

Display Name: Record Created On

owningbusinessunit

Edm.Guid

Description: Unique identifier of the business unit that owns the contract line.

Display Name: Owning Business Unit

Read-only property

owninguser

Edm.Guid

Description: Unique identifier of the user who owns the contract line.

Display Name: Owning User

Read-only property

price

Edm.Decimal

Description: Type the total service charge for the contract line before any discounts are credited.

Display Name: Total Price

price_base

Edm.Decimal

Description: Shows the Total Price field converted to the system's default base currency for reporting purposes. The calculation uses the exchange rate specified in the Currencies area.

Display Name: Total Price (Base)

Read-only property

productserialnumber

Edm.String

Description: Type the serial number for the product that is eligible for services on the contract line.

Display Name: Serial Number

rate

Edm.Decimal

Description: Shows the cost per case or minute, calculated by dividing the Total Price value by the total number of cases or minutes allocated to the contract line.

Display Name: Rate

Read-only property

rate_base

Edm.Decimal

Description: Shows the Rate field converted to the system's default base currency for reporting purposes. The calculation uses the exchange rate specified in the Currencies area.

Display Name: Rate (Base)

Read-only property

servicecontractunitscode

Edm.Int32

Description: Select the unit type allotted in the contract line, such as cases or minutes, to determine the level of support.

Default Options:

1 : Default Value

Display Name: Service Contract Units

statecode

Edm.Int32

Description: Shows whether the contract line is existing, renewed, canceled, or expired. You can't edit a contract line after it is saved, regardless of the status.

Default Options:

0 : Existing
1 : Renewed
2 : Canceled
3 : Expired

Display Name: Status

statuscode

Edm.Int32

Description: Select the contract line's status.

Default Options:

1 : New
2 : Renewed
3 : Canceled
4 : Expired

Display Name: Status Reason

timezoneruleversionnumber

Edm.Int32

Description: For internal use only.

Display Name: Time Zone Rule Version Number

title

Edm.String

Description: Type a title or name that describes the contract line.

Display Name: Title

totalallotments

Edm.Int32

Description: Type the total number of minutes or cases allowed for the contract line.

Display Name: Total Allotments

utcconversiontimezonecode

Edm.Int32

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

Display Name: UTC Conversion Time Zone Code

versionnumber

Edm.Int64

Description: Version number of the contract template.

Display Name: Version Number

Read-only property

Lookup Properties

Lookup properties are read-only, computed properties which contain entity primary key Edm.Guid data for one or more corresponding single-valued navigation properties. More information: Lookup properties and Retrieve data about lookup properties

Name

Single-valued navigation property

Description

_accountid_value

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

_contactid_value

Unique identifier for the contact associated with the contract line.

_contractid_value

contractid

Unique identifier of the contract associated with the contract line.

_createdby_value

createdby

Shows who created the record.

_createdonbehalfby_value

createdonbehalfby

Shows who created the record on behalf of another user.

_customerid_value

customerid_account

customerid_contact

Select the customer account or contact to provide a quick link to additional customer details, such as address, phone number, activities, and orders.

_modifiedby_value

modifiedby

Shows who last updated the record.

_modifiedonbehalfby_value

modifiedonbehalfby

Shows who last updated the record on behalf of another user.

_ownerid_value

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

_productid_value

productid

Choose the product that is eligible for services on the contract line.

_serviceaddress_value

serviceaddress

Choose the address for the customer account or contact where the services are provided.

_transactioncurrencyid_value

transactioncurrencyid

Choose the local currency for the record to make sure budgets are reported in the correct currency.

_uomid_value

uomid

Choose the unit of measurement for the base unit quantity for this purchase, such as each or dozen.

_uomscheduleid_value

uomscheduleid

Unique identifier of the unit group associated with the contract line.

Single-valued navigation properties

Single-valued navigation properties represent lookup fields where a single entity can be referenced. Each single-valued navigation property has a corresponding partner collection-valued navigation property on the related entity.

Name

Type

Partner

contractid

contract EntityType

contract_line_items

createdby

systemuser EntityType

lk_contractdetailbase_createdby

createdonbehalfby

systemuser EntityType

lk_contractdetail_createdonbehalfby

customerid_account

account EntityType

contractlineitem_customer_accounts

customerid_contact

contact EntityType

contractlineitem_customer_contacts

modifiedby

systemuser EntityType

lk_contractdetailbase_modifiedby

modifiedonbehalfby

systemuser EntityType

lk_contractdetail_modifiedonbehalfby

productid

product EntityType

product_contract_line_items

serviceaddress

customeraddress EntityType

customer_address_contract_line_items

transactioncurrencyid

transactioncurrency EntityType

transactioncurrency_contractdetail

uomid

uom EntityType

unit_of_measurement_contract_line_items

uomscheduleid

uomschedule EntityType

contract_detail_unit_of_measure_schedule

Collection-valued navigation properties

Collection-valued navigation properties represent collections of entities which may represent either a one-to-many (1:N) or many-to-many (N:N) relationship between the entities.

Name

Type

Partner

contract_detail_cases

incident EntityType

contractdetailid

ContractDetail_Annotation

annotation EntityType

objectid_contractdetail

ContractDetail_AsyncOperations

asyncoperation EntityType

regardingobjectid_contractdetail

ContractDetail_BulkDeleteFailures

bulkdeletefailure EntityType

regardingobjectid_contractdetail

ContractDetail_SyncErrors

syncerror EntityType

regardingobjectid_contractdetail_syncerror

See Also

Use the Microsoft Dynamics 365 Web API
Web API Action Reference
Web API Function Reference
Web API Query Function Reference
Web API EnumType Reference
Web API ComplexType Reference
Web API Metadata EntityType Reference

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright