xMatix
Sign in Request demo
xMatix
PRODUCTS
SalesField Sales & SFACRMRewardsClaimsInventoryProcurementWarehouse ManagementField ServiceServiceSupportTelephony & MessagingFinance & AccountingPayrollExpense ManagementCommercePortalsAnalytics & ReportingData StudioMobile AppSee all products →
PLATFORM
Platform overviewApp BuilderAutomationIntegrationsSecurity & GovernanceChange ManagementDevelopers
SENSE AI
Sense AI overviewSense AssistSense ControlSense VisionAI StudioTrust & governanceIn Claude & ChatGPTUse cases
SOLUTIONS
Auto DMSConsumer Goods DMSSales Force Automation (SFA) FMCG & DistributionManufacturing & Dealer NetworksAutomotive & DealershipsPharma & HealthcareConsumer DurablesAgri-InputsBuilding MaterialsService NetworksWarehousing & 3PLFinancial AccountingERP SoftwareIndia GST ComplianceUAE VAT & e-InvoicingSaudi ZATCA & VATAll solutions →
RESOURCES
Knowledge CenterDeveloper & CLIBlogGuidesWhat is xMatix?Company facts
COMPANY
AboutCareersPartnersEventsContactAuthorsLegal
Sign in Request demo
Home/Docs/Entity Reference/Item — entity reference
REFERENCE · Last reviewed

Item — entity reference

An item is the master record for anything bought, sold, stocked or serviced - a product, part, charge, unit of work, service contract or discounted item - and every document line names one. Its list is on the Warehouse app's navigation bar and under Settings in the Sales, Inventory, Procurement and Service apps. Name, Code and Item Type are required and Code is unique; there is no automatic numbering. A new item is inactive until Active is switched on, and every document line rejects an inactive item. The item stores no selling price, cost or tax rate: prices, discounts and taxes are dated rules that name it. Its behaviour is driven by flags - Track Inventory, Track Lots, Track Asset, Inspection On Receipt, SKU Required, Package - and by related records on its tabs: SKUs, units of measure, package components, lot types, alternates and per-branch inventory attributes. Step-by-step procedures are on the Items page of the Inventory documentation.

Fields

