General.EnterpriseCompanies Entity

Namespace: General

The companies in the enterprise that issue documents. Entity: Gen_Enterprise_Companies

Default Visualization

Default Display Text Format:
{Company.PartyName:T}
Default Search Members:
Company.RegistrationNumber; Company.PartyName
Code Data Member:
Company.RegistrationNumber
Name Data Member:
Company.PartyName

Aggregate

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

Aggregate Tree

• General.EnterpriseCompanies
  • Applications.Fleet.Crews
    • Applications.Fleet.CrewMembers
  • Applications.Fleet.VehicleSets
    • Applications.Fleet.VehicleSetVehicles
  • General.Geography.MapPoints
  • Finance.Vat.BGVATDeclaringPersons
  • Projects.Resources

Attributes

Name	Type	Description
BIStartDate	datetime nullable	Defines the period for which BI extracts data. BI includes documents with "Document Date" greater than or equal to "BI Start Date". Filter(eq) Introduced in version 18.2
DefaultCostingMethod	DefaultCostingMethod	Default method for cost evaluation (if not specified in the product). Currently supported: EXP - Explicit lot specifying; AVG - Average cost. Required Default("AVG")
DefaultCustomer CreditLimitBase	Amount (18, 2) nullable	Customer credit limit, which is used by default when creating new customers. It is specified in the base currency of the enterprise company. Currency: BaseCurrency Filter(eq;like)
DefaultLanguage	DefaultLanguage nullable	The default language for multi-language names in the definitions (like Customer_Name, Product_Name, ...). Default("en")
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
EditPeriodStartDate	datetime nullable	Start date of the priod when the documents can be edited.
Id	guid
IsActive	boolean	Indicates whether the current Enterprise company is active. Required Default(true) Filter(multi eq) Introduced in version 20.1
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.
PrintImagesRetentionMonths	int32	A period of months for which the printed images of the documents will be kept. Required Default(60) Filter(multi eq;ge;le) Introduced in version 20.1
UIBaseColor	int32 nullable	When not null, specifies the background color to use for visualization of the UI when the current enterprise company is selected. The color is in RGBA color format. Introduced in version 18.2

References

Name	Type	Description
AccessKey	AccessKeys (nullable)	The access key, containing the user permissions for this EnterpriseCompany. Null means that all users have unlimited permissions. Filter(multi eq)
AdvanceProduct	Products (nullable)	Product that is used for handling advances in trade documents. Filter(multi eq)
BaseCurrency	Currencies	The base currency for summary reporting for this company. Required Filter(multi eq)
Company	Companies	Contains the base company data on which this enterprise company is based. Required Filter(multi eq)
ExchangeDifference CreditAccount	Accounts (nullable)	Account for balancing accounting vouchers with credit difference due to currency exchanges. Filter(multi eq)
ExchangeDifference DebitAccount	Accounts (nullable)	Account for balancing accounting vouchers with debit difference due to currency exchanges. Filter(multi eq)
VATDocumentAmountType	DocumentAmountTypes (nullable)	The document amount that is used to determine the amount of the VAT entries when they are generated. Filter(multi eq)

Child Collections

