Entity Definition

Logical Name : SaleReturnLineItem
Physical Name : TR_LTM_SLS_RTN

A line item component of a RetailTransaction that records the exchange in ownership of a merchandise item (i.e. a sale or return) or the sale or refund related to a service. The Sale or refund related to a service captures an item and action taken that reflects an event of interest to the retail business but DOES NOT RESULT in the exchange in ownership of a merchandise item.

Data Definition

Attribute Description Physical Name Domain Data Type Foreign Key Table
TransactionID (FK)(PK) A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. ID_TRN IdentityUUID char(32)
RetailTransactionLineItemSequenceNumber (FK)(PK) The sequence number of line item within the context of this RetailTransaction. IC_LN_ITM LineNumber smallint
InventoryControlFulfillment (FK) A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. INV_CTL_FLFMT IdentityUUID char(32) FulfillmentAcknowledgementLineItem(TR_LTM_FLF_ACK)
SellingLocationID (FK) A unique system assigned identifier for the SellingLocation. ID_LCN Identity integer SellingLocation(LO_LCN_SL)
BusinessUnitGroupID (FK) A unique system assigned identifier for a group of BusinessUnits. ID_BSNGP Identity integer POSIdentity(ID_PS)
ItemLookupMethodCode A mnemonic code denoting which code was used to enter the Item into the RetailTransaction. e.g. POSIdentity, POSIdentiyAndQualifier, ItemID, POSDepartmentID, CD_MTH_ITM_LKP Code4 char(4)
POSItemID (FK) The barcode, point of sale scan code or other keyed identifying number used at POS and the internal stock keping ItemID for the item. Will generally be filled with the GTIN (UPC, EAN etc) for an item -- but it is not mandatory -- A retailer may develop and maintain its own set of POS identifiers. ID_ITM_PS IdentityGTIN varchar(14) POSIdentity(ID_PS)
POSItemIDQualifier (FK) A secondary qualifier on the POSItemID which denotes a separate item. Eg: When single bottles & six-packs of the same beverage both have the same UPC or other barcode, the POSItemIDQualifier holds denotes the two different items. ID_ITM_PS_QFR Identity integer POSIdentity(ID_PS)
ItemID (FK) A unique system assigned identifier for the retailer's SKU. ID_ITM IdentityUUID char(32) Item(AS_ITM)
POSDepartmentID (FK) A unique system-assigned identifier for the POSDepartment ID_DPT_PS Identity integer POSDepartment(ID_DPT_PS)
UnitOfMeasureCode (FK) The code used to specify the units in which a value is being expressed, or manner in which a measurement has been taken. This code relates to the UCC data element 355. CD_UOM Code varchar(20) UnitOfMeasure(CO_UOM)
SaleReturnItemType Meta-Data denoting the kind of item being sold (or returned) in the line item STOCK_ITEM SERVICE_ITEM RENTAL_ITEM LINKED_ITEM MISC_FEE Stock item refers to a tangible merchandise item. Service item refers to the execution of some process or completion of a task involving the expenditure of time for a customer Rental Item is the temporarly loan of a tangbile item for use by a customer with the expectation that it will be returned at the end of a rental period Linked item is a second item that is always sold along with a merchandise item. For example a car battery typically comes with a core charge item which is a fee for recycling used batteries. Bottle deposits are a similar scenario involving linked items. Misc. fee is an amount charged for an activity or service that does not have a corresponding Item entity type instance. Retailers use misc. fees to capture monies charged for things they typically are not interested in tracking for analytic purposes. It is up to retailers to choose how to use Misc. Fee types versus Service Item types. ARTS provides both. TY_ITM Code4 char(4)
SubItemType Meta-Data denoting the kind of StockItem or ServiceItem being sold (or returned) in the line item e.g. FuelItem, BulkItem, ApparelItem, RentalItem, MiscellaneousFee, etc... TY_ITM_SUB Code4 char(4)
RegularUnitPrice The regular or lookup per-unit price for the item before any discounts have been applied. MO_PRC_REG MoneyShortRetail decimal(7,2)
RegularUnitPriceQuantity The number of sellable units applicable to the regular or lookup-up price of the Item at the time of the Transaction. e.g. 3 for 99c This attribute should default to a value of 1 which means that a unit retail price applies to one sellable unit. UN_UPRQY_REG Quantity DECIMAL(9,3)
ActualUnitPrice The actual per-unit price paid by the customer for this particular sale. It is obtained by applying applicable price derivation rules to the regular unit price. The ActualUnitPrice should reflect the RegularUnitPrice increased by UnitPriceIncreaseAmount and reduced by the Unit ExtendedDiscountAmount. MO_PRC_ACT MoneyShortRetail decimal(7,2)
ActualUnitPriceQuantity The number of units applicable to the actual per-unit price paid by the customer for this particular sale. e.g. 3 for 87c UN_UPRQY_ACT Quantity DECIMAL(9,3)
Quantity The number of retail selling units sold to or returned by a customer. For services the number of units (e.g. hours or job) sold or in the case of refunds, reduced to zero revenue. QU_ITM_LM_RTN_SLS Quantity DECIMAL(9,3)
BulkUnitCount The number of units sold, when selling bulk merchandise. Eg: A sale of 20 Gallons of Gas: Quantity=20, Units=1, UnitOfMeasure=Ga Eg: A sale of 3 cans of Beans: Quantity=3, Units=3, UnitOfMeasure=Ea QU_UN Quantity DECIMAL(9,3)
ExtendedAmount The product of multiplying Quantity by the retail selling unit price derived from price lookup (and any applicable price derivation rules) (i.e.,ActualUnitPrice). This retail sale unit price excludes sales and/or value added tax. MO_EXTND Money decimal(16,5)
UnitDiscountAmount The monetary total per-unit of all Discounts and price reduction RetailPriceModifiers that were applied to this Item. MO_DSC_UN MoneyShortRetail decimal(7,2)
ExtendedDiscountAmount The monetary total of all Discounts and price reduction RetailPriceModifiers that were applied to this Item MO_DSC_UN_EXT MoneyShortRetail decimal(7,2)
ItemIDEntryMethodCode A code that describes how this line item's item identification is being entered (e.g. it is scanned, keyed SKU, keyed department, etc.) LU_MTH_ID_ENR Code4 char(4)
SellUnitRetailPriceEntryMethodCode A code that describes how this line item's retail selling unit price is being entered (e.g. it is manually keyed, obtained from price lookup, etc.) LU_ENR_RT_PRC Code4 char(4)
SellUnitRetailPriceDerivationMethodCode A code that documents how the selling unit retail prices were derived for this line item. LU_PRC_RT_DRVN Code4 char(4)
ActionCode A code denoting how the item is being treated in the line item. Sample values include: SL = Sale RT = Return LU_ACTN_CD Code2 char(2)
ReasonCode (FK) A unique retailer defined reason code for an action that is taken (or not taken) at a Workstation. e.g. Return reason codes - Past Use By Date, Defective Merchandise, etc. POSNoSale reason Codes - Customer Change Query CD_RSN Code varchar(20) Reason(CO_CD_RSN)
FulfillmentAcknowledgementLineItemSequenceNumber (FK) The sequence number of the FulfillmentAcknowledgment LineItem that records the fulfillment of this sale to the Customer. IC_LTM_FLF_ACK LineNumber smallint FulfillmentAcknowledgementLineItem(TR_LTM_FLF_ACK)
UnitCostPrice The unit cost of the Item to the retail enterprise at the time of the Transaction. CP_UN MoneyShortCost decimal(16,5)
UnitCostPriceQuantity The number of units applicable to the cost of the Item to the retail enterprise at the time of the Transaction e.g. 3 for 99c Where this value is > 1, the effective UnitCostPrice per selling unit is the UnitCostPrice / UnitCostPriceQuantity. So a unit cost of $.45 with a designated UnitCostPriceQuantity of 3 has an effecive UnitCostPrice per selling unit of $.15. UN_UPRQY Quantity DECIMAL(9,3)
UnitListPrice The unit MSRP of the Item at the time of the Transaction RP_MSRP MoneyShortRetail decimal(7,2)
UnitListPriceQuantity The number of units applicable to the MSRP of the Item at the time of the Transaction e.g. 3 for 99c UN_MSRP_UPRQY Quantity DECIMAL(9,3)
InventoryValuePrice The value per unit of the Item (at retail) taken from the StockLedger at the time of the Transaction. CP_INV MoneyShortCost decimal(16,5)
InventoryValuePriceQuantity The number of units applicable to the value per unit of the Item taken from the StockLedger at the time of the Transaction. e.g. 3 for 99c UN_INV_UPRQY Quantity DECIMAL(9,3)
GiftReceiptFlag A flag denoting that an abbreviated GiftReceipt was issued for this LineItem. This may mean that return processing will be different if the item is returned. FL_GF_RCT Flag integer
ItemTraceableUnitID (FK) A universally unique identifier used to identify an instance of a distinguisable instance of a retail item. The item traceable unit ID is similar to a serial number in that it allows each selling unit to be explicitly identified and distinguished from other sellling units of the same Item. ID_ITM_UN_TRC IdentityUUID CHAR(32) ItemTraceableUnit(AS_ITM_TRCBL_UN)
UnitPriceIncreaseAmount The monetary total per-unit of all price modifiers that INCREASE the unit retail price of this sale return item. MO_UN_PRC_INCRS MoneyShortRetail decimal(7,2)
ExtendedPriceIncreaseAmount The monetary total of all extended price increase RetailPriceModifiers that were applied to this Item. MO_EXTND_PRC_INCRS Money decimal(16,5)


