Logistics.Inventory.Stores Entity
Namespace: Logistics.Inventory
Inherited From: General.Contacts.Parties
Represents the physical warehouses. Entity: Inv_Stores
Default Visualization
Default Display Text Format:
{PartyName:T}
Default Search Members:
Code; PartyName
Code Data Member:
Code
Name Data Member:
PartyName
Category: Definitions
Show in UI: ShownByDefault
Layout category attribute: PartyType
Track Changes
Min level: 4 - Track object attribute and blob changes
Max level: 4 - Track object attribute and blob changes
Aggregate
An aggregate is a cluster of domain objects that can be treated as a single unit.
Aggregate Tree
Attributes
| Name | Type | Description |
|---|---|---|
| boolean nullable | OBSOLETE! Do not use! Obsolete - Use Gen_Parties.Is_Active. Obsolete Obsoleted in version 22.1.6.61 |
|
| Code | string (16) | The unique code of the Store. Required Filter(eq;like) ORD |
| CreationTime | datetime nullable | Date and time when the Store was created. Filter(ge;le) ReadOnly |
| CreationUser | string (64) nullable | Login name of the user, who created the Store. Filter(like) ReadOnly |
| DefaultSupplyStoreId | guid nullable | The store from which goods are usually supplied to this store. Filter(multi eq) |
| 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) |
| Name | MultilanguageString (254) | Name of the store. Required Filter(like) |
| NumberOfDimensions | int32 | Number of dimensions in the coordinate system of the storage bins. 0 means single-bin store. Currently, this is only stored for information and is not used for automatical generation of store bins, as it was intended. Required Default(0) 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 (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) |
| SchemaXML | string (max) nullable | Obsolete. Not used. |
| Unmanaged | boolean | If false the system will expect the user to process the store transactions. If true the system will auto-generate them. Required Default(true) |
| UpdateTime | datetime nullable | Date and time when the Store was last updated. Filter(ge;le) ReadOnly |
| UpdateUser | string (64) nullable | Login name of the user, who last updated the Store. Filter(like) ReadOnly |
References
| Name | Type | Description |
|---|---|---|
| AccessKey | AccessKeys (nullable) | The access key, containing the user permissions for this Store. 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) |
| Currency | Currencies (nullable) | The currency for the warehouse cost calculations. When null, the base currency for the enterprise company will be used. 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) |
| DefaultStoreBin | StoreBins (nullable) | To be used when store bin is unknown. Filter(multi eq) |
| EnterpriseCompany | EnterpriseCompanies (nullable) | The Enterprise Company to which this Store applies, or null if it is for all enterprise companies. Filter(multi eq) |
| EnterpriseCompanyLocation | CompanyLocations (nullable) | The Enterprise Company Location to which this Store applies, or null if it is for all enterprise company locations. Filter(multi eq) |
| Parent | Stores (nullable) | Obsolete. Not used. (Hierarchy of the stores is now represented by the Store Groups entity). 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) (Inherited from Parties) |
| ResponsibleParty | Parties (nullable) | Primary responsible party (usually employee) for the stock in the store. Filter(multi eq) |
| StoreGroup | StoreGroups | The store group, to which this store belongs. Required Filter(multi eq) |
| TaxWarehouse | TaxWarehouses (nullable) | Excise Tax Warehouse for this Store. null means that the Store is not an Excise Tax Warehouse. Filter(multi eq) Introduced in version 21.1.3.93 |
| Warehouse | Warehouses (nullable) | Specifies, the warehouse, which manages the warehouse operations for the store. null for stores, which do not have managed operations. Filter(multi eq) Introduced in version 20.1 |
Child Collections
| Name | Type | Description |
|---|---|---|
| ApplicableLegislations | PartyApplicableLegislations | List of PartyApplicable<br />Legislation(General.Contacts.PartyApplicableLegislations.md) child objects, based on the General.Contacts.PartyApplicableLegislation.Party(General.Contacts.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) |
| Bins | StoreBins | List of StoreBin(Logistics.Inventory.StoreBins.md) child objects, based on the Logistics.Inventory.StoreBin.Store(Logistics.Inventory.StoreBins.md#store) 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 (Inherited from Parties) |
| LocationNumbers | PartyLocationNumbers | List of PartyLocationNumber(General.Contacts.PartyLocationNumbers.md) child objects, based on the General.Contacts.PartyLocationNumber.Party(General.Contacts.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) |
| Relationships | PartyRelationships | List of PartyRelationship(General.Contacts.PartyRelationships.md) child objects, based on the General.Contacts.PartyRelationship.FromParty(General.Contacts.PartyRelationships.md#fromparty) back reference (Inherited from Parties) |
| ResponsibleParties | StoreResponsibleParties | List of StoreResponsibleParty(Logistics.Inventory.StoreResponsibleParties.md) child objects, based on the Logistics.Inventory.StoreResponsibleParty.Store(Logistics.Inventory.StoreResponsibleParties.md#store) back reference |
Attribute Details
Active
OBSOLETE! Do not use! Obsolete - Use Gen_Parties.Is_Active. Obsolete Obsoleted in version 22.1.6.61
Type: boolean nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Show in UI: CannotBeShown
Code
The unique code of the Store. Required Filter(eq;like) ORD
Type: string (16)
Indexed: True
Category: System
Supported Filters: Equals, Like
Supports Order By: True
Maximum Length: 16
Show in UI: ShownByDefault
Back-End Default Expression:
obj.IncMax( o => o.Code, null, "00000")
CreationTime
Date and time when the Store 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 Store. Filter(like) ReadOnly
Type: string (64) nullable
Category: System
Supported Filters: Like
Supports Order By: False
Maximum Length: 64
Show in UI: HiddenByDefault
DefaultSupplyStoreId
The store from which goods are usually supplied to this store. Filter(multi eq)
Type: guid nullable
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: CannotBeShown
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
Name
Name of the store. Required Filter(like)
Type: MultilanguageString (254)
Category: System
Supported Filters: Like
Supports Order By: False
Show in UI: ShownByDefault
NumberOfDimensions
Number of dimensions in the coordinate system of the storage bins. 0 means single-bin store. Currently, this is only stored for information and is not used for automatical generation of store bins, as it was intended. Required Default(0) Filter(eq)
Type: int32
Category: System
Supported Filters: Equals
Supports Order By: False
Default Value: 0
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
Back-End Default Expression:
obj.IncMax( o => o.PartyCode, null, "00000")
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
SchemaXML
Obsolete. Not used.
Type: string (max) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 2147483647
Show in UI: CannotBeShown
Unmanaged
If false the system will expect the user to process the store transactions. If true the system will auto-generate them. Required Default(true)
Type: boolean
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Default Value: True
Show in UI: ShownByDefault
UpdateTime
Date and time when the Store 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 Store. 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
AccessKey
The access key, containing the user permissions for this Store. Null means that all users have unlimited permissions. Filter(multi eq)
Type: AccessKeys (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: CannotBeShown
Remarks
Supported permissions
| Permission | Type |
|---|---|
| Update | - |
| Delete | - |
| Administer (manage security) | - |
| Release Receipt Store Transactions | Permission1 |
| Release Issue Store Transactions | Permission2 |
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
Currency
The currency for the warehouse cost calculations. When null, the base currency for the enterprise company will be used. Filter(multi eq)
Type: Currencies (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault
Front-End Recalc Expressions:
IIF( ( obj.EnterpriseCompany != null), obj.EnterpriseCompany.BaseCurrency, obj.Transaction.CurrentEnterpriseCompany.BaseCurrency)
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
DefaultStoreBin
To be used when store bin is unknown. Filter(multi eq)
Type: StoreBins (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: HiddenByDefault
EnterpriseCompany
The Enterprise Company to which this Store applies, or null if it is for all enterprise companies. Filter(multi eq)
Type: EnterpriseCompanies (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: HiddenByDefault
EnterpriseCompanyLocation
The Enterprise Company Location to which this Store applies, or null if it is for all enterprise company locations. Filter(multi eq)
Type: CompanyLocations (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault
Parent
Obsolete. Not used. (Hierarchy of the stores is now represented by the Store Groups entity). Filter(multi eq)
Type: Stores (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: CannotBeShown
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
ResponsibleParty
Primary responsible party (usually employee) for the stock in the store. Filter(multi eq)
Type: Parties (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault
StoreGroup
The store group, to which this store belongs. Required Filter(multi eq)
Type: StoreGroups
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault
TaxWarehouse
Excise Tax Warehouse for this Store. null means that the Store is not an Excise Tax Warehouse. Filter(multi eq) Introduced in version 21.1.3.93
Type: TaxWarehouses (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault
Warehouse
Specifies, the warehouse, which manages the warehouse operations for the store. null for stores, which do not have managed operations. Filter(multi eq) Introduced in version 20.1
Type: Warehouses (nullable)
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: 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
Create a notification immediately in a separate transaction, and send 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 notification 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
API
Domain API Query: https://demodb.my.erp.net/api/domain/odata/Logistics_Inventory_Stores?$top=10
Domain API Query Builder: https://demodb.my.erp.net/api/domain/querybuilder#Logistics_Inventory_Stores?$top=10