Modifier

Partager via


ContractTemplate entity reference

Template for a contract containing the standard attributes of a contract.

Added by: Service Solution

Messages

Message SDK class or method
Create CreateRequest or
Create
Delete DeleteRequest or
Delete
Retrieve RetrieveRequest or
Retrieve
RetrieveMultiple RetrieveMultipleRequest or
RetrieveMultiple
Update UpdateRequest or
Update

Properties

Property Value
CollectionSchemaName ContractTemplates
DisplayCollectionName Contract Templates
DisplayName Contract Template
EntitySetName contracttemplates
IsBPFEntity False
LogicalCollectionName contracttemplates
LogicalName contracttemplate
OwnershipType OrganizationOwned
PrimaryIdAttribute contracttemplateid
PrimaryNameAttribute name
SchemaName ContractTemplate

Writable attributes

These attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.

Abbreviation

Property Value
Description Abbreviation of the contract template name.
DisplayName Abbreviation
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName abbreviation
MaxLength 20
RequiredLevel SystemRequired
Type String

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

AllotmentTypeCode Choices/Options

Value Label Description
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

BillingFrequencyCode Choices/Options

Value Label Description
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

ContractServiceLevelCode Choices/Options

Value Label Description
1 Gold
2 Silver
3 Bronze

ContractTemplateId

Property Value
Description Unique identifier of the contract template.
DisplayName Contract Template
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName contracttemplateid
RequiredLevel SystemRequired
Type Uniqueidentifier

Description

Property Value
Description Description of the contract template.
DisplayName Description
Format Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName description
MaxLength 2000
RequiredLevel None
Type Memo

EffectivityCalendar

Property Value
Description Days of the week and times for which contracts based on the template are effective.
DisplayName Support Calendar
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName effectivitycalendar
MaxLength 168
RequiredLevel None
Type String

ImportSequenceNumber

Property Value
Description Sequence number of the import that created this record.
DisplayName Import Sequence Number
Format None
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName importsequencenumber
MaxValue 2147483647
MinValue -2147483648
RequiredLevel None
Type Integer

IntroducedVersion

Property Value
Description Version in which the form is introduced.
DisplayName Introduced Version
FormatName VersionNumber
IsLocalizable False
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName introducedversion
MaxLength 48
RequiredLevel None
Type String

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
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName name
MaxLength 100
RequiredLevel SystemRequired
Type String

OverriddenCreatedOn

Property Value
DateTimeBehavior UserLocal
Description Date and time that the record was migrated.
DisplayName Record Created On
Format DateOnly
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName overriddencreatedon
RequiredLevel None
Type DateTime

TimeZoneRuleVersionNumber

Property Value
Description For internal use only.
DisplayName Time Zone Rule Version Number
Format None
IsValidForForm False
IsValidForRead True
LogicalName timezoneruleversionnumber
MaxValue 2147483647
MinValue -1
RequiredLevel None
Type Integer

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

UseDiscountAsPercentage Choices/Options

Value Label Description
1 Yes
0 No

DefaultValue: 0

UTCConversionTimeZoneCode

Property Value
Description Time zone code that was in use when the record was created.
DisplayName UTC Conversion Time Zone Code
Format None
IsValidForForm False
IsValidForRead True
LogicalName utcconversiontimezonecode
MaxValue 2147483647
MinValue -1
RequiredLevel None
Type Integer

Read-only attributes

These attributes return false for both IsValidForCreate or IsValidForUpdate. Listed by SchemaName.

ComponentState

Property Value
Description For internal use only.
DisplayName Component State
IsValidForForm False
IsValidForRead True
LogicalName componentstate
RequiredLevel SystemRequired
Type Picklist

ComponentState Choices/Options

Value Label Description
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
Targets systemuser
Type Lookup

CreatedByName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdbyname
MaxLength 100
RequiredLevel None
Type String

CreatedByYomiName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdbyyominame
MaxLength 100
RequiredLevel None
Type String

CreatedOn

Property Value
DateTimeBehavior UserLocal
Description Date and time when the contract template was created.
DisplayName Created On
Format DateAndTime
IsValidForForm False
IsValidForRead True
LogicalName createdon
RequiredLevel None
Type DateTime

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
Targets systemuser
Type Lookup

CreatedOnBehalfByName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdonbehalfbyname
MaxLength 100
RequiredLevel None
Type String

CreatedOnBehalfByYomiName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdonbehalfbyyominame
MaxLength 100
RequiredLevel None
Type String

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

IsManaged Choices/Options

Value Label Description
1 Managed
0 Unmanaged

DefaultValue: 0

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
Targets systemuser
Type Lookup

ModifiedByName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedbyname
MaxLength 100
RequiredLevel None
Type String

