REST Object Definitions Inventory Related Objects Inventory Usage Object

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

Required properties are in bold.

Property Type Description

ModifiedUTC datetime Identifies the date and time, in UTC format, when this object was last modified.

RefModule

string

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
1007 - Automatic inventory adjustment

RefObjID

string

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

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

StorageLocations

collection

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

Property

Type

Description

StorageLocationID

string

Identifies the storage location whose inventory was affected.

Items

collection

A collection of items whose inventory count was affected.

Property	Type	Description
BatchNum	string	Identifies the batch number for the item - if required.
DispositionReasons	collection	Contains a collection of Parts Disposition Reason Objects associated with the item. 3.18.1
InQty	decimal	Contains the quantity that was added to the storage location's inventory.
InventoryDamagedQty	decimal	Future
InventoryQty	decimal	Contains the actual inventory count for the item as determined by the mobile device.
OutQty	decimal	Identifies the quantity of the item that was used for this transaction.
ProdNum	string	Identifies the product number of the item.
ReportedDamagedQty	decimal	Future
SerialNum	string	Identifies the serial number of the item - if required.

UserID string Identifies the user ID who adjusted the inventory.