xMatix
Sign in Request demo
xMatix
PRODUCTS
SalesField SalesCRMRewardsClaimsInventoryProcurementWarehouse 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
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 Alternate — entity reference
REFERENCE · Last reviewed

Item Alternate — entity reference

A directed substitution from one item to another, optionally effective-dated, used both automatically and as a suggestion. ItemAlternateService.SetAlternateItem runs on order, invoice, purchase-order and service-order lines: if the line explicitly names the alternate it swaps the line onto the alternate item and records the original in originalItemId, and independently it force-swaps any line whose item has an alternate of type Superseded that is currently within its effective window. The Sense alternate-item signal provider separately suggests alternates for short-stocked lines, ranking by the quantityAvailable held on the alternate row itself.

Fields

FieldLabelTypeRequiredWhat it does
AlternateItemIdAlternate ItemLookup → Item
AlternateItemNameAlternateItemNameLongMultiLineTextA stored display name for the alternate, preferred over the alternate item's own label when a suggestion is worded; it is not kept in step with the alternate item automatically.
AlternateTypeAlternate TypePickListDecides whether the substitution is automatic: only the exact value 'Superseded' makes the save pipeline swap a document line onto the alternate item. The Sense alternate-item nudge additionally singles out the value 'Refurbished', which is not one of the seeded picklist values. Values: Superseded, Optional/Interchangeable.
CreatedByIdCreated ByLookup → UserAccountYes
CreatedDateTimeCreated DateDateAndTimeYes
EffectiveFromDateEffective From DateDateStart of the window in which a superseded alternate is auto-applied to document lines; an empty value means the alternate is effective from the outset.
EffectiveTillDateEffective Till DateDateA second end-of-window column kept for compatibility: automatic substitution falls back to it only when the effective-to date is empty, and the alternate-suggestion nudge ignores it entirely. Prefer the effective-to date.
EffectiveToDateEffectiveToDateDateAndTimeEnd of the alternate's effective window; empty means open-ended. This is the field the alternate-suggestion nudge filters on.
ExternalIdExternalText
IdIdGuidYes
ItemIdItemLookup → Item
ModifiedByIdModified ByLookup → UserAccountYes
NameNameText, unique
OwnerIdOwnerLookup → UserAccountYes
QuantityAvailableAvailableDecimal (calculated)A denormalized availability figure held on the substitution row, used to decide and rank which alternate to suggest for a short-stocked line. No code path writes or refreshes it, so it has to be maintained by import or by hand.
QuantityInHandIn HandDecimal (calculated)
RecordTypeIdRecord TypeGuid, hidden
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
EditEntityEditEditEditEntity
EditInLineEditEditInlineEdit in line
EditInListEditEditInlineEdit in List Header
NewNewNewNew