ModifiedByYomiName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedbyyominame
MaxLength 100
RequiredLevel None
Type String

ModifiedOn

Property Value
DateTimeBehavior UserLocal
Description Date and time when the contract template was last modified.
DisplayName Modified On
Format DateAndTime
IsValidForForm False
IsValidForRead True
LogicalName modifiedon
RequiredLevel None
Type DateTime

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
Targets systemuser
Type Lookup

ModifiedOnBehalfByName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedonbehalfbyname
MaxLength 100
RequiredLevel None
Type String

ModifiedOnBehalfByYomiName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedonbehalfbyyominame
MaxLength 100
RequiredLevel None
Type String

OrganizationId

Property Value
Description Unique identifier for the organization
DisplayName Organization Id
IsValidForForm False
IsValidForRead True
LogicalName organizationid
RequiredLevel SystemRequired
Targets organization
Type Lookup

OrganizationIdName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName organizationidname
MaxLength 100
RequiredLevel SystemRequired
Type String

OverwriteTime

Property Value
DateTimeBehavior UserLocal
Description For internal use only.
DisplayName Record Overwrite Time
Format DateOnly
IsValidForForm False
IsValidForRead True
LogicalName overwritetime
RequiredLevel SystemRequired
Type DateTime

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
MaxValue 9223372036854775807
MinValue -9223372036854775808
RequiredLevel None
Type BigInt

One-To-Many Relationships

Listed by SchemaName.

ContractTemplate_SyncErrors

Added by: System Solution Solution

Same as the ContractTemplate_SyncErrors many-to-one relationship for the syncerror entity.

Property Value
ReferencingEntity syncerror
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName ContractTemplate_SyncErrors
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: Cascade
Delete: Cascade
Merge: Cascade
Reparent: Cascade
Share: Cascade
Unshare: Cascade

ContractTemplate_AsyncOperations

Added by: System Solution Solution

Same as the ContractTemplate_AsyncOperations many-to-one relationship for the asyncoperation entity.

Property Value
ReferencingEntity asyncoperation
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName ContractTemplate_AsyncOperations
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

contracttemplate_MailboxTrackingFolders

Added by: System Solution Solution

Same as the contracttemplate_MailboxTrackingFolders many-to-one relationship for the mailboxtrackingfolder entity.

Property Value
ReferencingEntity mailboxtrackingfolder
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName contracttemplate_MailboxTrackingFolders
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

ContractTemplate_ProcessSessions

Added by: System Solution Solution

Same as the ContractTemplate_ProcessSessions many-to-one relationship for the processsession entity.

Property Value
ReferencingEntity processsession
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName ContractTemplate_ProcessSessions
AssociatedMenuConfiguration Behavior: UseCollectionName
Group: Details
Label:
Order: 110
CascadeConfiguration Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

ContractTemplate_BulkDeleteFailures

Added by: System Solution Solution

Same as the ContractTemplate_BulkDeleteFailures many-to-one relationship for the bulkdeletefailure entity.

Property Value
ReferencingEntity bulkdeletefailure
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName ContractTemplate_BulkDeleteFailures
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

contracttemplate_PrincipalObjectAttributeAccesses

Added by: System Solution Solution

Same as the contracttemplate_PrincipalObjectAttributeAccesses many-to-one relationship for the principalobjectattributeaccess entity.

Property Value
ReferencingEntity principalobjectattributeaccess
ReferencingAttribute objectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName contracttemplate_PrincipalObjectAttributeAccesses
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

contract_template_contracts

Same as the contract_template_contracts many-to-one relationship for the contract entity.

Property Value
ReferencingEntity contract
ReferencingAttribute contracttemplateid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName contract_template_contracts
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Restrict
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

Many-To-One Relationships

Each Many-To-One relationship is defined by a corresponding One-To-Many relationship with the related entity. Listed by SchemaName.

lk_contracttemplatebase_createdby

Added by: System Solution Solution

See the lk_contracttemplatebase_createdby one-to-many relationship for the systemuser entity.

lk_contracttemplate_createdonbehalfby

Added by: System Solution Solution

See the lk_contracttemplate_createdonbehalfby one-to-many relationship for the systemuser entity.

lk_contracttemplatebase_modifiedby

Added by: System Solution Solution

See the lk_contracttemplatebase_modifiedby one-to-many relationship for the systemuser entity.

lk_contracttemplate_modifiedonbehalfby

Added by: System Solution Solution

See the lk_contracttemplate_modifiedonbehalfby one-to-many relationship for the systemuser entity.

organization_contract_templates

Added by: System Solution Solution

See the organization_contract_templates one-to-many relationship for the organization entity.

See also

About the Entity Reference
Web API EntityType Reference