contractdetail EntityType

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

Entity Set Path
[organization URI]/api/data/v9.0/contractdetails
Base Type
crmbaseentity
Display Name
Contract Line
Primary Key
contractdetailid
Primary Key Attribute
title
Operations Supported
POST GET PATCH DELETE

Properties

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

Name Type Details
activeon Edm.DateTimeOffset

Enter the date when the contract line becomes active.

Display Name: Start Date

allotmentsoverage Edm.Int32

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
allotmentsremaining Edm.Int32

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

Display Name: Allotments Remaining

Read Only
allotmentsused Edm.Int32

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

Display Name: Allotments Used

Read Only
contractdetailid Edm.Guid

Unique identifier of the contract line.

Display Name: Contract Line

contractstatecode Edm.Int32

Status of the contract.

Display Name: Contract State

Read Only
createdon Edm.DateTimeOffset

Date and time when the record was created.

Display Name: Created On

Read Only
discount Edm.Decimal

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

Value of the Discount in base currency.

Display Name: Discount (Base)

Read Only
discountpercentage Edm.Decimal

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

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

Display Name: Support Calendar

exchangerate Edm.Decimal

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
expireson Edm.DateTimeOffset

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

Sequence number of the import that created this record.

Display Name: Import Sequence Number

initialquantity Edm.Int32

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

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

Date and time when the record was modified.

Display Name: Modified On

Read Only
net Edm.Decimal

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

Display Name: Net

Read Only
net_base Edm.Decimal

Value of the Net in base currency.

Display Name: Net (Base)

Read Only
overriddencreatedon Edm.DateTimeOffset

Date and time that the record was migrated.

Display Name: Record Created On

price Edm.Decimal

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

Display Name: Total Price

price_base Edm.Decimal

Value of the Total Price in base currency.

Display Name: Total Price (Base)

Read Only
productserialnumber Edm.String

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

Display Name: Serial Number

rate Edm.Decimal

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
rate_base Edm.Decimal

Value of the Rate in base currency.

Display Name: Rate (Base)

Read Only
servicecontractunitscode Edm.Int32

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

Display Name: Service Contract Units

Default Options
Value Label
1 Default Value
statecode Edm.Int32

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.

Display Name: Status

Default Options
Value Label
0 Existing
1 Renewed
2 Canceled
3 Expired
statuscode Edm.Int32

Select the contract line's status.

Display Name: Status Reason

Default Options
Value Label
1 New
2 Renewed
3 Canceled
4 Expired
timezoneruleversionnumber Edm.Int32

For internal use only.

Display Name: Time Zone Rule Version Number

title Edm.String

Type a title or name that describes the contract line.

Display Name: Title

totalallotments Edm.Int32

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

Display Name: Total Allotments

utcconversiontimezonecode Edm.Int32

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

Display Name: UTC Conversion Time Zone Code

versionnumber Edm.Int64

Version Number

Display Name: Version Number

Read Only

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_accountcustomerid_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

Owner Id

_owningbusinessunit_value

Unique identifier for the business unit that owns the record

_owningteam_value owningteam

Unique identifier for the team that owns the record.

_owninguser_value owninguser

Unique identifier for the user that owns the record.

_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 contract_line_items
createdby systemuser lk_contractdetailbase_createdby
createdonbehalfby systemuser lk_contractdetail_createdonbehalfby
customerid_account account contractlineitem_customer_accounts
customerid_contact contact contractlineitem_customer_contacts
modifiedby systemuser lk_contractdetailbase_modifiedby
modifiedonbehalfby systemuser lk_contractdetail_modifiedonbehalfby
owningteam team team_contractdetail
owninguser systemuser user_contractdetail
productid product product_contract_line_items
serviceaddress customeraddress customer_address_contract_line_items
transactioncurrencyid transactioncurrency transactioncurrency_contractdetail
uomid uom unit_of_measurement_contract_line_items
uomscheduleid uomschedule 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 contractdetailid
ContractDetail_Annotation annotation objectid_contractdetail
ContractDetail_AsyncOperations asyncoperation regardingobjectid_contractdetail
ContractDetail_BulkDeleteFailures bulkdeletefailure regardingobjectid_contractdetail
contractdetail_MailboxTrackingFolders mailboxtrackingfolder regardingobjectid_contractdetail
contractdetail_principalobjectattributeaccess principalobjectattributeaccess objectid_contractdetail
ContractDetail_ProcessSessions processsession regardingobjectid_contractdetail
ContractDetail_SyncErrors syncerror regardingobjectid_contractdetail_syncerror

Solutions

The following solutions include the contractdetail entity type.

Name Description
Service Dynamics 365 workload for service.

See also