Name	Type	Description
BGVATDeclaringPersons	BGVATDeclaringPersons	List of BGVATDeclaringPerson(Finance.Vat.BGVATDeclaringPersons.md) child objects, based on the Finance.Vat.BGVATDeclaringPerson.EnterpriseCompany(Finance.Vat.BGVATDeclaringPersons.md#enterprisecompany) back reference
Crews	Crews	List of Crew(Applications.Fleet.Crews.md) child objects, based on the Applications.Fleet.Crew.EnterpriseCompany(Applications.Fleet.Crews.md#enterprisecompany) back reference
MapPoints	MapPoints	List of MapPoint(General.Geography.MapPoints.md) child objects, based on the General.Geography.MapPoint.EnterpriseCompany(General.Geography.MapPoints.md#enterprisecompany) back reference
Resources	Resources	List of Resource(Projects.Resources.md) child objects, based on the Projects.Resource.EnterpriseCompany(Projects.Resources.md#enterprisecompany) back reference
VehicleSets	VehicleSets	List of VehicleSet(Applications.Fleet.VehicleSets.md) child objects, based on the Applications.Fleet.VehicleSet.EnterpriseCompany(Applications.Fleet.VehicleSets.md#enterprisecompany) back reference

Attribute Details

BIStartDate

Defines the period for which BI extracts data. BI includes documents with "Document Date" greater than or equal to "BI Start Date". Filter(eq) Introduced in version 18.2

Type: datetime nullable
Category: System
Supported Filters: Equals
Supports Order By: False

DefaultCostingMethod

Default method for cost evaluation (if not specified in the product). Currently supported: EXP - Explicit lot specifying; AVG - Average cost. Required Default("AVG")

Type: DefaultCostingMethod
Category: System
Allowed values for the DefaultCostingMethod(General.EnterpriseCompanies.md#defaultcostingmethod) data attribute
Allowed Values (General.EnterpriseCompaniesRepository.DefaultCostingMethod Enum Members)

Value	Description
AverageCost	AverageCost value. Stored as 'AVG'. Database Value: 'AVG' Model Value: 0 Domain API Value: 'AverageCost'
ExplicitlySpecifyLot	ExplicitlySpecifyLot value. Stored as 'EXP'. Database Value: 'EXP' Model Value: 1 Domain API Value: 'ExplicitlySpecifyLot'
SetByBlockedForDocument	SetByBlockedForDocument value. Stored as 'BLD'. Database Value: 'BLD' Model Value: 2 Domain API Value: 'SetByBlockedForDocument'

Supported Filters: NotFilterable
Supports Order By: False
Default Value: AverageCost

DefaultCustomerCreditLimitBase

Customer credit limit, which is used by default when creating new customers. It is specified in the base currency of the enterprise company. Currency: BaseCurrency Filter(eq;like)

Type: Amount (18, 2) nullable
Category: System
Supported Filters: Equals, Like
Supports Order By: False

DefaultLanguage

The default language for multi-language names in the definitions (like Customer_Name, Product_Name, ...). Default("en")

Type: DefaultLanguage nullable
Category: System
Allowed values for the DefaultLanguage(General.EnterpriseCompanies.md#defaultlanguage) data attribute
Allowed Values (General.EnterpriseCompaniesRepository.DefaultLanguage Enum Members)

Value	Description
Bulgarian	Bulgarian value. Stored as 'bg'. Database Value: 'bg' Model Value: 0 Domain API Value: 'Bulgarian'
English	English value. Stored as 'en'. Database Value: 'en' Model Value: 1 Domain API Value: 'English'

Supported Filters: NotFilterable
Supports Order By: False
Default Value: English

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: ****

EditPeriodStartDate

Start date of the priod when the documents can be edited.

Type: datetime nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False

Id

Type: guid
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Default Value: NewGuid

IsActive

Indicates whether the current Enterprise company is active. Required Default(true) Filter(multi eq) Introduced in version 20.1

Type: boolean
Category: System
Supported Filters: Equals, EqualsIn
Supports Order By: False
Default Value: True

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: ****

PrintImagesRetentionMonths

A period of months for which the printed images of the documents will be kept. Required Default(60) Filter(multi eq;ge;le) Introduced in version 20.1

Type: int32
Category: System
Supported Filters: Equals, GreaterThanOrLessThan, EqualsIn
Supports Order By: False
Default Value: 60

UIBaseColor

When not null, specifies the background color to use for visualization of the UI when the current enterprise company is selected. The color is in RGBA color format. Introduced in version 18.2

Type: int32 nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False

Reference Details

AccessKey

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

Type: AccessKeys (nullable)
Category: System
Supported Filters: Equals, EqualsIn

AdvanceProduct

Product that is used for handling advances in trade documents. Filter(multi eq)

Type: Products (nullable)
Category: System
Supported Filters: Equals, EqualsIn

BaseCurrency

The base currency for summary reporting for this company. Required Filter(multi eq)

Type: Currencies
Category: System
Supported Filters: Equals, EqualsIn

Company

Contains the base company data on which this enterprise company is based. Required Filter(multi eq)

Type: Companies
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn

ExchangeDifferenceCreditAccount

Account for balancing accounting vouchers with credit difference due to currency exchanges. Filter(multi eq)

Type: Accounts (nullable)
Category: System
Supported Filters: Equals, EqualsIn

ExchangeDifferenceDebitAccount

Account for balancing accounting vouchers with debit difference due to currency exchanges. Filter(multi eq)

Type: Accounts (nullable)
Category: System
Supported Filters: Equals, EqualsIn

VATDocumentAmountType

The document amount that is used to determine the amount of the VAT entries when they are generated. Filter(multi eq)

Type: DocumentAmountTypes (nullable)
Category: System
Supported Filters: Equals, EqualsIn

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

None

Front-End Business Rules

None

API

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

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