Skip to content

Inventory Countings

Inventory count/stocktake records.

Fields

FieldTypeRequiredVersionDescription
idguidYes1.1.2Unique counting identifier
namestringNo1.1.2Count name/description
customerIdintegerYes1.1.2Reference to Customer
locationIdguidNo1.1.2Reference to InventoryLocation
statusstringNo1.1.2Count status
countDatedateYes1.1.2Date of count
itemsarrayNo1.1.2Array of counted items
createdBystringNo1.1.2User who created count
created_atdateNo1.1.2Creation timestamp
completedBystringNo1.1.2User who completed count
completed_atdateNo1.1.2Completion timestamp

Count Item Structure

json
{
  "itemId": "guid",
  "expectedAmount": 10.0,
  "countedAmount": 9.5,
  "variance": -0.5,
  "unit": "kg"
}

Status Values

StatusDescription
draftCount in progress
submittedCount submitted for review
approvedCount approved, adjustments made
cancelledCount 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"
}
  • Customer - Parent customer/tenant
  • InventoryLocation - Count location
  • InventoryItem - Counted items

Technical documentation for partners and integrators