Table of Contents

General.Contacts.Persons Entity

Namespace: General.Contacts
Inherited From: General.Contacts.Parties

Personal records. Requires related party record. Entity: Cm_Persons (Introduced in version 22.1.6.13)

Default Visualization

Default Display Text Format:
{PartyName:T}
Default Search Members:
NationalNumber; PartyName
Code Data Member:
NationalNumber
Name Data Member:
PartyName
Category: Definitions
Show in UI: ShownByDefault
Layout category attribute: PartyType

Track Changes

Min level: 3 - Track object and attribute changes
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

Attributes

Name Type Description
BirthDate datetime nullable Birth date. null means unknown. Filter(ge;le)
City MultilanguageString (64) nullable City from the legal registration address for the person. Filter(like)
CreationTime datetime nullable Date and time when the Person was created. Filter(ge;le) ReadOnly
CreationUser string (64) nullable Login name of the user, who created the Person. Filter(like) ReadOnly
DisplayText string Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
FirstName MultilanguageString (64) nullable First name of the person. Filter(eq;like)
Gender Gender nullable Person gender. M=Male;F=Female;O=Other;N=Prefer not to say;null=not known/not provided. Filter(eq)
GLN string (13) nullable Global Location Number used by EDI systems. Filter(multi eq) ORD (Inherited from Parties)
Id guid
IsActive boolean Specifies whether the current party is active in the system or not. Required Default(true) Filter(eq) (Inherited from Parties)
LastName MultilanguageString (64) nullable Last name of the person. Filter(eq;like)
MiddleName MultilanguageString (64) nullable Middle name of the person. Filter(eq;like)
NationalNumber string (16) nullable Government assigned unique personal number. null means unknown. Filter(eq;like)
Notes string (254) nullable Internal notes for the person.
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.
PartyCode string (16) The unique code of the party. Required Filter(eq;like) ORD ReadOnly (Inherited from Parties)
PartyCreationTime datetime nullable Date and time when the Party was created. Filter(ge;le) ReadOnly (Inherited from Parties)
PartyCreationUser string (64) nullable Login name of the user, who created the Party. Filter(like) ReadOnly (Inherited from Parties)
PartyName MultilanguageString (254) The name of the party. Required Filter(eq;like) ReadOnly (Inherited from Parties)
PartyNotes string (254) nullable Notes for this Party. (Inherited from Parties)
PartyType PartyType Type of party. Currently supported are P=Person, C=Company, S=Store, L=Company Location, V=Division. Required Default("P") Filter(multi eq) (Inherited from Parties)
PartyUniqueNumber string (16) nullable Unique number of the party (National number for persons, Registration number for companies). Filter(eq;like) ReadOnly (Inherited from Parties)
PartyUpdateTime datetime nullable Date and time when the Party was last updated. Filter(ge;le) ReadOnly (Inherited from Parties)
PartyUpdateUser string (64) nullable Login name of the user, who last updated the Party. Filter(like) ReadOnly (Inherited from Parties)
PassportIssuingDate datetime nullable Date of issuing the passport. null means unknown. Filter(ge;le)
PassportNumber string (14) nullable Current passport number. null means unknown. Filter(eq)
Title MultilanguageString (32) nullable The persons title. It may be one of the standard titles - Mr., Mrs., etc., but it can also contains professional or academic qualification.
UpdateTime datetime nullable Date and time when the Person was last updated. Filter(ge;le) ReadOnly
UpdateUser string (64) nullable Login name of the user, who last updated the Person. Filter(like) ReadOnly

References

Name Type Description
AdministrativeRegion AdministrativeRegions (nullable) The administrative region in which the party is situated. Filter(multi eq) (Inherited from Parties)
Area Areas (nullable) The area in which the party is situated. Filter(multi eq) (Inherited from Parties)
DefaultProductCodingSystem CodingSystems (nullable) When not null, specifies coding system for products, which is required by the party. The coding system is used primarily for document printouts and document import/exports. Filter(multi eq) (Inherited from Parties)
Nationality Countries (nullable) Person's nationality. null means the default (same as enterprise) nationality. Filter(multi eq)
ParentParty Parties (nullable) Organizational unit (branch from the hierarchy of all parties) to which this party is referred to. Filter(multi eq) (Inherited from Parties)

