General.Contacts.CompanyLocations Entity

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

Stores company locations. The locations are parties and as such, can be organized hierarchically mixed with other structuring mechanisms. The locations, departments and divisions are parallel and different structuring mechanisms for the companies. Entity: Cm_Company_Locations

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.CompanyLocations

Attributes

Name	Type	Description
BillTo	BillTo nullable	If filled indicates which party is billed for the amounts from documents that require payments. This setting is used in CRM module when the company and the location are customers. Possible values: 'C' = Company, 'L' = Company location, null = unidentified.
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` (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)
LocationName	MultilanguageString (64)	The name of the company location. `Required` `Filter(eq;like)`
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)
WorkingTime	string (254) nullable	Textual representation of the working time of the location.

References

Name	Type	Description
AccessKey	AccessKeys (nullable)	The access key, containing the user permissions for this CompanyLocation. Null means that all users have unlimited permissions. `Filter(multi eq)`
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)
Company	Companies	The company to which this location belongs. `Required` `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)` (Inherited from Parties)
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.PartyApplicable Legislations.md) child objects, based on the `General.PartyApplicableLegislation.Party`(General.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)
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)
Distributors	Distributors	List of `Distributor`(Crm.Distributors.md) child objects, based on the `Crm.Distributor.Party`(Crm.Distributors.md#party) back reference (Inherited from Parties)
LocationNumbers	PartyLocationNumbers	List of `PartyLocationNumber`(General.PartyLocationNumbers.md) child objects, based on the `General.PartyLocationNumber.Party`(General.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)

Attribute Details

BillTo

If filled indicates which party is billed for the amounts from documents that require payments. This setting is used in CRM module when the company and the location are customers. Possible values: 'C' = Company, 'L' = Company location, null = unidentified.

Type: BillTo nullable
Category: System
Allowed values for the BillTo(General.Contacts.CompanyLocations.md#billto) data attribute
Allowed Values (General.Contacts.CompanyLocationsRepository.BillTo 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'

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

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 (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

LocationName

The name of the company location. Required Filter(eq;like)

Type: MultilanguageString (64)
Category: System
Supported Filters: Equals, Like
Supports Order By: False
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

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

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

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

WorkingTime

Textual representation of the working time of the location.

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

Reference Details

AccessKey

The access key, containing the user permissions for this CompanyLocation. Null means that all users have unlimited permissions. Filter(multi eq)

Type: AccessKeys (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: CannotBeShown

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

Company

The company to which this location belongs. Required Filter(multi eq)

Type: Companies
Indexed: True
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

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

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

Front-End Business Rules

None

API

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

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