Stock Items

StockItem represents the material/equipment record stored in a stock. This page documents item-level records and item-type register governance.

---

1. Business Meaning

1.1 What a Stock Item Represents

StockItem is a stock-bound material record with quantity, optional serial/batch, optional catalog specification reference, and item status. It provides the basis for movement operations (StockMovement).

1.2 What a Stock Item Type Represents

StockItemType is a validity-governed type register for item classification and optional module/config metadata.

1.3 Transient Item Fields

StockItem contains transient helper fields:

• transferStockSideRight,
• movType.

They are intended for runtime processing/UI behavior and are not persisted as business attributes.

---

2. Entity Reference: StockItem (StockItem)

Field	Type	Required	Read-only	Description
stock	String	No	No	FK to Stock.key.
key	String	No (create)	No	Business-readable item key; generated if not provided.
id	UUID	No	No	Item primary key.
amount	Float	No	No	Quantity/amount in stock.
entCatSpecRef	UUID	No	No	Optional catalog specification reference.
serialNumber	String	No	No	Optional serial number.
price	Float	No	No	Optional item price value.
batchNo	String	No	No	Optional batch number.
status	StockItemStatus	No	No	Item status enum (ACTIVE, ARCHIVE).
stockItemType	String	No	No	FK code to StockItemType.code.
transferStockSideRight	Boolean	No	No	Transient runtime helper flag (not stored).
movType	String	No	No	Transient runtime helper value (not stored).
description	String	No	No	Optional description.
dataTags	List<String>	No	No	Optional labels/tags.
chars	TsmChars	No	No	Dynamic item attributes.

---

3. Enum Reference: StockItemStatus (StockItemStatus)

Value	Meaning
ACTIVE	Active stock item record.
ARCHIVE	Archived stock item record.

---

4. Entity Reference: StockItemType (StockItemType)

Field	Type	Required	Read-only	Description
id	UUID	No	No	Item type primary key.
code	String	Yes	No	Technical unique code.
name	String	Yes	No	Display name.
validityFrom	Date	No	No	Validity start.
validityTo	Date	No	No	Validity end.
description	String	No	No	Optional description.
localizationData	LocalizationData	No	No	Localization payload.
icon	String	No	No	Optional icon metadata.
config	Map<String, Any?>	No	No	Additional configuration payload.
registry	Map<String, Any?>	No	No	Register payload.
processingData	Object	No	Write-only	Transient processing context (max 32 top-level keys, max 64 KB, max depth 12).
dataTags	List<String>	No	No	Optional labels/tags.
createPrivilege	String	No	No	Optional privilege constraint.
tsmModule	String	No	No	Optional module code reference.
entitySpecId	UUID	No	No	Optional entity specification reference.
mnemonicCode	String	No	No	Optional mnemonic code.