General.Contacts.PartyCommunications

PartyCommunications contains all communication related to a specific business partner, such as emails, chats, and internal notes, centralized in a single communication timeline.

General

Namespace: General.Contacts
Repository: General.Contacts.PartyCommunications
Base Table: Cm_Party_Communications
Introduced In Version: 26.2.1.50
API access: ReadWrite

Visualization

Display Format: {Id}: {PartyId}
Search Members:
Category: Definitions
Show in UI: ShownByDefault

Track Changes

Min level: 1 - Track last changes only
Max level: 4 - Track object attribute and blob changes

Aggregate

An aggregate is a cluster of domain objects that can be treated as a single unit.

Aggregate Tree

General.Contacts.PartyCommunications

Attributes

Name	Type	Description
AdditionalDetailsJson	string (max) nullable	For entering additional information`Introduced in version 26.2.2.24`
Channel	Channel	Main channel of communication.`Required` `Default("EML")` `Filter(eq)`
CommunicationFrom	string (254)	Who the message is from (email/phone/identifier).`Required` `Filter(eq;like)`
CommunicationTo	string (254)	Who the message is addressed to (main recipient)`Required` `Filter(eq;like)`
ConversationId	guid nullable	Usually is entered by the supplier of the message. `Filter(multi eq)`
CreationTimeUtc	datetime	Date and time when the document was created.`Required` `Default(NowUtc)` `Filter(ge;le)` `ReadOnly` `Introduced in version 26.2.2.24`
Direction	Direction nullable	Direction: received or sent.`Default("I")` `Filter(eq)`
Message	string (max) nullable	Full content of the message.`Filter(like)`
SubChannel	string (254) nullable	Usually populated automatically when synchronized with external systems and indicates the specific source, e.g. Outlook, Viber, WhatsApp.`Filter(eq;like)`
Subject	string (254) nullable	Short title of the message.`Filter(like)`
TimeOccurredAt	datetime	When the message happened.`Required` `Filter(eq;ge;le)`

References

Name	Type	Description
CreationUser	Users	The login name of the user, who created the document.
DataObject	ExtensibleDataObjects	Which object this communication is about.
Document	Documents (nullable)	Reference to the related document
Party	Parties	Which partner this communication is about.

System Attributes

Name	Type	Description
Id	guid
ObjectVersion	int32	The latest version of the extensible data object for the aggregate root for the time the object is loaded from the database. Can be used for optimistic locking.
ExternalId	string	The id of the object, when it is imported/synchronized with external system. Used by sync apps to identify the object in external systems. [Filter(multi eq)] [ORD] [Introduced in version 24.1.0.89]
ExternalSystem	string	The name of the external system from which the object is imported/synchronized. [Filter(multi eq)] [Introduced in version 24.1.0.89]
AggregateLastUpdateTimeUtc	datetime	The exact server time (in UTC) of the last modification of the object represented by this system object. null means that it is unknown. [Filter(ge;le)] [ORD] [Introduced in version 19.1]
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.

Attribute Details

AdditionalDetailsJson

For entering additional informationIntroduced in version 26.2.2.24

Type: string (max) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 2147483647
Show in UI: ShownByDefault

Channel

Main channel of communication.Required Default("EML") Filter(eq)