Parent Entity Verb Phrase Child Entity
ItemTraceableUnit appears on SaleReturnLineItem
FulfillmentAcknowledgementLineItem is dispatched because of SaleReturnLineItem
UnitOfMeasure defines counting units SaleReturnLineItem
SellingLocation conducted SaleReturnLineItem
Reason classifies returns from SaleReturnLineItem
POSDepartment identifies SaleReturnLineItem
POSIdentity identifies SaleReturnLineItem
Item is sold via SaleReturnLineItem
SaleReturnLineItem is a RentalModifier
SaleReturnLineItem is to be delivered via RetailTransactionDeliveryPreferenceItem
SaleReturnLineItem has retail price modified by RetailPriceModifier
SaleReturnLineItem refers to SerializedUnitModifier
SaleReturnLineItem is shipped as CustomerOrderShipmentItem
SaleReturnLineItem used RestrictionValidationModifier
SaleReturnLineItem was performed by LineItemAssociate
SaleReturnLineItem earns Z_CustomerMembershipEarnedRewardJournal
SaleReturnLineItem includes SaleReturnItemModification
SaleReturnLineItem is posted to ItemInventoryJournalEntry
SaleReturnLineItem is charged with SaleReturnTaxLineItem
SaleReturnLineItem validates CouponTenderLineItem
SaleReturnLineItem is intended for GiftRegistryLineItemAssociation
RetailTransactionLineItem can be a SaleReturnLineItem
SaleReturnLineItem can be a ReturnLineItem
SaleReturnLineItem can be a FuelSalesLineItem
SaleReturnLineItem can be a FoodServiceLineItem

