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 Component — entity reference
REFERENCE · Last reviewed

Item Component — entity reference

One entry in the contents of a package item: it names the component item (and optionally its SKU), the quantity per package, quantity limits and whether the component is mandatory, selected by default or optional. When an order, invoice, quote, opportunity, purchase order or requisition line is saved for an item with Package switched on, a line is added under it for each component whose Feature Type is Product Configurator, that is mandatory or selected, and whose SKU, Applicable For and partner filters fit the document; components are added in Sort Order. The added lines record the component in their Item Component field, follow the package line's quantity when the Package Type is Multiple Of Package, are removed with the package line, and are checked against the component's minimum, maximum, editable and mandatory settings when a user changes or deletes them. Delivery orders, service orders, goods receipts, bills, transfers and adjustments never add component lines. Components are listed on the package item's Related tab and numbered from the IPPN series.

Fields

FieldLabelTypeRequiredWhat it does
ApplicableForApplicable ForPickListLimits the component to one kind of document: Sale for orders, invoices and quotes, Purchase for purchase orders and requisitions, Service for opportunities. Empty applies everywhere. The three values are shipped inactive, so the list offers nothing until an administrator activates them.
ComponentItemIdComponent ItemLookup → ItemThe item placed on the line that is added under the package line.
ComponentSKUIdComponent SKULookup → SKUThe SKU placed on the added line. The picker lists only SKUs of the Component Item.
CreatedByIdCreated ByLookup → UserAccountYes
CreatedDateTimeCreated DateDateAndTimeYes
ExternalIdExternalText
FeatureTypeFeature TypePickListOnly the value Product Configurator is acted on: a component with any other value, or none, is never added to document lines and never offered by the configurator. Values: Standard Package, Optional Package, Product Configurator.
IdIdGuidYes
IsBundledIs BundledBooleanCopied to the added line's Price Bundled flag on order, invoice, quote and opportunity lines (not purchase order or requisition lines). Bundled lines are never priced from a price list, and order and invoice lines refuse a unit price above zero.
IsMandatoryIs MandatoryBooleanThe component is always added, needs a quantity above zero on its line, cannot be deleted on its own ("Mandatory package component cannot be removed.") and is locked as selected in the configurator.
IsQuantityEditableIs Quantity EditableBooleanWhen off, any change to the added line's quantity by a user is refused with "Quantity cannot be changed for this component." Quantity changes made by the package line itself still apply.
IsSelectedIs SelectedBooleanAn optional component that is added automatically; the user can remove it in the configurator. Components with neither this nor Is Mandatory are only added through the configurator.
ItemFeatureIdProduct PackagesLookup → ItemFeatureThe option group the component belongs to. The configurator groups components under the group's name; it sets no selection limits. Only on the component's record page, not the New form.
ItemIdItemLookup → ItemThe package item this component belongs to. Only items with Package switched on add component lines.
ItemLotTypeIdItem Lot TypeLookup → ItemLotTypeNot on any shipped form and not read by any process; the added line gets no lot type from it.
MaxQuantityMax QuantityNumberLargest quantity a user may set on the added line ("Quantity cannot exceed … for this component."). 0 means no maximum.
MinQuantityMin QuantityNumberSmallest quantity a user may set on the added line ("Quantity cannot be less than … for this component."). 0 means no minimum. Not checked against Max Quantity.
ModifiedByIdModified ByLookup → UserAccountYes
NameComponent NameTextComponent number from the IPPN series, set when the record is saved.
OwnerIdOwnerLookup → UserAccountYes
PackageTypePackage TypePickListMultiple Of Package multiplies the component Quantity by the package line's quantity and recalculates the added line when the package quantity changes. Independent Of Package, or an empty value, uses the component Quantity as it is and leaves the line alone when the package quantity changes. Values: Multiple Of Package, Independent Of Package.
PartnerAccountGroupIdPartner Account GroupLookup → AccountGroupLimits the component to documents whose Partner Account is a member of this account group. Empty applies to every company.
PartnerAccountIdPartner AccountLookup → AccountLimits the component to documents whose Partner Account (the selling or buying company) is this account. Empty applies to every company.
QuantityQuantityNumberQuantity of the component per package, used for the added line. It defaults to 0, and 0 or less is refused with "Quantity cannot be 0 or negative."
RecordTypeIdRecord TypeGuid, hidden
SKUIdItem SKULookup → SKULimits the component to one SKU of the package item: when the package line has a SKU, only components with this SKU or with none are added. Empty applies to every SKU. This is not the component's own SKU, which is Component SKU.
SortOrderSort OrderNumberOrder in which components are added to a document and listed in the configurator. Defaults to 0.
UIPropsUI PropsText
UpdatedDateTimeModified DateDateAndTimeYes

Actions

ActionLabelTypeWhat it does
BulkDeleteDeleteDeleteDelete the selected records.
CloneCloneServerAction (Clone)Create a copy of this record
DeleteDeleteDeleteDelete
DeleteInListDeleteDeleteDelete in a list page
EditEditEditEdit
EditInLineEditEditInlineEdit in page.
EditListHeaderEditEditInlineEditListHeader
EditListRowEditEditEditListRow
NewNewNewNew

Validations

ValidationApplies toError messageNotes
Quantity Rule ValidationQuantity, ErrorQuantity cannot be 0 or negative.Quantity Rule Validation

Lookup filters

FilterLookup fieldNotes
Component SKUComponentSKUId