Contract Template (ContractTemplate) table/entity reference (Microsoft Dynamics 365)
Template for a contract containing the standard attributes of a contract.
Messages
The following table lists the messages for the Contract Template (ContractTemplate) table. Messages represent operations that can be performed on the table. They may also be events.
Name Is Event? |
Web API Operation | SDK for .NET |
---|---|---|
Associate Event: True |
Associate records | Associate records |
Create Event: True |
POST /contracttemplatesSee Create |
Create records |
CreateMultiple Event: True |
CreateMultiple | CreateMultipleRequest |
Delete Event: True |
DELETE /contracttemplates(contracttemplateid)See Delete |
Delete records |
Disassociate Event: True |
Disassociate records | Disassociate records |
Retrieve Event: True |
GET /contracttemplates(contracttemplateid)See Retrieve |
Retrieve records |
RetrieveMultiple Event: True |
GET /contracttemplatesSee Query data |
Query data |
Update Event: True |
PATCH /contracttemplates(contracttemplateid)See Update |
Update records |
UpdateMultiple Event: True |
UpdateMultiple | UpdateMultipleRequest |
Upsert Event: False |
PATCH /contracttemplates(contracttemplateid)See Upsert a table row |
UpsertRequest |
UpsertMultiple Event: False |
UpsertMultiple | UpsertMultipleRequest |
Properties
The following table lists selected properties for the Contract Template (ContractTemplate) table.
Property | Value |
---|---|
DisplayName | Contract Template |
DisplayCollectionName | Contract Templates |
SchemaName | ContractTemplate |
CollectionSchemaName | ContractTemplates |
EntitySetName | contracttemplates |
LogicalName | contracttemplate |
LogicalCollectionName | contracttemplates |
PrimaryIdAttribute | contracttemplateid |
PrimaryNameAttribute | name |
TableType | Standard |
OwnershipType | OrganizationOwned |
Writable columns/attributes
These columns/attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.
- Abbreviation
- AllotmentTypeCode
- BillingFrequencyCode
- ContractServiceLevelCode
- ContractTemplateId
- Description
- EffectivityCalendar
- ImportSequenceNumber
- IntroducedVersion
- IsCustomizable
- Name
- OverriddenCreatedOn
- TimeZoneRuleVersionNumber
- UseDiscountAsPercentage
- UTCConversionTimeZoneCode
Abbreviation
Property | Value |
---|---|
Description | Abbreviation of the contract template name. |
DisplayName | Abbreviation |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | abbreviation |
RequiredLevel | SystemRequired |
Type | String |
Format | Text |
FormatName | Text |
ImeMode | Auto |
IsLocalizable | False |
MaxLength | 20 |
AllotmentTypeCode
Property | Value |
---|---|
Description | Criteria for the contracts based on the template, such as number of cases, time, or coverage dates. |
DisplayName | Allotment Type |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | allotmenttypecode |
RequiredLevel | None |
Type | Picklist |
DefaultFormValue | 1 |
GlobalChoiceName | contracttemplate_allotmenttypecode |
AllotmentTypeCode Choices/Options
Value | Label |
---|---|
1 | Number of Cases |
2 | Time |
3 | Coverage Dates |
BillingFrequencyCode
Property | Value |
---|---|
Description | How often the customer or account is to be billed in contracts that are based on the template. |
DisplayName | Billing Frequency |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | billingfrequencycode |
RequiredLevel | None |
Type | Picklist |
DefaultFormValue | 1 |
GlobalChoiceName | contracttemplate_billingfrequencycode |
BillingFrequencyCode Choices/Options
Value | Label |
---|---|
1 | Monthly |
2 | Bimonthly |
3 | Quarterly |
4 | Semiannually |
5 | Annually |
ContractServiceLevelCode
Property | Value |
---|---|
Description | Unique identifier of the level of service specified in contracts that are based on the template. |
DisplayName | Contract Service Level |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | contractservicelevelcode |
RequiredLevel | None |
Type | Picklist |
DefaultFormValue | 1 |
GlobalChoiceName | contracttemplate_contractservicelevelcode |
ContractServiceLevelCode Choices/Options
Value | Label |
---|---|
1 | Gold |
2 | Silver |
3 | Bronze |
ContractTemplateId
Property | Value |
---|---|
Description | Unique identifier of the contract template. |
DisplayName | Contract Template |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | contracttemplateid |
RequiredLevel | SystemRequired |
Type | Uniqueidentifier |
Description
Property | Value |
---|---|
Description | Description of the contract template. |
DisplayName | Description |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | description |
RequiredLevel | None |
Type | Memo |
Format | Text |
FormatName | Text |
ImeMode | Auto |
IsLocalizable | False |
MaxLength | 2000 |
EffectivityCalendar
Property | Value |
---|---|
Description | Days of the week and times for which contracts based on the template are effective. |
DisplayName | Support Calendar |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | effectivitycalendar |
RequiredLevel | None |
Type | String |
Format | Text |
FormatName | Text |
ImeMode | Auto |
IsLocalizable | False |
MaxLength | 168 |
ImportSequenceNumber
Property | Value |
---|---|
Description | Sequence number of the import that created this record. |
DisplayName | Import Sequence Number |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | importsequencenumber |
RequiredLevel | None |
Type | Integer |
MaxValue | 2147483647 |
MinValue | -2147483648 |
IntroducedVersion
Property | Value |
---|---|
Description | Version in which the form is introduced. |
DisplayName | Introduced Version |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | introducedversion |
RequiredLevel | None |
Type | String |
Format | VersionNumber |
FormatName | VersionNumber |
ImeMode | Auto |
IsLocalizable | False |
MaxLength | 48 |
IsCustomizable
Property | Value |
---|---|
Description | Information that specifies whether this component can be customized. |
DisplayName | Customizable |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | iscustomizable |
RequiredLevel | SystemRequired |
Type | ManagedProperty |
Name
Property | Value |
---|---|
Description | Name of the contract template. |
DisplayName | Name |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | name |
RequiredLevel | SystemRequired |
Type | String |
Format | Text |
FormatName | Text |
ImeMode | Auto |
IsLocalizable | False |
MaxLength | 100 |
OverriddenCreatedOn
Property | Value |
---|---|
Description | Date and time that the record was migrated. |
DisplayName | Record Created On |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | overriddencreatedon |
RequiredLevel | None |
Type | DateTime |
CanChangeDateTimeBehavior | False |
DateTimeBehavior | UserLocal |
Format | DateOnly |
ImeMode | Inactive |
SourceTypeMask | 0 |
TimeZoneRuleVersionNumber
Property | Value |
---|---|
Description | For internal use only. |
DisplayName | Time Zone Rule Version Number |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | timezoneruleversionnumber |
RequiredLevel | None |
Type | Integer |
MaxValue | 2147483647 |
MinValue | -1 |
UseDiscountAsPercentage
Property | Value |
---|---|
Description | Specifies whether the discount is a percentage or a monetary amount in contracts based on the template. |
DisplayName | Use Discount as Percentage |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | usediscountaspercentage |
RequiredLevel | None |
Type | Boolean |
GlobalChoiceName | contracttemplate_usediscountaspercentage |
DefaultValue | False |
True Label | Yes |
False Label | No |
UTCConversionTimeZoneCode
Property | Value |
---|---|
Description | Time zone code that was in use when the record was created. |
DisplayName | UTC Conversion Time Zone Code |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | utcconversiontimezonecode |
RequiredLevel | None |
Type | Integer |
MaxValue | 2147483647 |
MinValue | -1 |
Read-only columns/attributes
These columns/attributes return false for both IsValidForCreate and IsValidForUpdate. Listed by SchemaName.
- ComponentState
- ContractTemplateIdUnique
- CreatedBy
- CreatedOn
- CreatedOnBehalfBy
- IsManaged
- ModifiedBy
- ModifiedOn
- ModifiedOnBehalfBy
- OrganizationId
- OverwriteTime
- SolutionId
- SupportingSolutionId
- VersionNumber
ComponentState
Property | Value |
---|---|
Description | For internal use only. |
DisplayName | Component State |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | componentstate |
RequiredLevel | SystemRequired |
Type | Picklist |
DefaultFormValue | -1 |
GlobalChoiceName | componentstate |
ComponentState Choices/Options
Value | Label |
---|---|
0 | Published |
1 | Unpublished |
2 | Deleted |
3 | Deleted Unpublished |
ContractTemplateIdUnique
Property | Value |
---|---|
Description | For internal use only. |
DisplayName | |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | contracttemplateidunique |
RequiredLevel | SystemRequired |
Type | Uniqueidentifier |
CreatedBy
Property | Value |
---|---|
Description | Unique identifier of the user who created the contract template. |
DisplayName | Created By |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | createdby |
RequiredLevel | None |
Type | Lookup |
Targets | systemuser |
CreatedOn
Property | Value |
---|---|
Description | Date and time when the contract template was created. |
DisplayName | Created On |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | createdon |
RequiredLevel | None |
Type | DateTime |
CanChangeDateTimeBehavior | False |
DateTimeBehavior | UserLocal |
Format | DateAndTime |
ImeMode | Inactive |
SourceTypeMask | 0 |
CreatedOnBehalfBy
Property | Value |
---|---|
Description | Unique identifier of the delegate user who created the contracttemplate. |
DisplayName | Created By (Delegate) |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | createdonbehalfby |
RequiredLevel | None |
Type | Lookup |
Targets | systemuser |
IsManaged
Property | Value |
---|---|
Description | Indicates whether the solution component is part of a managed solution. |
DisplayName | Is Managed |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | ismanaged |
RequiredLevel | SystemRequired |
Type | Boolean |
GlobalChoiceName | ismanaged |
DefaultValue | False |
True Label | Managed |
False Label | Unmanaged |
ModifiedBy
Property | Value |
---|---|
Description | Unique identifier of the user who last modified the contract template. |
DisplayName | Modified By |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | modifiedby |
RequiredLevel | None |
Type | Lookup |
Targets | systemuser |
ModifiedOn
Property | Value |
---|---|
Description | Date and time when the contract template was last modified. |
DisplayName | Modified On |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | modifiedon |
RequiredLevel | None |
Type | DateTime |
CanChangeDateTimeBehavior | False |
DateTimeBehavior | UserLocal |
Format | DateAndTime |
ImeMode | Inactive |
SourceTypeMask | 0 |
ModifiedOnBehalfBy
Property | Value |
---|---|
Description | Unique identifier of the delegate user who last modified the contracttemplate. |
DisplayName | Modified By (Delegate) |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | modifiedonbehalfby |
RequiredLevel | None |
Type | Lookup |
Targets | systemuser |
OrganizationId
Property | Value |
---|---|
Description | Unique identifier for the organization |
DisplayName | Organization Id |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | organizationid |
RequiredLevel | SystemRequired |
Type | Lookup |
Targets | organization |
OverwriteTime
Property | Value |
---|---|
Description | For internal use only. |
DisplayName | Record Overwrite Time |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | overwritetime |
RequiredLevel | SystemRequired |
Type | DateTime |
CanChangeDateTimeBehavior | False |
DateTimeBehavior | UserLocal |
Format | DateOnly |
ImeMode | Inactive |
SourceTypeMask | 0 |
SolutionId
Property | Value |
---|---|
Description | Unique identifier of the associated solution. |
DisplayName | Solution |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | solutionid |
RequiredLevel | SystemRequired |
Type | Uniqueidentifier |
SupportingSolutionId
Property | Value |
---|---|
Description | For internal use only. |
DisplayName | Solution |
IsValidForForm | False |
IsValidForRead | False |
LogicalName | supportingsolutionid |
RequiredLevel | None |
Type | Uniqueidentifier |
VersionNumber
Property | Value |
---|---|
Description | Version Number |
DisplayName | Version Number |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | versionnumber |
RequiredLevel | None |
Type | BigInt |
MaxValue | 9223372036854775807 |
MinValue | -9223372036854775808 |
Many-to-One relationships
These relationships are many-to-one. Listed by SchemaName.
- lk_contracttemplate_createdonbehalfby
- lk_contracttemplate_modifiedonbehalfby
- lk_contracttemplatebase_createdby
- lk_contracttemplatebase_modifiedby
- organization_contract_templates
lk_contracttemplate_createdonbehalfby
One-To-Many Relationship: systemuser lk_contracttemplate_createdonbehalfby
Property | Value |
---|---|
ReferencedEntity | systemuser |
ReferencedAttribute | systemuserid |
ReferencingAttribute | createdonbehalfby |
ReferencingEntityNavigationPropertyName | createdonbehalfby |
IsHierarchical | |
CascadeConfiguration | Archive: NoCascade Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade RollupView: NoCascade Share: NoCascade Unshare: NoCascade |
lk_contracttemplate_modifiedonbehalfby
One-To-Many Relationship: systemuser lk_contracttemplate_modifiedonbehalfby
Property | Value |
---|---|
ReferencedEntity | systemuser |
ReferencedAttribute | systemuserid |
ReferencingAttribute | modifiedonbehalfby |
ReferencingEntityNavigationPropertyName | modifiedonbehalfby |
IsHierarchical | |
CascadeConfiguration | Archive: NoCascade Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade RollupView: NoCascade Share: NoCascade Unshare: NoCascade |
lk_contracttemplatebase_createdby
One-To-Many Relationship: systemuser lk_contracttemplatebase_createdby
Property | Value |
---|---|
ReferencedEntity | systemuser |
ReferencedAttribute | systemuserid |
ReferencingAttribute | createdby |
ReferencingEntityNavigationPropertyName | createdby |
IsHierarchical | |
CascadeConfiguration | Archive: NoCascade Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade RollupView: NoCascade Share: NoCascade Unshare: NoCascade |
lk_contracttemplatebase_modifiedby
One-To-Many Relationship: systemuser lk_contracttemplatebase_modifiedby
Property | Value |
---|---|
ReferencedEntity | systemuser |
ReferencedAttribute | systemuserid |
ReferencingAttribute | modifiedby |
ReferencingEntityNavigationPropertyName | modifiedby |
IsHierarchical | |
CascadeConfiguration | Archive: NoCascade Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade RollupView: NoCascade Share: NoCascade Unshare: NoCascade |
organization_contract_templates
One-To-Many Relationship: organization organization_contract_templates
Property | Value |
---|---|
ReferencedEntity | organization |
ReferencedAttribute | organizationid |
ReferencingAttribute | organizationid |
ReferencingEntityNavigationPropertyName | organizationid |
IsHierarchical | |
CascadeConfiguration | Archive: NoCascade Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade RollupView: NoCascade Share: NoCascade Unshare: NoCascade |
One-to-Many relationships
These relationships are one-to-many. Listed by SchemaName.
- contract_template_contracts
- ContractTemplate_AsyncOperations
- ContractTemplate_BulkDeleteFailures
- contracttemplate_MailboxTrackingFolders
- contracttemplate_PrincipalObjectAttributeAccesses
- ContractTemplate_ProcessSessions
- ContractTemplate_SyncErrors
contract_template_contracts
Many-To-One Relationship: contract contract_template_contracts
Property | Value |
---|---|
ReferencingEntity | contract |
ReferencingAttribute | contracttemplateid |
ReferencedEntityNavigationPropertyName | contract_template_contracts |
IsCustomizable | False |
AssociatedMenuConfiguration | AvailableOffline: True Behavior: DoNotDisplay Group: Details Label: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
ContractTemplate_AsyncOperations
Many-To-One Relationship: asyncoperation ContractTemplate_AsyncOperations
Property | Value |
---|---|
ReferencingEntity | asyncoperation |
ReferencingAttribute | regardingobjectid |
ReferencedEntityNavigationPropertyName | ContractTemplate_AsyncOperations |
IsCustomizable | False |
AssociatedMenuConfiguration | AvailableOffline: True Behavior: DoNotDisplay Group: Details Label: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
ContractTemplate_BulkDeleteFailures
Many-To-One Relationship: bulkdeletefailure ContractTemplate_BulkDeleteFailures
Property | Value |
---|---|
ReferencingEntity | bulkdeletefailure |
ReferencingAttribute | regardingobjectid |
ReferencedEntityNavigationPropertyName | ContractTemplate_BulkDeleteFailures |
IsCustomizable | False |
AssociatedMenuConfiguration | AvailableOffline: True Behavior: DoNotDisplay Group: Details Label: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
contracttemplate_MailboxTrackingFolders
Many-To-One Relationship: mailboxtrackingfolder contracttemplate_MailboxTrackingFolders
Property | Value |
---|---|
ReferencingEntity | mailboxtrackingfolder |
ReferencingAttribute | regardingobjectid |
ReferencedEntityNavigationPropertyName | contracttemplate_MailboxTrackingFolders |
IsCustomizable | True |
AssociatedMenuConfiguration | AvailableOffline: True Behavior: DoNotDisplay Group: Details Label: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
contracttemplate_PrincipalObjectAttributeAccesses
Many-To-One Relationship: principalobjectattributeaccess contracttemplate_PrincipalObjectAttributeAccesses
Property | Value |
---|---|
ReferencingEntity | principalobjectattributeaccess |
ReferencingAttribute | objectid |
ReferencedEntityNavigationPropertyName | contracttemplate_PrincipalObjectAttributeAccesses |
IsCustomizable | True |
AssociatedMenuConfiguration | AvailableOffline: True Behavior: DoNotDisplay Group: Details Label: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
ContractTemplate_ProcessSessions
Many-To-One Relationship: processsession ContractTemplate_ProcessSessions
Property | Value |
---|---|
ReferencingEntity | processsession |
ReferencingAttribute | regardingobjectid |
ReferencedEntityNavigationPropertyName | ContractTemplate_ProcessSessions |
IsCustomizable | False |
AssociatedMenuConfiguration | AvailableOffline: True Behavior: UseCollectionName Group: Details Label: MenuId: null Order: 110 QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
ContractTemplate_SyncErrors
Many-To-One Relationship: syncerror ContractTemplate_SyncErrors
Property | Value |
---|---|
ReferencingEntity | syncerror |
ReferencingAttribute | regardingobjectid |
ReferencedEntityNavigationPropertyName | ContractTemplate_SyncErrors |
IsCustomizable | True |
AssociatedMenuConfiguration | AvailableOffline: True Behavior: DoNotDisplay Group: Details Label: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
See also
Dataverse table/entity reference
Dataverse Web API Reference