Inventory Countings
Inventory count/stocktake records.
Fields
| Field | Type | Required | Version | Description |
|---|---|---|---|---|
id | guid | Yes | 1.1.2 | Unique counting identifier |
name | string | No | 1.1.2 | Count name/description |
customerId | integer | Yes | 1.1.2 | Reference to Customer |
locationId | guid | No | 1.1.2 | Reference to InventoryLocation |
status | string | No | 1.1.2 | Count status |
countDate | date | Yes | 1.1.2 | Date of count |
items | array | No | 1.1.2 | Array of counted items |
createdBy | string | No | 1.1.2 | User who created count |
created_at | date | No | 1.1.2 | Creation timestamp |
completedBy | string | No | 1.1.2 | User who completed count |
completed_at | date | No | 1.1.2 | Completion timestamp |
Count Item Structure
json
{
"itemId": "guid",
"expectedAmount": 10.0,
"countedAmount": 9.5,
"variance": -0.5,
"unit": "kg"
}Status Values
| Status | Description |
|---|---|
draft | Count in progress |
submitted | Count submitted for review |
approved | Count approved, adjustments made |
cancelled | Count cancelled |
Example
json
{
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name": "Weekly Count - Kitchen",
"customerId": 12345,
"locationId": "location-kitchen-id",
"status": "approved",
"countDate": "2024-12-01",
"items": [
{
"itemId": "item-salmon-id",
"expectedAmount": 15.0,
"countedAmount": 14.5,
"variance": -0.5,
"unit": "kg"
},
{
"itemId": "item-olive-oil-id",
"expectedAmount": 8.0,
"countedAmount": 8.0,
"variance": 0.0,
"unit": "l"
}
],
"createdBy": "chef.john",
"created_at": "2024-12-01T22:00:00Z",
"completedBy": "manager.anna",
"completed_at": "2024-12-02T08:00:00Z"
}Related Entities
- Customer - Parent customer/tenant
- InventoryLocation - Count location
- InventoryItem - Counted items