Child Collections

Name Type Description
ApplicableLegislations PartyApplicableLegislations List of PartyApplicable<br />Legislation(General.Contacts.PartyApplicable
Legislations.md) child objects, based on the General.Contacts.PartyApplicableLegislation.Party(General.Contacts.PartyApplicable
Legislations.md#party) back reference (Inherited from Parties)
BankAccounts PartyBankAccounts List of PartyBankAccount(General.Contacts.PartyBankAccounts.md) child objects, based on the General.Contacts.PartyBankAccount.Party(General.Contacts.PartyBankAccounts.md#party) back reference (Inherited from Parties)
CompanyEmployees CompanyEmployees List of CompanyEmployee(General.Contacts.CompanyEmployees.md) child objects, based on the General.Contacts.CompanyEmployee.Person(General.Contacts.CompanyEmployees.md#person) back reference
ContactMechanisms PartyContactMechanisms List of PartyContactMechanism(General.Contacts.PartyContactMechanisms.md) child objects, based on the General.Contacts.PartyContactMechanism.Party(General.Contacts.PartyContactMechanisms.md#party) back reference (Inherited from Parties)
LocationNumbers PartyLocationNumbers List of PartyLocationNumber(General.Contacts.PartyLocationNumbers.md) child objects, based on the General.Contacts.PartyLocationNumber.Party(General.Contacts.PartyLocationNumbers.md#party) back reference (Inherited from Parties)
Pictures PartyPictures List of PartyPicture(General.Contacts.PartyPictures.md) child objects, based on the General.Contacts.PartyPicture.Party(General.Contacts.PartyPictures.md#party) back reference (Inherited from Parties)
Relationships PartyRelationships List of PartyRelationship(General.Contacts.PartyRelationships.md) child objects, based on the General.Contacts.PartyRelationship.FromParty(General.Contacts.PartyRelationships.md#fromparty) back reference (Inherited from Parties)

Attribute Details

BirthDate

Birth date. null means unknown. Filter(ge;le)

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

City

City from the legal registration address for the person. Filter(like)

Type: MultilanguageString (64) nullable
Category: System
Supported Filters: Like
Supports Order By: False
Show in UI: ShownByDefault

CreationTime

Date and time when the Person was created. Filter(ge;le) ReadOnly

Type: datetime nullable
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Show in UI: HiddenByDefault

CreationUser

Login name of the user, who created the Person. Filter(like) ReadOnly

Type: string (64) nullable
Category: System
Supported Filters: Like
Supports Order By: False
Maximum Length: 64
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

FirstName

First name of the person. Filter(eq;like)

Type: MultilanguageString (64) nullable
Category: System
Supported Filters: Equals, Like
Supports Order By: False
Show in UI: ShownByDefault

Gender

Person gender. M=Male;F=Female;O=Other;N=Prefer not to say;null=not known/not provided. Filter(eq)

Type: Gender nullable
Category: System
Allowed values for the Gender(General.Contacts.Persons.md#gender) data attribute
Allowed Values (General.Contacts.PersonsRepository.Gender Enum Members)

Value Description
Female Female value. Stored as 'F'.
Database Value: 'F'
Model Value: 0
Domain API Value: 'Female'
Male Male value. Stored as 'M'.
Database Value: 'M'
Model Value: 1
Domain API Value: 'Male'
Other Other value. Stored as 'O'.
Database Value: 'O'
Model Value: 2
Domain API Value: 'Other'
PreferNotToSay PreferNotToSay value. Stored as 'N'.
Database Value: 'N'
Model Value: 3
Domain API Value: 'PreferNotToSay'

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

GLN

Global Location Number used by EDI systems. Filter(multi eq) ORD (Inherited from Parties)

Type: string (13) nullable
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Supports Order By: True
Maximum Length: 13
Show in UI: ShownByDefault

Id

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

IsActive

Specifies whether the current party is active in the system or not. Required Default(true) Filter(eq) (Inherited from Parties)

Type: boolean
Category: System
Supported Filters: Equals
Supports Order By: False
Default Value: True
Show in UI: ShownByDefault

LastName

Last name of the person. Filter(eq;like)

Type: MultilanguageString (64) nullable
Category: System
Supported Filters: Equals, Like
Supports Order By: False
Show in UI: ShownByDefault

MiddleName

Middle name of the person. Filter(eq;like)

Type: MultilanguageString (64) nullable
Category: System
Supported Filters: Equals, Like
Supports Order By: False
Show in UI: ShownByDefault

NationalNumber

Government assigned unique personal number. null means unknown. Filter(eq;like)

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

Notes

Internal notes for the person.

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

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

PartyCode

The unique code of the party. Required Filter(eq;like) ORD ReadOnly (Inherited from Parties)

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

Back-End Default Expression:
obj.IncMax( o => o.PartyCode, null, "00000")

PartyCreationTime

Date and time when the Party was created. Filter(ge;le) ReadOnly (Inherited from Parties)

Type: datetime nullable
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Show in UI: HiddenByDefault

PartyCreationUser

Login name of the user, who created the Party. Filter(like) ReadOnly (Inherited from Parties)

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

PartyName

The name of the party. Required Filter(eq;like) ReadOnly (Inherited from Parties)

Type: MultilanguageString (254)
Indexed: True
Category: System
Supported Filters: Equals, Like
Supports Order By: False
Show in UI: ShownByDefault

PartyNotes

Notes for this Party. (Inherited from Parties)

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

PartyType

Type of party. Currently supported are P=Person, C=Company, S=Store, L=Company Location, V=Division. Required Default("P") Filter(multi eq) (Inherited from Parties)

Type: PartyType
Category: System
Allowed values for the PartyType data attribute
Allowed Values (General.Contacts.PartiesRepository.PartyType Enum Members)

Value Description
Company Company value. Stored as 'C'.
Database Value: 'C'
Model Value: 0
Domain API Value: 'Company'
CompanyLocation CompanyLocation value. Stored as 'L'.
Database Value: 'L'
Model Value: 1
Domain API Value: 'CompanyLocation'
Person Person value. Stored as 'P'.
Database Value: 'P'
Model Value: 2
Domain API Value: 'Person'
Store Store value. Stored as 'S'.
Database Value: 'S'
Model Value: 3
Domain API Value: 'Store'
CompanyDivision CompanyDivision value. Stored as 'V'.
Database Value: 'V'
Model Value: 4
Domain API Value: 'CompanyDivision'

Supported Filters: Equals, EqualsIn
Supports Order By: False
Default Value: Person
Show in UI: ShownByDefault

PartyUniqueNumber

Unique number of the party (National number for persons, Registration number for companies). Filter(eq;like) ReadOnly (Inherited from Parties)

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

PartyUpdateTime

Date and time when the Party was last updated. Filter(ge;le) ReadOnly (Inherited from Parties)

Type: datetime nullable
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Show in UI: HiddenByDefault

PartyUpdateUser

Login name of the user, who last updated the Party. Filter(like) ReadOnly (Inherited from Parties)

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

PassportIssuingDate

Date of issuing the passport. null means unknown. Filter(ge;le)

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

PassportNumber

Current passport number. null means unknown. Filter(eq)

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

Title

The persons title. It may be one of the standard titles - Mr., Mrs., etc., but it can also contains professional or academic qualification.

Type: MultilanguageString (32) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Show in UI: ShownByDefault

UpdateTime

Date and time when the Person was last updated. Filter(ge;le) ReadOnly

Type: datetime nullable
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Show in UI: HiddenByDefault

UpdateUser

Login name of the user, who last updated the Person. Filter(like) ReadOnly

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

Reference Details

AdministrativeRegion

The administrative region in which the party is situated. Filter(multi eq) (Inherited from Parties)

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

Area

The area in which the party is situated. Filter(multi eq) (Inherited from Parties)

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

DefaultProductCodingSystem

When not null, specifies coding system for products, which is required by the party. The coding system is used primarily for document printouts and document import/exports. Filter(multi eq) (Inherited from Parties)

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

Nationality

Person's nationality. null means the default (same as enterprise) nationality. Filter(multi eq)

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

ParentParty

Organizational unit (branch from the hierarchy of all parties) to which this party is referred to. Filter(multi eq) (Inherited from Parties)

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

API Methods

Methods that can be invoked in public APIs.

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

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

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

Business Rules

None

Front-End Business Rules

None

API

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

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

Suggest improvement to this page