Inventory Items
Inventory item master data.
Fields
| Field | Type | Required | Version | Description |
|---|---|---|---|---|
id | guid | Yes | 1.1.2 | Unique item identifier |
name | string | No | 1.1.2 | Item name |
base_unit | string | No | 1.1.2 | Base unit of measurement |
external_reference | string | No | 1.1.2 | External system reference |
customerId | integer | Yes | 1.1.2 | Reference to Customer |
groupId | guid | No | 1.1.2 | Reference to InventoryItemGroup |
supplierId | guid | No | 1.1.2 | Default supplier |
active | boolean | No | 1.1.2 | Item active status |
Base Unit Values
| Unit | Description |
|---|---|
kg | Kilogram |
g | Gram |
l | Liter |
ml | Milliliter |
pcs | Pieces |
box | Box |
case | Case |
Example
json
{
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name": "Fresh Salmon Fillet",
"base_unit": "kg",
"external_reference": "SUP-SALMON-001",
"customerId": 12345,
"groupId": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
"supplierId": "c3d4e5f6-a7b8-9012-cdef-123456789012",
"active": true
}Example - Various Items
json
[
{
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name": "Fresh Salmon Fillet",
"base_unit": "kg",
"external_reference": "SUP-SALMON-001",
"customerId": 12345,
"groupId": "group-seafood-id",
"supplierId": "supplier-fish-id",
"active": true
},
{
"id": "item-olive-oil-id",
"name": "Extra Virgin Olive Oil",
"base_unit": "l",
"external_reference": "SUP-OIL-001",
"customerId": 12345,
"groupId": "group-oils-id",
"supplierId": "supplier-deli-id",
"active": true
},
{
"id": "item-napkins-id",
"name": "Paper Napkins",
"base_unit": "pcs",
"external_reference": "SUP-NAP-001",
"customerId": 12345,
"groupId": "group-supplies-id",
"supplierId": "supplier-supplies-id",
"active": true
}
]Related Entities
- Customer - Parent customer/tenant
- InventoryItemGroup - Item grouping
- InventorySupplier - Default supplier
- InventoryTransaction - Stock movements
- InventoryRecipeItem - Recipe ingredients