FieldLabelTypeRequiredWhat it does
ABCCategoryABC CategoryPickListA value-class label on the item itself. Descriptive only: cycle counting and automatic ordering read the ABC category on the item's per-branch inventory attributes instead. Values: A Category, C Category.
AllowServiceAllow ServiceBooleanMarks an item that can be serviced. Hidden on the create form for Work Item, Charge Item and Service Contract types.
BillingFrequencyBilling FrequencyPickListHow often the item is billed, defaulted onto a document line when the line leaves it blank. All three seeded picklist values are inactive, so the field renders with no selectable options out of the box.
BillingTypeBilling TypePickListDefaulted onto document lines that leave it blank, alongside billing frequency, charge type and invoice group; it has no seeded picklist, so the values in use are whatever the tenant types.
ChargeTypeChargeTypePickListNature of the charge, defaulted onto a document line when blank. Its single seeded picklist value is inactive, so nothing is selectable until a tenant adds values.
ClaimToAccountIdClaim To AccountLookup
CreatedByIdCreated ByLookup → UserAccountYes
CreatedDateTimeCreated DateDateAndTimeYes
DescriptionDescriptionTextFree-text description of the item.
ExternalIdExternalExternalId
FailedItemIdFailed ItemLookup
FailedItemTreatmentFailed Item TreatmentPickListValues: Scrap, Send to Supplier.
FSNCategoryFSN CategoryPickListA fast, slow or non-moving label on the item itself. Descriptive only: cycle counting and automatic ordering read the FSN category on the item's per-branch inventory attributes instead. Values: F category, S category, N category.
GTINGTINTextThe item's trade (barcode) number. Barcode scanning matches it first, before the item code.
HsnSacCodeHSN/SAC CodeTextIndia GST goods (HSN) or services (SAC) classification code, up to eight characters. It is stamped onto document lines that have none - and re-stamped when the line's item changes - so it flows into the captured tax transactions and the HSN summaries of the GST returns.
IdIdGuidYes
InventoryValuationMethodInventory ValuationPickListLabelled Inventory Valuation. A descriptive costing label; stock is actually costed with the method chosen in the valuation policies. Values: FIFO, LIFO, Actual Cost, List Cost, Weighted Average.
InvoiceGroupInvoice GroupPickListCopied down onto a document line from the item when the line does not already carry one, so lines can be grouped into separate invoices by the nature of the charge; it is a defaulting value, not a rule the engine evaluates. Values: Insurance, Spare, Vehicle, Subscription.
IsActiveActiveBooleanWhether the item may be used. Off by default, so a new or imported item must be switched on before use. Every document line rejects an inactive item with 'Item is Inactive.', and an item group refuses to add one.
IsCodeEditableCode EditableBooleanStored setting not on the shipped form and not read by any process.
IsDiscontinuedDiscontinuedBooleanMarks an item that is no longer bought. Purchase order, requisition and automatic purchase order lines reject it with 'Discontinued Item Cannot be added', and barcode scanning on order screens refuses it. Sales and stock movements of the item are not blocked.
IsNameEditableName EditableBooleanStored setting not on the shipped form and not read by any process.
IsOrderAllowedOrder AllowedBooleanNot on the shipped form. When explicitly switched off, barcode scanning on order screens refuses the item.
IsPackagePackageBooleanMarks the item as a package whose contents are its item components. When a package line is saved on an order, invoice, quote, opportunity, purchase order or requisition, a child line is added for each mandatory or selected component.
IsRegistrationRequiredRegistration RequiredBooleanMarks an item that needs registration. Shown on the create form for Product and Discounted Item types only.
IsSaleableSaleableBooleanNot on the shipped form. When explicitly switched off, barcode scanning on order screens refuses the item.
IsSKURequiredSKU RequiredBooleanWhen on, every document line for the item must name one of the item's own SKUs; lines without one are rejected with 'SKU is required for this item.'
ItemCodeCodeText, uniqueYesLabelled Code. The item's unique code, required and typed by hand - there is no automatic numbering. Barcode scanning matches it after GTIN. A cloned item gets an empty code to fill in.
ItemFamilyItem FamilyPickListFree-text grouping used as a reporting dimension - the financial statement service groups product profitability by it, labelling items without one as '(no family)'. It is not a lookup and takes no part in pricing or scoping. Values: Family A, Family B, Family C, Family D, Family E.
ItemMaintenanceScheduleIdItem Maintenance ScheduleLookup → ItemMaintenanceSchedule
ItemSegmentItem SegmentPickListA descriptive grouping of the item for views and reports. Values: Segment A, Segment B, Segment C, Segment D, Segment E.
ItemSubTypeItem Sub TypePickListA finer descriptive grouping of the item. Values: Accessories, Bikes, Clothing, Components.
ItemTypeItem TypePickListYesWhat kind of item this is: Product, Part, Charge Item, Work Item, Service Contract or Discounted Item. Required. Work Item and Service Contract hide the stock flags on the form. Saving a Discounted Item switches Track Inventory off. Values: Product, Part, Charge Item, Work Item, Service Contract.
MakeMakePickListValues: Honda, Honda, TVS, TVS, Bajaj, Bajaj, Yamaha, Yamaha, Suzuki, Suzuki, Royal Enfield, Royal Enfield.
ManufacturerOEMManufacturer (OEM)TextThe manufacturer's name. Not on the shipped form.
MarkupRateMarkupRateDecimalLabelled Markup Rate (%) on the record page. The only price-like value stored on the item; selling prices come from dated price list rules.
MaximumLotQuantityMaximum Lot QuantityNumberThe largest quantity one goods receipt or shipment line may carry; larger lines are split when added. 0 means no cap. A SKU's value above zero takes precedence.
ModelModelPickListValues: Activa 110, Activa 125, Activa 125, Shine 125, Shine 125, Dio 125, Dio 125, Jupiter 125, Jupiter 125, Ntorq 125, Ntorq 125, Raider 125, Raider 125, Apache RTR 160 4V, Apache RTR 160 4V, Pulsar NS200, Pulsar NS200, Pulsar N250, Pulsar N250, Chetak 3501, Chetak 3501, FZ-S FI V4, FZ-S FI V4, R15 V4, R15 V4, Access 125, Access 125, Burgman Street EX, Burgman Street EX, Classic 350, Classic 350, Meteor 350, Meteor 350.
ModifiedByIdModified ByLookup → UserAccountYes
NameNameTextYesThe item's name as people read it. Required, not unique. Copied into the description of new order, invoice, opportunity, purchase order and bill lines.
OnlySoldInPackageOnly Sold In PackageBooleanMarks a component that may only be invoiced as part of a package. Checked on invoice lines only, which reject it outside a package with 'Item can only be sold as part of a package.'
OwnerIdOwnerLookup → UserAccountYesThe user who owns the item record; drives record sharing like any other owned record.
PercentageOfTotalPercentage Of TotalPercent
PercentageOfTotalCategoryPercentage Of Total CategoryPickList
PricingMethodPricing MethodPickListCopied onto a subscription created from an invoice line for this item; nothing on the item itself branches on it, so it is descriptive metadata carried forward rather than a pricing switch. Values: Markup On Cost, Bundled Price, Percent Of Total.
ProductMaintenanceScheduleIdProduct Maintenance ScheduleLookup
QuantityUnitOfMeasurePrimary Unit Of MeasurePickListLabelled Primary Unit Of Measure. The base unit stock balances and line quantities are expressed in. Only Each is seeded. Alternate units and their conversion ratios are the item's units of measure. Values: Each.
RecordTypeIdRecord TypeGuid, hidden
RequireInspectionOnDeliveryInspection On DeliveryBooleanLabelled Inspection On Delivery. Stored but not read by any process, so it has no effect today.
RequireInspectionOnReceiptInspection On ReceiptBooleanLabelled Inspection On Receipt. Received quantity waits for inspection instead of becoming available, and the goods receipt cannot complete while any line has uninspected quantity.
RequireServiceOrderOnReceiptRepair Order On ReceiptBooleanLabelled Repair Order On Receipt. Allows Create Service Order on the item's goods receipt inspection lines, which raises one service order of type PDI per inspection line. Nothing raises it automatically, and completing the inspection does not wait for the service order.
RFIDRFTextLabelled RF. An RFID tag value of up to 18 characters.
SequenceNumberSequence NumberNumber
ServiceDurationInMinutesService Duration(Minutes)DecimalStandard labour time for a service item. Quote and service order lines convert it to hours, and service bay allocation uses it. Zero leaves the line duration at zero.
SubscriptionDurationInMonthsSubscription Duration(Months)NumberTerm of a subscription sold on an invoice line: the subscription ends on the invoice date plus this many months, minus one day.
TrackAssetTrack AssetBooleanWhen on, each unit becomes a serialized asset after receipt or sale, and goods receipts and shipments ask for a serial number. Saving it without Track Lots fails with 'Tracking assets requires tracking lots.'
TrackInventoryTrack InventoryBooleanWhen on, the item keeps stock balances and its lines post stock movements. Leave it off for services and charges: their lines post no stock, and an inventory adjustment refuses them. Forced off for a Discounted Item.
TrackLotsTrack LotsBooleanWhen on, the item's stock is held per lot and every stock-moving line must name a lot. It is also required for Track Asset.
UIPropsUI PropsText
UOMDecimalPrecisionPrimary UOM Decimal PrecisionNumberDecimal places a line quantity in the primary unit is rounded to. Defaults to 0, which keeps quantities whole, but never fewer decimals than the item's finest conversion ratio needs.
UpdatedDateTimeModified DateDateAndTimeYes

Actions

ActionLabelTypeWhat it does
BulkDeleteDeleteDeleteDelete the selected records.
CloneCloneServerAction (Clone)Copies the item, including its owned related records, into a new item named after the original with (Copy) appended. Code is left empty because it must be unique; enter a new one and save.
DeleteDeleteDeleteDelete
DeleteInListDeleteDeleteDelete in a list page
EditEditEditEdit
EditInLineEditEditInlineDelete in page.
EditListHeaderEditEditInlineEditListHeader
EditListRowEditEditEditListRow
NewNewNewNew
productConfiguratorProduct ConfiguratorServerActionNot placed on the shipped record page and has no effect from the item. Configure a package from the document that uses it.
ShowStockShow StockServerAction (ShowStock)Not placed on the shipped record page and does not read stock. Read the item's balances on its Inventory tab.