contract EntityType

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

Entity Set Path
[organization URI]/api/data/v9.0/contracts
Base Type
crmbaseentity
Display Name
Contract
Primary Key
contractid
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 becomes active.

Display Name: Contract Start Date

allotmenttypecode Edm.Int32

Type of allotment that the contract supports.

Display Name: Allotment Type

Default Options
Value Label
1 Number of Cases
2 Time
3 Coverage Dates
billingendon Edm.DateTimeOffset

Enter the end date for the contract's billing period to indicate the period for which the customer must pay for a service.

Display Name: Billing End Date

billingfrequencycode Edm.Int32

Select the billing schedule of the contract to indicate how often the customer should be invoiced.

Display Name: Billing Frequency

Default Options
Value Label
1 Monthly
2 Bimonthly
3 Quarterly
4 Semiannually
5 Annually
billingstarton Edm.DateTimeOffset

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.

Display Name: Billing Start Date

cancelon Edm.DateTimeOffset

Shows the date and time when the contract was canceled.

Display Name: Cancellation Date

Read Only
contractid Edm.Guid

Unique identifier of the contract.

Display Name: Contract

contractlanguage Edm.String

Type additional information about the contract, such as the products or services provided to the customer.

Display Name: Description

contractnumber Edm.String

Shows the number for the contract for customer reference and searching capabilities. You cannot modify this number.

Display Name: Contract ID

contractservicelevelcode Edm.Int32

Select the level of service that should be provided for the contract based on your company's definition of bronze, silver, or gold.

Display Name: Service Level

Default Options
Value Label
1 Gold
2 Silver
3 Bronze
contracttemplateabbreviation Edm.String

Shows the abbreviation of the contract template selected when the contract is created.

Display Name: Template Abbreviation

Read Only
createdon Edm.DateTimeOffset

Date and time when the record was created.

Display Name: Created On

Read Only
duration Edm.Int32

Shows for the duration of the contract, in days, based on the contract start and end dates.

Display Name: Duration

Read Only
effectivitycalendar Edm.String

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

Display Name: Support Calendar

emailaddress Edm.String

The primary email address for the entity.

Display Name: Email Address

entityimage Edm.Binary

The default image for the entity.

Display Name: Entity Image

entityimage_timestamp Edm.Int64
Read Only
entityimage_url Edm.String
Read Only
entityimageid Edm.Guid
Read Only
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 expires.

Display Name: Contract End Date

importsequencenumber Edm.Int32

Sequence number of the import that created this record.

Display Name: Import Sequence Number

modifiedon Edm.DateTimeOffset

Date and time when the record was modified.

Display Name: Modified On

Read Only
netprice Edm.Decimal

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.

Display Name: Net Price

Read Only
netprice_base Edm.Decimal

Value of the Net Price in base currency.

Display Name: Net Price (Base)

Read Only
overriddencreatedon Edm.DateTimeOffset

Date and time that the record was migrated.

Display Name: Record Created On

statecode Edm.Int32

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.

Display Name: Status

Default Options
Value Label
0 Draft
1 Invoiced
2 Active
3 On Hold
4 Canceled
5 Expired
statuscode Edm.Int32

Select the contract's status.

Display Name: Status Reason

Default Options
Value Label
1 Draft
2 Invoiced
3 Active
4 On Hold
5 Canceled
6 Expired
timezoneruleversionnumber Edm.Int32

For internal use only.

Display Name: Time Zone Rule Version Number

title Edm.String

Type a title or name for the contract that indicates the purpose of the contract.

Display Name: Contract Name

totaldiscount Edm.Decimal

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.

Display Name: Total Discount

Read Only
totaldiscount_base Edm.Decimal

Value of the Total Discount in base currency.

Display Name: Total Discount (Base)

Read Only
totalprice Edm.Decimal

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.

Display Name: Total Price

Read Only
totalprice_base Edm.Decimal

Value of the Total Price in base currency.

Display Name: Total Price (Base)

Read Only
usediscountaspercentage Edm.Boolean

Select whether the discounts entered on contract lines for this contract should be entered as a percentage or a fixed dollar value.

Display Name: Discount

