General.PartyLocationNumbers Entity

Namespace: General

Location numbers for a party. Depending on the partner with which we are doing an exchange, our location number might be different. Entity: Gen_Party_Location_Numbers (Introduced in version 19.1)

Default Visualization

Default Display Text Format:
{Party.PartyName:T}
Default Search Members:
LocationNumber; Party.PartyName
Code Data Member:
LocationNumber
Name Data Member:
Party.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 Parent:
General.Contacts.Parties
Aggregate Root:
General.Contacts.Parties

Attributes

Name	Type	Description
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
Id	guid
LocationCodingSystem	LocationCodingSystem	The coding system for which we are defining the location number. `Required` `Default("GLN")` `Filter(multi eq)`
LocationNumber	string (16)	The location number of Party. `Required` `Filter(multi eq;like)` `ORD`
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.
PartnerLocationNumber	string (16) nullable	The location number of the partner party for which we define the main Party location number. The location number of the main Party might be different depending on the location number of the partner party. null means that the location number is not dependent on the partner location number. `Filter(multi eq)`
Significance	int32	Order of significance of the location number within the main Party. If there are multiple location numbers, only the most significant is used. 0 is the least significant and higher numbers indicate higher significance. `Required` `Default(0)` `Filter(multi eq;ge;le)`

References

Name	Type	Description
PartnerParty	Parties (nullable)	The party with which we are doing exchange. Depending on the Partner Party, the main Party might have different location number. null means that the location number is not dependent on the Partner Party. `Filter(multi eq)`
Party	Parties	The party for which we are defining the location number. `Required` `Filter(multi eq)` `Owner`

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

Id

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

LocationCodingSystem

The coding system for which we are defining the location number. Required Default("GLN") Filter(multi eq)

Type: LocationCodingSystem
Category: System
Allowed values for the LocationCodingSystem(General.PartyLocationNumbers.md#locationcodingsystem) data attribute
Allowed Values (General.PartyLocationNumbersRepository.LocationCodingSystem Enum Members)

Value	Description
GLN	GS1 Global Location Number (GLN). Stored as 'GLN'. Database Value: 'GLN' Model Value: 0 Domain API Value: 'GLN'
Internal	Internal coding system. Stored as 'INT'. Database Value: 'INT' Model Value: 1 Domain API Value: 'Internal'

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

LocationNumber

The location number of Party. Required Filter(multi eq;like) ORD

Type: string (16)
Indexed: True
Category: System
Supported Filters: Equals, Like, EqualsIn
Supports Order By: True
Maximum Length: 16
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

PartnerLocationNumber

The location number of the partner party for which we define the main Party location number. The location number of the main Party might be different depending on the location number of the partner party. null means that the location number is not dependent on the partner location number. Filter(multi eq)

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

Significance

Order of significance of the location number within the main Party. If there are multiple location numbers, only the most significant is used. 0 is the least significant and higher numbers indicate higher significance. Required Default(0) Filter(multi eq;ge;le)

Type: int32
Category: System
Supported Filters: Equals, GreaterThanOrLessThan, EqualsIn
Supports Order By: False
Default Value: 0
Show in UI: ShownByDefault

Reference Details

PartnerParty

The party with which we are doing exchange. Depending on the Partner Party, the main Party might have different location number. null means that the location number is not dependent on the Partner Party. Filter(multi eq)

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

Party

The party for which we are defining the location number. Required Filter(multi eq) Owner

Type: Parties
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Filterable Reference: True
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