Each entity below lists its OData feed entity set name and its columns, whether a value is required, a description, and the entity it relates to. For the terms used in these articles (tools, materials, assets, uniquely-tracked, and quantity-tracked), see Document Conventions in the ToolWatch OData API Overview.
Inventories
OData feed entity set: rc.Inventories
Column | Required | Description | Relates to |
ItemId | Yes | The item this record is for. | Items |
TrackingMethod | No | - | - |
EntityId | Yes | - | - |
OwnerEntityId | Yes | - | - |
Quantity | Yes | - | - |
IsPersonalIssue | Yes | - | - |
ReturnDate | No | - | - |
LastCountDate | No | - | - |
PurchaseCost | No | - | - |
PurchaseDate | No | - | - |
ReturnToEntityId | Yes | - | - |
CreatedOn | No | When the record was created. | - |
InventoryKeyId | No | - | - |
RecordId | No | - | - |
NextCountDater | No | - | - |
InventoryKeys
The InventoryKeys table provides a single, convenient ID, an InventoryKeyId, for each group of assets displayed in inventory. A more in depth explanation follows... ToolWatch tracks essentially two types of assets: unique and quantity. Unique assets have an individual identity, and therefore are simple to track. In ToolWatch, a unique asset can be identified by simply referring to its ItemId. Quantity assets are more complicated. Because quantity assets don't have an individual identity, we can't refer to any specific quantity tool with a unique ID. Instead, we must describe the asset we are referring to. For example, instead of saying "the hammers with ID = 2" we say something like "the used Craftsman hammers that are assigned to Joe". In ToolWatch there are six different attributes that can be used to describe a quantity asset. They are:
ItemId: specifies which item these asset(s) are an instance of (e.g. Craftsman hammers)
EntityId: the entity the asset(s) are assigned to
KitItemId: the kit the asset(s) are contained in
StatusCodeId: the status of the asset(s)
IsPersonalIssue: whether these assets were personally issued to an entity
OwnerEntityId: the stock location that owns these assets
It would be noisy to see these six columns all over the database. Instead, ToolWatch tables refer to an asset by specifying a single value that uniquely identifies the combination of the six fields. This value is the InventoryKeyId.
OData feed entity set: rc.InventoryKeys
Column | Required | Description | Relates to |
InventoryKeyId | Yes | A unique value that represents an asset that can be described by the following six fields | - |
EntityId | Yes | The entity this asset is assigned to | Entities |
ItemId | Yes | Which item this asset is an instance of | Items |
StatusCodeId | No | The status of the asset | StatusCodes |
IsPersonalIssue | Yes | If the asset has been personally issued | - |
KitItemId | No | The kit containing this asset | Items |
OwnerEntityId | Yes | The owner of this asset | Entities |
Items
Contains a record for each instance of an asset in ToolWatch. For uniquely-tracked assets, there is a single item record for every unique asset. For quantity-tracked assets, there is just one record. This is because quantity-tracked assets are not individually distinguishable, so the item information for all instances is the same. (see the conventions section for an explanation of uniquely-tracked vs. quantity-tracked.)
OData feed entity set: rc.Items
Column | Required | Description | Relates to |
ItemId | Yes | The unique ID of this item | - |
ModelId | Yes | The model this item is an instance of. | Models |
Number | Yes | A shorthand string used to refer to this Item | - |
BarCode | No | A short text string used to find this item when scanning. Is usually a printed barcode label physically on the asset. | - |
SerialNumber | No | The serial number for this instance. | - |
RFID | No | The RFID identification number for this item. | - |
IsDeleted | Yes | Indicates if this record has been deleted | - |
Notes | No | Custom notes for this item | - |
CreatedOn | Yes | When the item was created. | - |
CreatedById | Yes | The user that created the item. | Entities |
ModifiedOn | Yes | When the item was last modified. | - |
ModifiedById | Yes | The user that last modified the item. | Entities |
LostAndFound
OData feed entity set: rc.LostAndFound
Column | Required | Description | Relates to |
ItemId | Yes | The reference to the Item being retired. | Items |
EntityId | Yes | The entity this asset was assigned to | Entities |
OwnerEntityId | No | - | - |
ReturnToEntityId | No | - | - |
Quantity | Yes | - | - |
IsPersonalIssue | Yes | - | - |
LastTransferId | No | - | - |
ReturnDate | No | - | - |
ItemStatusId | No | - | - |
DepartmentId | No | - | - |
RetiredByEntityId | No | - | - |
RetiredDate | Yes | The Date this asset was retired | - |
MaterialsViewDaily
OData feed entity set: rc.MaterialsViewDaily
Column | Required | Description | Relates to |
asOfDate | Yes | - | - |
assignedToId | No | - | - |
itemId | No | The item this record is for. | Items |
personalIssue | No | - | - |
itemStatusId | No | - | - |
kitId | No | - | - |
ownerId | No | - | - |
masterId | No | - | - |
statusNoTransfer | No | - | - |
model | No | - | - |
itemType | No | - | - |
itemStatus | No | - | - |
description | No | - | - |
itemNumber | No | - | - |
meterLevel | No | - | - |
assignedTo | No | - | - |
lostFoundId | No | - | - |
statusCodeNumber | No | - | - |
quantity | No | - | - |
owner | No | - | - |
supervisor | No | - | - |
manager | No | - | - |
managerId | No | - | - |
kitNumber | No | - | - |
deleted | No | - | - |
lostAtId | No | - | - |
descriptionId | No | - | - |
assetHash | No | - | - |
manufacturer | No | - | - |
manufacturerId | No | - | - |
barcode | No | - | - |
category | No | - | - |
masterCategoryId | No | - | - |
rfid | No | - | - |
lastTransferLineId | No | - | - |
lastCountAdjustmentId | No | - | - |
masterNumber | No | - | - |
enclosure | No | - | - |
assignmentIsStockpoint | No | - | - |
meterUomId | No | - | - |
serialNumber | No | - | - |
itemTypeId | No | - | - |
upc | No | - | - |
uomId | No | - | - |
entitytype | No | - | - |
classId | No | - | - |
departmentId | No | - | - |
className | No | - | - |
department | No | - | - |
assetId | No | - | - |
lastTransferNumber | No | - | - |
lastTransferDate | No | - | - |
lastTransferDeliveredBy | No | - | - |
lastCountDate | No | - | - |
returnDate | No | - | - |
responsibleParty | No | - | - |
responsiblePartyId | No | - | - |
lastScannedOn | No | - | - |
MeterTransactions
OData feed entity set: rc.MeterTransactions
Column | Required | Description | Relates to |
MeterTransactionId | Yes | The unique ID of this meter transaction. | - |
ItemId | No | The reference to the Item being invoiced. | Items |
MeterLevel | No | A shorthand string used to refer to this manufacturer | - |
CreatedOn | Yes | When the Meter Transaction was created. | - |
Models
OData feed entity set: rc.Models
Column | Required | Description | Relates to |
ModelId | Yes | The unique ID of this model | - |
Type | Yes | 'T' for unique tools, 'Q' for quantity tools, 'K' for kits, 'M' for materials | - |
Number | Yes | A shorthand string used to refer to this number | - |
CategoryId | Yes | The category this model is organized into | Categories |
DefaultClassId | No | The class that all assets derived from this model belong to. Can be overridden at the Items level for unique assets. | Classes |
DescriptionId | Yes | The description of this model | Descriptions |
ManufacturerId | No | The manufacturer of this model | Manufacturers |
UnitOfMeasureId | No | The units this model is counted in (e.g. pallets, boxes) | UnitsOfMeasure |
ReplacementCost | No | Cost to replace one item, taking into account time, delivery fees, effort, etc. | - |
Msrp | No | The Manufacturer's Manufacturer's Suggested Retail Price | - |
ItemBaseValue | No | The base value to use in billing rate sheets | - |
IsDoNotBill | No | If set, new Rate Sheets will be defaulted to not bill for assets derived from this model | - |
IsDeleted | Yes | Indicates if this record has been deleted | - |
ManufacturerModel | No | The manufacturer's name for the model. | - |
ManufacturerYear | No | The manufacturer's year for the model. | - |
ManufactuerPartNumber | No | - | - |
UPCNumber | No | The UPC identifier for the model. | - |
DefaultCertificationId | No | The default certification for the model. | Certifications |
CreatedOn | Yes | When the work order was created. | - |
CreatedById | Yes | The user that created the work order. | Entities |
ModifiedOn | Yes | When the work order was last modified. | - |
ModifiedById | Yes | The user that last modified the work order. | Entities |
RecycleBin
OData feed entity set: rc.RecycleBin
Column | Required | Description | Relates to |
RecordId | Yes | - | - |
DeletedRecordType | Yes | - | - |
DeletedRecordId | Yes | - | - |
DeletedRecordNumber | No | - | - |
OriginalDescription | Yes | - | - |
DeletedOn | Yes | - | - |
DeletedBy | Yes | - | - |
ScanHistory
OData feed entity set: rc.ScanHistory
Column | Required | Description | Relates to |
ItemId | Yes | The item this record is for. | Items |
ItemNumber | No | - | - |
TimeScanned | Yes | - | - |
ScanType | Yes | - | - |
ScannedBy | Yes | - | - |
ScannedLocation | Yes | - | - |
ScanArea | Yes | - | - |
Lat | Yes | - | - |
Long | Yes | - | - |
MacAddress | No | - | - |
StockView
OData feed entity set: rc.StockView
Column | Required | Description | Relates to |
EntityId | Yes | - | - |
ItemId | Yes | The item this record is for. | Items |
IsPersonalIssue | Yes | - | - |
StatusCodeId | No | - | - |
KitId | No | - | - |
OwnerEntityId | Yes | - | - |
StockViewHash | Yes | - | - |
Quantity | Yes | - | - |
IsUnstockOn | No | - | - |
ItemTypeId | Yes | - | - |
LastTransferLineId | No | - | - |
LastCountAdjustmentId | No | - | - |
ToolInformation
OData feed entity set: rc.ToolInformation
Column | Required | Description | Relates to |
ModelRecordId | Yes | - | - |
TrackingMethod | No | - | - |
Manufacturer | No | - | - |
Category | Yes | - | - |
Model | No | - | - |
YourDescription | Yes | - | - |
ManufacturerDescription | No | - | - |
BinLocation | No | - | - |
ItemNumber | No | - | - |
BarCode | No | - | - |
AssignedTo | Yes | - | - |
Owner | Yes | - | - |
Manager | Yes | - | - |
Status | No | - | - |
Quantity | Yes | - | - |
IsPersonalIssue | Yes | - | - |
SerialNumber | No | - | - |
Department | No | - | - |
Class | No | - | - |
LicenseNo | No | - | - |
FuelCard | No | - | - |
ExpirationDate | No | - | - |
StateId | No | - | - |
Meter | No | - | - |
ToolPurchaseCostInfo
OData feed entity set: rc.ToolPurchaseCostInfo
Column | Required | Description | Relates to |
ModelRecordId | Yes | - | - |
TrackingMethod | No | - | - |
Manufacturer | No | - | - |
Category | Yes | - | - |
Model | No | - | - |
YourDescription | Yes | - | - |
ManufacturerDescription | No | - | - |
BinLocation | No | - | - |
ItemNumber | No | - | - |
BarCode | No | - | - |
Cost | No | - | - |
ReplacementCost | No | - | - |
Vendor | No | - | - |
PurchaseCost | No | - | - |
PurchaseDate | No | - | - |
WarrantyExpiration | No | - | - |
PurchaseOrderNumber | No | - | - |
ItemId | Yes | The item this record is for. | Items |
ItemCreatedOn | Yes | - | - |
VehicleInformation
This table extends the Items table with information on Items that are Vehicles.
OData feed entity set: rc.VehicleInformation
Column | Required | Description | Relates to |
ItemId | Yes | The unique ID of the item that this information relates to. | Items |
LicensePlate | No | The license plate number for the vehicle. | - |
Expiration | No | The date that the registration expires on. | - |
FuelCard | No | The fuel card number for the vehicle. | - |