Logical Views containing SaleReturnLineItem

Logical View
Logical 01400 - Item Rewards Derivation - Transaction Level
Logical 02000 - Item Inventory and Stock Ledger View
Logical 02020 - Item Inventory - Selling View
Logical 02200 - Transaction Macro View
Logical 02300 - Retail Transaction - Macro View
Logical 02309 - Retail Transaction Delivery
Logical 02310 - Retail Transaction - Item Sale View
Logical 02311 - Retail Transaction Item KIT Sale View
Logical 02312 - Retail Transaction - Item Voids View
Logical 02315 - Retail Transaction - Customer Order
Logical 02316 - Distributed Order Management View
Logical 02320 - Retail Transaction - Taxation View
Logical 02333 - Retail Transaction - Tender - Coupon View
Logical 02340 - Retail Transaction - Shipping View
Logical 02341 - Retail Transaction - Change for Charities View
Logical 02350 - Retail Transaction - Restriction Validation View
Logical 02360 - Retail Transaction - Food Service View
Logical 02370 - Retail Transaction - Rental View
Logical 02380 - Retail Transaction - Total View
Logical 02395 - Retail Transaction - Deposit Redemption View
Logical 02600 - Inventory Control Transaction View
Logical 04000 - Financial Ledger - Macro View
Logical 04100 - Financial Ledger - Retail Transaction View
Logical 05000 - Taxation - Macro View
Logical 05200 - Taxation - Retail Transaction View
Logical 05400 - Taxation - Reporting View - Tax Rule Reference
Logical 07040 - Customer Segment Dependent Behavior
Logical 07200 - Customer Purchase Transaction History View
Logical 10400 - Enterprise - Channels
Logical 11140 - Worker - Retail Transaction View
Logical 20000 - Forecourt Macro View
Logical 20030 - Forecourt Transaction View
Logical 21000 - Fresh Item Management Macro View