Default Options
Value Label
1 Percentage
0 Amount
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.

_billingaccountid_value

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

_billingcontactid_value

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

_billingcustomerid_value billingcustomerid_accountbillingcustomerid_contact

Select the customer account or contact to which the contract should be billed to provide a quick link to address and other customer details.

_billtoaddress_value billtoaddress

Choose which address to send the invoice to.

_contactid_value

Unique identifier of the contact specified for the contract.

_contracttemplateid_value contracttemplateid

Choose the contract template that should be used to determine the terms of the contract, such as allotment type, available hours, and billing frequency.

_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.

_originatingcontract_value originatingcontract

Choose the original contract that this contract was created from. This information is used to track renewal history.

_ownerid_value ownerid

Owner Id

_owningbusinessunit_value owningbusinessunit

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.

_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.

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
billingcustomerid_account account contract_billingcustomer_accounts
billingcustomerid_contact contact contract_billingcustomer_contacts
billtoaddress customeraddress customer_address_contracts_as_billing_address
contracttemplateid contracttemplate contract_template_contracts
createdby systemuser lk_contractbase_createdby
createdonbehalfby systemuser lk_contract_createdonbehalfby
customerid_account account contract_customer_accounts
customerid_contact contact contract_customer_contacts
modifiedby systemuser lk_contractbase_modifiedby
modifiedonbehalfby systemuser lk_contract_modifiedonbehalfby
originatingcontract contract contract_originating_contract
ownerid principal owner_contracts
owningbusinessunit businessunit business_unit_service_contracts
owningteam team team_service_contracts
owninguser systemuser system_user_service_contracts
serviceaddress customeraddress customer_address_contracts_as_service_address
transactioncurrencyid transactioncurrency transactioncurrency_contract

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_activity_parties activityparty partyid_contract
Contract_ActivityPointers activitypointer regardingobjectid_contract
Contract_Annotation annotation objectid_contract
Contract_Appointments appointment regardingobjectid_contract_appointment
Contract_AsyncOperations asyncoperation regardingobjectid_contract
Contract_BulkDeleteFailures bulkdeletefailure regardingobjectid_contract
contract_cases incident contractid
contract_connections1 connection record1id_contract
contract_connections2 connection record2id_contract
Contract_DuplicateBaseRecord duplicaterecord baserecordid_contract
Contract_DuplicateMatchingRecord duplicaterecord duplicaterecordid_contract
Contract_Emails email regardingobjectid_contract_email
Contract_Faxes fax regardingobjectid_contract_fax
Contract_Letters letter regardingobjectid_contract_letter
contract_line_items contractdetail contractid
Contract_MailboxTrackingFolder mailboxtrackingfolder regardingobjectid_contract
contract_msdyn_approvals msdyn_approval regardingobjectid_contract_msdyn_approval
contract_msdyn_bookingalerts msdyn_bookingalert regardingobjectid_contract_msdyn_bookingalert
contract_originating_contract contract originatingcontract
Contract_Phonecalls phonecall regardingobjectid_contract_phonecall
contract_principalobjectattributeaccess principalobjectattributeaccess objectid_contract
Contract_ProcessSessions processsession regardingobjectid_contract
Contract_RecurringAppointmentMasters recurringappointmentmaster regardingobjectid_contract_recurringappointmentmaster
Contract_ServiceAppointments serviceappointment regardingobjectid_contract_serviceappointment
Contract_SocialActivities socialactivity regardingobjectid_contract_socialactivity
Contract_SyncErrors syncerror regardingobjectid_contract_syncerror
Contract_Tasks task regardingobjectid_contract_task
servicecontractcontacts_association contact servicecontractcontacts_association

Operations

The following operations can be used with the contract entity type.

Name Binding
CancelContract Entity
CancelSalesOrder Not Bound
CloneContract Entity
GrantAccess Not Bound
ModifyAccess Not Bound
RenewContract Entity
RetrievePrincipalAccess Not Bound
RetrieveSharedPrincipalsAndAccess Not Bound
RevokeAccess Not Bound
Rollup Not Bound

Solutions

The following solutions include the contract entity type.

Name Description
Service Dynamics 365 workload for service.

See also