Type: Channel
Category: System
Allowed values for the Channel(General.Contacts.PartyCommunications.md#channel) data attribute
Allowed Values (General.Contacts.PartyCommunicationsRepository.Channel Enum Members)

Value	Description
Email	Email value. Stored as 'EML'. Database Value: 'EML' Model Value: 0 Domain API Value: 'Email'
InstantMessage	InstantMessage value. Stored as 'MSG'. Database Value: 'MSG' Model Value: 1 Domain API Value: 'InstantMessage'
Note	Note value. Stored as 'NOT'. Database Value: 'NOT' Model Value: 2 Domain API Value: 'Note'

Supported Filters: Equals
Supports Order By: False
Default Value: Email
Show in UI: ShownByDefault

CommunicationFrom

Who the message is from (email/phone/identifier).Required Filter(eq;like)

Type: string (254)
Category: System
Supported Filters: Equals, Like
Supports Order By: False
Maximum Length: 254
Show in UI: ShownByDefault

CommunicationTo

Who the message is addressed to (main recipient)Required Filter(eq;like)

Type: string (254)
Category: System
Supported Filters: Equals, Like
Supports Order By: False
Maximum Length: 254
Show in UI: ShownByDefault

ConversationId

Usually is entered by the supplier of the message. Filter(multi eq)

Type: guid nullable
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

CreationTimeUtc

Date and time when the document was created.Required Default(NowUtc) Filter(ge;le) ReadOnly Introduced in version 26.2.2.24

Type: datetime
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Default Value: CurrentDateTimeUtc
Show in UI: ShownByDefault

Direction

Direction: received or sent.Default("I") Filter(eq)

Type: Direction nullable
Category: System
Allowed values for the Direction(General.Contacts.PartyCommunications.md#direction) data attribute
Allowed Values (General.Contacts.PartyCommunicationsRepository.Direction Enum Members)

Value	Description
Inbound	Inbound value. Stored as 'I'. Database Value: 'I' Model Value: 0 Domain API Value: 'Inbound'
Outbound	Outbound value. Stored as 'O'. Database Value: 'O' Model Value: 1 Domain API Value: 'Outbound'

Supported Filters: Equals
Supports Order By: False
Default Value: Inbound
Show in UI: ShownByDefault

Message

Full content of the message.Filter(like)

Type: string (max) nullable
Category: System
Supported Filters: Like
Supports Order By: False
Maximum Length: 2147483647
Show in UI: ShownByDefault

SubChannel

Usually populated automatically when synchronized with external systems and indicates the specific source, e.g. Outlook, Viber, WhatsApp.Filter(eq;like)

Type: string (254) nullable
Category: System
Supported Filters: Equals, Like
Supports Order By: False
Maximum Length: 254
Show in UI: ShownByDefault

Subject

Short title of the message.Filter(like)

Type: string (254) nullable
Category: System
Supported Filters: Like
Supports Order By: False
Maximum Length: 254
Show in UI: ShownByDefault

TimeOccurredAt

When the message happened.Required Filter(eq;ge;le)

Type: datetime
Category: System
Supported Filters: Equals, GreaterThanOrLessThan
Supports Order By: False
Show in UI: ShownByDefault

Id

Type: guid
Indexed: True
Category: System
Supported Filters: Equals, GreaterThanOrLessThan, EqualsIn
Default Value: NewGuid
Show in UI: HiddenByDefault

ObjectVersion

The latest version of the extensible data object for the aggregate root for the time the object is loaded from the database. Can be used for optimistic locking.

Type: int32
Category: Extensible Data Object
Supported Filters: NotFilterable
Supports Order By: ****
Show in UI: HiddenByDefault

ExternalId

The id of the object, when it is imported/synchronized with external system. Used by sync apps to identify the object in external systems. [Filter(multi eq)] [ORD] [Introduced in version 24.1.0.89]

Type: string
Category: Extensible Data Object
Supported Filters: NotFilterable
Supports Order By: ****
Show in UI: HiddenByDefault

ExternalSystem

The name of the external system from which the object is imported/synchronized. [Filter(multi eq)] [Introduced in version 24.1.0.89]

Type: string
Category: Extensible Data Object
Supported Filters: NotFilterable
Supports Order By: ****
Show in UI: HiddenByDefault

AggregateLastUpdateTimeUtc

The exact server time (in UTC) of the last modification of the object represented by this system object. null means that it is unknown. [Filter(ge;le)] [ORD] [Introduced in version 19.1]

Type: datetime
Category: Extensible Data Object
Supported Filters: NotFilterable
Supports Order By: ****
Show in UI: HiddenByDefault

DisplayText

Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.

Type: string
Category: Calculated Attributes
Supported Filters: NotFilterable
Supports Order By: ****
Show in UI: HiddenByDefault

Reference Details

CreationUser

The login name of the user, who created the document.

Type: Users
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

Back-End Default Expression:
obj.Transaction.CurrentUser.ToSecurityUser( )

DataObject

Which object this communication is about.

Type: ExtensibleDataObjects
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

Document

Reference to the related document

Type: Documents (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

Party

Which partner this communication is about.

Type: Parties
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

API Methods

Methods that can be invoked in public APIs.

CreateCopy

Duplicates the object and its child objects belonging to the same aggregate. The duplicated objects are not saved to the data source but remain in the same transaction as the original object.
Return Type: EntityObject
Declaring Type: EntityObject
Domain API Request: POST

CreateNotification

Create a notification immediately in a separate transaction, and send a real-time event to the user.
Return Type: void
Declaring Type: EntityObject
Domain API Request: POST

Parameters

user
The user.
Type: Users
notificationClass
The notification class.
Type: string
subject
The notification subject.
Type: string

priority
The notification priority.
Type: Systems.Core.NotificationsRepository.Priority
Allowed values for the Priority(Systems.Core.Notifications.md#priority) data attribute
Allowed Values (Systems.Core.NotificationsRepository.Priority Enum Members)

Value	Description
Background	Background value. Stored as 1. Model Value: 1 Domain API Value: 'Background'
Low	Low value. Stored as 2. Model Value: 2 Domain API Value: 'Low'
Normal	Normal value. Stored as 3. Model Value: 3 Domain API Value: 'Normal'
High	High value. Stored as 4. Model Value: 4 Domain API Value: 'High'
Urgent	Urgent value. Stored as 5. Model Value: 5 Domain API Value: 'Urgent'

Optional: True
Default Value: Normal

GetAllowedCustomPropertyValues

Gets the allowed values for the specified custom property for this entity object. If supported the result is ordered by property value. Some property value sources do not support ordering - in that case the result is not ordered.
Return Type: Collection Of CustomPropertyValue
Declaring Type: EntityObject
Domain API Request: GET

Parameters

customPropertyCode
The code of the custom property
Type: string
search
The search text - searches by value or description. Can contain wildcard character %.
Type: string
Optional: True
Default Value: null
exactMatch
If true the search text should be equal to the property value
Type: boolean
Optional: True
Default Value: False
orderByDescription
If true the result is ordered by Description instead of Value. Note that ordering is not always possible.
Type: boolean
Optional: True
Default Value: False
top
The top clause - default is 10
Type: int32
Optional: True
Default Value: 10
skip
The skip clause - default is 0
Type: int32
Optional: True
Default Value: 0

GetOrCreateExtensibleDataObject

Gets an existing extensible data object associated with the specified entity, or creates a new one if none exists. The newly created extensible data object is immediately commited to the database.
Return Type: ExtensibleDataObjects
Declaring Type: EntityObject
Domain API Request: GET

GetPropertyAllowedValues

Gets the allowed values for the specified property for this entity object.
Return Type: Collection Of ErpNet.Model.OData.ValueTextPair
Declaring Type: EntityObject
Domain API Request: GET

Parameters

propertyName
The name of the attribute or reference
Type: string
search
The search text - searches by display text. Can contain wildcard character %.
Type: string
Optional: True
Default Value: null
top
The top clause - default is 10
Type: int32
Optional: True
Default Value: 10
skip
The skip clause - default is 0
Type: int32
Optional: True
Default Value: 0

Business Rules

None

Front-End Business Rules

None

API

Domain API Entity Set: General_Contacts_PartyCommunications

Domain API Entity Type: General_Contacts_PartyCommunication

Domain API Query: https://testdb.my.erp.net/api/domain/odata/General_Contacts_PartyCommunications?$top=10

Domain API Query Builder: https://testdb.my.erp.net/api/domain/querybuilder#General_Contacts_PartyCommunications?$top=10

Table of Contents

General.Contacts.PartyCommunications

General

Visualization

Track Changes

Aggregate

Attributes

References

System Attributes

Attribute Details

AdditionalDetailsJson

Channel

CommunicationFrom

CommunicationTo

ConversationId

CreationTimeUtc

Direction

Message

SubChannel

Subject

TimeOccurredAt

Id

ObjectVersion

ExternalId

ExternalSystem

AggregateLastUpdateTimeUtc

DisplayText

Reference Details

CreationUser

DataObject

Document

Party

API Methods

CreateCopy

CreateNotification

GetAllowedCustomPropertyValues

GetOrCreateExtensibleDataObject

GetPropertyAllowedValues

Business Rules

Front-End Business Rules

API