General.Contacts.Parties Entity

Namespace: General.Contacts

Contains base data for different kind of parties - companies, persons, departments, etc. Entity: Gen_Parties

Default Visualization

Default Display Text Format:
{PartyName:T}
Default Search Members:
PartyCode; PartyName
Code Data Member:
PartyCode
Name Data Member:
PartyName
Category: Definitions
Show in UI: ShownByDefault

Aggregate

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

Aggregate Tree

• General.Contacts.Parties
  • Crm.Distributors
  • General.PartyApplicableLegislations
  • General.PartyLocationNumbers
  • General.Contacts.PartyContactMechanisms
  • General.Contacts.PartyBankAccounts
  • General.Contacts.PartyPictures

Attributes

Name	Type	Description
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
GLN	string (13) nullable	Global Location Number used by EDI systems. Filter(multi eq) ORD
IsActive	boolean	Specifies whether the current party is active in the system or not. Required Default(true) Filter(eq)
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
PartyCreationTime	datetime nullable	Date and time when the Party was created. Filter(ge;le) ReadOnly
PartyCreationUser	string (64) nullable	Login name of the user, who created the Party. Filter(like) ReadOnly
PartyId	guid	Gets the Id of the party row, related to the domain object
PartyName	MultilanguageString (254)	The name of the party. Required Filter(eq;like) ReadOnly
PartyNotes	string (254) nullable	Notes for this Party.
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)
PartyUniqueNumber	string (16) nullable	Unique number of the party (National number for persons, Registration number for companies). Filter(eq;like) ReadOnly
PartyUpdateTime	datetime nullable	Date and time when the Party was last updated. Filter(ge;le) ReadOnly
PartyUpdateUser	string (64) nullable	Login name of the user, who last updated the Party. Filter(like) ReadOnly

References

Name	Type	Description
AdministrativeRegion	AdministrativeRegions (nullable)	The administrative region in which the party is situated. Filter(multi eq)
Area	Areas (nullable)	The area in which the party is situated. Filter(multi eq)
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)
ParentParty	Parties (nullable)	Organizational unit (branch from the hierarchy of all parties) to which this party is referred to. Filter(multi eq)

Child Collections

Name	Type	Description
ApplicableLegislations	PartyApplicableLegislations	List of PartyApplicable<br />Legislation(General.PartyApplicable Legislations.md) child objects, based on the General.PartyApplicableLegislation.Party(General.PartyApplicable Legislations.md#party) back reference
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
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
Distributors	Distributors	List of Distributor(Crm.Distributors.md) child objects, based on the Crm.Distributor.Party(Crm.Distributors.md#party) back reference
LocationNumbers	PartyLocationNumbers	List of PartyLocationNumber(General.PartyLocationNumbers.md) child objects, based on the General.PartyLocationNumber.Party(General.PartyLocationNumbers.md#party) back reference
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

Attribute Details

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

GLN

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

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

IsActive

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

Type: boolean
Category: System
Supported Filters: Equals
Supports Order By: False
Default Value: True
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

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

PartyCreationTime

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

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

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

PartyId

Gets the Id of the party row, related to the domain object

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

PartyName

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

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

PartyNotes

Notes for this Party.

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)

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

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

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

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)

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)

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)

Type: CodingSystems (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)

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

Creates a notification and sends 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 subject.
  Type: string

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

• R18731 Party - Party Name
• R27851 Party - Party Unique Number

Front-End Business Rules

None

API

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

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