Поделиться через


contract EntityType

 

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

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

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

Base Type: crmbaseentity EntityType

Display Name: Contract

Primary Key: contractid

Primary Name Attribute: title

Properties

Lookup Properties

Single-valued navigation properties

Collection-valued navigation properties

Operations bound to contract

Operations using the contract entity type.

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 becomes active.

Display Name: Contract Start Date

allotmenttypecode

Edm.Int32

Description: Type of allotment that the contract supports.

Default Options:

1 : Number of Cases
2 : Time
3 : Coverage Dates

Display Name: Allotment Type

billingendon

Edm.DateTimeOffset

Description: 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

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

Default Options:

1 : Monthly
2 : Bimonthly
3 : Quarterly
4 : Semiannually
5 : Annually

Display Name: Billing Frequency

billingstarton

Edm.DateTimeOffset

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.

Display Name: Billing Start Date

cancelon

Edm.DateTimeOffset

Description: Shows the date and time when the contract was canceled.

Display Name: Cancellation Date

Read-only property

contractid

Edm.Guid

Description: Unique identifier of the contract.

Display Name: Contract

contractlanguage

Edm.String

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

Display Name: Description

contractnumber

Edm.String

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

Display Name: Contract ID

contractservicelevelcode

Edm.Int32

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

Default Options:

1 : Gold
2 : Silver
3 : Bronze

Display Name: Service Level

contracttemplateabbreviation

Edm.String

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

Display Name: Template Abbreviation

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

duration

Edm.Int32

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

Display Name: Duration

Read-only property

effectivitycalendar

Edm.String

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

Display Name: Support Calendar

entityimage

Edm.Binary

Description: The default image for the entity.

Display Name: Entity Image

entityimage_timestamp

Edm.Int64

Description:

Read-only property

entityimage_url

Edm.String

Description:

Read-only property

entityimageid

Edm.Guid

Description: For internal use only.

Display Name: Entity Image Id

Read-only property

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

Display Name: Contract End Date

importsequencenumber

Edm.Int32

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

Display Name: Import Sequence Number

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

netprice

Edm.Decimal

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.

Display Name: Net Price

Read-only property

netprice_base

Edm.Decimal

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

Display Name: Net Price (Base)

Read-only property

overriddencreatedon

Edm.DateTimeOffset

Description: Date and time that the record was migrated.

Display Name: Record Created On

statecode

Edm.Int32

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.

Default Options:

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

Display Name: Status

statuscode

Edm.Int32

Description: Select the contract's status.

Default Options:

1 : Draft
2 : Invoiced
3 : Active
4 : On Hold
5 : Canceled
6 : 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 for the contract that indicates the purpose of the contract.

Display Name: Contract Name

totaldiscount

Edm.Decimal

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.

Display Name: Total Discount

Read-only property

totaldiscount_base

Edm.Decimal

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

Display Name: Total Discount (Base)

Read-only property

totalprice

Edm.Decimal

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.

Display Name: Total Price

Read-only property

totalprice_base

Edm.Decimal

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

Display Name: Total Price (Base)

Read-only property

usediscountaspercentage

Edm.Boolean

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

Default Options:

1 : Percentage
0 : Amount

Display Name: Discount

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.

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.

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

billingcustomerid_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_contact

customerid_account

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

Enter the user or team who is assigned to manage the record. This field is updated every time the record is assigned to a different user.

_owningbusinessunit_value

owningbusinessunit

Unique identifier of the business unit that owns the contract.

_owningteam_value

owningteam

Unique identifier of the team who owns the contract.

_owninguser_value

owninguser

Unique identifier of the user who owns the contract.

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

contract_billingcustomer_accounts

billingcustomerid_contact

contact EntityType

contract_billingcustomer_contacts

billtoaddress

customeraddress EntityType

customer_address_contracts_as_billing_address

contracttemplateid

contracttemplate EntityType

contract_template_contracts

createdby

systemuser EntityType

lk_contractbase_createdby

createdonbehalfby

systemuser EntityType

lk_contract_createdonbehalfby

customerid_account

account EntityType

contract_customer_accounts

customerid_contact

contact EntityType

contract_customer_contacts

modifiedby

systemuser EntityType

lk_contractbase_modifiedby

modifiedonbehalfby

systemuser EntityType

lk_contract_modifiedonbehalfby

originatingcontract

contract EntityType

contract_originating_contract

ownerid

principal EntityType

owner_contracts

owningbusinessunit

businessunit EntityType

business_unit_service_contracts

owningteam

team EntityType

team_service_contracts

owninguser

systemuser EntityType

system_user_service_contracts

serviceaddress

customeraddress EntityType

customer_address_contracts_as_service_address

transactioncurrencyid

transactioncurrency EntityType

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 EntityType

partyid_contract

Contract_ActivityPointers

activitypointer EntityType

regardingobjectid_contract

Contract_Annotation

annotation EntityType

objectid_contract

Contract_Appointments

appointment EntityType

regardingobjectid_contract_appointment

Contract_AsyncOperations

asyncoperation EntityType

regardingobjectid_contract

Contract_BulkDeleteFailures

bulkdeletefailure EntityType

regardingobjectid_contract

contract_cases

incident EntityType

contractid

contract_connections1

connection EntityType

record1id_contract

contract_connections2

connection EntityType

record2id_contract

Contract_DuplicateBaseRecord

duplicaterecord EntityType

baserecordid_contract

Contract_DuplicateMatchingRecord

duplicaterecord EntityType

duplicaterecordid_contract

Contract_Emails

email EntityType

regardingobjectid_contract_email

Contract_Faxes

fax EntityType

regardingobjectid_contract_fax

Contract_Letters

letter EntityType

regardingobjectid_contract_letter

contract_line_items

contractdetail EntityType

contractid

contract_originating_contract

contract EntityType

originatingcontract

Contract_Phonecalls

phonecall EntityType

regardingobjectid_contract_phonecall

Contract_RecurringAppointmentMasters

recurringappointmentmaster EntityType

regardingobjectid_contract_recurringappointmentmaster

Contract_ServiceAppointments

serviceappointment EntityType

regardingobjectid_contract_serviceappointment

Contract_SocialActivities

socialactivity EntityType

regardingobjectid_contract_socialactivity

Contract_SyncErrors

syncerror EntityType

regardingobjectid_contract_syncerror

Contract_Tasks

task EntityType

regardingobjectid_contract_task

servicecontractcontacts_association

contact EntityType

servicecontractcontacts_association

Operations bound to contract

The following operations are bound to the contract entity type.

Name

Bound to

CancelContract Action

Entity

CloneContract Action

Entity

RenewContract Action

Entity

Operations using the contract entity type.

The following operations use the contract entity type in a parameter or return type.

Name

How used

Description

CancelContract Action

entity Parameter

Cancels a contract.

CloneContract Action

entity Parameter

Copies an existing contract and its line items.

CloneContract Action

ReturnType

Copies an existing contract and its line items.

RenewContract Action

entity Parameter

Renews a contract and create the contract details for a new contract.

RenewContract Action

ReturnType

Renews a contract and create the contract details for a new contract.

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