General.Contacts.Companies Entity
Namespace: General.Contacts
Inherited From: General.Contacts.Parties
Contains company definitions. Entity: Cm_Companies
Default Visualization
Default Display Text Format:
{Name:T}
Default Search Members:
PartyCode; Name
Code Data Member:
PartyCode
Name Data Member:
Name
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
Attributes
| Name | Type | Description |
|---|---|---|
| BranchNumber | int32 | Branch number of the company. Companies with equal names and/or registration numbers can be inserted only if their branch numbers are different. Required Default(0) Filter(eq) |
| City | MultilanguageString (64) nullable | The city in which the company is registered. Filter(like) |
| CreationTime | datetime nullable | Date and time when the Company was created. Filter(ge;le) ReadOnly |
| CreationUser | string (64) nullable | Login name of the user, who created the Company. Filter(like) ReadOnly |
| 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) |
| IsVATCashReporting Registered |
boolean | When true, specifies that the company uses the special VAT Cash Reporting Mode. Required Default(false) |
| IsVATRegistered | boolean | Determines wheather the company is included in VAT registers. Required Default(false) |
| Name | MultilanguageString (254) nullable | The name of this Company. 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) |
| RegistrationNumber | string (16) nullable | Unique, government-assigned registration number. null means unknown. Filter(eq;like) ORD |
| RegistrationPrimaryAddress | MultilanguageString (254) nullable | The primary registration address of the company. Filter(like) |
| RegistrationType | MultilanguageString (16) nullable | Legal registration type - like LTD., PLC, etc. null means unknown. Filter(eq) |
| RegistrationVATNumber | string (16) nullable | VAT registration number where applicable. null means that VAT number is not applicable or unknown. Filter(eq) ORD |
| ResponsiblePersonName | MultilanguageString (64) nullable | Primary responsible person of the company. null means unknown. Filter(like) |
| UpdateTime | datetime nullable | Date and time when the Company was last updated. Filter(ge;le) ReadOnly |
| UpdateUser | string (64) nullable | Login name of the user, who last updated the Company. 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) |
| Country | Countries (nullable) | The country, where the company is registered. 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) |
| RegistrationResponsible Person |
Persons (nullable) | The personal record of the primary responsible person as per registration. null means unknown. Filter(multi eq) |
Child Collections
| Name | Type | Description |
|---|---|---|
| ActivityTimeIntervals | ActivityTimeIntervals | List of ActivityTimeInterval(General.Contacts.ActivityTimeIntervals.md) child objects, based on the General.Contacts.ActivityTimeInterval.Party(General.Contacts.ActivityTimeIntervals.md#party) back reference (Inherited from Parties) |
| ApplicableLegislations | PartyApplicableLegislations | List of PartyApplicable<br />Legislation(General.PartyApplicableLegislations.md) child objects, based on the General.PartyApplicableLegislation.Party(General.PartyApplicableLegislations.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) |
| Departments | CompanyDepartments | List of CompanyDepartment(General.Contacts.CompanyDepartments.md) child objects, based on the General.Contacts.CompanyDepartment.Company(General.Contacts.CompanyDepartments.md#company) back reference |
| 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
BranchNumber
Branch number of the company. Companies with equal names and/or registration numbers can be inserted only if their branch numbers are different. Required Default(0) Filter(eq)
Type: int32
Category: System
Supported Filters: Equals
Supports Order By: False
Default Value: 0
Show in UI: ShownByDefault
City
The city in which the company is registered. 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 Company 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 Company. 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
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
IsVATCashReportingRegistered
When true, specifies that the company uses the special VAT Cash Reporting Mode. Required Default(false)
Type: boolean
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Default Value: False
Show in UI: ShownByDefault
IsVATRegistered
Determines wheather the company is included in VAT registers. Required Default(false)
Type: boolean
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Default Value: False
Show in UI: ShownByDefault
Name
The name of this Company. Filter(eq;like)
Type: MultilanguageString (254) nullable
Indexed: True
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
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
RegistrationNumber
Unique, government-assigned registration number. null means unknown. Filter(eq;like) ORD
Type: string (16) nullable
Indexed: True
Category: System
Supported Filters: Equals, Like
Supports Order By: True
Maximum Length: 16
Show in UI: ShownByDefault
RegistrationPrimaryAddress
The primary registration address of the company. Filter(like)
Type: MultilanguageString (254) nullable
Category: System
Supported Filters: Like
Supports Order By: False
Show in UI: ShownByDefault
RegistrationType
Legal registration type - like LTD., PLC, etc. null means unknown. Filter(eq)
Type: MultilanguageString (16) nullable
Category: System
Supported Filters: Equals
Supports Order By: False
Show in UI: ShownByDefault
RegistrationVATNumber
VAT registration number where applicable. null means that VAT number is not applicable or unknown. Filter(eq) ORD
Type: string (16) nullable
Indexed: True
Category: System
Supported Filters: Equals
Supports Order By: True
Maximum Length: 16
Show in UI: ShownByDefault
ResponsiblePersonName
Primary responsible person of the company. null means unknown. Filter(like)
Type: MultilanguageString (64) nullable
Category: System
Supported Filters: Like
Supports Order By: False
Show in UI: ShownByDefault
UpdateTime
Date and time when the Company 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 Company. 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
Country
The country, where the company is registered. Filter(multi eq)
Type: Countries (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
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
RegistrationResponsiblePerson
The personal record of the primary responsible person as per registration. null means unknown. Filter(multi eq)
Type: Persons (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: CannotBeShown
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: stringsearch
The search text - searches by value or description. Can contain wildcard character %.
Type: string
Optional: True
Default Value: nullexactMatch
If true the search text should be equal to the property value
Type: boolean
Optional: True
Default Value: FalseorderByDescription
If true the result is ordered by Description instead of Value. Note that ordering is not always possible.
Type: boolean
Optional: True
Default Value: Falsetop
The top clause - default is 10
Type: int32
Optional: True
Default Value: 10skip
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: UsersnotificationClass
The notification class.
Type: stringsubject
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
None
Front-End Business Rules
API
Domain API Query: https://demodb.my.erp.net/api/domain/odata/General_Contacts_Companies?$top=10
Domain API Query Builder: https://demodb.my.erp.net/api/domain/querybuilder#General_Contacts_Companies?$top=10