Document toolboxDocument toolbox

Item Object

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

The Item object contains line item usage details. The Item object is always used inside of another object such as the work order object, inventory object, inventory transfer object, etc. 

Although very similar to the Product object, the Item object is used inside other objects to identify usage e.g. consumed, returned, ordered, transferred, etc. while the Product object contains just the definition.

On this page:

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

(info) Required properties are in bold.

Property
Type
Description
AllowConcessionsboolean

Identifies if the item has discounted price concessions in invoice for a work order.

Valid values are:

  • true = Item has discounted price concessions in the invoice.
  • false = Item has regular price in the invoice for a work order. This is the default value if this property is not specified.

3.34.0

AllowDiscountsboolean

Identifies if the item has discounted price in invoice for a work order.

Valid values are:

  • true = Item has discounted price in the invoice.
  • false = Item has regular price in the invoice for a work order. This is the default value if this property is not specified.

3.34.0

AssetNumstringIdentifies the optional asset number associated with the line item.
BatchNum1string

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

DispositionReasonscollection

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

3.18.1

FlexViewobject

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

GeneralIncomeAccountstring

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 CodeReservedDescription
1001Yes

General Income


3.19.0

IDstring

Optional property.

This property uniquely identifies the item object.

3.19.1

IsAdvShipboolean

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

IsChargeableboolean

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
IsRetboolean

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.
IsUnusedboolean

Identifies if mobile worker has utilized an advance ship part in the installation process. 

Valid values are:

  • true = Advance ship item (Identified by IsAdvShip = true) is marked as unused. Mobile application configuration WorkOrder.advShipUnusedPartsEnabled must be set to true to be able to set an advance ship part to unused.  If this setting is set equal to false, all advance ship parts will behave as advance ship used parts.
  • false = Item is being used. This is the default value if this property is not specified.

   4.16.0

NonDiscountableboolean

Identifies if the item is exempt from applicable discounts.

Valid values are:

  • true - Item is exempt from discounts, concessions, service contracts, and warranties.
  • false - Item is discountable. This is the default value if this property is missing.

3.45.0

NonTaxable


boolean

Indicates whether the item is exempt from tax collection

3.19.0

PricedecimalThis property identifies the price to charged for the item.
PriceOverrideFlagboolean

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.
ProdAttrsobject

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.

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

PropertyTypeDescription
DescstringProvides the description of the product item. This description will be in the preferred language of the technician.
IsBatchboolean

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.
IsInvCtrlboolean

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.
IsSerializedboolean

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.
ProdTypestring

Identifies the product item type or category.

See: Product Types System Category

See: Product Object

ProdNumstringIdentifies the product number associated with the line item.
QtydecimalIdentifies the quantity of the item.
RefCodestringThis 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.
ReturnReasonCodestringThis property is populated when a user returns a item from a customer and specifies the reason why it was returned.
SerialNum2string

Identifies the serial number for the line item.

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

StorageLocationIDstringIdentifies 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.
SupersededPartsDescstring

Provides the description about original and superseded product item. This description will be in the preferred language of the technician.

3.47.0


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.