contracttemplate EntityType

Entity Set Path
[organization URI]/api/data/v9.0/contracttemplates
Base Type
crmbaseentity
Display Name
Contract Template
Primary Key
contracttemplateid
Primary Key Attribute
name
Operations Supported
POST GET PATCH DELETE

Properties

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

Name Type Details
abbreviation Edm.String

Abbreviation of the contract template name.

Display Name: Abbreviation

allotmenttypecode Edm.Int32

Criteria for the contracts based on the template, such as number of cases, time, or coverage dates.

Display Name: Allotment Type

Default Options
Value Label
1 Number of Cases
2 Time
3 Coverage Dates
billingfrequencycode Edm.Int32

How often the customer or account is to be billed in contracts that are based on the template.

Display Name: Billing Frequency

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

For internal use only.

Display Name: Component State

Read Only
Default Options
Value Label
0 Published
1 Unpublished
2 Deleted
3 Deleted Unpublished
contractservicelevelcode Edm.Int32

Unique identifier of the level of service specified in contracts that are based on the template.

Display Name: Contract Service Level

Default Options
Value Label
1 Gold
2 Silver
3 Bronze
contracttemplateid Edm.Guid

Unique identifier of the contract template.

Display Name: Contract Template

contracttemplateidunique Edm.Guid

For internal use only.

Read Only
createdon Edm.DateTimeOffset

Date and time when the contract template was created.

Display Name: Created On

Read Only
description Edm.String

Description of the contract template.

Display Name: Description

effectivitycalendar Edm.String

Days of the week and times for which contracts based on the template are effective.

Display Name: Support Calendar

importsequencenumber Edm.Int32

Sequence number of the import that created this record.

Display Name: Import Sequence Number

introducedversion Edm.String

Version in which the form is introduced.

Display Name: Introduced Version

iscustomizable BooleanManagedProperty

Information that specifies whether this component can be customized.

Display Name: Customizable

ismanaged Edm.Boolean

Indicates whether the solution component is part of a managed solution.

Display Name: Is Managed

Read Only
Default Options
Value Label
1 Managed
0 Unmanaged
modifiedon Edm.DateTimeOffset

Date and time when the contract template was last modified.

Display Name: Modified On

Read Only
name Edm.String

Name of the contract template.

Display Name: Name

overriddencreatedon Edm.DateTimeOffset

Date and time that the record was migrated.

Display Name: Record Created On

overwritetime Edm.DateTimeOffset

For internal use only.

Display Name: Record Overwrite Time

Read Only
solutionid Edm.Guid

Unique identifier of the associated solution.

Display Name: Solution

Read Only
timezoneruleversionnumber Edm.Int32

For internal use only.

Display Name: Time Zone Rule Version Number

usediscountaspercentage Edm.Boolean

Specifies whether the discount is a percentage or a monetary amount in contracts based on the template.

Display Name: Use Discount as Percentage

Default Options
Value Label
1 Yes
0 No
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
_createdby_value createdby

Unique identifier of the user who created the contract template.

_createdonbehalfby_value createdonbehalfby

Unique identifier of the delegate user who created the contracttemplate.

_modifiedby_value modifiedby

Unique identifier of the user who last modified the contract template.

_modifiedonbehalfby_value modifiedonbehalfby

Unique identifier of the delegate user who last modified the contracttemplate.

_organizationid_value organizationid

Unique identifier for the organization

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
createdby systemuser lk_contracttemplatebase_createdby
createdonbehalfby systemuser lk_contracttemplate_createdonbehalfby
modifiedby systemuser lk_contracttemplatebase_modifiedby
modifiedonbehalfby systemuser lk_contracttemplate_modifiedonbehalfby
organizationid organization organization_contract_templates

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_template_contracts contract contracttemplateid
ContractTemplate_AsyncOperations asyncoperation regardingobjectid_contracttemplate
ContractTemplate_BulkDeleteFailures bulkdeletefailure regardingobjectid_contracttemplate
contracttemplate_MailboxTrackingFolders mailboxtrackingfolder regardingobjectid_contracttemplate
contracttemplate_PrincipalObjectAttributeAccesses principalobjectattributeaccess objectid_contracttemplate
ContractTemplate_ProcessSessions processsession regardingobjectid_contracttemplate
ContractTemplate_SyncErrors syncerror regardingobjectid_contracttemplate_syncerror

Solutions

The following solutions include the contracttemplate entity type.

Name Description
Service Dynamics 365 workload for service.

See Also