/
Inventory Usage Object
Document toolboxDocument toolbox

Inventory Usage Object

Owned by Andrew Hill (Deactivated)
Last updated: Oct 07, 2024 by Jason Andrew

The Inventory Usage object reports on inventory adjustments being made by the technician.

Inventory usage transactions are generated by the following processes:

  • Accepting inventory loads
  • Completing a physical inventory count
  • Completing an inventory transfer
  • Consuming parts on a work order

Inventory Usage Object Formats

JSON Format 
{
	"UserID": "", 
    "ModifiedUTC" : "2013-01-01T12:00:00Z",
    "RefModule" : "",
    "RefObjID": "", 
    "StorageLocations": [
        {
            "StorageLocationID": "", 
            "Items": [
                {
                    "BatchNum": "",
					"DispositionReasons": [
						{
							"Desc": "",
							"InQty": 0.0,
							"InventoryQty": 0.0,
							"OutQty": 0.0,							
							"Qty": 0.0,
							"ReasonCode": ""
						}
					], 
                    "InQty": 0.0,
                    "InventoryDamagedQty" : 0.0, 
                    "InventoryQty" : 0.0,
                    "OutQty": 0.0,
                    "ProdNum": "", 
                    "ReportedDamagedQty": 0.0,
                    "SerialNum": ""
                }
            ]
        }
    ]
}

Inventory Usage Object Properties

(info) Required properties are in bold.

PropertyTypeDescription
ModifiedUTCdatetimeIdentifies the date and time, in UTC format, when this object was last modified.
RefModulestring

Identifies what module, within the mobile application, adjusted the inventory.

Valid values are:

  • 1001 - Inventory load module
  • 1002 - Work order module
  • 1003 - Inventory transfer module
  • 1004 - Inventory count - full
  • 1005 - Inventory count - partial
RefObjIDstring

Identifies the source object the load adjustment was based off of. This property is translated differently based on the RefModule property.

RefModule ValueRefObjID Meaning
1001Inventory load ID
1002Work order number
1003Inventory transfer validation code
1004Physical inventory request number
1005Physical inventory request number
StorageLocationscollection

This object contains a collection of one or more storage locations that were affected by the usage.

PropertyTypeDescription
StorageLocationIDstringIdentifies the storage location whose inventory was affected.
Itemscollection

A collection of items whose inventory count was affected.

PropertyTypeDescription
BatchNumstringIdentifies the batch number for the item - if required.
DispositionReasonscollection

Contains a collection of Parts Disposition Reason Objects associated with the item.

3.18.1

InQtydecimalContains the quantity that was added to the storage location's inventory.
InventoryDamagedQtydecimal(info) Future
InventoryQtydecimalContains the actual inventory count for the item as determined by the mobile device.
OutQtydecimalIdentifies the quantity of the item that was used for this transaction.
ProdNumstringIdentifies the product number of the item.
ReportedDamagedQtydecimal(info) Future
SerialNumstringIdentifies the serial number of the item - if required.
UserIDstringIdentifies the user ID who adjusted the inventory.

Related content

Inventory Load Object
Inventory Load Object
ServiceMobility 3
More like this
Usage Data Object
Usage Data Object
ServiceMobility 3
More like this
Physical Inventory Count Object
Physical Inventory Count Object
ServiceMobility 3
More like this
Inventory Transfer Object
Inventory Transfer Object
ServiceMobility 3
More like this
Storage Location Object
Storage Location Object
ServiceMobility 3
More like this