Letter entity reference
Note
Effective Nov 2020, Common Data Service has been renamed to Microsoft Dataverse.
Activity that tracks the delivery of a letter. The activity can contain the electronic copy of the letter.
Messages
| Message | Web API Operation | SDK Assembly |
|---|---|---|
| Assign | PATCH [org URI]/api/data/v9.0/letters(activityid) Update ownerid property. |
AssignRequest |
| Create | POST [org URI]/api/data/v9.0/letters See Create |
CreateRequest or Create |
| Delete | DELETE [org URI]/api/data/v9.0/letters(activityid) See Delete |
DeleteRequest or Delete |
| GrantAccess | GrantAccess Action | GrantAccessRequest |
| ModifyAccess | ModifyAccess Action | ModifyAccessRequest |
| Retrieve | GET [org URI]/api/data/v9.0/letters(activityid) See Retrieve |
RetrieveRequest or Retrieve |
| RetrieveMultiple | GET [org URI]/api/data/v9.0/letters See Query Data |
RetrieveMultipleRequest or RetrieveMultiple |
| RetrievePrincipalAccess | RetrievePrincipalAccess Function | RetrievePrincipalAccessRequest |
| RetrieveSharedPrincipalsAndAccess | RetrieveSharedPrincipalsAndAccess Function | RetrieveSharedPrincipalsAndAccessRequest |
| RevokeAccess | RevokeAccess Action | RevokeAccessRequest |
| SetState | PATCH [org URI]/api/data/v9.0/letters(activityid) Update statecode and statuscode properties. |
SetStateRequest |
| Update | PATCH [org URI]/api/data/v9.0/letters(activityid) See Update |
UpdateRequest or Update |
Entity properties
| Property | Value |
|---|---|
| CollectionSchemaName | Letters |
| DisplayCollectionName | Letters |
| DisplayName | Letter |
| EntitySetName | letters |
| IsBPFEntity | False |
| LogicalCollectionName | letters |
| LogicalName | letter |
| OwnershipType | UserOwned |
| PrimaryIdAttribute | activityid |
| PrimaryNameAttribute | subject |
| SchemaName | Letter |
Writable attributes
These attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.
- ActivityId
- ActualDurationMinutes
- ActualEnd
- ActualStart
- Address
- bcc
- Category
- cc
- Description
- DirectionCode
- from
- ImportSequenceNumber
- IsBilled
- IsWorkflowCreated
- LastOnHoldTime
- OverriddenCreatedOn
- OwnerId
- OwnerIdType
- PriorityCode
- ProcessId
- RegardingObjectId
- RegardingObjectTypeCode
- ScheduledEnd
- ScheduledStart
- SLAId
- SortDate
- StageId
- StateCode
- StatusCode
- Subcategory
- Subject
- SubscriptionId
- TimeZoneRuleVersionNumber
- to
- TransactionCurrencyId
- TraversedPath
- UTCConversionTimeZoneCode
ActivityId
| Property | Value |
|---|---|
| Description | Unique identifier of the letter activity. |
| DisplayName | Letter |
| IsValidForForm | False |
| IsValidForRead | True |
| IsValidForUpdate | False |
| LogicalName | activityid |
| RequiredLevel | SystemRequired |
| Type | Uniqueidentifier |
ActualDurationMinutes
| Property | Value |
|---|---|
| Description | Type the number of minutes spent creating and sending the letter. The duration is used in reporting. |
| DisplayName | Duration |
| Format | Duration |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | actualdurationminutes |
| MaxValue | 2147483647 |
| MinValue | 0 |
| RequiredLevel | None |
| Type | Integer |
ActualEnd
| Property | Value |
|---|---|
| DateTimeBehavior | UserLocal |
| Description | Enter the actual end date and time of the letter. By default, it displays the date and time when the activity was completed or canceled, but can be edited to capture the actual time to create and send the letter. |
| DisplayName | Actual End |
| Format | DateOnly |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | actualend |
| RequiredLevel | None |
| Type | DateTime |
ActualStart
| Property | Value |
|---|---|
| DateTimeBehavior | UserLocal |
| Description | Enter the actual start date and time for the letter. By default, it displays the date and time when the activity was created, but can be edited to capture the actual time to create and send the letter. |
| DisplayName | Actual Start |
| Format | DateOnly |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | actualstart |
| RequiredLevel | None |
| Type | DateTime |
Address
| Property | Value |
|---|---|
| Description | Type the complete recipient address for the letter to ensure timely delivery. |
| DisplayName | Address |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | address |
| MaxLength | 200 |
| RequiredLevel | None |
| Type | String |
bcc
| Property | Value |
|---|---|
| Description | Enter the recipients that are included in the letter distribution, but are not displayed to other recipients. |
| DisplayName | Bcc |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | bcc |
| RequiredLevel | None |
| Targets | account,contact,systemuser |
| Type | PartyList |
Category
| Property | Value |
|---|---|
| Description | Type a category to identify the letter type, such as sales offer or past due notice, to tie the letter to a business group or function. |
| DisplayName | Category |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | category |
| MaxLength | 250 |
| RequiredLevel | None |
| Type | String |
cc
| Property | Value |
|---|---|
| Description | Enter the recipients that should be copied on the letter. |
| DisplayName | Cc |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | cc |
| RequiredLevel | None |
| Targets | account,contact,systemuser |
| Type | PartyList |
Description
| Property | Value |
|---|---|
| Description | Type the letter body or additional information to describe the letter, such as the primary message or the products and services described. |
| DisplayName | Description |
| Format | Text |
| IsLocalizable | False |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | description |
| MaxLength | 2000 |
| RequiredLevel | None |
| Type | Memo |
DirectionCode
| Property | Value |
|---|---|
| Description | Select the direction of the letter as incoming or outbound. |
| DisplayName | Direction |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | directioncode |
| RequiredLevel | None |
| Type | Boolean |
DirectionCode Options
| Value | Label |
|---|---|
| 1 | Outgoing |
| 0 | Incoming |
DefaultValue: True
from
| Property | Value |
|---|---|
| Description | Enter the account, contact, lead, or user who sent the letter. |
| DisplayName | From |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | from |
| RequiredLevel | None |
| Targets | account,contact,systemuser |
| Type | PartyList |
ImportSequenceNumber
| Property | Value |
|---|---|
| Description | Unique identifier of the data import or data migration 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 |
IsBilled
| Property | Value |
|---|---|
| Description | Shows whether the letter activity was billed as part of resolving a case. |
| DisplayName | Is Billed |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | isbilled |
| RequiredLevel | None |
| Type | Boolean |
IsBilled Options
| Value | Label |
|---|---|
| 1 | Yes |
| 0 | No |
DefaultValue: False
IsWorkflowCreated
| Property | Value |
|---|---|
| Description | Shows whether the letter activity was created by a workflow rule. |
| DisplayName | Is Workflow Created |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | isworkflowcreated |
| RequiredLevel | None |
| Type | Boolean |
IsWorkflowCreated Options
| Value | Label |
|---|---|
| 1 | Yes |
| 0 | No |
DefaultValue: False
LastOnHoldTime
| Property | Value |
|---|---|
| DateTimeBehavior | UserLocal |
| Description | Contains the date and time stamp of the last on hold time. |
| DisplayName | Last On Hold Time |
| Format | DateAndTime |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | lastonholdtime |
| RequiredLevel | None |
| Type | DateTime |
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 |
OwnerId
| Property | Value |
|---|---|
| Description | 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. |
| DisplayName | Owner |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | ownerid |
| RequiredLevel | SystemRequired |
| Targets | systemuser,team |
| Type | Owner |
OwnerIdType
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | owneridtype |
| RequiredLevel | SystemRequired |
| Type | EntityName |
PriorityCode
| Property | Value |
|---|---|
| Description | Select the priority so that preferred customers or critical issues are handled quickly. |
| DisplayName | Priority |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | prioritycode |
| RequiredLevel | None |
| Type | Picklist |
PriorityCode Options
| Value | Label |
|---|---|
| 0 | Low |
| 1 | Normal |
| 2 | High |
ProcessId
| Property | Value |
|---|---|
| Description | Shows the ID of the process. |
| DisplayName | Process |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | processid |
| RequiredLevel | None |
| Type | Uniqueidentifier |
RegardingObjectId
| Property | Value |
|---|---|
| Description | Choose the record that the letter relates to. |
| DisplayName | Regarding |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | regardingobjectid |
| RequiredLevel | None |
| Targets | account,contact,knowledgearticle,knowledgebaserecord |
| Type | Lookup |
RegardingObjectTypeCode
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | regardingobjecttypecode |
| RequiredLevel | None |
| Type | EntityName |
ScheduledEnd
| Property | Value |
|---|---|
| DateTimeBehavior | UserLocal |
| Description | Enter the expected due date and time. |
| DisplayName | Due Date |
| Format | DateAndTime |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | scheduledend |
| RequiredLevel | None |
| Type | DateTime |
ScheduledStart
| Property | Value |
|---|---|
| DateTimeBehavior | UserLocal |
| Description | Enter the expected due date and time. |
| DisplayName | Start Date |
| Format | DateAndTime |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | scheduledstart |
| RequiredLevel | None |
| Type | DateTime |
SLAId
| Property | Value |
|---|---|
| Description | Choose the service level agreement (SLA) that you want to apply to the Letter record. |
| DisplayName | SLA |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | slaid |
| RequiredLevel | None |
| Targets | sla |
| Type | Lookup |
SortDate
| Property | Value |
|---|---|
| DateTimeBehavior | UserLocal |
| Description | Shows the date and time by which the activities are sorted. |
| DisplayName | Sort Date |
| Format | DateAndTime |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | sortdate |
| RequiredLevel | None |
| Type | DateTime |
StageId
| Property | Value |
|---|---|
| Description | Shows the ID of the stage. |
| DisplayName | (Deprecated) Process Stage |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | stageid |
| RequiredLevel | None |
| Type | Uniqueidentifier |
StateCode
| Property | Value |
|---|---|
| Description | Shows whether the letter is open, completed, or canceled. Completed and canceled letters are read-only and can't be edited. |
| DisplayName | Activity Status |
| IsValidForCreate | False |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | statecode |
| RequiredLevel | SystemRequired |
| Type | State |
StateCode Options
| Value | Label | DefaultStatus | InvariantName |
|---|---|---|---|
| 0 | Open | 2 | Open |
| 1 | Completed | 4 | Completed |
| 2 | Canceled | 5 | Canceled |
StatusCode
| Property | Value |
|---|---|
| Description | Select the letter's status. |
| DisplayName | Status Reason |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | statuscode |
| RequiredLevel | None |
| Type | Status |
StatusCode Options
| Value | Label | State |
|---|---|---|
| 1 | Open | 0 |
| 2 | Draft | 0 |
| 3 | Received | 1 |
| 4 | Sent | 1 |
| 5 | Canceled | 2 |
Subcategory
| Property | Value |
|---|---|
| Description | Type a subcategory to identify the letter type and relate the activity to a specific product, sales region, business group, or other function. |
| DisplayName | Sub-Category |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | subcategory |
| MaxLength | 250 |
| RequiredLevel | None |
| Type | String |
Subject
| Property | Value |
|---|---|
| Description | Type a short description about the objective or primary topic of the letter. |
| DisplayName | Subject |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | subject |
| MaxLength | 200 |
| RequiredLevel | ApplicationRequired |
| Type | String |
SubscriptionId
| Property | Value |
|---|---|
| Description | For internal use only. |
| DisplayName | Subscription |
| IsValidForForm | False |
| IsValidForRead | False |
| IsValidForUpdate | False |
| LogicalName | subscriptionid |
| RequiredLevel | None |
| Type | Uniqueidentifier |
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 |
to
| Property | Value |
|---|---|
| Description | Enter the account, contact, lead, or user recipients for the letter. |
| DisplayName | To |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | to |
| RequiredLevel | None |
| Targets | account,contact,systemuser |
| Type | PartyList |
TransactionCurrencyId
| Property | Value |
|---|---|
| Description | Choose the local currency for the record to make sure budgets are reported in the correct currency. |
| DisplayName | Currency |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | transactioncurrencyid |
| RequiredLevel | None |
| Targets | transactioncurrency |
| Type | Lookup |
TraversedPath
| Property | Value |
|---|---|
| Description | For internal use only. |
| DisplayName | (Deprecated) Traversed Path |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | traversedpath |
| MaxLength | 1250 |
| RequiredLevel | None |
| Type | String |
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.
- ActivityTypeCode
- CreatedBy
- CreatedByName
- CreatedByYomiName
- CreatedOn
- CreatedOnBehalfBy
- CreatedOnBehalfByName
- CreatedOnBehalfByYomiName
- ExchangeRate
- IsRegularActivity
- ModifiedBy
- ModifiedByName
- ModifiedByYomiName
- ModifiedOn
- ModifiedOnBehalfBy
- ModifiedOnBehalfByName
- ModifiedOnBehalfByYomiName
- OnHoldTime
- OwnerIdName
- OwnerIdYomiName
- OwningBusinessUnit
- OwningTeam
- OwningUser
- RegardingObjectIdName
- RegardingObjectIdYomiName
- ScheduledDurationMinutes
- SLAInvokedId
- SLAInvokedIdName
- SLAName
- TransactionCurrencyIdName
- VersionNumber
ActivityTypeCode
| Property | Value |
|---|---|
| Description | Shows the type of activity. |
| DisplayName | Activity Type |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | activitytypecode |
| RequiredLevel | SystemRequired |
| Type | EntityName |
CreatedBy
| Property | Value |
|---|---|
| Description | Shows who created the record. |
| DisplayName | Created By |
| IsValidForForm | True |
| 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 | 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. |
| DisplayName | Created On |
| Format | DateAndTime |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | createdon |
| RequiredLevel | None |
| Type | DateTime |
CreatedOnBehalfBy
| Property | Value |
|---|---|
| Description | Shows who created the record on behalf of another user. |
| DisplayName | Created By (Delegate) |
| IsValidForForm | True |
| 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 |
ExchangeRate
| Property | Value |
|---|---|
| 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. |
| DisplayName | Exchange Rate |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | exchangerate |
| MaxValue | 100000000000 |
| MinValue | 0.0000000001 |
| Precision | 10 |
| RequiredLevel | None |
| Type | Decimal |
IsRegularActivity
| Property | Value |
|---|---|
| Description | Shows whether the activity is a regular activity type or event type. |
| DisplayName | Is Regular Activity |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | isregularactivity |
| RequiredLevel | SystemRequired |
| Type | Boolean |
IsRegularActivity Options
| Value | Label |
|---|---|
| 1 | Yes |
| 0 | No |
DefaultValue: False
ModifiedBy
| Property | Value |
|---|---|
| Description | Shows who last updated the record. |
| DisplayName | Modified By |
| IsValidForForm | True |
| 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 | 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. |
| DisplayName | Modified On |
| Format | DateAndTime |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | modifiedon |
| RequiredLevel | None |
| Type | DateTime |
ModifiedOnBehalfBy
| Property | Value |
|---|---|
| Description | Shows who last updated the record on behalf of another user. |
| DisplayName | Modified By (Delegate) |
| IsValidForForm | True |
| 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 |
OnHoldTime
| Property | Value |
|---|---|
| Description | Shows how long, in minutes, that the record was on hold. |
| DisplayName | On Hold Time (Minutes) |
| Format | None |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | onholdtime |
| MaxValue | 2147483647 |
| MinValue | -2147483648 |
| RequiredLevel | None |
| Type | Integer |
OwnerIdName
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | owneridname |
| MaxLength | 100 |
| RequiredLevel | SystemRequired |
| Type | String |
OwnerIdYomiName
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | owneridyominame |
| MaxLength | 100 |
| RequiredLevel | SystemRequired |
| Type | String |
OwningBusinessUnit
| Property | Value |
|---|---|
| Description | Unique identifier of the business unit that owns the letter activity. |
| DisplayName | Owning Business Unit |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | owningbusinessunit |
| RequiredLevel | None |
| Targets | businessunit |
| Type | Lookup |
OwningTeam
| Property | Value |
|---|---|
| Description | Unique identifier of the team that owns the letter activity. |
| DisplayName | Owning Team |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | owningteam |
| RequiredLevel | None |
| Targets | team |
| Type | Lookup |
OwningUser
| Property | Value |
|---|---|
| Description | Unique identifier of the user that owns the letter activity. |
| DisplayName | Owning User |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | owninguser |
| RequiredLevel | None |
| Targets | systemuser |
| Type | Lookup |
RegardingObjectIdName
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | regardingobjectidname |
| MaxLength | 400 |
| RequiredLevel | None |
| Type | String |
RegardingObjectIdYomiName
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | regardingobjectidyominame |
| MaxLength | 400 |
| RequiredLevel | None |
| Type | String |
ScheduledDurationMinutes
| Property | Value |
|---|---|
| Description | Scheduled duration of the letter activity, specified in minutes. |
| DisplayName | Scheduled Duration |
| Format | Duration |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | scheduleddurationminutes |
| MaxValue | 2147483647 |
| MinValue | 0 |
| RequiredLevel | None |
| Type | Integer |
SLAInvokedId
| Property | Value |
|---|---|
| Description | Last SLA that was applied to this Letter. This field is for internal use only. |
| DisplayName | Last SLA applied |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | slainvokedid |
| RequiredLevel | None |
| Targets | sla |
| Type | Lookup |
SLAInvokedIdName
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | slainvokedidname |
| MaxLength | 100 |
| RequiredLevel | None |
| Type | String |
SLAName
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | slaname |
| MaxLength | 100 |
| RequiredLevel | None |
| Type | String |
TransactionCurrencyIdName
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | transactioncurrencyidname |
| MaxLength | 100 |
| RequiredLevel | None |
| Type | String |
VersionNumber
| Property | Value |
|---|---|
| Description | Version number of the letter. |
| DisplayName | Version Number |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | versionnumber |
| MaxValue | 9223372036854775807 |
| MinValue | -9223372036854775808 |
| RequiredLevel | None |
| Type | BigInt |
One-To-Many Relationships
Listed by SchemaName.
- Letter_DuplicateBaseRecord
- Letter_BulkDeleteFailures
- letter_connections1
- slakpiinstance_letter
- Letter_AsyncOperations
- Letter_Annotation
- letter_actioncard
- letter_principalobjectattributeaccess
- Letter_ProcessSessions
- Letter_DuplicateMatchingRecord
- Letter_SyncErrors
- letter_activity_parties
- Letter_QueueItem
- letter_connections2
Letter_DuplicateBaseRecord
Same as duplicaterecord entity Letter_DuplicateBaseRecord Many-To-One relationship.
| Property | Value |
|---|---|
| ReferencingEntity | duplicaterecord |
| ReferencingAttribute | baserecordid |
| IsHierarchical | False |
| IsCustomizable | False |
| ReferencedEntityNavigationPropertyName | Letter_DuplicateBaseRecord |
| AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
| CascadeConfiguration | Assign: NoCascade Delete: Cascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
Letter_BulkDeleteFailures
Same as bulkdeletefailure entity Letter_BulkDeleteFailures Many-To-One relationship.
| Property | Value |
|---|---|
| ReferencingEntity | bulkdeletefailure |
| ReferencingAttribute | regardingobjectid |
| IsHierarchical | False |
| IsCustomizable | False |
| ReferencedEntityNavigationPropertyName | Letter_BulkDeleteFailures |
| AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
| CascadeConfiguration | Assign: NoCascade Delete: Cascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
letter_connections1
Same as connection entity letter_connections1 Many-To-One relationship.
| Property | Value |
|---|---|
| ReferencingEntity | connection |
| ReferencingAttribute | record1id |
| IsHierarchical | False |
| IsCustomizable | True |
| ReferencedEntityNavigationPropertyName | letter_connections1 |
| AssociatedMenuConfiguration | Behavior: UseCollectionName Group: Details Label: Order: 100 |
| CascadeConfiguration | Assign: NoCascade Delete: Cascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
slakpiinstance_letter
Same as slakpiinstance entity slakpiinstance_letter Many-To-One relationship.
| Property | Value |
|---|---|
| ReferencingEntity | slakpiinstance |
| ReferencingAttribute | regarding |
| IsHierarchical | False |
| IsCustomizable | True |
| ReferencedEntityNavigationPropertyName | slakpiinstance_letter |
| AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
| CascadeConfiguration | Assign: NoCascade Delete: Cascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
Letter_AsyncOperations
Same as asyncoperation entity Letter_AsyncOperations Many-To-One relationship.
| Property | Value |
|---|---|
| ReferencingEntity | asyncoperation |
| ReferencingAttribute | regardingobjectid |
| IsHierarchical | False |
| IsCustomizable | False |
| ReferencedEntityNavigationPropertyName | Letter_AsyncOperations |
| AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
| CascadeConfiguration | Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
Letter_Annotation
Same as annotation entity Letter_Annotation Many-To-One relationship.
| Property | Value |
|---|---|
| ReferencingEntity | annotation |
| ReferencingAttribute | objectid |
| IsHierarchical | False |
| IsCustomizable | True |
| ReferencedEntityNavigationPropertyName | Letter_Annotation |
| AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
| CascadeConfiguration | Assign: Cascade Delete: Cascade Merge: NoCascade Reparent: Cascade Share: Cascade Unshare: Cascade |
letter_actioncard
Same as actioncard entity letter_actioncard Many-To-One relationship.
| Property | Value |
|---|---|
| ReferencingEntity | actioncard |
| ReferencingAttribute | regardingobjectid |
| IsHierarchical | False |
| IsCustomizable | True |
| ReferencedEntityNavigationPropertyName | letter_actioncard |
| AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
| CascadeConfiguration | Assign: Cascade Delete: Cascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
letter_principalobjectattributeaccess
Same as principalobjectattributeaccess entity letter_principalobjectattributeaccess Many-To-One relationship.
| Property | Value |
|---|---|
| ReferencingEntity | principalobjectattributeaccess |
| ReferencingAttribute | objectid |
| IsHierarchical | False |
| IsCustomizable | False |
| ReferencedEntityNavigationPropertyName | letter_principalobjectattributeaccess |
| AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
| CascadeConfiguration | Assign: NoCascade Delete: Cascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
Letter_ProcessSessions
Same as processsession entity Letter_ProcessSessions Many-To-One relationship.
| Property | Value |
|---|---|
| ReferencingEntity | processsession |
| ReferencingAttribute | regardingobjectid |
| IsHierarchical | False |
| IsCustomizable | False |
| ReferencedEntityNavigationPropertyName | Letter_ProcessSessions |
| AssociatedMenuConfiguration | Behavior: UseCollectionName Group: Details Label: Order: 110 |
| CascadeConfiguration | Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
Letter_DuplicateMatchingRecord
Same as duplicaterecord entity Letter_DuplicateMatchingRecord Many-To-One relationship.
| Property | Value |
|---|---|
| ReferencingEntity | duplicaterecord |
| ReferencingAttribute | duplicaterecordid |
| IsHierarchical | False |
| IsCustomizable | False |
| ReferencedEntityNavigationPropertyName | Letter_DuplicateMatchingRecord |
| AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
| CascadeConfiguration | Assign: NoCascade Delete: Cascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
Letter_SyncErrors
Same as syncerror entity Letter_SyncErrors Many-To-One relationship.
| Property | Value |
|---|---|
| ReferencingEntity | syncerror |
| ReferencingAttribute | regardingobjectid |
| IsHierarchical | False |
| IsCustomizable | True |
| ReferencedEntityNavigationPropertyName | Letter_SyncErrors |
| AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
| CascadeConfiguration | Assign: Cascade Delete: Cascade Merge: Cascade Reparent: Cascade Share: Cascade Unshare: Cascade |
letter_activity_parties
Same as activityparty entity letter_activity_parties Many-To-One relationship.
| Property | Value |
|---|---|
| ReferencingEntity | activityparty |
| ReferencingAttribute | activityid |
| IsHierarchical | False |
| IsCustomizable | False |
| ReferencedEntityNavigationPropertyName | letter_activity_parties |
| AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
| CascadeConfiguration | Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
Letter_QueueItem
Same as queueitem entity Letter_QueueItem Many-To-One relationship.
| Property | Value |
|---|---|
| ReferencingEntity | queueitem |
| ReferencingAttribute | objectid |
| IsHierarchical | False |
| IsCustomizable | True |
| ReferencedEntityNavigationPropertyName | Letter_QueueItem |
| AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
| CascadeConfiguration | Assign: NoCascade Delete: Cascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
letter_connections2
Same as connection entity letter_connections2 Many-To-One relationship.
| Property | Value |
|---|---|
| ReferencingEntity | connection |
| ReferencingAttribute | record2id |
| IsHierarchical | False |
| IsCustomizable | True |
| ReferencedEntityNavigationPropertyName | letter_connections2 |
| AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: 100 |
| CascadeConfiguration | Assign: NoCascade Delete: Cascade 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.
- KnowledgeBaseRecord_Letters
- Contact_Letters
- sla_letter
- activity_pointer_letter
- team_letter
- processstage_letters
- user_letter
- KnowledgeArticle_Letters
- lk_letter_createdby
- TransactionCurrency_Letter
- lk_letter_modifiedby
- Account_Letters
- lk_letter_createdonbehalfby
- business_unit_letter_activities
- manualsla_letter
- lk_letter_modifiedonbehalfby
KnowledgeBaseRecord_Letters
See knowledgebaserecord Entity KnowledgeBaseRecord_Letters One-To-Many relationship.
Contact_Letters
See contact Entity Contact_Letters One-To-Many relationship.
sla_letter
See sla Entity sla_letter One-To-Many relationship.
activity_pointer_letter
See activitypointer Entity activity_pointer_letter One-To-Many relationship.
team_letter
See team Entity team_letter One-To-Many relationship.
processstage_letters
See processstage Entity processstage_letters One-To-Many relationship.
user_letter
See systemuser Entity user_letter One-To-Many relationship.
KnowledgeArticle_Letters
See knowledgearticle Entity KnowledgeArticle_Letters One-To-Many relationship.
lk_letter_createdby
See systemuser Entity lk_letter_createdby One-To-Many relationship.
TransactionCurrency_Letter
See transactioncurrency Entity TransactionCurrency_Letter One-To-Many relationship.
lk_letter_modifiedby
See systemuser Entity lk_letter_modifiedby One-To-Many relationship.
Account_Letters
See account Entity Account_Letters One-To-Many relationship.
lk_letter_createdonbehalfby
See systemuser Entity lk_letter_createdonbehalfby One-To-Many relationship.
business_unit_letter_activities
See businessunit Entity business_unit_letter_activities One-To-Many relationship.
manualsla_letter
See sla Entity manualsla_letter One-To-Many relationship.
lk_letter_modifiedonbehalfby
See systemuser Entity lk_letter_modifiedonbehalfby One-To-Many relationship.
See also
About entity reference
Web API reference
letter EntityType
Note
Can you tell us about your documentation language preferences? Take a short survey.
The survey will take about seven minutes. No personal data is collected (privacy statement).