REST Object Definitions Inventory Related Objects Item Object

Item Object Formats

JSON Format

{
	"AllowConcessions": false,
	"AllowDiscounts": false,
	"AssetNum": "",
	"BatchNum": "",
	"Delete": "",
	"DispositionReasons": [{
		"ReasonCode": "",
		"Desc": "",
		"Qty": 0
	}],
	"FlexView": [{
		"Title": "GroupName",
		"Items": [{
			"Label": "",
			"Value": ""
		}]
	}],
	"GeneralIncomeAccount": "1001",
	"ID": "",
	"IsAdvShip": false,
	"IsChargeable": true,
	"IsRet": false,
	"IsUnused": false,
	"NonDiscountable": false,
	"NonTaxable": false,
	"Price": 0,
	"PriceOverrideFlag": true,
	"ProdAttrs": {
		"Desc": "",
		"IsBatch": false,
		"IsInvCtrl": false,
		"IsSerialized": false,
		"ProdType": ""
	},
	"ProdNum": "",
	"Qty": 0,
	"RefCode": "",
	"ReturnReasonCode": "",
	"SerialNum": "",
	"StorageLocationID": "",
	"SupersededPartsDesc": ""
}

Item Object Properties

Required properties are in bold.

Property

Type

Description

AssetNum string Identifies the optional asset number associated with the line item.

BatchNum¹

string

Identifies the batch number for the item.

If ProdAttrs.IsBatch property is true, then this property is required.

Delete

boolean

Optional property.

This property is used during a PATCH request to remove specific items. This property will never be returned during a GET request.

3.19.1

DispositionReasons

collection

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

3.18.1

FlexView

object

The optional FlexViews object is used to provided additional read-only details and information specific to the object they are included in. The FlexViews are fully customizable by the customer.

See: Flex Views Object

GeneralIncomeAccount

string

Identifies General Income Account for the product. This property will store information which will be used in preparation of the company's financial statements.

Valid values are:

Codes

Activity Code	Reserved	Description
1001	Yes	General Income

3.19.0

ID

string

Optional property.

This property uniquely identifies the item object.

3.19.1

IsAdvShip

boolean

Identifies if the item is a advanced shipped item.

Valid values are:

true = Item is advanced shipped item.
false = Item is not advanced shipped item. This is a default value.

3.18.2

IsChargeable

boolean

When a work order is flagged as in warranty (identified by the work order Rules.InWarranty property), this property can be used to force an item as chargeable.

Valid values are:

true = Item is chargeable
false = Item is not chargeable

IsRet

boolean

Identifies if the item was returned.

Valid values are:

true = Item is a return
false = Item is being used. This is the default value if this property is not specified.

NonTaxable

boolean

Indicates whether the item is exempt from tax collection

3.19.0

Price decimal This property identifies the price to charged for the item.

PriceOverrideFlag

boolean

Identifies if the Price property can be overridden by the user.

Valid values are:

true = Price property can be overridden
false = Price property can not be changed. This is the default value if this property is not set.

ProdAttrs

object

This object contains the item's product attributes from the Product table. If this object is not specified, then the Broker ESB will automatically populate it from the details in the Product table.

If the Product table is not being managed through the Product REST APIs, then this object is required.

Property	Type	Description
Desc	string	Provides the description of the product item. This description will be in the preferred language of the technician.
IsBatch	boolean	Identifies if this product item is batch controlled. If `true`, then the `BatchNum` property is required. Valid values are: `true` - Item is batch controlled. `false` - Item is not batch controlled. This is the default value if this property is missing.
IsInvCtrl	boolean	Identifies if this product is under inventory control. If `true`, then the application will automatically adjust the proper storage location's inventory based on the item usage. Valid values are: `true` - Item is under inventory control. `false` - Item is not under inventory control. This is the default value if this property is missing.
IsSerialized	boolean	Identifies if this product item is serialized or not. If `true`, then the `SerialNum` property is required. Valid values are: `true` - Item is serialized and requires a serial number. `false` - Item is not serialized. This is the default value if this property is missing.
ProdType	string	Identifies the product item type or category. See: Product Types System Category

See: REST Object Definitions Inventory Related Objects Product Object

ProdNum string Identifies the product number associated with the line item.

Qty decimal Identifies the quantity of the item.

RefCode string This optional property is available for customer defined use and is currently not used by the mobile application. Typically it is used to associate a line item with another object in the Customer's back office system.

ReturnReasonCode string This property is populated when a user returns a item from a customer and specifies the reason why it was returned.

SerialNum²

string

Identifies the serial number for the line item.

If the ProdAttrs.IsSerialized property is true, then this property is required.

StorageLocationID string Identifies the inventory storage location where the item was used from. Usually this is the storage location ID of the servicing technician's vehicle although it could also be the storage location ID of the account location if using customer consignment inventory.

1 - If the ProdAttrs.IsBatch is true, then the BatchNum property is required.

2 - If the ProdAttrs.IsSerialized is true, then the SerialNum property is required.