NearPhysical VolumeII

ARTS Data Model Committee
Retail Data Model Near Physical View

Volume II (Table & Column Definitions)
August 25, 2003
Release 4.01
AccessPassword
Definition: CO_ACS_PSWD
Definition: A secret term used by an operator to obtain access to a workstation.
Column Domain DataType PK? FK? NULL? Definition
ID_STR_RT Identity int Y Y N A unique retailer assigned identifier for a RetailStore
ID_OPR Identity int Y Y N A unique, automatically assigned number used to identify a workstation OPERATOR.
PS_ACS_OPR Password varchar(20) N N Y The password which permits the OPERATOR to specific RESOURCES and workstations within the
RETAIL STORE.
Retail Data Model Near Physical View - Release 4.01 Page 2
Association for Retail Technology Standards August 25, 2003
AccountReceivablePayableLineItem
Definition: TR_LTM_ACNT_RPL
Definition: A line item component of a RETAIL TRANSACTION that records the dollar amount to be debited or credited to a customer account. This line reflects a transaction
specific to the creation of a current asset or liability to be settled at some future point in time through an exchange of tender.
ID_WS Identity int Y Y N The unique identifier for the WORKSTATION, typically the serial number.
AI_TRN Identity int Y Y N A unique, non-significant, automatically assigned sequential number used to identify a TRANSACTION
within the context of a WORKSTATION and a BUSINESS PERIOD.
AI_LN_ITM LineNumber smallint Y Y N The sequence number of line item within the context of this RetailTransaction.
DC_DY_BSN DateCalendar datetime Y Y N The calendar date of the BusinessDay.
FL_ACNT_PYB Flag bit N N Y Flag that determines whether this line item is a payable or a receivable.
MO_ACNT_RCV_PYB Money decimal(14,3) N N N The monetary amount of the account payable/receivable line item.
LU_ACNT_RCV_PYB Code4 char(4) N N Y Identifies how the account payable/receivable should be recorded in the financial journal.
ID_ACNT_CT_RCV_PYB Identity int N N Y Identifies a customer account that is being debited or credited by the account payable/receivable line
item.
Address
Definition: LO_ADS
Definition: A mail location for a party (i.e. a customer, supplier, etc.)
ID_ADS Identity int Y N N A unique identifier for a location and mail address.
TY_ADS Code2 char(2) N Y Y Defines a standard type of address usage.
AddressType
Definition: CO_TYP_ADS
Definition: Describes a valid address usage for an ADDRESS entity type. Valid uses include billing, shipping, legal, etc.
TY_ADS Code2 char(2) Y N N Defines a standard type of address usage.
DE_ADS_TYP DescriptionShort varchar(255) N N Y Description of address type.
NM_ADS_TYP Name varchar(40) N N Y Business name for an address type.
AdvancedShipNoticeDocument
Definition: DO_NTC_ADVN_SHP
Definition: An electronic document sent to a store by a supplier that defines the shipment date, expected delivery date, carrier, shipped items, and ORDER DOCUMENT
reference. It is sent out in advance of the shipment to enable the retailer to plan workload and receipt processing.
ID_ICD Identity int Y Y N The reference number that uniquely identifies the INVENTORY CONTROL DOCUMENT.
AgeRestrictionRule
Definition: RU_RST_AG
Definition: Defines a rule that restricts the sale of an item to customers that must be a minimum age and by the employee that must be a minimum age.
CD_RST_SLS Code6 char(6) Y Y N A unique, automatically assigned code for a specific limitation on an ITEMs sale.
TY_RST_SLS Code4 char(4) Y Y N A unique code for a group of SALES RESTRICTIONS.
DE_AG_RST DescriptionShort varchar(255) N N Y A description of the type of age restriction that applies to this ITEM
QU_AG_CT_MNM QuantityYearCount decimal(3,0) N N N The minimum age under which the customer is prohibited from purchasing the ITEM.
QU_AG_EM_MNM QuantityYearCount decimal(3,0) N N N The minimum age under which the employee is prohibited from selling the ITEM.
AggregateItem
Definition: AS_ITM_AGGT
Definition: A sub-type of Item that is an aggregation of one or more constituent Items. The constituent items may be sold individually.
ID_ITM Identity int Y Y N The retailers SKU or unique item identifier for items sold or returned.
TY_ITM_AGGT Code2 char(2) N N Y How are the items combined? Choices are Blend & Kit. If items are combined in a Blend, then the
PerAssemblyCount attribute of ItemCollection denotes the percentage of the blend.
AlternativeItem
Definition: AS_ITM_ALT
Definition: A cross reference of items that may be substituted or offered in place of another item.
ID_ITM_ORGL Identity int Y Y N The retailers SKU or unique item identifier for the original Item being substituted.
ID_ITM_SBST Identity int Y Y N The retailers SKU or unique item identifier for the subtitute Item.
DE_RSN_SBST DescriptionShort varchar(255) N N Y A narrative describing the circumstances under which one item can be substituted for another. For
instance, one item may be offered as an alternative in a gift registry scenario, but not in a clearance or
promotional scenario.
ApparelItem
Definition: AS_ITM_APR
Definition: A dress, skirt, blouse, pair of trousers or any other item of clothing that can be related to other APPAREL ITEMS by way of SIZE, COLOR or STYLE.
DE_SLH DescriptionShort varchar(255) N N Y Describes the cut or fit of the APPARELL ITEM. For example, shirts may be sold as slim or standard
fit.
DE_FBRC DescriptionShort varchar(255) N N Y Describes the material used to make the APPAREL ITEM
AssociatedCalendarPeriod
Definition: ST_ASCTN_CLD_PRD
Definition: (null)
ID_CLD Identity int Y Y N A unique system assigned identifier for the Calendar.
ID_CLD_LV_PRNT Identity int Y Y N A unique system assigned identifier for the CalendarLevel.
ID_CLD_LV_CHLD Identity int Y Y N A unique system assigned identifier for the CalendarLevel.
ID_CLD_PRD_PRNT Identity int Y Y N A unique system assigned identifier for the ParentCalendarPeriod
ID_CLD_PRD_CHLD Identity int Y Y N A unique system assigned identifier for the ChildCalendarPeriod
AssociatedMerchandiseHierarchyGroup
Definition: ST_ASCTN_MRHRC
Definition: An association between two MerchandiseHierarchies that establishes one as the higher and one as the lower level for summarizing item sales information.
ID_MRHRC_FNC Identity int Y Y N A unique system assigned identifier for the MerchandiseHierarchyFunction
ID_MRHRC_GP_PRNTIdentity int Y Y N Unique identifier for the Parent merchandise structure group in the association.
ID_MRHRC_GP_CHLDIdentity int Y Y N Unique identifier for the child merchandise structure group in the association.
ID_MRHRC_LV Code4 char(4) Y Y N A unique system assigned identifier for the Level within the merchandise hierarchy tree.
AssociatedRetailStoreGroup
Definition: ST_ASCTN_STRGP
Definition: An associative entity resolving the recursive-many-to-many relationship on RetailStoreGroup. It denotes a parent & child relationship between two RetailStoreGroups
for a particular RetailStoreGroupFunction. Each child RetailStoreGroup will have a different parent RetailStoreGroup for each RetailStoreGroupFunction that is defined.
ID_STRGP_PRNT Identity int Y Y N A unique system-assigned identifier for the RetailStoreGroup
ID_STRGP_CHLD Identity int Y Y N A unique system-assigned identifier for the RetailStoreGroup
ID_STRGP_FNC Identity int Y Y N A unique system-assigned identifier for the RetailStoreGroupFunction
ID_STRGP_LV Identity int Y Y N A unique system assigned identifier, for a level within the RetailStoreGroup hierarchy
Blender
Definition: CO_BLD
Definition: A connection between a LOGICAL NOZZLE and one or more LOCATIONs each containing a single BULK ITEM which are blended by the LOGICAL NOZZLE
when performing a FUELLING TRANSACTION
ID_PNT_FUEL Identity int Y Y N A unique identifier for the FuelingPoint that this Nozzle is a part of
ID_NZL Identity int Y Y N A unique identifier for the Nozzle
ID_LCN Identity int Y Y N A unique system assigned identifier for a specific InventoryLocation within the retail enterprise.
ID_MTR_STK Identity int N Y Y A unique identifier for the stock meter
PE_BLD Percent decimal(5,2) N N Y The percentage of the final blend that the given BULK ITEM constitutes.
Brand
Definition: ID_BRN
Definition: The selling and promotional name used to identify a product for advertising and name recognition purposes.
NM_BRN Name varchar(40) Y N N A unique name to denote a class of ITEMs as a product of a single supplier or manufacturer. The
brand can include private label ITEMs.
DE_BRN DescriptionShort varchar(255) N N Y The description of a class of ITEMs produced by a product of a single supplier or manufacturer.
BrandPriceDerivationRuleEligbility
Definition: CO_EL_BRN_PRDV
Definition: Defines an association between a BRAND and PRICE DERIVATION RULE and the conditions that govern the application of the associated rule to an item belonging
to the specified BRAND at the time an instance of the item is recorded as a line item in a sale.
ID_EL_PRDV Identity int Y Y N A unique identifier for a Price Derivation Rule Eligibility.
NM_BRN Name varchar(40) N Y N A unique name to denote a class of ITEMs as a product of a single supplier or manufacturer. The
BulkItem
Definition: AS_ITM_BLK
Definition: A sub-type of STOCK ITEM that is purchased in bulk and is measured and sold by weight, volume or linear measure.
PE_WST_BLK_SLS Percent decimal(5,2) N N Y The pre-defined waste factor percentage, e.g. boning allowance.
TY_WST_BLK_SLS Code2 char(2) N N Y The code to denote the type of waste associated with the BULK ITEM when breaking down to retail
selling units.
BusinessDay
Definition: CA_DY_BSN
Definition: A calendar date that corresponds to an accounting period fiscal day at a particular RetailStore, has financial transactions attributed to it and is aggregated using the
CalendarPeriod structure. May be closed programmatically (eg: every day at 10:00pm precisely) or manually at each RetailStore using PeriodCloseTransaction
DC_DY_BSN DateCalendar datetime Y N N The calendar date of the BusinessDay.
ID_WS Identity int N Y Y The unique identifier for the WORKSTATION, typically the serial number.
AI_TRN Identity int N Y Y A unique, non-significant, automatically assigned sequential number used to identify a TRANSACTION
TS_BGN TimeStampAudit datetime N N N The date & time the BusinessDay begain at the nominated RetailStore - This is normally defined by the
closure of the previous BusinessDay
TS_END TimeStampAudit datetime N N N The date & time the BusinessDay ended at the nominated RetailStore
CalculateTaxRateRule
Definition: RU_TX_RT_CLC
Definition: A kind of TaxRateRule that denotes a percentage of the taxable total that is to be applied to a RetailTransaction.
ID_ATHY_TX Identity int Y Y N A specific TAX AUTHORITY that establishes the tax rate. The TAX AUTHORITY is normally a
government body.
ID_GP_TX Identity int Y Y N A unique retailer assigned identifier for the TaxGroup
AI_TX_RT_RU MoneyShortRetail decimal(8,3) Y Y N A squential number for theTaxRateRule, denoting the order of creation of the rules.
PE_TX_RT Percent decimal(5,2) N N Y The percentage tax-rate that is to be applied
Calendar
Definition: CA_CLD
Definition: A business function for which a specific Calendar is maintained within the retail enterprise. Eg: Merchandising, SalesTax, Payroll, Promotions, Sales Reporting, etc...
ID_CLD Identity int Y N N A unique system assigned identifier for the Calendar.
NM_CLD Name varchar(40) N N Y The name of the Calendar
CalendarLevel
Definition: CA_CLD_LV
Definition: A level of roll-up within a particular Calendar. Eg: MerchandisingCalendar may have Weeks, SubSeason, Seasons and Years, while Payroll Calendar may have
Months and Years, SalesTax Calendar may have Quarters and Years.
ID_CLD_LV Identity int Y N N A unique system assigned identifier for the CalendarLevel.
ID_CLD_LV_CHLD Identity int N Y Y A unique system assigned identifier for the CalendarLevel which is rolled-up into this CalendarLevel.
This allows: Years rollup from Months Quarters rollup from 3 months Months rollup from 30/31 days
Weeks rollup from 7 days Days are the base period
NM_CLD_LV Name varchar(40) N N Y The name for this level with in the Calendar
QU_PRD_CHLD QuantityShortCount decimal(3,0) N N N The number of instances of the ChildPeriod that go to make up this CalendarPeriod Possible values
include: NULL - period starts same time each Day/Week/Month rather than as a multiple of child
periods 3 Shifts = Day 7 Days = Week 30/31 Days = Month 12 Months = Year
CD_PRD_SRT Code4 char(4) N N Y A code denoting which day of week/month/year the period starts on. Suggested values include: NULL -
Period is pure multiple of child Mon, Tue, Wed, Thu, Fri, Sat, Sun - Period starts on given week day
FMon, FTue, FWed, FThu, FFri, FSat, FSun - Period starts on First given week day of month LMon,
LTue, LWed, LThu, LFri, LSat, LSun - Period starts on Last given week day of month 125 - Julian day
number 125 = 5-May
DT_PRD_SRT Time datetime N N Y The time of day that the period starts
CalendarPeriod
Definition: CA_CLD_PRD
Definition: A period of time in a particular Calendar, defined by a start & end date & time stamp.
ID_CLD_LV Identity int Y Y N A unique system assigned identifier for the CalendarLevel.
ID_CLD_PRD Identity int Y N N A unique system assigned identifier for this CalendarPeriod
TS_SRT TimeStampEffective datetime N N Y The date and time the CalendarPeriod begins
TS_END TimeStampEffective datetime N N Y The date and time the CalendarPeriod ends.
CalendarPeriodPriceDerivationRuleEligibility
Definition: CO_EL_CLD_PRDV
Definition: A kind of PriceDerivationRuleEligibility that allows PriceDerivationRules and Promotions to be targetted to particular CalendarPeriods (Eg: Season, SubSeason,
Easter, Christmas, Thanksgiving etc..)
ID_CLD Identity int N Y N A unique system assigned identifier for the Calendar.
ID_CLD_LV Identity int N Y N A unique system assigned identifier for the CalendarLevel.
ID_CLD_PRD Identity int N Y N A unique system assigned identifier for this CalendarPeriod
Carrier
Definition: PA_CRR
Definition: An external party that transports merchandise and/or supply items from their source to the retail store and from the retail store back to their source.
ID_CRR Identity int Y N N The carrier presenting the bill of lading.
ID_PRTY Identity int N Y N A unique, automatically assigned identity for a PARTY.
TY_RO_PRTY Code6 char(6) N Y N A code that identifies a group of PARTY ROLES. This is used for subtyping the PARTY ROLEs.
NM_CRR Name varchar(40) N N Y The legal name of the transportation company referenced by the CARRIER-ID.
DU_CRR IdentityDunsIdentifier char(9) N N Y The identifier assigned by Dun & Bradstreet for the purposes of corporate identification in the retail
community and credit worthiness.
CensusGeographicCoding
Definition: LO_LCN_CENS_GEO
Definition: Standardized national, state, and local codes created by a governmental census agency for the identification of geographic areas.
Charity
Definition: PA_CHRTY
Definition: An organization that has been designated as a charitable organization for tax purposes.
ID_PRTY_ORGN Identity int Y Y N A unique, automatically assigned identity for a PARTY.
ID_RGST_CHRTY TaxIdentityNumber varchar(20) N N Y An ID assigned by a tax authority for charitable organizations.
CheckTenderLineItem
Definition: TR_LTM_CHK_TND
Definition: A type of TENDER LINE ITEM that records the specifics about a check received from a customer in settling a transaction.
ID_BK_CHK Identity int N N Y The unique identifier of the bank or third party authorization center.
ID_ACNT_CHK Identity int N N Y The check account number of CUSTOMERs whose checks have been previously honored or rejected.
Retaining a check history by CUSTOMER provides the RETAIL STORE with a means of tender
authorization.
LU_MTH_ACNT_ENR Code varchar(20) N N Y A code denoting how the CheckAccountNumber was entered into the system.
AI_CHK LineNumber smallint N N Y A unique sequence number relating to a particular check authorization.
LU_MTH_SQN_ENR Code varchar(20) N N Y A code denoting how the CheckSequenceNumber was entered into the system.
TY_ID_PRSL_RQ Code2 char(2) N N Y Identifies the type of personal identification required to authorize tender. Examples include drivers
license, a second credit card, social security card, etc.
ID_PRSL_AZN Identity int N N Y The personal identification number that must be keyed by an individual at the point of sale when paying
by personal check.
ID_ADJN_CHK Code4 char(4) N N Y A code to denote that approval has been received from the authorization center.
DC_BRT_CHK DateCalendarDay char(2) N N Y The customers date of birth captured as part of the personal data required to verify their identity and
authorize their use of a check to pay for a purchase.
Color
Definition: CO_CLR
Definition: This entity type serves as a standard store reference for APPAREL ITEM color. Certain apparel retailers will record data at this level, specifically for replenishment.
ED_CLR Code4 char(4) Y N N A code to identify the color. The assumption is that the retailer will adopt the standards as designated
by the NRF, created to facilitate the exchange of data between vendors and retailers
NM_CLR Name varchar(40) N N Y The individual names of the associated colors that are encompassed by the respective color code. For
example, color code 201 may include both chocolate and kola nut.
DE_CLR DescriptionShort varchar(255) N N Y A full description of the individual color, designated by the respective code and name.
CombinationPriceDerivationRuleEligibility
Definition: CO_EL_CMBN_PRDV
Definition: A kind of Price Derivation Rule Eligibility which combines two or more other Price Derivation Rule Eligibilities in some boolean fashion.
CD_CMBN Code2 char(2) N N Y A retailer assigned code denoting the style of combination that is to be applied across the child
eligibilities that ve been defined in MultiplePriceDerivationRuleEligibilities Examples include: OR, AND,
XOR
CommercialEnterprise
Definition: PA_CMY_CMCL
Definition: An organization that is not exempt from sales taxes
CommissionedEmployee
Definition: PA_CMN_EM
Definition: An employee who receives a percentage or fee that is based on some type of sales metric.
ID_EM Identity int Y Y N A unique, non-significant number used to identify a store employee.
CommissionModifier
Definition: CO_MDFR_CMN
Definition: A modifier that captures earned commissions by an employee involved in serving the customer purchasing the merchandise or service item identified in the
SALE/RETURN LINE ITEM.
AI_MDFR_CMN LineNumber smallint Y N N A sequential counter used to uniquely identify an instance of a COMMISSION MODIFIER.
ID_EM Identity int N Y Y A unique, non-significant number used to identify a store employee.
MO_MDFR_CMN Money decimal(14,3) N N N Defines the flat amount of commission earned on the sale of this item
PE_MDFR_CMN Percent decimal(5,2) N N N Defines the percentage applied to the sold-at retail amount to arrive at the commission for an item or
service sold in the SALE/RETURN LINE ITEM.
FL_PE_CMN_AMT Code varchar(20) N N Y A code denoting the commission calculation method to be used.
LU_ACTN_ASCTN Code varchar(20) N N Y A code denoting what action the Associate did on this sale to earn the commission. This action code
may affect the commission calculation.
TS_TM_DT Datetime datetime N N Y The date and time that the associate performed the action for which a commission is payable.
Competitor
Definition: PA_CMP
Definition: A retailer with a product range and customer base similar to those for the store.
ID_CMP Identity int Y N N The unique identifier assigned to a competitor by the store.
NM_CMP Name varchar(40) N N Y The name of retailer competing in the same sector within the same locality
DC_OPN_CMP DateCalendar datetime N N Y The date the competitor opened.
DE_CL_CMP DateCalendar datetime N N Y The date the date the competitor closed
SC_CMP Code2Status char(2) N N Y The current status of the competitor.
CompetitorRetailItem
Definition: TR_ITM_CMP_RTL
Definition: A RETAIL ITEM which is stocked by a COMPETITOR and is perceived by the customer to have no discernible difference in terms of form, fit or function -- but may
be sold at a different retail price.
ID_CMP Identity int Y Y N The unique identifier assigned to a competitor by the store.
ID_STRGP Identity int Y Y N A unique system-assigned identifier for the RetailStoreGroup
RP_UN_SLS_CMP MoneyShortRetail decimal(8,3) N N N The retail sale unit price that a competitor has assigned to the item.
FL_PRM_ON_CMP Flag bit N N Y Flag that indicates that the item offered by a competitor is being promoted (i.e. offered at a lower
price).
DC_PRC_RT_CMP DateCalendar datetime N N Y The effective date of the competitor retail sale unit price.
DC_PRC_RT_EP DateCalendar datetime N N Y The expiration date of the competitor retail sale unit price.
FL_CPN_STR_RT_PRMFlag bit N N Y A flag to indicate whether or not the competitor is promoting the item using in-store coupons.
FL_ADV_CMP_LCL Flag bit N N Y A flag that indicates whether or not the competitor is advertising the item in local media.
Contact
Definition: PA_CNCT
Definition: An individual person who has been designated by a PARTY organization for a specific PARTY ROLE and may be contacted by the store during the normal course of
business.
TY_CNCT Code2 char(2) Y Y N A code used to categorize different kinds of contact.
TY_RO_PRTY Identity int Y Y N A unique, automatically assigned identity for a PARTY.
NM_AFLN_PRS_ORGNString varchar(20) Y Y N A name or label for a group of affiliations of people and organizations. For instance, this might be
employment .
DC_AFLN_PRS_ORGNDateCalendar datetime Y Y N The start date of a PERSONs affiliation with an organization.
ID_PRTY_PRS Identity int Y Y N A unique, automatically assigned identity for a PARTY.
LU_FNC_CNCT Code2 char(2) N N Y A code to identify the major duty or responsibility of the contact. These codes relate to the UCC data
element 366.
ContactType
Definition: CO_TYP_CNCT
Definition: Defines valid types of contacts for a store. Contact types refer to the role played by a contact when interacting with a store.
TY_CNCT Code2 char(2) Y N N A code used to categorize different kinds of contact.
NM_CNCT Name varchar(40) N N Y The business name for this type of contact.
DE_CNCT DescriptionShort varchar(255) N N Y The business description for this type of contact
LU_CNCT_RO Code2 char(2) N N Y The role played by this type of contact (e.g., pays invoices, approves RTVs , etc.)
ContainerType
Definition: ID_TYP_CNR
Definition: A valid UCC type of container which may be used to transport shipping units between a supplier and a store, a store and a store, etc.
LU_FRM_PCKG Code4External char(4) Y N N The UCC code to denote the type of packaging from the UCC 103 packaging code data element list..
LU_MTR_PCKG Code4External char(4) Y N N A UCC defined code that describes the material used to fabricate the CONTAINER TYPE. This code
uses the UCC 103 packaging code date element value list for packaging materials.
DE_CNTR Name varchar(40) N N Y A description of the container type.
Contractor
Definition: PA_CNTR
Definition: A person who is not an employee but provides services to the retail enterprise.
ID_CNTR Identity int Y N N An alternate ID assigned to a CONTRACTOR.
TY_WRKR Code2 char(2) N Y N A unique retailer assigned code denoting the kind of Worker.
ControlTransaction
Definition: TR_CTL
Definition: A type of TRANSACTION that records non-financial activity that tracks changes in the status of a point of sale terminal, terminal access by retail store employees and
their supervisors and other activities and events related to the administration and management of the point of sale system.
TY_TRN_CTL Code4 char(4) N N Y A code that describes the type of control transaction, i.e. period close, etc.
CoordinateType
Definition: LO_CRDN_TYP
Definition: A system of identifying physical locations.
TY_CRDN Code2 char(2) Y N N A categorization of co-ordinate systems.
DE_CRDN_TYP DescriptionNarrative text N N Y A description of a category of co-ordinate systems.
CouponHandlingRule
Definition: RU_HN_CPN
Definition: A rule that states how a particular coupon should be processed. For example, store coupons are normally taken as a markdown against the purchased ITEM, whereas
manufacturer coupons are redeemed in full.
TY_CPN Code2 char(2) Y N N A code to denote the type of coupon, e.g. raincheck, manufacturer coupon, electronic coupon.
DE_CPN DescriptionShort varchar(255) N N Y A description of the coupon, e.g. money off a particular ITEM.
DP_CPN_VL Code4 char(4) N N Y The disposition code for the coupon, e.g. store coupons are charged as an expense or markdown.
CouponTenderLineItem
Definition: TR_LTM_CPN_TND
Definition: Records the use of a coupon (which must be valiated against an item in the TRANSACTION) to tender part (or all) of a TRANSACTION.
ID_MF Identity int N Y Y A unique identifier to denote the ITEM MANUFACTURER.
FC_FMY_MF ProductCodeFamily char(3) N Y Y The UPC designated three digit coupon family code for the manufacturer item.
AI_LN_ITM_VL LineNumber smallint N Y Y The sequence number of line item within the context of this RetailTransaction.
UC_CPN_SC PostalCode varchar(15) N N Y The barcode on a store or manufacturer coupon. The coupon scan code comprises two parts: the first
is a fixed 12 character code that contains the manufacturer identification, family code, and coupon
value, the second is based on Code 128 and comprises up to 20 characters. This supplementary code
comprises the manufacturers number system character, the offer code, and end of offer code. The
supplementary was introduced as a guideline in 1997.
DC_CPN_EP ProductCodeExpiry varchar(20) N N Y The date a coupon may no longer be used as part of the settlement of a sale transaction. It is normally
found in the UCC/EAN-128 coupon extended code. In this code, the expiration code is only four digits
and contains only month and year. The day is always the last day of the month.
LU_CPN_PRM Code6 char(6) N N Y Identifies a promotion associated with the coupon. Promotion codes are used by manufacturers and
suppliers to analyze the impact their promotion is having on sales across a geographic area and over a
specified promotional period of time.
FL_ENR_CPN_KY Flag bit N N Y A flag to denote whether the coupon is key entered or scanned, i.e. 0=no (scanned), 1=yes (key
entered)
CreditDebitCardTenderLineItem
Definition: TR_LTM_CRDB_CRD_TN
Definition: A type of TENDER LINE ITEM that records the specifics about a credit or debit card used to settle a transaction.
TY_CRD Code6 char(6) N N Y A code denoting which kind of card is being accepted.
ID_ISSR_TND_MD Identity int N N Y The identifying number of the bank, credit union, financial services firm or other third party issuing the
debit/credit card used in the transaction.
ID_ACNT_DB_CR_CRDName varchar(40) N N Y The account number appearing on a debit/credit card and identifying the card issuers customer
account to be charged or credited for the transaction.
LU_NMB_CRD_SWP_KY Code2 char(2) N N Y A code that indicates whether the credit or debit card account number was read using a magnetic
stripe reader (i.e. swiped) or keyed.
LU_SCR_ENR Code2 char(2) N N Y A code denoting who entered the card: Merchant or Customer.
TY_ID_PRSL_RQ Code2 char(2) N N Y Identifies the type of personal identification required to authorize tender. Examples include drivers
license, a second credit card, social security card, etc.
ID_RFC_PRSL_ID Identity int N N Y The identifying number of the driver license or other personal id provided by the customer to verify
his/her identity at the point of sale.
LU_MTH_AZN Code4 char(4) N N Y Identifies the method used to authorize tender. Examples include by electronic query, by sales
employee visual inspection of customer card and id.
DE_TRCK_1_BT_MP BitMap binary(128) N N Y Defines the bit pattern used on track 1 of the magnetic strip on the back of a credit card.
DE_TRCK_2_BT_MP BitMap binary(128) N N Y Defines the bit pattern used on track 2 of the magnetic strip on the back of a credit card.
DE_TRCK_3_BT BitMap binary(128) N N Y Defines the bit pattern used on track 3 of the magnetic strip on the back of a credit card.
LU_ADJN_CRDB Code6 char(6) N N Y A code indicating the result of a request to authorize the use of tender to settle a transaction.
CH_IM_TND_AZN_CT Code2Status char(2) N N Y Digitized image of the customers signature.
DC_EP_CRD Code4 char(4) N N Y The expiration date of the Credit or Debit card, as taken from the card in MMYY format.
NM_CRD_HLD Name varchar(40) N N Y The name of the cardholder, as taken from the card.
AI_CRD_ISS Identity int N N Y The IssueSequnce number of the credit card being used.
Currency
Definition: CO_CNY
Definition: Specifies the national designation and quantitative value of monetary media used as tender in the processing of this TENDER LINE ITEM.
ID_CNY Identity int Y N N The unique identifier of the CURRENCY.
DE_CNY DescriptionShort varchar(255) N N Y A description of the currency, i.e. pounds sterling, US dollars, Canadian dollars, etc.
SY_CNY Name varchar(40) N N Y National symbol for the main unit of currency, e.g. , $, etc
LU_CNY_ISSG_CY Code4 char(4) N N Y Identification of the country issuing the currency. This code relates to the UCC data element 100,
Currency Code,
Customer
Definition: PA_CT
Definition: A person or individual who purchases, may purchase, or did purchase goods and or services from a retail store.
ID_CT Identity int Y N N A unique identifier for a customer.
TY_CT_LFC Name varchar(40) N N Y A categorization of CUSTOMERs based on the type of relationship that customer has with the retail
enterprise.
MO_CT_INCM_ANN Money decimal(14,3) N N Y A customers annual salary or income.
SC_MRTL Code2Status char(2) N N Y A code that describes a CUSTOMERs current marital status. For instance, married, single, etc.
NM_RLG_AFLN Name varchar(40) N N Y A name or label that describes a CUSTOMERs religious preference.
NM_HGH_EDC_LV Name varchar(40) N N Y A name or label that describes a CUSTOMERs highest level of education. For instance, primary
school, post-secondary, graduate, etc.
CustomerAccount
Definition: LE_CTAC
Definition: A charge account or other accounting relationship a customer has with the store or enterprise. An account exists to allow the store to record a series of transactions with
the same customer and keep an ongoing record of monies owed by the customer and monies due to the customer.
ID_CTAC Identity int Y N N A unique identifier for a customer account. Generally assigned by the home office.
ID_CT Identity int N Y N A unique identifier for a customer.
ID_ACNT_LDG Identity int N Y Y The reference for the STORE FINANCIAL LEDGER ACCOUNT
TY_CTAC Code2 char(2) N N Y Determines what kind of customer account this is. Examples include a trade account, a school
account, a not-for-profit, regular customer, etc.
FL_IDN__CT_RQ Flag bit N N Y Flag that if set to true requires the customer to provide proof of his/her identity to verify that he/she may
use the CUSTOMER ACCOUNT.
TY_IDN_CT Code2 char(2) N N Y Determines the type of customer identification proof required. Examples include drivers license, store
charge card, trade association identification card, etc.
QU_PNT_FQ_SHPR_CMQuantity decimal(9,2) N N N A counter that accumulates frequent shopper points earned by a customer over a period of time and
which may entitle a customer to a free gift or additional price reductions on selected items.
TY_PNT_FQ_SHPR Code2 char(2) N N Y A retailer assigned code that defines which kind of frequent shopper points are being accumulated by
the customer.
CustomerAccountCard
Definition: LE_ACNT_CT_CRD
Definition: An card or other device used in association with an account.
AI_ACNT_CT_CRD Number int Y N N A unique retailer assigned identifier for a CustomerAccountCard.
ID_CTAC Identity int N Y N A unique identifier for a customer account. Generally assigned by the home office.
DC_EP DateCalendar datetime N N Y A date that a specific CUSTOMER ACCOUNT CARD is no longer valid.
CustomerAccountPriceDerivationRuleEligibility
Definition: CO_EL_CTAC_PRDV
Definition: This entity associates a customer account to a price derivation rule.This entity exists to provide a linkage to special accounts for tradesmen who may purchase supplies
at a discount not offered to regular customers. It may also establish associations between price derivation rules and other kinds of accounts as determined by a retailer.
ID_CTAC Identity int N Y N A unique identifier for a customer account. Generally assigned by the home office.
CustomerAccountTenderLineItem
Definition: TR_LTM_CTAC_TND
Definition: A sub-type of TenderLineItem whereby the RetailTransaction is tendered against a CustomerAccountCard or CustomerAccount
ID_CT Identity int N Y Y A unique identifier for a customer.
ID_CT_RPS Identity int N Y Y A customer assigned identifier for the Driver fueling the vehicle.
ID_CTAC Identity int N Y Y A unique identifier for a customer account. Generally assigned by the home office.
AI_ACNT_CT_CRD Number int N Y Y A unique retailer assigned identifier for a CustomerAccountCard.
CustomerAffiliation
Definition: CO_CTAF
Definition: Associates a customer with a customer group.
ID_CT Identity int Y Y N A unique identifier for a customer.
ID_GP_ID Identity int Y Y N A unique identification number assigned to a customer group
FL_IDN_CTAF_VR_RQFlag bit N N Y A flag to denote whether the CUSTOMERs identity has been verified as belonging to the CUSTOMER
AFFILIATION scheme.
CustomerAffiliationPriceDerivationRuleEligibility
Definition: CO_EL_CTAF_PRDV
Definition: This entity associates a price derivation rule with a customer group affiliation and, by its presence, defines a customer affiliation condition for triggering the application
of the rule at the point of sale. This entity provides the linkages required to provide senior citizens discounts, credit union member discounts, etc.
ID_GP_ID Identity int N Y N A unique identification number assigned to a customer group
ID_CT Identity int N Y N A unique identifier for a customer.
CustomerAgent
Definition: PA_CT_RPS
Definition: A person (or other Party) who has some relationship with a Customer.
ID_CT_RPS Identity int Y N N A customer assigned identifier for the Driver fueling the vehicle.
CustomerAsset
Definition: PA_CT_AST
Definition: A customers asset of interest to a retailer. This item may be maintained or enhanced using products and services provided by the retailer
ID_CT_AST Identity int Y N N A unique, automatically assigned identifier for an asset or other item of interest that belongs to or is
related to a customer.
DE_CT_AST DescriptionNarrative text N N Y A narrative that describes this asset or other item belonging to a CUSTOMER.
CustomerAssetAssociation
Definition: ST_AST_CT_ASCTN
Definition: A cross reference of customers to assets they own or possess.
ID_CT_AST Identity int Y Y N A unique, automatically assigned identifier for an asset or other item of interest that belongs to or is
related to a customer.
DC_OWN DateCalendar datetime N N Y A self-reported original ownership/lease/acquisition date for a CUSTOMER ASSET.
DC_VR DateCalendar datetime N N Y The date that an asset is verified as being in the possession of a CUSTOMER.
CustomerConsumerChargeAccount
Definition: LE_ACNT_CT_CNS_CHG
Definition: A type of CUSTOMER ACCOUNT that allows a customer to make purchases on credit. This type of account is a "house " charge account and usually requires the
customer to use a charge card to settle a transaction.
ID_CTAC Identity int Y Y N A unique identifier for a customer account. Generally assigned by the home office.
CustomerCorrespondence
Definition: DO_CRSP_CT
Definition: An e-mail, letter, telegram, or other written communication from a CUSTOMER.
DC_CRSP_CT_RCV DateCalendar datetime Y N N The date and time that a CUSTOMERs letter, fax, e-mail, or phone call is taken or received at a retail
store or other facility.
DC_CRSP_CT_SND DateCalendar datetime N N Y The date and time that a CUSTOMERs letter, fax, e-mail, or phone call was sent by the customer.
DC_CRSP_CT_CRT DateCalendar datetime N N Y The date and time that a CUSTOMERs letter, fax, or e-mail was created.
DE_CRSP_CT_SMY DescriptionNarrative text N N Y A brief interpretation summarizing the main points of the correspondence.
CustomerDemographicRole
Definition: PA_RO_DMOG_CT
Definition: A specific customers assignment to the most fitting demographic role.
NM_RO_DMOG Name varchar(40) Y Y N A label or title given to a group of people or organizations that represents their assignment to a class of
buyers.
DC_RO_DMOG_CT DateCalendar datetime Y N N The date that a CUSTOMER is first assigned to a demographic role.
CustomerGiftRegistration
Definition: TR_RGST_CT_GF
Definition: A specific CUSTOMERs registration for an occasion.
TY_OCCN_CT Name varchar(40) Y Y N A short label for a group of CUSTOMER OCCASIONs. For instance, this could be a wedding, a high
school graduation, a birthday, a golden wedding anniversary, etc.
DC_OCCN_CT DateCalendar datetime Y Y N The start date of a an event or other occasion that a customer celebrates.
DC_RGST_CT_GF DateCalendar datetime N N N The date that a CUSTOMER GIFT RESTRATION is created.
CustomerGroup
Definition: PA_GP_CT
Definition: A group of customers based on specific demographic and marketing attributes and properties. Examples include over 65 year old customers, students, unions, and other
associations.
ID_GP_ID Identity int Y N N A unique identification number assigned to a customer group
NM_GP Name varchar(40) N N Y The business name applied to a customer group.
DE_GP_CT DescriptionShort varchar(255) N N Y The text description applied to a customer group.
CustomerInformationLineItem
Definition: TR_LTM_CT_INF
Definition: A retail transaction line item component that captures different kinds of customer information required to fulfill a retail transaction. Examples include customer
address, customer account, delivery directions, special handling instructions and so on.
TY_INF_CT Code2 char(2) N N Y Defines the type of customer information captured in this line item instance. Valid examples include:
Customer Name, Customer Address, Delivery Address, Customer Account, and Special Handling
Instructions.
CustomerInformationLineModifier
Definition: CO_MDFR_CT_INF_LN
Definition: Provides a specific data element level description and value for customer information line item. This modifier provides a flexible, dictionary driven method for
specifying the kind of data captured about a customer.
AI_MDFR LineNumber smallint Y N N A sequential number designed to uniquely identify each modifier for a CUSTOMER INFORMATION
LINE item.
ID_ELM_DAT Identity int N N Y A dictionary data element identity assigned by each retailer for the type of data they want to collect as
part of their CUSTOMER INFORMATION LINE.
MO_ELM_DAT_VL Money decimal(14,3) N N N The value entered for a data element in a CUSTOMER INFORMATION LINE MODIFIER.
LU_FRMT_DAT_ELM Code2 char(2) N N Y Defines how the value of a data element is to be internally represented. Valid examples include TEXT,
MONEY, LOGICAL (yes/no), COUNT (integer), FLOAT.
CustomerInstallmentPaymentAccount
Definition: LE_ACNT_CT_INS_PYM
Definition: A type of CUSTOMER ACCOUNT established to track installment payments made against a sale transaction. This type of account is generally established to support
big ticket sales.
CustomerLayawayAccount
Definition: LE_ACNT_CT_LY
Definition: A type of CUSTOMER ACCOUNT established to record layaway payments made against merchandise set aside for a customer. The merchandise is retained at the
store until the transaction is settled.
CustomerLoyaltyAccount
Definition: LE_ACNT_CT_PRM
Definition: A type of CUSTOMER ACCOUNT established purely for the purposes of tracking a customers activity over a period of time and based on the volume of NET sales to
provide an award to the customer in the form of a gift or special discount.
ID_PRGM_LYLT Identity int N Y Y A artificial, unique identifier for a loyalty program.
DC_ACNT_CT_PRM_EFDateCalendar datetime N N Y The date this CUSTOMER PROMOTIONAL ACCOUNT becomes active for accumulating sales and
other activity.
DC_ACNT_CT_PRM_ELDateCalendar datetime N N Y The date this CUSTOMER PROMOTIONAL ACCOUNT expires making him/her ineligible for special
awards and/or price reductions.
TP_SLS_NT_CM Money decimal(14,3) N N N The net sales (gross sales less returns) accumulated for the CUSTOMER PROMOTIONAL
ACCOUNT. Note the accumulation is for the period bounded by the effective date and the expiration
date for this promotional account.
CustomerLoyaltyAccountRedemption
Definition: TR_RDM_CT_LYLT_PRM
Definition: A members use of promotional account (points/dollars/miles) for a reward.
ID_PDT_PRM Identity int Y Y N A unique identifier for a Promotional Product.
CustomerOccasion
Definition: PA_OCCN_CT
Definition: An event celebrated or observed by a customer.
DC_OCCN_CT DateCalendar datetime Y N N The start date of a an event or other occasion that a customer celebrates.
CustomerOccasionType
Definition: PA_OCCN_CT_TYP
Definition: A categorization of CUSTOMER OCCASIONs.
TY_OCCN_CT Name varchar(40) Y N N A short label for a group of CUSTOMER OCCASIONs. For instance, this could be a wedding, a high
DE_OCCN_CT DescriptionNarrative text N N Y A description of a categorization of celebrated events or occasions.
CustomerPreference
Definition: PA_PRFC_CT
Definition: A description of a KEY CUSTOMERs merchandise preferences for classes of items or general categories..
TY_PRFC Code2 char(2) Y Y N A unique code for a group of preferences. For instance, all the types of material (clothing) preferences
may be grouped together.
DE_PRFC_CT DescriptionNarrative text N N Y A description of customers likes or dislikes of classes of items, colors, sizes, materials, etc.
CustomerRelationship
Definition: ST_RLTN_CT
Definition: A grouping of customers who tend to jointly make purchasing decisions.
ID_CT_1 Identity int Y Y N A unique identifier for a customer.
ID_CT_2 Identity int Y Y N A unique identifier for a customer.
NM_TYP_CT_RLTN Name varchar(40) Y Y N The name or code assigned to a type of CUSTOMER RELATIONSHIP.
CustomerRelationshipType
Definition: ST_RLTN_CT_TYP
Definition: A categorization of CUSTOMER RELATIONSHIPS.
NM_RLTN_CT_TYP Name varchar(40) Y N N The name or code assigned to a type of CUSTOMER RELATIONSHIP.
DE_RLTN_CT_TYP DescriptionNarrative text N N Y A description of a categorization of customer relationships.
CustomerRentalAccount
Definition: LE_ACNT_CT_RNT
Definition: A sub-type of CustomerAccount that records details of the customer as a rentor of RentalService items.
CustomerRentalAccountHistory
Definition: LE_HST_CT_RNT_ACNT
Definition: A summary of all rentals made against the CustomerRentalAccount during the ReportingPeriod.
ID_PRD_RP Identity int Y Y N The identifier for a particular REPORTING PERIOD.
QU_RNT QuantityShortCount decimal(3,0) N N Y The number of RentalUnits that were rented by the customer during the reporting period.
QU_RTN_LT QuantityShortCount decimal(3,0) N N Y The number of RentalUnits that were rented and were not returned promptly by the customer during
the reporting period.
QU_RTN_DM QuantityShortCount decimal(3,0) N N Y The number of RentalUnits that were rented and were returned in a damaged condition by the
customer during the reporting period.
QU_RTN_DTY QuantityShortCount decimal(3,0) N N Y The number of RentalUnits that were rented and were returned in a dirty condition by the customer
during the reporting period.
CustomerSurvey
Definition: DO_SRVY_CT
Definition: A collection of questions or other inquiries for soliciting responses from customers (shoppers too?).
CustomerSurveyResponse
Definition: DO_SRVY_CT_RSPS
Definition: A specific customers survey responses
CustomerTradeAccount
Definition: LE_ACNT_CT_TRD
Definition: A type of CUSTOMER ACCOUNT established for builders, plumbers, electricians and other trade businesses that purchase merchandise, usually at a preferential
discount, from the store.
MO_DSC_CT_TRD Money decimal(14,3) N N N The monetary amount of discount provided to a specific CUSTOMER TRADE ACCOUNT.
PE_DSC_CT_TRD Percent decimal(5,2) N N N The percentage of the base retail price discount provided to a specific CUSTOMER TRADE
ACCOUNT.
DataMaintenanceEvent
Definition: CO_EV_MNT
Definition: A type of EVENT which represents a collection of changes to configuration data stored in the database. These changes may reflect a promotional activity, a set of price
changes, item additions and deletions, or general maintenance of data.
ID_EV Identity int Y Y N A unique, automatically assigned identifier for each EVENT instance.
ID_CMP Identity int N Y Y The unique identifier assigned to a competitor by the store.
NM_EV_MNT Name varchar(40) N N Y Assigns a name to the maintenance event.
DE_EV_MNT DescriptionShort varchar(255) N N Y Describes the maintenance event in business terms.
RC_EV_MNT Code4 char(4) N N Y Establishes a reason for the maintenance event. Reason codes will be determined by each retailer.
TY_EV_MNT Code2 char(2) N N Y Categorizes the maintenance event based on its intended purpose and subject. Examples include
ITEM maintenance, selling rules maintenance, tender authorization maintenance and a whole host of
different aspects of the retail store data model that may be maintained from the home office.
SC_EV_MNT Code2Status char(2) N N Y The current status of the maintenance event. Valid status conditions include pending, applied,
canceled, expired, etc.
TS_EV_MNT_APLY TimeStampAudit datetime N N N The date and time the maintenance events associated adds, changes and deletes are applied to the
store database.
TS_EV_MNT_CRT TimeStampAudit datetime N N N The date and time this maintenance event was created.
TY_EV_MNT_ORG Code4 char(4) N N Y The origin for this maintenance event. Examples of origins include: home office, store, etc.
Deal
Definition: CO_DL
Definition: A deal refers to a special offer from a supplier to the store. The deal generally provides allowances, discounts, special favorable terms of payment or other incentives to
motivate the store to buy more products or services from a supplier.
LU_DL Identity int Y N N A code which uniquely identifies the type of DEAL offered by the SUPPLIER. For example the
SUPPLIER may offer an additional 2% discount off the cost price, or increase the case units by 10%
for the same cost price. Normally DEALs last for finite periods.
ID_SPR Identity int Y Y N A code assigned by the retailer to uniquely identify the supplier.
NM_DL Name varchar(40) N N Y The business name for the deal.
DE_DL DescriptionShort varchar(255) N N Y A brief text description of the DEAL.
DC_DL_EF DateCalendar datetime N N Y The start date upon which an ITEM can be ordered under the terms of a given deal.
DC_DL_EL DateCalendar datetime N N Y The end date upon which an ITEM can be ordered under the terms of a given deal.
DealSupplierItem
Definition: AS_ITM_DL_SPR
Definition: This entity identifies a specific SUPPLIER ITEM that is offered as part of a deal to the store and defines how the deal cost is to be handled.
LU_DL Identity int Y Y N A code which uniquely identifies the type of DEAL offered by the SUPPLIER. For example the
TY_UN_CST Code2 char(2) Y Y N Defines the unit type the owned attribute costs are assigned to for this item. Valid unit types include:
SALE UNIT, PACK UNIT and SHIP UNIT. A single SUPPLIER ITEM may in effect have 1 to three
SUPPLIER ITEM BASE COST entities associated with it.
ID_ITM_SPR Identity int Y Y N The code assigned by the supplier to uniquely identify the ITEM
MO_CHN_CST MoneyShortCost decimal(10,5) N N N The difference between the standard and DEAL cost prices or the DEAL cost intended to replace the
standard catalog cost for the item.
PE_CHN_CST Percent decimal(5,2) N N N The percentage difference between the standard and DEAL cost prices or the DEAL cost intended to
replace the standard catalog cost for the item.
LU_CHN_CST_RPL_MDF Code2 char(2) N N Y A code that determines how the deal-supplier-cost-change-amount is to be applied -- i.e. it is to replace
or modify the catalog cost.
DealSupplierItemCostBreak
Definition: CO_CBRK_DL_SPR_ITM
Definition: This entity establishes deal-related cost breaks offered to a store. Cost breaks represent stepped cost reductions based on the number of units acquired by the store.
LU_DL Identity int Y Y N A code which uniquely identifies the type of DEAL offered by the SUPPLIER. For example the
QU_TH_UN_DL Quantity decimal(9,2) Y N N A count associated with an item that triggers a cost reduction as part of a DEAL.
MO_CHN_CST_BRK Money decimal(14,3) N N N The additional allowance amount which is applied when the SUPPLIERs breakpoint is attained.
PE_CHN_CST_BRK Percent decimal(5,2) N N N The additional allowance percentage that is applied when the SUPPLIERs breakpoint is attained.
DemographicRole
Definition: PA_RO_DMOG
Definition: An industry or proprietary categorization of a person or organization based on his/her/its purchasing behaviors, age, desires, geographic location, job type, etc.
NM_RO_DMOG Name varchar(40) Y N N A label or title given to a group of people or organizations that represents their assignment to a class of
buyers.
DE_RO_DMOG DescriptionNarrative text N N Y A description of a grouping of customers based on their lifestyles, purchasing trends, income ranges,
etc.
Denomination
Definition: CO_DNM
Definition: Specifies the quantitative value of the referenced CURRENCY media.
ID_CNY Identity int Y Y N The unique identifier of the CURRENCY.
ID_DNM Identity int Y N N An identifier which uniquely identifies the quantitative value of a specific currency, e.g. $100, 50, etc.
NM_DNM Name varchar(40) N N Y A description of the quantitative value of a specific currency.
DepositRedemption
Definition: TR_DPRD
Definition: A DEPOSIT is a monetary amount that is paid to secure an ITEM. The DEPOSIT can be redeemed against the eventual purchase or returned to the CUSTOMER when
the ITEM is returned, e.g. bottle or can. DEPOSITs/REDEMPTIONs are very prevalent in Northern European grocery where a DEPOSIT is paid for the container at the time of
purchase and a REDEMPTION payment made when returned at a future visit.
LU_RFM_DS Code2 char(2) Y N N Defines the type of deposit or redemption. In addition to distinguishing between deposits (i.e. deposits
on bottles, etc.) and redemptions, this code allows the store to establish different categories of deposits
and redemptions.
DepositRedemptionLineItem
Definition: TR_LTM_DPRD
Definition: A line item component of a RETAIL TRANSACTION that records the dollar amount to be debited or credited to a deposit receivable or payable account and added to
or subtracted from the balance due total of the transaction.
LU_RDM_DS Code2 char(2) N Y Y Defines the type of deposit or redemption. In addition to distinguishing between deposits (i.e. deposits
on bottles, etc.) and redemptions, this code allows the store to establish different categories of deposits
and redemptions.
MO_DS Money decimal(14,3) N N N The monetary amount of a deposit or redemption.
QU_DS Quantity decimal(9,2) N N N The number of containers, bottles, racks, cases, etc. involved in the deposit or redemption. For
example a redemption of $5.00 for 100 aluminum cans - 100 here is the unit count.
LU_UOM_DS Code2 char(2) N N Y The unit of measures applied for counting the number of units involved in a deposit or redemption.
Examples include cans, cases, racks, bottles, etc.
DepositRule
Definition: RU_DS
Definition: An association of a STOCK ITEM and a RETURN AGENT that defines the rules governing the deposit payment that must be paid by the customer at the time the item
is purchased and the refund that must be made to the customer upon return of the item package or container. This rule is most often related to bottles, aluminum cans, crates and
other containers which must be returned for reuse or recycling.
ID_RU_DS Identity int Y N N A unique system assigned identifier for the deposit rule
ID_AGNT_RTN Identity int N Y N The company to whom the returns for ITEMs, such as empty bottles, are made.
ID_ITM Identity int N Y N The retailers SKU or unique item identifier for items sold or returned.
LU_UOM_DS_PD Code2 char(2) N N Y The unit of measure (e.g. each bottle, each case, each rack, etc.) that the customer pays a deposit on
at the time of a sale.
MO_UOM_DS_PD Money decimal(14,3) N N N Th deposit amount paid for each deposit-paid-on-unit-of-measure-code by the consumer at the time an
item is purchased.
DevicePrice
Definition: CO_PRC_DVC
Definition: The current mapping between the system ItemPrice and a FuelingPoint device specific identifier used to identify aretail unit price.
ID_PNT_FUEL Identity int Y Y N A unique identifier for the FuelingPoint at a particular retail store
ID_PRC_DVC Identity int Y N N The devicePriceID used by the FuelingPoint to identifiy the retail price.
ID_PRC_ITM Identity int N Y N A unique identifier for the ItemPrice.
DisbursementFundsReceiptReason
Definition: CO_RCV_DSB_FND
Definition: The reason why a petty cash disbursement has been made or funds receipt received.
RC_RCV_DSB Code2 char(2) Y N N The reason code for the DISBURSEMENT or the FUNDS RECEIPT.
DE_RCV_DSB DescriptionShort varchar(255) N N Y A textual description of the reason for the DISBURSEMENT or FUNDS RECEIPT
DisbursementTransaction
Definition: TR_DSB
Definition: A type of FINANCIAL ACCOUNTING TRANSACTION that records disbursement (with an offsetting miscellaneous expense).
ID_RPSTY_TND Identity int N Y Y The unique identifier for the TENDER RESPOSITORY.
RC_RCV_DSB Code2 char(2) N Y Y The reason code for the DISBURSEMENT or the FUNDS RECEIPT.
ID_PRTY_PTY_CSH Identity int N N Y Identifies the party receiving the petty cash.
FL_RCV_PTY_CSH_RQFlag bit N N Y A flag that when true indicates that the recipient of a petty cash payment must provide a written receipt
as evidence that the transaction was valid.
Discount
Definition: TR_DSC
Definition: A reduction in the selling price that is normally charged as an expense to the RETAIL STOREs general ledger. Can be applied by transaction line item or to the whole
transaction.
TY_DSC Code2 char(2) Y N N The type code used as a look up key for the standard discount types represented in the DISCOUNT
entity collection
NM_DSC Name varchar(40) N N Y The name of the standard discount types represented in the DISCOUNT entity collection.
DE_DSC DescriptionShort varchar(255) N N Y A text description of the standard discount types represented in the DISCOUNT entity collection.
CD_RDN_MTH Code2 char(2) N N Y A code denoting the method of discounting that is being applied to the transaction. Possible values
include, Monetary Amount Reduction, Percentage Reduction, New Price Amount and Cost Plus Price
MO_RDN_AMT MoneyShortRetail decimal(8,3) N N Y The amount of the discount expressed as a dollar amount
PE_RDN_AMT Percent decimal(5,2) N N Y The amount of the discount expressed as a percentage of the normal price.
MO_NW_PRC MoneyShortRetail decimal(8,3) N N Y The discount amount expressed as the new price for the item.
DiscountLineItem
Definition: TR_LTM_DSC
Definition: A line item component of a RETAIL that records the granting of a reduction of price on items and/or services purchased by a customer and treats that price reduction as
an expense item for accounting purposes.
TY_DSC Code2 char(2) N Y Y The type code used as a look up key for the standard discount types represented in the DISCOUNT
entity collection
MO_DSC Money decimal(14,3) N N N The monetary value for the discount line item.
DiscrepancyToleranceRule
Definition: RU_TLRN_DSCP
Definition: A rule that defines permissible variance between the total inventory control document cost (based on the suppliers cost) and the stores receiving total (based on the
stores record of supplier item cost). Any variance that exceeds the discrepancy threshold will trigger an invoice or item-level reconciliation.
ID_RU_DSCP Identity int Y N N A specific rule which defines the nature and amount of the cost, weight or quantity discrepancy. Rules
can apply to the entire bill or individual lines and be measured in amount or percentage terms.
TY_DSCP Code2 char(2) N N Y Determines whether the discrepancy rule applies to cost (in monetary units), weight or quantity (i.e.
item count).
MO_TH_DSCP Money decimal(14,3) N N N The monetary value, weight or quantity that establishes the tolerance threshold that when reached will
exceed the tolerance for the SUPPLIER and require special approval or remedial action.
PE_TH_DSCP Percent decimal(5,2) N N N The monetary value, weight or quantity percent variance between what is ordered and what is received
that establishes the tolerance threshold that when reached will exceed the tolerance for the SUPPLIER
and require special approval or remedial action.
NA_MSG_TH_DSCP DescriptionNarrative text N N Y Message to detail the reason for the difference between the billed and ITEM cost amounts, weights or
counts.
DisplayUnitItem
Definition: AS_ITM_DPLY
Definition: A sub-type of STOCK ITEM for shelf, rack or other display unit that is used by the store to display merchandise. Particularly used for racks & shelves custom designed
for a particular item. Not normally for sale.
DP_UN_DPLY Code2 char(2) N N Y A code to denote how the DISPLAY UNIT is to be disposed, ie returned to the supplier, destroyed, or
retained until the next promotion.
DC_UN_DPLY_TK_DWN DateCalendar datetime N N Y The date on which the display unit can be taken down by the RETAIL STORE
DC_UN_DPLY_ST_UP DateCalendar datetime N N Y The date on which the DISPLAY UNIT can be setup within the RETAIL STORE
TY_UN_DPLY Code2 char(2) N N Y A code to denote the type of display unit, i.e. free-standing, shelf end, refrigerator, etc.
QU_CPC_HLD Quantity decimal(9,2) N N Y The maximum number of SHELF ITEMS that can be stocked on the DISPLAY UNIT.
DriveOffTransaction
Definition: TR_DRV_OFF
Definition: A type of TRANSATION that records the clearing of a FUELLING TRANSACTION without accepting payment because the customer simply drove off wthout
paying. Operator may record some details about the vehicle that has driven off
ID_TRN_FUEL Identity int N Y Y A unique identifier for the fuelling transaction
NM_CLR_VH Name varchar(40) N N Y The color of the vehicle that did the drive-off
NM_MF_VH Name varchar(40) N N Y The make of the vehicle that did the drive-off
NM_MDL_VH Name varchar(40) N N Y The model of the vehicle that did the drive-off
NM_RGST_VH Name varchar(40) N N Y The registration nujmber of the vehicle that did the drive-off
EmailAddress
Definition: LO_EML_ADS
Definition: An electronic mail address.
ID_PRTY Identity int Y Y N A unique, automatically assigned identity for a PARTY.
EM_ADS Email address varchar(64) Y N N An electronic address for sending messages..
Employee
Definition: PA_EM
Definition: An individual that works for a retail store, accepts direction from the retail store management and satisfies the statutory criteria requiring that payroll taxes and benefit
contributions be paid by the retailer.
ID_EM Identity int Y N N A unique, non-significant number used to identify a store employee.
TY_WRKR Code2 char(2) N Y N A unique retailer assigned code denoting the kind of Worker.
ID_LGE Code4External char(4) N Y Y A combination of ISO-639-1 and ISO-3661-1 to denote a lanuage as spoken in a particular country.
ID_PLN_EM_CMN Code4 char(4) N Y Y A unique reference number for an employees commission plan. This may be the employees payroll
number.
NM_EM Name varchar(40) N N Y The full name of the EMPLOYEE.
SC_EM Code2Status char(2) N N Y The status code regarding the EMPLOYEE, i.e. active or inactive.
UN_NMB_SCL_SCTY IdentitySocialSecurityNumber char(9) N N Y The social security number of the EMPLOYEE.
TY_EM_CMPSN Code varchar(20) N N Y Defines how the employee is paid. (Hourly or Salaried)
EmployeeAssignment
Definition: ST_EM_ASGMT
Definition: An employees assignment to a specific position, at one point in time.
ID_PST Identity int Y Y N A unique identifier for a specific job. This may or may not be controlled by a centralized HR function.
SC_EM_ASGMT Code2Status char(2) N N Y A code that represents the current state of an EMPLOYEE ASSIGNEMENT.
DC_EF DateCalendar datetime N N Y The date that an EMPLOYEE ASSIGMENT is first valid.
DC_EP DateCalendar datetime N N Y The date that an employees assignment is no longer valid.
EmployeeCommissionPlan
Definition: CO_PLN_EM_CMN
Definition: A plan for compensating employees for sales they make to customers.
ID_PLN_EM_CMN Code4 char(4) Y N N A unique reference number for an employees commission plan. This may be the employees payroll
number.
DE_PLN_EM_CMN DescriptionShort varchar(255) N N Y A textual description of the type of employees commission plan
EmployeeDiscountedSalesHistory
Definition: LE_HST_EM_DSC_SLS
Definition: A collection of accumulators for each employee who purchases merchandise, at a discount, from the store.
MO_RTN_TOT_EM_DSC Money decimal(14,3) N N N The total monetary amount of refunds made for ITEMs originally purchased as part of an EMPLOYEE
discount scheme in each REPORTING PERIOD.
QU_TRN_TOT_EM_DSC QuantityTransactionCount decimal(7,0) N N N The total number of transactions involving EMPLOYEE purchases in a given REPORTING PERIOD.
QU_FE_MSC_TOT_EMQuantityTransactionCount decimal(7,0) N N N The total number of miscellaneous fees discounted for EMPLOYLEEs in each REPORTING PERIOD.
MO_FE_MSC_EM_DSCMoney decimal(14,3) N N N The total monetary amount of discount granted to EMPLOYEEs for miscellaneous fees in each
REPORTING PERIOD.
MO_SLS_NT_EM_DSCMoney decimal(14,3) N N N The total monetary amount of net sales resulting from EMPLOYEE purchases in each REPORTING
PERIOD.
QU_ITM_LN_EM_DSC QuantityTransactionCount decimal(7,0) N N N The total number of ITEMs discounted as part of EMPLOYEE purchases in each REPORTING
PERIOD.
MO_SLS_TOT_EM_DSCMoney decimal(14,3) N N N The total monetary amount of discount granted in EMPLOYEE purchases in each REPORTING
PERIOD.
QU_RFD_TOT_EM_DSC QuantityTransactionCount decimal(7,0) N N N The total number of refunds made for ITEMs originally purchased as part of an EMPLOYEE discount
scheme in each REPORTING PERIOD.
MO_RFD_TOT_EM_DSC Money decimal(14,3) N N N The total number of refunds made for ITEMs originally purchased as part of an EMPLOYEE discount
scheme in each REPORTING PERIOD.
QU_RTN_TOT_EM_DSC QuantityTransactionCount decimal(7,0) N N N The total number of returns of ITEMs originally purchased as part of an EMPLOYEE discount scheme
in each REPORTING PERIOD.
EmployeeDiscountGroup
Definition: CO_GP_EM_DSC
Definition: A group of EMPLOYEEs who share the same employee discount privilege.
ID_GP_EM_DSC Identity int Y N N The identifier for a specific EMPLOYEE DISCOUNT GROUP.
NM_GP_EM_DSC Name varchar(40) N N Y The name given to a specific EMPLOYEE DISCOUNT GROUP, e.g. store management, part-time
employees, etc.
EmployeeDiscountGroupPriceDerivationRuleEligibility
Definition: CO_EL_EM_DSC_PRDV
Definition: Establishes the association between an employee Discount Group and a PRICE DERIVATION RULE. The association indicates that the employee group is eligible for
a price reduction.
ID_GP_EM_DSC Identity int N Y N The identifier for a specific EMPLOYEE DISCOUNT GROUP.
DE_EL_EM_PRDV_RUDescriptionShort varchar(255) N N Y Describes the derivation rule for the employee group price discount.
FL_MKD_APLY_AFT Flag bit N N Y A flag to denote whether the EMPLOYEE DISCOUNT is applied after all the ITEM markdowns have
been applied.
FL_CST_PLS_EM_DSCFlag bit N N Y A flag to denote whether the price of the ITEM to the EMPLOYEE is calculated by adding a dollar
amount or percent to the cost price.
DE_EL_EM_DSC_GP DescriptionShort varchar(255) N N Y Describes this employee-group discount eligibility rule.
EmployeeDiscountLineItem
Definition: TR_LTM_EM__DSC
Definition: A special kind of retail line item set up to record and keep track of employee discounts taken in a transaction.
ID_EM Identity int N Y N A unique, non-significant number used to identify a store employee.
MO_ITM_LN_EM_DSCMoney decimal(14,3) N N N The discount amount granted to an EMPLOYEE when making a purchase. The item sales are typically
held separately in order to assess whether the EMPLOYEE is abusing the privilege.
EmployeeMembershipDiscountGroup
Definition: CO_GP_EM_MBS_DSC
Definition: An association between an employee and an employee discount group which makes the employee eligible for the price reductions available to the discount group.
ID_GP_EM_DSC Identity int Y Y N The identifier for a specific EMPLOYEE DISCOUNT GROUP.
DE_GP_EM_DSC_GP DescriptionShort varchar(255) N N Y Description associated with this employee discount group.
FL_IDN_VR_RQ_EM Flag bit N N Y A flag to denote whether the identity of the EMPLOYEE has been verified.
EmployeeRetailStoreAssignment
Definition: ST_ASGMT_EM_STR
Definition: An associative entity that links EMPLOYEE and RETAIL STORE. The assumption here is that a RETAIL STORE has many EMPLOYEEs and EMPLOYEEs can
operate in many different RETAIL STOREs.
DC_ASGMT_STR_EF DateCalendar datetime N N Y The date on which an individual assignment in a store becomes effective.
DC_ASGMT_STR_EP DateCalendar datetime N N Y The date on which an individual assignment in a store expires.
SC_ASGMT_STR Code2Status char(2) N N Y A code to signify the status of a specific assignment.
EnvironmentClass
Definition: LO_ENV
Definition: A category of environmental properties, such as humidity, lighting, and temperatures.
CD_CLS_ENV Code6 char(6) Y N N A code that identifies a class environmental properties of a location. For instance, this might describe
humidity, temperature, or lighting restrictions or requirements
DE_CLS_ENV DescriptionNarrative text N N N A descriptive narrative of the environmental class.
Equipment
Definition: AS_EQ
Definition: An instance of EQUIPMENT CLASS, it comes in a variety of flavours Workstation, FuelPump, TankGauge, TankProbe.
ID_EQ Identity int Y N N The fixed asset number assigned by the retailer for this particular piece of equipment.
ID_EQ_CLS Identity int N Y Y A unique identifier for the class of equipment.
TY_EQ Code2 char(2) N N Y A 2 character code denoting the kind of equipment. Choices are currently Workstation, FuelPump,
TankGauge and TankProbe
NM_MDL_NMB Name varchar(40) N N Y The model number assigned to the piece of equipment by the manufacturer.
EquipmentClass
Definition: AS_EQ_CLS
Definition: A class of device used as an as interface to any store business function. All instances of the class have a common manufacturer, service provider and supplier. Class
instanaces are currently Workstation, FuelPump, TankGuage and TankProbe.
ID_EQ_CLS Identity int Y N N A unique identifier for the class of equipment.
ID_SPR Identity int N Y Y A code assigned by the retailer to uniquely identify the supplier.
ID_PVR_SV Identity int N Y Y A unique identifier for the service provider.
NM_MF Name varchar(40) N N Y The name of the hardware manufacturer
Event
Definition: CO_EV
Definition: Something that happens, takes place or has been planned represented by the designation of time, place and purpose. Events are normally associated with business
processes like markdowns, physical inventory, special promotional displays and advertising, etc.
ID_EV Identity int Y N N A unique, automatically assigned identifier for each EVENT instance.
TY_EV Code4 char(4) N N Y Identifies the category for the event. Examples include holiday promotion, physical inventory count,
Presidents Day, Back to School Sale, Register Roulette, etc.
DE_EV DescriptionShort varchar(255) N N Y Describes the event.
NM_EV Name varchar(40) N N Y The business name of the event.
SC_EV Code2Status char(2) N N Y The current status code of the event -- e.g. active, pending, deferred, canceled, etc.
CC_EV Code2 char(2) N N Y A code to indicate whether the event is controlled by the store or by the home office.
NM_EV_OWNR Name varchar(40) N N Y Identifies who in the retailer organization owns and is responsible for the EVENT.
TS_EV_PL_EF TimeStampEffective datetime N N Y The planned starting time and date for an event.
TS_EV_PL_EP TimeStampExpiration datetime N N Y The planned time and date when the event terminates
TS_EV_ACT_EF TimeStampEffective datetime N N Y The actual start date and time for an event.
TS_EV_ACT_EP TimeStampExpiration datetime N N Y The actual time and date when the event terminates.
ExchangeRate
Definition: CO_RT_EXC
Definition: Expresses the quantitative conversion factor between two kinds of CURRENCY, one which must be the stores home currency.
ID_CNY_FM Identity int Y Y N The unique identifier of the CURRENCY.
ID_CNY_EXC_TO Identity int Y Y N The unique identifier of the CURRENCY.
AI_EXC_RT LineNumber smallint Y N N A sequence number denoting the order in which Exchange rate records were created for this pairing of
currencies.
DC_RT_EXC_EF DateCalendar datetime N N N The date on which a specific exchange rate becomes effective.
DC_RT_EXC_EP DateCalendar datetime N N N Date on which the exchange rate expires and is no longer valid.
MO_RT_TO_BUY Money decimal(14,3) N N N The buying rate of the tender type, based on the stores local currency.
MO_RT_TO_SL Money decimal(14,3) N N N The selling rate of the tender type, based on the stores local currency
MO_FE_SV_EXC Money decimal(14,3) N N N The add-on fee, in local currency amounts, imposed on the exchange
LL_CNY_EXC Money decimal(14,3) N N N The minimum monetary amount the store will either purchase or sell foreign tender.
ExCustomer
Definition: PA_CT_EX
Definition: An individual, collection of individuals, company, or public institution that does not currently purchase merchandise or services from the retailer, but who was at one
time a customer. An Ex-customer has an inactive relationship with the retailer.
ExternalDepository
Definition: LO_EXTDST
Definition: A bank or other institution that accepts periodic deposits of TENDER from the retail store.
ID_RPSTY_TND Identity int Y Y N The unique identifier for the TENDER RESPOSITORY.
NM_RPSTY_EXTRN Name varchar(40) N N Y The business name of the external repository.
DE_RPSTY_EXTRN DescriptionShort varchar(255) N N Y Business description of the external depository
ID_EXTDST Identity int N Y Y A unique identifier for an External Depository Party. The identifiers are only unique within this type of
PARTY.
ExternalDepositoryHistory
Definition: LE_HST_EXTDST
Definition: A record of the TRANSACTIONs that lists the deposit of TENDER in the EXTERNAL DEPOSITORY by the store.
ExternalDepositoryParty
Definition: PA_EXTDST
Definition: A type of party related to an EXTERNAL DEPOSITORY.
ID_EXTDST Identity int Y N N A unique identifier for an External Depository Party. The identifiers are only unique within this type of
PARTY.
ExternalDepositorySettlementTransaction
Definition: TR_STLM_EXTDST
Definition: A transaction that records the closing balances for the EXTERNAL REPOSITORY HISTORY. This is associated with the cash count of the deposit made to an
external repository.
ExternalDepositoryTender
Definition: AS_TND_EXTDST
Definition: A set of tender repository totals for each type of tender in an EXTERNAL DEPOSITORY
TY_TND Code4 char(4) Y Y N A code which uniquely identifies the type of tender, ie cash, check, credit card, etc.
MO_BLNC_OPN_TOT Money decimal(14,3) N N N The monetary amount of the opening balance of TENDER in the EXTERNAL DEPOSITORY at the
start of the current deposit..
MO_DS_TND_TOT Money decimal(14,3) N N N The total amount of tender deposited in the EXTERNAL DEPOSITORY.
QU_DS_TND_TOT QuantityTransactionCount decimal(7,0) N N N The total number of TENDER deposits made in the EXTERNAL DEPOSITORY.
TS_DS_TND TimeStampAudit datetime N N N The timestamp when tender is deposited in the EXTERNAL DEPOSITORY.
MO_RCV_TND_TOT Money decimal(14,3) N N N The total amount of money received from the EXTERNAL DEPOSITORY.
QU_RCV_TND_TOT QuantityTransactionCount decimal(7,0) N N N The total number of receipts to the STORE from the EXTERNAL DEPOSITORY.
MO_DSCP_TND_UND Money decimal(14,3) N N N The shortage, expressed as an amount, between the actual and recorded tender deposited in the
EXTERNAL DEPOSITORY.
MO_DSCP_TND_OVR Money decimal(14,3) N N N The overage, expressed as an amount, between the actual and recorded tender deposited in the
EXTERNAL DEPOSITORY.
ExternalDepositoryTenderHistory
Definition: LE_HST_EXTDST_TND
Definition: An accumulator for various tender amounts and units held and transferred to an EXTERNAL REPOSITORY. These totals cover an accumulation period bounded by
the EXTERNAL REPOSITORY SETTLEMENT TRANSACTION.
MO_BLNC_OPN Money decimal(14,3) N N N The monetary amount of the opening balance of TENDER in the EXTERNAL DEPOSITORY at the
start of the accumulation period.
MO_DS_TND Money decimal(14,3) N N N The total amount of tender deposited in the EXTERNAL DEPOSITORY for each accumulation period..
QU_DS_TND_TOT QuantityTransactionCount decimal(7,0) N N N The total number of TENDER deposits made in the EXTERNAL DEPOSITORY for each accumulation
period.
TS_DS_TND TimeStampAudit datetime N N N The timestamp when tender is deposited in the EXTERNAL DEPOSITORY for each accumulation
period.
MO_RCV_TND_TOT Money decimal(14,3) N N N The total amount of money received from the EXTERNAL DEPOSITORY in each accumulation period.
QU_RCV_TND_TOT QuantityTransactionCount decimal(7,0) N N N The total number of receipts to the STORE from the EXTERNAL DEPOSITORY in each accumulation
period.
MO_DSCP_TND_UND Money decimal(14,3) N N N The shortage, expressed as an amount, between the actual and recorded tender deposited in the
EXTERNAL DEPOSITORY for each accumulation period.
MO_DSCP_TND_OVR Money decimal(14,3) N N N The overage, expressed as an amount, between the actual and recorded tender deposited in the
EXTERNAL DEPOSITORY for each accumulation period.
Facility
Definition: LO_FCLY
Definition: A distribution center, warehouse or store which ships merchandise to and accepts returned merchandise from the retail store.
ID_FC Identity int Y N N The unique reference for the facility that originated the supply. This facility is a generic term that will
normally apply to a warehouse or distribution center.
NM_FC Name varchar(40) N N Y The name by which the FACILITY is known.
FinancialAccountingTransaction
Definition: TR_CTL_TND
Definition: A type of TRANSACTION that records the physical movement of tender from one tender repository to another.
FL_RCV_EXTRN_DS Flag bit N N Y Flag determines whether this transaction is a deposit to or receipt from a bank or other external tender
repository.
LU_PKP_LON Code2 char(2) N N Y A code to determine whether this is a pick up or loan.
RC_TND_CTL Code2 char(2) N N Y The reason for this tender control transaction (e.g. normal end of shift, end of day, special audit, etc.)
FinancialTransactionJournalEntry
Definition: JL_JE_FN_ACNT
Definition: An entry in a journal of transaction details for posting to a STORE FINANCIAL LEDGER ACCOUNT and/or the STOCK LEDGER.
ID_ENR_FN_TRN_JR Identity int Y N N The unique reference of the FINANCIAL TRANSACTION JOURNAL ENTRY.
AI_ENR_FN_TRN_JR LineNumber smallint Y N N The sequence number of the FINANCIAL TRANSACTION JOURNAL ENTRY.
DC_DY_BSN DateCalendar datetime N Y Y The calendar date of the BusinessDay.
ID_ICD Identity int N Y Y The reference number that uniquely identifies the INVENTORY CONTROL DOCUMENT.
TS_ENR_FN_TRN_JR TimeStampAudit datetime N N N The time at which the FINANCIAL TRANSACTION JOURNAL ENTRY is made.
MO_ENR_FN_TRN_JRMoney decimal(14,3) N N N The monetary value of the FINANCIAL TRANSACTION JOURNAL ENTRY.
LU_ENR_JR_DB_CR Code2 char(2) N N Y A code to denote whether the value of the FINANCIAL TRANSACTION JOURNAL ENTRY is debited
or credited to the FINANCIAL LEDGER.
SC_ENR_FN_TRN_JR Code2Status char(2) N N Y Defines the current status of the FINANCIAL TRANSACTION JOURNAL ENTRY. Examples include
pending, booked, etc.
FlatTaxRateRule
Definition: RU_TX_FLT_RT
Definition: A kind of TaxRateRule that denotes a monetary amount of tax that is to be applied to a RetailTransaction.
government body.
MO_RT_TX Money decimal(14,3) N N Y The flat tax amount that is to be applied
FleetInfo
Definition: TR_FLE_INF
Definition: Vehicle, Driver & other fleet management data that is collected as part of the process of tendering a transaction (that includes the sale of a FuelItem) with a
CustomerAccount
ID_VH unknown varbinary N N Y A unique customer assigned identifier for the vehicle being fueled. Usually this will be the vehicles
license plate number, but not always.
FL_VH_TMP Flag bit N N Y A flag denoting that this FleetInfo refers to a temporary vehicle, which means there is no valid
VehicleID present.
QU_RDG_ODO String varchar(20) N N Y The OdometerReading for the vehicle being fueled.
FoodServiceTransaction
Definition: TR_FDSV
Definition: A sub-type of RetailTransaction specifically for the Food Service segment of the retail industry. Which can be used to record TableNumber, PartySize, Servers, etc...
ID_SRV Identity int N Y Y A unique identifier for the Server
ID_TB Identity int N N Y A unique identifier for the table that was used for the hospitality transaction.
QU_SZ_PRTY QuantityShortCount decimal(3,0) N N Y The number of people served at the table during the hospitality transaction.
ForecourtSettlementTransaction
Definition: TR_STLM_FCRT
Definition: A special kind of forecourt transaction, that causes the system to do the following: 1. Perform an automatic PhysicalInventory of the tank Locations via TankGauge
equipment 2. Take a set of StockMeter and/or Sales/Meter Readings 3. Close-off the
ID_EV Identity int N Y Y A unique, automatically assigned identifier for each EVENT instance.
ForecourtTransaction
Definition: TR_FCRT
Definition: A type of TRANSATION that records the clearing of FUELLING TRANSACTIONs without accepting money for them by an operator at a workstation.
TY_TRN_FCRT Code2 varchar(20) N N Y A code to denote the type of ForecourtTransaction , eg DriveOff, TestDelivery
ForeignCurrencyTenderLineItem
Definition: TR_LTM_FRG_CNY_TND
Definition: A type of TENDER LINE ITEM used to record the collection of cash in a foreign currency (i.e. a currency that is different from the stores host country currency).
MO_FRG_CNY Money decimal(14,3) N N N A tender line item identifying the foreign currency tendered by the CUSTOMER as payment.
FreightBill
Definition: DO_BL_FRGT
Definition: A carrier-originated document that lists the number of containers (e.g. pallets, cartons, etc.) that were delivered to the store. The freight bill does not reference the inner
contents of a shipment.
ID_CRR Identity int Y Y N The carrier presenting the bill of lading.
ID_BL_FRGT Identity int Y N N The carrier-assigned shipping document number
LU_RST_CRR_WT Code2 char(2) N N Y A code to denote the maximum weight of each carton that can be handled by the carrier.
QU_CTN_STR Quantity decimal(9,2) N N N The number of cartons as established by the store.
QU_CTN_FRGT_BL_SHP Quantity decimal(9,2) N N N The number of cartons listed on the FREIGHT BILL.
TM_RCV TimeStampAudit datetime N N N The time and date when the freight is received at the store.
SC_BL_FRGT Code2Status char(2) N N Y The status of the receiving event: scheduled, initiated, completed, processed, reviewed, modified.
LU_HN_SPL Code2 char(2) N N Y A code that specifies special handling instructions.
TX_DSCR_HN DescriptionNarrative text N N Y Free form additional description of special handling conditions if special handling code inadequate.
ID_SRZ_FRM String varchar(20) N N Y An identifier for this document, usually preprinted on the form stock prior to being filled out.
FuelingPoint
Definition: AS_PNT_FUEL
Definition: A device used to deliver fuel.
ID_PNT_FUEL Identity int Y N N A unique identifier for the FuelingPoint at a particular retail store
ID_FUEL_PMP Identity int N Y Y A unique identifier for the FuelPump
LU_UOM Code2 char(2) N Y Y 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.
NM_WM_SW_VN Name varchar(40) N N Y The software version in the FuellingPoint as reported to Weights & Measures
CA_WM_SW_DT DateCalendar datetime N N Y The date of the software version in the FuellingPoint as reported to Weights & Measures
CD_WM_SCTY Code2 varchar(20) N N Y A security code in the FuellingPoint as reported to Weights & Measures
CD_VN_PRTCL Code2 varchar(20) N N Y The version of the protocol this FuellingPoint uses.
FuelingTransaction
Definition: EV_TR_FUEL
Definition: An auditing event, recording a particular NOZZLE completing a delivery of fuel.
ID_TRN_FUEL Identity int Y N N A unique identifier for the fuelling transaction
ID_ITM Identity int N Y Y The retailers SKU or unique item identifier for items sold or returned.
ID_PNT_FUEL Identity int N Y Y A unique identifier for the FuelingPoint that this Nozzle is a part of
ID_NZL Identity int N Y N A unique identifier for the Nozzle
ID_PRC_ITM Identity int N Y Y A unique identifier for the ItemPrice.
ID_OPR Identity int N Y Y A unique, automatically assigned number used to identify a workstation OPERATOR.
CD_TRN_FUEL Code2 varchar(20) N N Y A two charcter code denoting the type of FuelingTransactionEvent being recorded. Possible values
include PostPay: Where the FuelingTransaction is yet to be sold by a FuelSalesLineItem in a
RetailTransaction PrePayCompletion: Where money has been collected for the FuelingTransaction in a
previous FuelSalesLineItem and there is no refund required. PrePayRefund: Where too much money
was collected for the FuelingTransaction in a previous FuelSalesLineItem, and a further
FuelSalesLineItem in a RetailTransaction is required to deal with the refund.
TS_TRN_FUEL Datetime datetime N N Y The date & time of the completion of the fuelling transaction
QV_TRN_FUEL Number int N N Y The volume of fuel delivered in the fuelling transaction.
RP_TRN_FUEL Number int N N Y The price per volume unit charged by the FUELLING POINT for the fuel delivered in the FUELLING
TRANSACTION
TP_TRN_FUEL Number int N N Y The total price charged by the FUELLING POINT for the fuel delivered in the FUELLING
TRANSACTION.
MO_TX_SLS MoneyShortRetail decimal(7,2) N N Y The sales tax charged by the FUELLING POINT for the fuel delivered in the FUELLING
TRANSACTION.
FL_SLS_TX_INC Flag char(18) N N Y A flag denoting the inclusion (or non-inclusion) of the reported sales tax in the total price figure.
MI_AZN_ELPSD QuantityShortCountMilliseconds decimal(5,0) N N Y The number of milli-seconds elapsed between CUSTOMER lifting NOZZLE and FUELING
TRANSACTION commencing
SI_DV_ELPSD QuantityShortCountSeconds decimal(5,0) N N Y The number of seconds between FUELING TRANSACTION commencing and completing.
SI_SLS_ELPSD QuantityShortCountSeconds decimal(5,0) N N N The number of seconds elapsed between FUELING TRANSACTION completing and being sold at a
point of sale.
ID_STR_RT Identity int N Y Y A unique retailer assigned identifier for a RetailStore
FuelItem
Definition: AS_ITM_FUEL
Definition: A sub-type of STOCK ITEM for Petroleum products such as Petrol, Gas, Diesel and Kerosene. It is purchased in bulk and blended, measured and dispensed by a
FUELING POINT..
CD_PDT_GP Code varchar(20) N N Y Specifies the product group of the Item for calculation of temperature corrected volume. Defined by
ASTM D 1250 table 54 or American Petroleum Institute (API) Std 2540 table 6
QU_DNSTY_RFC Quantity decimal(9,2) N N Y The reference density at reference temperature of the product, used for calculating the volume
correction factor. Cf. ASTM D 1250 table 54 or American Petroleum Institute (API) Std 2540 table 6
FuelItemPrice
Definition: CO_PRC_ITM
Definition: A sparse array allowing combinations of Time, Forecourt Service Level, Price Level and Fueling Point affect the current retail price of an ITEM. The available set of
valid prices for all ITEMs dispensed by a FUELLING POINT are downloaded into the FUELING POINT, this entity provides a mapping from all the parameters to the set of
available prices.
ID_PRC_ITM Identity int Y N N A unique identifier for the ItemPrice.
ID_LV_SV Identity int N Y N A unique identifier for the service level for which this FuelItemPrice is valid
ID_LV_PRC Identity int N Y Y A unique identifier for the price level for which this FuelItemPrice is valid
ID_GP_TM Identity int N Y Y A unique identifier for the time group for which this FuelItemPrice is valid
NM_PRC_ITM Name varchar(40) N N Y A descriptive short name that people use to identify the ItemPrice
SC_ITM_PRC Code2Status varchar(20) N N Y The current status of the ItemPrice entry. Possible values include Active, InActive and Pending.
EF_PRC_ITM DateCalendar datetime N N Y The calendar day this ItemPrice becomes active
EP_PRC_ITM DateCalendar datetime N N Y The calendar day this ItemPrice becomes inactive
MO_PRC_ITM MoneyShortRetail decimal(7,2) N N Y The price per unit for this FuelItem when all the other parameters have been satisfied.
FuelPriceLevel
Definition: CO_LV_PRC
Definition: A collection of price levels, which are merely parameters to the ITEM PRICE structure for fuel prices. Examples are "Cash Price ", "Credit Price "
ID_LV_PRC Identity int Y N N A unique identifier for the price level
NM_LV_PRC Name varchar(40) N N Y A human readable name for the price level
FuelPump
Definition: AS_PMP_FUEL
Definition: The piece of EQUIPMENT on the forecourt that houses one or more FUELING POINTs
ID_FUEL_PMP Identity int Y N N A unique identifier for the FuelPump
ID_EQ Identity int N Y Y The fixed asset number assigned by the retailer for this particular piece of equipment.
FuelSalesLineItem
Definition: TR_LTM_SLS_FUEL
Definition: A line item component of a RETAIL TRANSACTION that records the collection of money in return for the fuel dispensed by a FUELLING TRANSACTION.
ID_PNT_FUEL Identity int N Y Y A unique identifier for the FuelingPoint at a particular retail store
SC_SLS_FUEL Code2 varchar(20) N N N A status code denoting the mode of the Fuel Sale. Possible values are: Prepay: Where the
FuelSaleLineItem happens before the FuellingTransaction PostPay: Where the FuelSaleLineItem
happens after the Fuelling Transaction PrepayRefund: Where the FuelSaleLineItem happens after a
Prepay FuelSaleLineItem and the matching FuellingTransaction did not use all of the money
FuelServiceLevel
Definition: CO_LV_SV
Definition: A collection of service levels, which are merely parameters to the ITEM PRICE structure for fuel prices. Examples are "Full Service " & "Self Service "
ID_LV_SV Identity int Y N N A unique identifier for the service level
NM_LV_SV Name varchar(40) N N Y A human readable name for the service level
FundsReceiptTransaction
Definition: TR_RCV_FND
Definition: A type of FINANCIAL ACCOUNTING TRANSACTION that records a cash receipt (with an offsetting miscellaneous income).
ID_RPSTY_TND Identity int N Y Y The unique identifier for the TENDER RESPOSITORY.
RC_RCV_DSB Code2 char(2) N Y Y The reason code for the DISBURSEMENT or the FUNDS RECEIPT.
ID_PRTY_FND_RCV Identity int N N Y The identifier for the party who submitted the FUNDS RECEIPT.
GiftCertificate
Definition: DO_CF_GF
Definition: A certificate with a face monetary value issued by a store for subsequent exchange for merchandise. A GIFT CERTIFICATE when sold to a customer represents a
current liability that is carried until the GIFT CERTIFICATE is redeemed or until it is aged to the point where the store declares it invalid/expired.
ID_STR_ISSG Identity int Y N N A unique store number reference to identify the RETAIL STORE that issued the GIFT CERTIFICATE.
ID_NMB_SRZ_GF_CF Name varchar(40) Y N N The serial number that uniquely identifies a GIFT CERTIFICATE.
ID_CT Identity int N Y Y A unique identifier for a customer.
TY_GF_CF Code2 char(2) N Y N Identifies a gift certificate type.
TY_ISS_GF_CF Code2 char(2) N N Y A code to denote how GIFT CERTIFICATEs are issued by the RETAIL STORE, e.g. embossed or
printed at the point of sale.
TS_ISS_GF_CF TimeStampEffective datetime N N Y The time and date when the gift certificate was issued by the RETAIL STORE to the CUSTOMER.
DC_EP_GF_CF DateCalendar datetime N N Y The expiration date when the GIFT CERTIFICATE can no longer be tendered.
MO_VL_FC_GF_CF Money decimal(14,3) N N N The monetary value printed or embossed on the GIFT CERTIFICATE.
MO_BLNC_UNSP Money decimal(14,3) N N N The monetary value of the unspent amount outstanding on a specific GIFT CERTIFICATE.
LU_DPSN_UNSP_BLNCCode2 char(2) N N Y A code denoting how any unspent balance is to be treated when the GiftCertificate is redeemed.
GiftCertificateClass
Definition: CO_CLS_GF_CF
Definition: Defines a class of gift certificates and establishes the business rules governing their issuance and redemption.
TY_GF_CF Code2 char(2) Y N N Identifies a gift certificate type.
DE_TYP_GF_CF DescriptionShort varchar(255) N N Y Describes a gift certificate type
NM_AF_BSN_GF_CF Name varchar(40) N N Y Identifies the business affiliate (i.e. a mall, another peer store, a union, etc.) on whose behalf this type
of gift certificate is set up.
QU_DY_RDM_PRD QuantityDayCount decimal(3,0) N N N Defines the number of days this gift certificate remains outstanding and redeemable.
ID_FRM_GF_CF Identity int N N Y Identifies the format and type of paper used to print this type of gift certificate.
DP_BLNC_UNSP_GF_CF Code4 char(4) N N Y Defines how the unspent balance for a gift certificate is to be handled. Options are to pay the balance
back to the customer as cash, issue a 2nd gift certificate for the remaining balance, etc.
GiftCertificateLineItem
Definition: TR_LTM_GF_CF
Definition: A type of RETAIL TRANSACTION LINE ITEM that records the sale of redeemable form of tender for a predetermined monetary value of sellable merchandise in the
store. Creates a liability for the retailer in the amount denoted on the face value of the certificate.
ID_STR_ISSG Identity int N Y Y A unique store number reference to identify the RETAIL STORE that issued the GIFT CERTIFICATE.
ID_NMB_SRZ_GF_CF Name varchar(40) N Y N The serial number that uniquely identifies a GIFT CERTIFICATE.
LU_NMB_SRZ_SC_KYCode2 char(2) N N Y A code that indicates whether the serial number for the gift certificate was keyed or scanned.
GiftCertificateTenderLineItem
Definition: TR_LTM_GF_CF_TND
Definition: A type of TENDER LINE ITEM that records the specifics about a GIFT CERTIFICATE redeemed as part of settling a transaction.
ID_NMB_SRZ_GF_CF Name varchar(40) N Y Y The serial number that uniquely identifies a GIFT CERTIFICATE.
GiftRegisteredItem
Definition: AS_ITM_GF_RGST
Definition: A customers selection of an item for inclusion in his or her gift registry.
QU_ITM_DR QuantityShortCount decimal(3,0) N N N The quantity of ITEMs that are asked for in the GIFT REGISTRATION.
GiftRegistryLineItem
Definition: AS_LTM_GF_RGST
Definition: A linkage of ITEMs that have been registered for and items that have been purchased.
QU_LTM_GF_RGST Quantity decimal(9,2) N N Y The number of items purchased for the GIFT REGRISTRATION on this line item.
GroupResourceAccess
Definition: CO_ACS_GP_RS
Definition: GROUP RESOURCE ACCESS defines a specific Groups access privileges to a given RESOURCE.
ID_GP_WRK Identity int Y Y N A unique identifier for a work classification group to which EMPLOYEEs are assigned.
ID_RS Identity int Y Y N A code to uniquely identify a given application or application component.
FL_ACS_GP_RD Code2 char(2) N N Y A flag to indicate whether read access is granted to the referenced GROUP for the corresponding
RESOURCE identified in this record.
FL_ACS_GP_WR Code2 char(2) N N Y A flag to signify whether write access is granted to the referenced GROUP for the corresponding
RESOURCE identified in this record.
GroupSelectItem
Definition: AS_ITM_GP_SEL
Definition: An item which is a group of items, only one of which will be sold. The choice of which item is made by the customer at the POS.
HourlyEmployee
Definition: PA_EM_HR
Definition: An employee that is compensated based on hours worked.
InventoryAdjustmentDocument
Definition: DO_ADJT_INV
Definition: A document that captures an increment or decrement to an items unit on hand count and/or financial valuation.
ID_DCM_INV_ADJT Identity int Y N N A unique identifier for an INVENTORY ADJUSTMENT DOCUMENT which lists adjustments between
actual and notified amounts.
InventoryAdjustmentLineItem
Definition: TR_LTM_INV_ADJ
Definition: The detail line item on the INVENTORY ADJUSTMENT DOCUMENT which applies an increment or decrement to the ITEMs unit on hand and /or the financial
valuation.
ID_DCM_INV_ADJT Identity int Y Y N A unique identifier for an INVENTORY ADJUSTMENT DOCUMENT which lists adjustments between
IC_INV_ADJT LineNumber smallint Y N N The line number for a specific line item adjustment.
RC_INV_ADJT Code2 char(2) N N Y The reason code for the line item adjustment.
InventoryCondition
Definition: CO_CN_INV
Definition: A reference entity type that defines permissible inventory conditions (e.g. damaged, shorted, etc.). An inventory condition applies to inbound, stored and outbound
merchandise and is important in establishing the value of that merchandise.
LU_CN_INV Code4 char(4) Y N N A code which uniquely identifies the condition for inventory being received, stored or shipped out by a
retail store. These codes will signify good, broken, damaged, wrong, partial shipment, overage, etc.
This code relates to the UCC code, Receiving Condition Code, data element 412.
DE_CN_INB_INV DescriptionShort varchar(255) N N Y A textual description of the condition of the shipment.
InventoryControlDocument
Definition: DO_CTL_INV
Definition: A written or printed paper, or digital equivalent, that evidences an exchange in the ownership of merchandise or supply STOCK ITEMs.
ID_ICD Identity int Y N N The reference number that uniquely identifies the INVENTORY CONTROL DOCUMENT.
ID_SP_PCKG Identity int N Y Y the unique identifier for the packing slip, typically the reference number.
ID_CNY Identity int N Y Y The unique identifier of the CURRENCY.
ID_FC Identity int N Y Y The unique reference for the facility that originated the supply. This facility is a generic term that will
normally apply to a warehouse or distribution center.
TS_CMPL TimeStampAudit datetime N N N The time and date when the processing of the inventory control document was completed.
TY_ICD Code2 char(2) N N Y This code identifies the type of INVENTORY CONTROL DOCUMENT.
ID_PRTY_TO_ICD Identity int N N Y The name and address of the party to whom the inventory control is directed for the purposes of
receiving, transferring or ordering of merchandise.
ID_PRTY_FM_ICD Identity int N N Y The party that originated the inventory control document.
TS_CRT_ICD TimeStampAudit datetime N N N The time and date when the inventory control document was originally created.
DC_UPDT_LS_ICD DateCalendar datetime N N Y The date when the inventory control document was last updated by the store.
LU_TRMCD_ICD Code4 char(4) N N Y This code denotes the relevant terms and conditions pertaining to this particular inventory control
document, eg the supplier must be notified of any shortages within three days.
LU_DF_RCV_ICD Code2 char(2) N N Y A code to indicate the reason for the difference between the quantity ordered and quantity shipped.
This code relates to the UCC code, Shipment/Order Status Code, data element 368.
DC_PYM_DFR_ICD DateCalendar datetime N N Y The deferred payment date on which the RETIL STORE has to make its payment. Deferred payments
are an inducement to retailers to accept certain stock.
DC_DV_EXP_ICD DateCalendar datetime N N Y The expected delivery date of the shipment, to which this particular inventory control document relates.
DC_DV_ACT_ICD DateCalendar datetime N N Y The actual delivery date of the shipment, to which this particular inventory control document relates.
DC_SPR_EXP_SHP_ICD DateCalendar datetime N N Y The expected arrival date of the shipment, to which this particular inventory control document relates.
DC_SPR_ACT_SHP DateCalendar datetime N N Y The actual ship date of the shipment, to which this particular inventory control document relates. The
actual date of the to which this particular inventory control document relates, is expected to be shipped
from the originating company or store.
QU_DSCP_ICD Quantity decimal(9,2) N N N The discrepancy count between the units recorded on the INVENTORY CONTROL DOCUMENT and
the actual units counted.
ID_ORGR_ICD Identity int N N Y Identifies the point of origin for this inventory control document. An originator may be a program (for
automatically generated documents) or a person.
DP_CHG_FRGT_ICD Code4 char(4) N N Y A code that assigns responsibility for payment of the freight and insurance charges for this inventory
control document to the store or other party in the transaction.
ID_CNTRT Identity int N N Y The contract against which the delivery has been made.
ID_SRZ_FRM String varchar(20) N N Y An idenfier for this document, usually preprinted on the form stock prior to being filled out.
InventoryControlDocumentAllowanceLineItem
Definition: TR_LTM_ICD_ALW
Definition: A type of INVENTORY CONTROL DOCUMENT LINE ITEM that records allowances applicable to the whole INVENTORY CONTROL DOCUMENT.
IC_LN_ICD LineNumber smallint Y Y N The INVENTORY CONTROL DOCUMENT LINE NUMBER specifies the line number within the
INVENTORY CONTROL DOCUMENT.
MO_ITM_LN_ALW Money decimal(14,3) N N N The monetary allowance made by the supplier against a specific line on the INVENTORY CONTROL
DOCUMENT.
TY_ITM_LN_ALW Code2 char(2) N N Y This code defines the type of allowance. For ARTS purposes the UCC-defined codes, data elements
150 and 340, are used as the basis for the domain of this attribute.
RC_ALW_IDC Code2 char(2) N N Y The reason code for applying the allowance.
ID_ALW_SPR Identity int N N Y The number assigned by the supplier referencing an allowance, promotion or deal.
ID_FRM_RTL String varchar(20) N N Y An idenfier for this document, usually preprinted on the form stock prior to being filled out.
InventoryControlDocumentChargeLineItem
Definition: TR_LTM_ICD_CHG
Definition: A type of INVENTORY CONTROL DOCUMENT LINE ITEM that records charges applicable to the whole INVENTORY CONTROL DOCUMENT.
MO_ITM_LN_CHG Money decimal(14,3) N N N The monetary charge levied against a specific line on the INVENTORY CONTROL DOCUMENT.
TY_ITM_LN_CHG Code2 char(2) N N Y This code defines the type of charge. For ARTS purposes the UCC-defined codes, as per data
elements 150 and 340, are used as the basis for the domain of this attribute.
RC_CHG_IDC Code2 char(2) N N Y The reason code for the levy of this charge, eg price labeling the merchandise prior to shipment.
ID_CHG_ICD_SPR Identity int N N Y The number assigned by the supplier referencing the charge.
InventoryControlDocumentFreightLineItem
Definition: TR_LTM_ICD_FRGT
Definition: A type of INVENTORY CONTROL DOCUMENT LINE ITEM that records the type and amount of freight cost incurred on an INVENTORY CONTROL
DOCUMENT.
LU_CST_FRGT Code2 char(2) N N Y A code to signify whether the freight cost is met by the retailer or supplier.
MN_CST_FRGT Money decimal(14,3) N N N The freight charges.
InventoryControlDocumentLineItem
Definition: TR_LTM_ICD
Definition: A detail line on an INVENTORY CONTROL DOCUMENT that identifies the STOCK ITEM, and unit of measure exchanged, or the freight, charges, taxes, and
allowances applicable to a particular inventory control event and action.
IC_LN_ICD LineNumber smallint Y N N The INVENTORY CONTROL DOCUMENT LINE NUMBER specifies the line number within the
TY_ITM_DCM_LN Code2 char(2) N N Y The DOCUMENT LINE ITEM CODE TYPE CODE specifies the item type.
InventoryControlDocumentMerchandiseLineItem
Definition: TR_LTM_ICD_MR
Definition: A type of INVENTORY CONTROL DOCUMENT LINE ITEM that identifies and records the number of retail and ship units and unit cost for a STOCK ITEM being
received, returned, transferred or shipped on an INVENTORY CONTROL DOCUMENT.
ID_LCN Identity int N Y Y A unique system assigned identifier for a specific InventoryLocation within the retail enterprise.
LU_CN_INV Code4 char(4) N Y Y A code which uniquely identifies the condition for inventory being received, stored or shipped out by a
retail store. These codes will signify good, broken, damaged, wrong, partial shipment, overage, etc.
This code relates to the UCC code, Receiving Condition Code, data element 412.
ID_ICD_PCH Identity int N Y Y The reference number that uniquely identifies the INVENTORY CONTROL DOCUMENT.
TY_CST_UN Code2 char(2) N N Y Defines the unit type the owned attribute costs are assigned to for this item. Valid unit types include:
QU_ITM Quantity decimal(9,2) N N N A count of all item units (in the item-cost-per-unit-type) received or shipped in this document line item.
QU_UN_DM Quantity decimal(9,2) N N N A count of the damaged item units (in the item-cost-per-unit-type) received or shipped in this document
line item. This count when subtracted from the document-line-item-unit-count yields the number
received or shipped in good condition.
TC_UN_BS Money decimal(14,3) N N N The cost of the merchandise by itself exclusive of shipping and handling, duties and import fees,
insurance, taxes and other logistic expenses that a store incurs to bring the item into the store.
CP_UN_NT Money decimal(14,3) N N N The cost of the merchandise by itself plus shipping and handling, duties and import fees, insurance,
taxes and other logistic expenses that a store incurs to bring the item into the store; and less any
discounts or allowances allocated to the line item (hence the term NET).
QU_UN_SHP Quantity decimal(9,2) N N N The count of units shipped versus the receiving count. This is subtracted from the
document-line-item-unit-count to yield an over/under variance between what a supplier said was
shipped and what was counted and received at by the stores staff.
RC_CHN_IDC Code2 char(2) N N Y A code that defines the reason for the difference between the quantity ordered and quantity shipped for
a line item.This code relates to the UCC code, Line Item Change Reason Code, data element 892.
FL_ITM_PRPTD Flag bit N N Y A flag indicating whether this line item has been preticketed by the SUPPLIER.
FL_ITM_PCD Flag bit N N Y A flag indicating whether or not the item is prepriced by the manufacturer.
InventoryControlDocumentMerchandiseLineItemModifier
Definition: CO_LTM_ICD_MR_MDFR
Definition: A modifier that applies an allowance or a charge to a single line item on an INVENTORY CONTROL DOCUMENT.
IC_MDFR_LN LineNumber smallint Y N N A reference number against which a specific instance of a modifier is applied.
MO_MDFR_LN Money decimal(14,3) N N N The monetary amount amendment resulting from the INVENTORY DOCUMENT MERCHANDISE
LINE ITEM MODIFIER.
PE_MDFR_LN Percent decimal(5,2) N N N The percent amendment resulting from the INVENTORY DOCUMENT MERCHANDISE LINE ITEM
MODIFIER.
RC_MDFR_LN Code2 char(2) N N Y The code which denotes the reason for the change made to a specific INVENTORY CONTROL
DOCUMENT MERCHANDISE LINE ITEM.
DP_MDFR_LN Code4 char(4) N N Y The code to denote as to how the amendment resulting from the INVENTORY DOCUMENT
MERCHANDISE LINE ITEM MODIFIER will be accounted for within the STOCK LEDGER.
LU_MDFR_ALW_CHG Code2 char(2) N N Y A code to denote whether a charge or allowance is applied to a specific merchandise control document
line.
InventoryControlDocumentMerchandiseTaxLineItem
Definition: TR_LTM_ICD_MR_TX
Definition: A Line Item to record taxation implications of a single INVENTORY CONTROL DOCUMENT MERCHANDISE LINE ITEM rather than an entire INVENTORY
CONTROL DOCUMENT
government body.
MO_TXBL MoneyShortRetail decimal(8,3) N N Y The monetary value for which tax must be paid for the INVENTORY CONTROL DOCUMENT
MERCHANDISE LINE ITEM
MO_TX MoneyShortRetail decimal(8,3) N N Y The amount of tax to be paid for the INVENTORY CONTROL DOCUMENT MERCHANDISE LINE
ITEM
MO_TX_EXM MoneyShortRetail decimal(8,3) N N Y The amount of tax that does not have to be paid for the INVENTORY CONTROL DOCUMENT
MERCHANDISE LINE ITEM
RC_TX_EXM Code2 char(2) N N Y A code denoting the reason why the tax that should ve been paid was exempt for the INVENTORY
CONTROL DOCUMENT MERCHANDISE LINE ITEM
InventoryControlDocumentReference
Definition: CO_RFC_ICD
Definition: Defines instances where one inventory control document refers to one or more other inventory control documents.
ID_ICD_BY Identity int Y Y N The reference number that uniquely identifies the INVENTORY CONTROL DOCUMENT.
ID_ICD_TO Identity int Y Y N The reference number that uniquely identifies the INVENTORY CONTROL DOCUMENT.
InventoryControlDocumentTaxExemptionModifier
Definition: TR_LTM_ICD_MDFR_TX
Definition: A line item modifier to the InventoryControlDocumentTaxLineItem that provides supplementary data regarding tax exemptions that have been applied.
MO_TX_EXM MoneyShortRetail decimal(8,3) N N Y The monetary amount of the tax exemption
RC_TX_EXM Code2 char(2) N N Y A reason code for the tax exemption. Typically the CUSTOMER belongs a special group, such foreign
diplomats, religious bodies, etc. The bearer must have a certificate to qualify for the tax exemption.
AUTHORITY.
InventoryControlDocumentTaxLineItem
Definition: TR_LTM_ICD_TX
Definition: A type of INVENTORY CONTROL DOCUMENT LINE ITEM that records sales, use and value added taxes applicable to the whole INVENTORY CONTROL
DOCUMENT.
ID_ATHY_TX Identity int N Y Y A specific TAX AUTHORITY that establishes the tax rate. The TAX AUTHORITY is normally a
government body.
ID_GP_TX Identity int N Y Y A unique retailer assigned identifier for the TaxGroup
MO_TXBL MoneyShortRetail decimal(8,3) N N Y The taxable amount for which tax is to be paid
MO_TX MoneyShortRetail decimal(8,3) N N Y The amount of tax that is being paid
InventoryLocation
Definition: LO_LCN
Definition: A floor and an area on a floor inside a RETAIL STORE that is explicitly identified for tracking inventory, sales activity and other business activities that are important
to measuring a stores performance.
ID_LCN Identity int Y N N A unique system assigned identifier for a specific InventoryLocation within the retail enterprise.
ID_LCN_PRNT Identity int N Y Y A unique system assigned identifier for the parent InventoryLocation of the nominated
InventoryLocation within the retail enterprise.
ID_LV_LCN Identity int N Y N A unique identifier for the location level of the parent InventoryLocation.
NM_LCN Name varchar(40) N N Y The name designated to identify the LOCATION, eg first floor sales area.
QU_SZ_LCN Quantity decimal(9,2) N N N The size of the location in an appropriate UnitOfMeasure
CD_LCN_FNC Code6 char(6) N N Y A code that describes what business activities and functions are performed in a specific location.
Activities may include: ADMIN - Administration functions (no stock or customer services are handled
here) DISPLY - Merchandise display (stock is presented to the customer for sale) CUSTSVC -
Customer service - Customer merchandise may be picked up, returned, etc. RETADJ - Returns and
adjustments - where a customer may return merchandise for a credit or refund. Where customers may
request price adjustments (e.g. when they bought a sale item just before it went on special) STOCKPT
- Stock Point - Out of customer sight location where merchandise is stored, counted and tracked at a
physical and financial level. This could be the "back room " (like you see in shoe stores) or it could be a
receiving dock, etc. RECV - Receiving or merchandise intake location where merchandise is physically
unloaded and accepted by the retail store into its inventory (or at least acknowledged). And lots more
depending on the retailer. These codes should indicate which locations involve merchandise sales and
tracking. Based on the examples above DISPLY, STOCKPT, CUSTSVC, RECV and RETADJ all
represent types of locations that involve the storage, sale or return of merchandise. There are many
additional functions and codes that might be assigned depending on the retailer. As Internet sales
open up, the concept of location changes. Instead of physical locations, merchandise tracking may be
by URL and HTML name. The goal is still to understand WHERE merchandise is moving and where
the ownership gets transferred from one party to another.
CD_LCN_SCTY_CLS Code6 char(6) N N Y Defines the level of security required for a specific location. This is to accommodate secured
merchandise like prescription drugs, guns and ammunition, upper end sound and video equipment,
etc.
InventoryLocationEnvironmentClass
Definition: LO_ENV_CLS
Definition: A cross reference of LOCATIONS to the class of environmental propertiesfor that location. For instance, this might describe humidity, temperature, or lighting
restrictions or requirements
CD_CLS_ENV Code6 char(6) Y Y N A code that identifies a class environmental properties of a location. For instance, this might describe
humidity, temperature, or lighting restrictions or requirements
InventoryLocationLevel
Definition: LO_LV_LCN
Definition: A group of locations at the same hierarchical level within the location hierarchy.
ID_LV_LCN Identity int Y N N A unique identifier for a specific location level.
DE_LV_LCN DescriptionNarrative text N N N A narrative that describes a location level.
FL_CTL_STKG Flag bit N N Y A flag that indicates whether or not a LOCATION LEVEL will be used to track stock ledger items. If a
LOCATION LEVEL has a stock-ledger-control-flag of N , no lower levels can have a
stock-ledger-control-flag of Y .
InventoryTransactionJournalEntry
Definition: JL_JE_TR_INV
Definition: A list of inventory retail-selling-unit receipts and issues that is applied to an ITEM - LOCATION STOCK LEDGER ACCOUNT stock-on-hand and is directly
traceable to an inventory control event, inventory control document and document line item.
ID_JR Identity int Y N N A unique identifier for the INVENTORY TRANSACTION JOURNAL.
ID_STRGP Identity int N Y Y A unique system-assigned identifier for the RetailStoreGroup
AI_TRN Identity int N Y N A unique, non-significant, automatically assigned sequential number used to identify a TRANSACTION
ID_WS Identity int N Y N The unique identifier for the WORKSTATION, typically the serial number.
DC_DY_BSN DateCalendar datetime N Y N The calendar date of the BusinessDay.
AI_LN_ITM LineNumber smallint N Y N The sequence number of line item within the context of this RetailTransaction.
ID_DCM_INV_ADJT Identity int N Y Y A unique identifier for an INVENTORY ADJUSTMENT DOCUMENT which lists adjustments between
IC_INV_ADJT LineNumber smallint N Y Y The line number for a specific line item adjustment.
IC_CNT_PHY_ITM Identity int N Y Y The physical count line item.
ID_DCM_PHY_CNT Identity int N Y Y The identifier for the physical count document on which the actual item counts are recorded.
IC_LN_ICD LineNumber smallint N Y Y The INVENTORY CONTROL DOCUMENT LINE NUMBER specifies the line number within the
ID_ICD Identity int N Y Y The reference number that uniquely identifies the INVENTORY CONTROL DOCUMENT.
DC_ENR_JR DateCalendar datetime N N Y The accounting date within which the INVENTORY TRANSACTION JOURNAL ENTRY is recorded.
TS_ENR_JR TimeStampAudit datetime N N N The time and date when the INVENTORY TRANSACTION JOURNAL ENTRY is recorded.
QU_UN_RT Quantity decimal(9,2) N N N The actual number of units of a specific ITEM.
LU_ACTN_STK_LDG Code4 char(4) N N Y Defines the action taken against a specific stock ledger item location by the source transaction.
RP_SLS_CRT Money decimal(14,3) N N N The actual monetary amount charged to the customer in exchange for ITEMs.
MO_MKD_RT_UN Money decimal(14,3) N N N The monetary amount of the markdown applied to the retail price.
MO_ALW_RT_UN Money decimal(14,3) N N N The allowance permitted between the actual count and the inventory on hand unit amount.
ID_STR_RT Identity int N Y N A unique retailer assigned identifier for a RetailStore
Item
Definition: AS_ITM
Definition: The lowest level of merchandise for which inventory and sales records are retained within the retail store. It is analogous to the SKU ( Stock Keeping Unit).
ID_ITM Identity int Y N N The retailers SKU or unique item identifier for items sold or returned.
ID_ITM_SL_PRC Identity int N Y Y A unique system assigned identifier for the ItemSellingPrices.
ID_RU_ITM_SL Identity int N Y Y A unique system assigned identifier for the ItemSellingPrices.
ID_DPT_PS Identity int N Y Y A unique system-assigned identifier for the POSDepartment
ID_LN_PRC Identity int N Y Y A unique identifier for this price point.
ID_MRHRC_GP Identity int N Y Y Unique identifier for a merchandise structure.
NM_BRN Name varchar(40) N Y Y A unique name to denote a class of ITEMs as a product of a single supplier or manufacturer. The
FL_AZN_FR_SLS Flag bit N N Y A flag to indicate that the RETAIL STORE is authorized to stock this particular ITEM.
FL_ITM_DSC Flag bit N N Y A flag to indicate whether this ITEM can be discounted.
FL_ADT_ITM_PRC Flag bit N N Y A flag to denote whether this ITEM was validated (scanned) during verification of the ITEM table.
LU_EXM_TX Code2 char(2) N N Y A code to denote the tax exemption status from sales and use tax. The codes refer to the UCC code,
Tax Exempt Code, defined in data element 441.
LU_ITM_USG Code2 char(2) N N Y This code defines how this item may be used within a store. Usage is a function of how an item may be
consumed or disposed of by the store.
NM_ITM Name varchar(40) N N Y The name by which the ITEM is known.
DE_ITM DescriptionShort varchar(255) N N Y The textural description of the ITEM and its characteristics.
TY_ITM Code4 char(4) N N Y This code indicates whether the item is a STOCK ITEM or SERVICE ITEM.
LU_KT_ST Code2 char(2) N N Y This code signifies this ITEM is provided as a kit which has to made up either by the customer or by
the store at an additional cost.
FL_ITM_SBST_IDN Flag bit N N Y An ITEM for which there is a substitute available for sale within the RETAIL STORE.
LU_CLN_ORD Code2 char(2) N N Y A code to signify that this ITEM is ordered as part of a collection of ITEMs.
ItemAlternateIdentity
Definition: ID_IDN_ITM_ALT
Definition: Defines an alternative identifier for a STOCK ITEM entity type instance. The alternative identifier is assigned by the retail store.
ID_ITM_RT_ALT Identity int Y N N An alternate identifying number or code for an item.
ED_CLR Code4 char(4) N Y Y A code to identify the color. The assumption is that the retailer will adopt the standards as designated
by the NRF, created to facilitate the exchange of data between vendors and retailers
ED_SZ Code6 char(6) N Y Y A code to designate the size of the ITEM. It is proposed to use the 5 apparel and miscellaneous coding
structure as specified by the NRMA to facilitate data interchange between vendors and retailers. This
code permits the use of both standard and proprietary coding format.
LU_STYL Code4 char(4) N Y Y A code that uniquely identifies the specific appearance type or variety in which an APPAREL ITEM is
available.
LU_USG_RT_ITM_ALTCode2 char(2) N N Y A code that defines how this ITEM ALTERNATE IDENTITY is to be used.
DE_ITM_RT_ALT DescriptionShort varchar(255) N N Y The textual description for the alternate ITEM.
QU_PCK_ALT_CS_CDQuantity decimal(9,2) N N N The number of units in the case for the alternate ITEM.
ItemChoice
Definition: CO_CHC_ITM
Definition: A mapping from a parent GroupSelectItem to Item denoting one of the choices that may be made by the customer at the time of sale.
ID_ITM_MBR Identity int Y Y N The retailers SKU or unique item identifier for items sold or returned.
ItemCollection
Definition: CO_CLN_ITM
Definition: An optional relationship between an item and its components and affiliates where the components consist of other ITEMs. Note that this data structure is intended to
support one and only one level of decomposition and/or affiliation between an ITEM parent and its ITEM children.
ID_ITM_CLN Identity int Y Y N The retailers SKU or unique item identifier for an Item which is a collection of other items.
ID_ITM_MBR Identity int Y Y N The retailers SKU or unique item identifier for an Item which is a member of the collection Item.
AI_ITM_CLN LineNumber smallint N N N Assigns a sequence / sorting order for the items in the collection.
QU_ITM_PR_ASMB Quantity decimal(9,2) N N N The number of individual constituent ITEMs within the ITEM COLLECTION.
PE_BLD Percent decimal(5,2) N N Y The percentage of the parent item that comes from the child item.
ItemCreation
Definition: MA_CRT_ITM
Definition: A type of ITEM - MAINTENANCE EVENT that creates a new ITEM entity and related supporting attributive entities.
ItemDeletion
Definition: MA_DLT_ITM
Definition: A type of ITEM - MAINTENANCE EVENT that deletes an ITEM entity and its associated supporting attributive entities.
ItemDescriptonUpdate
Definition: MA_UPDT_ITM_DSCR
Definition: A type of ITEM - MAINTENANCE EVENT that updates the non-retail price descriptive data for an ITEM and its attributive entities.
ItemElectronicLabel
Definition: AS_LB_ITM_ELTNC
Definition: A type of ITEM LABEL that defines the properties of the electronic shelf labels used to present the current retail price to customers. Electronic labels are small liquid
crystal screens, attached to the front of the display shelf or unit,which convey the current selling price and other information regarding the RETAIL ITEM to the CUSTOMER or
EMPLOYEE. These labels are electronically linked to the store processor. In this way any amendments to the ITEM can be transmitted to the shelf label at the same time they take
effect. This facility ensures that ITEM details and prices on the shelf and store processor are synchronized.
ID_LB Identity int Y Y N A unique identifier for a specific ITEM LABEL.
ItemLabel
Definition: AS_LB_ITM
Definition: A means of conveying information about a RETAIL ITEM to the CUSTOMER and/or EMPLOYEE. This information is available on or adjacent to the ITEM. It may
be in the form of an item tag or paper or electronic shelf label.
ID_LB Identity int Y N N A unique identifier for a specific ITEM LABEL.
TY_LB Code2 char(2) N N Y Identifies the type of label to be created for the associated item maintenance event.
ItemLot
Definition: AS_ITM_LOT
Definition: A batch or group of items. The idenfication of this grouping normally comes from the MANUFACTURER and normally applies to ITEMs that are dependent on
matching of colours or detailed tracking requirements.
ID_ITM_LOT Identity int Y N N An identifier for a LOT of specific ITEMs.
ItemLoyaltyAccountEligibility
Definition: AS_EL_ITM_LYLT_ACN
Definition: A specific items eligibility for loyalty account point accrual.
ItemMaintenanceEvent
Definition: MA_ITM
Definition: A type of DataMaintenanceEvent that results in the creation, update or deletion of an Item.
LU_EV_ITM_MNT Code2 char(2) N N Y Defines the maintenance action taken by this ITEM - MAINTENANCE EVENT against an ITEM.
ItemPriceDerivationRule
Definition: RU_PRDV_ITM
Definition: A type of PRICE DERIVATION RULE that modifies the retail sale unit price amount for an item as read from the PLU and results in a new retail sale unit price that is
presented to the customer and/or used as the new base for compounding price changes. This rule affects prices of the items that triggered the eligibility.
ID_RU_PRDV Identity int Y Y N A identifier for a specific price derivation rule.
CD_RDN_MTH Percent decimal(5,2) N N Y A code denoting the method for calculating the new price for the item. Possible values include, Amount
Reduction, Percent Reduction, New Price, and Cost Price Plus.
CD_RDN_FRM_PRC Code varchar(20) N N Y A code denoting which price is to be used as the base price when calculating the price reduction.
Possible values include: ManufacturerPrice, PermanentSellingPrice, CurrentSellingPrice.
MO_RDN MoneyShortRetail decimal(8,3) N N N The reduction to be appled to the item being marked down, expressed as a dollar amount.
PE_RDN Percent decimal(5,2) N N Y The reduction to be appled to the item being marked down, expressed as a percentage of the original
price
MO_NW_PRC MoneyShortRetail decimal(8,3) N N Y The reduction to be appled to the item being marked down, expressed as the new price for the item.
ItemPriceDerivationRuleEligibility
Definition: CO_EL_ITM_PRDV
Definition: Defines an association between an ITEM and a PRICE DERIVATION RULE and the conditions which govern the application of the associated rule to an item at the
time an instance of the item is recorded as a line item in a sale.
TY_TH Code4 char(4) N N Y A code for the type of threshold wich applies to a price derivation rule eligibility.
QU_TH Quantity decimal(9,2) N N Y A quanity of items within a single merchandise structure level required to be purchased to trigger this
price derivation rule.
MO_TH Money decimal(14,3) N N N A monetary amount within a single merchandise structure level required to be purchased to trigger this
QU_INTV Quantity decimal(9,2) N N N An interval quantiy for which this price derivation rulle eligible.
MO_INTV Money decimal(14,3) N N N An interval monetary armount for which this price derivation rulle eligible.
QU_LM Quantity decimal(9,2) N N N The maximum number of items within a merchanidise structure level for which this price deriviation rule
is eligible.
MO_LM Money decimal(14,3) N N N The maximum monetary amount within a merchanidise structure level for which this price deriviation
rule is eligible.
ItemPriceMaintenance
Definition: MA_PRC_ITM
Definition: A type of ITEM MAINTENANCE EVENT that updates the current retail price of an item or creates, updates or deletes a PRICE DERIVATION RULE.
TY_PRC_MNT Code2 char(2) N N Y A code to denote how the permanent price is actioned, ie global or individual ITEM amendment.
ItemSalesProhibitionPeriodRule
Definition: RU_PRD_ITM_SLS_PRH
Definition: A rule that identifies specific days of the week and/or special dates and time periods during which the sale of an ITEM is prohibited.
WD_SRT_RST DateFiscalDay char(1) N N Y A code to denote the start date in the week for the item sales restriction.
WD_END_RST DateFiscalDay char(1) N N Y A code to denote the end date in the week for the item sales restriction.
TM_SRT_RST Time datetime N N Y A code to denote the start time on a specified day for the item sales restriction.
TM_END_RST Time datetime N N Y A code to denote the end time on a specified day for the item sales restriction.
ItemSalesSummary
Definition: LE_SMY_ITM_SLS
Definition: Sales accumulations for RETAIL ITEMS by different FISCAL PERIODs.
MO_SLS_ITM Money decimal(14,3) N N N The monetary value of ITEMS sold during the REPORTING PERIOD
QU_SLS_ITM QuantityShortCount decimal(3,0) N N N The number of ITEMs sold during the REPORTING PERIOD
QU_SLS_TRN QuantityTransactionCount decimal(7,0) N N N The number of TRANSACTIONS featuring the sale of this ITEM during the REPORTING PERIOD
MO_RTN_ITM Money decimal(14,3) N N N The monetary value of ITEMS returned during the REPORTING PERIOD
QU_RTN_ITM QuantityShortCount decimal(3,0) N N N The number of ITEMs returned during the REPORTING PERIOD
QU_RTN_TRN QuantityTransactionCount decimal(7,0) N N N The number of TRANSACTIONS featuring the return of this ITEM during the REPORTING PERIOD
QU_DSC_ITM Money decimal(14,3) N N N The monetary value of all ordinary discounts applied to this ITEM during the REPORTING PERIOD
MO_DSC_ITM QuantityShortCount decimal(3,0) N N N The number of ITEMs that had an ordinary discount applied to during the REPORTING PERIOD
QU_DSC_TRN QuantityTransactionCount decimal(7,0) N N N The number of TRANSACTIONS featuring the application of ordinary discounts to this ITEM during the
REPORTING PERIOD
MO_DSC_EM_ITM Money decimal(14,3) N N N The monetary value of all employee discounts applied to this ITEM during the REPORTING PERIOD
QU_DSC_EM_ITM QuantityShortCount decimal(3,0) N N N The number of ITEMs that had an employee discount applied to during the REPORTING PERIOD
QU_DSC_EM_TRN QuantityTransactionCount decimal(7,0) N N N The number of TRANSACTIONS featuring the application of employee discounts to this ITEM during
the REPORTING PERIOD
MO_CPN_STR_ITM Money decimal(14,3) N N N The monetary value of all StoreCoupons presented for this ITEM during the REPORTING PERIOD
QU_CPN_STR_ITM QuantityShortCount decimal(3,0) N N N The number of ITEMs for which StoreCoupons presented during the REPORTING PERIOD
QU_CPN_STR_TRN QuantityTransactionCount decimal(7,0) N N N The number of TRANSACTIONSs during which StoreCoupons were presented for this ITEM during the
REPORTING PERIOD
MO_RFD_STR_ITM Money decimal(14,3) N N N The monetary amount of all Store Refunds applied to this ITEM during the REPORTING PERIOD
QU_RFD_STR_ITM QuantityShortCount decimal(3,0) N N N The number of store refunds that were applied to this ITEM during the REPORTING PERIOD
QU_RFD_STR_TRN QuantityTransactionCount decimal(7,0) N N N The number of TRANSACTIONS during which store refunds were applied to this ITEM during the
REPORTING PERIOD
MO_MKD_ITM Money decimal(14,3) N N N The total value of ITEM markdowns sold within the REPORTING PERIOD.
QU_MKD_ITM QuantityShortCount decimal(3,0) N N N The total number of items marked down within the REPORTING PERIOD.
QU_MKD_TRN QuantityTransactionCount decimal(7,0) N N N The number of TRANSACTIONS during which this ITEM was marked down during the REPORTING
PERIOD
MO_VD_ITM Money decimal(14,3) N N N The total monetary value of items voided items within the REPORTING PERIOD.
QU_VD_ITM QuantityShortCount decimal(3,0) N N N The total number of items voided within the REPORTING PERIOD.
QU_VD_TRN QuantityTransactionCount decimal(7,0) N N N The number of TRANSACTIONS during which this ITEM was voided during the REPORTING PERIOD
ItemSellingPriceHistory
Definition: LE_HST_ITM_SLS_PRC
Definition: The historical archive of the retail-selling unit price at which a given ITEM was actually sold at POS, net of markdowns, markups and other price changes that modify
the cumulative markon for an item.
AI_PRC_RT LineNumber smallint Y N N The reference number that applies to each occurrence of a price change.
TS_PR_EF TimeStampEffective datetime N N Y The date and date on which a specific price change became effective.
TS_PR_END TimeStampExpiration datetime N N Y The date and time when an ITEM price no longer applied.
RP_UN_ITM_HST_SL MoneyShortRetail decimal(8,3) N N N The historical unit retail price of an item associated with an event.
ItemSellingPrices
Definition: RU_ITM_SL_PRC
Definition: The set of prices that re applied to an Item
ID_ITM_SL_PRC Identity int Y N N A unique system assigned identifier for the ItemSellingPrices.
RP_PR_SLS MoneyShortRetail decimal(8,3) N N N The sale unit monetary value of the item which is the original retail minus permanent markdowns taken
against this item.
FL_MKD_ORGL_PRC_PR Flag bit N N Y This flag indicates whether the permanent sale unit retail price amount is the original retail value or the
value after one or more permanent markdowns.
QU_MKD_PR_PRC_PRQuantityTransactionCount decimal(7,0) N N N The number of permanent markdowns taken against this item.
DC_PRC_EF_PRN_RTDateCalendar datetime N N Y The date when the permanent retail price becomes effective. This will impact the stock ledger valuation
(retail method).
RP_SLS_CRT MoneyShortRetail decimal(8,3) N N N The current retail price per sale unit of the item. This monetary amount is used as the basis for deriving
retail price at the point of sale.
TY_PRC_RT Code2 char(2) N N Y Defines the type of retail price represented in the item-current-sale-unit-retail-price-amount. Examples
include marked down merchandise (permanent markdown price), promotional markdown (temporarily
marked down and owned at low.
FL_PRC_RT_PNT_ALWFlag bit N N Y This flag determines whether this ITEM may or may not have an associted price point.
DC_PRC_SLS_EF_CRTDateCalendar datetime N N Y The date on which the item-current-sale-retail-price-amount becomes effective and is used as the
basis for deriving the retail price used at the point of sale.
DC_PRC_SLS_EP_CRTDateCalendar datetime N N Y The date the item-current-sale-unit-retail-price-amount expires and is no longer valid as the basis for
deriving the point of sale price.
RP_PRC_MF_RCM_RTMoneyShortRetail decimal(8,3) N N N The suggested sale unit retail price provided by the items manufacturer.
DC_PRC_MF_RCM_RTDateCalendar datetime N N Y The date the manufacturers suggested retail price becomes effective.
RP_PRC_CMPR_AT_SLS MoneyShortRetail decimal(8,3) N N N Provides the monetary saving that can be gained by the purchase of this ITEM at this time from this
RETAIL STORE. Used as a promotional tool, this saving (normally between the normal selling retail
price and the price shown at the point of sale) is usually printed on the shelf label and the customer
receipt to reinforce the marketing strategy of this retailer.
FL_QTY_PRC Flag bit N N Y Denotes whether the item is priced using Quantity Package Price (Eg: 3 for $0.89)
QU_PCKG_PRC_CRT QuantityShortCount decimal(3,0) N N Y The Quantity part of the current package quantity price (Eg: 3 for $1.00)
RP_PCKG_PRC_CRT MoneyShortRetail decimal(8,3) N N Y The Price part of the current package quantity price (Eg: 3 for $1.00)
QU_PCKG_PRC_PRN QuantityShortCount decimal(3,0) N N Y The Quantity part of the permanent package quantity price (Eg: 3 for $1.00)
RP_PCKG_PRC_PRN MoneyShortRetail decimal(8,3) N N Y The Price part of the permanent package quantity price (Eg: 3 for $1.00)
RP_RTN_UN_PRN_SLSMoneyShortRetail decimal(8,3) N N Y The ordinary or regular price to be refunded when the item is returned by a customer.
RP_RTN_UN_CRT_SLSMoneyShortRetail decimal(8,3) N N Y The crrent price to be refunded when the item is returned by a customer.
ItemSellingRule
Definition: RU_ITM_SL
Definition: A set of commonly used selling rules for Items. Usually this entity will be in a one-to-one relationship with Item, except when each combination of Size/Color/Style of
a particular piece of merchandise are individually assigned to a new SKU for inventory recording purposes but all Sizes/Colors/Styles of that item have the same selling rules.
ID_RU_ITM_SL Identity int Y N N A unique system assigned identifier for the ItemSellingPrices.
LU_GP_TND_RST Code2 char(2) N Y Y A code to denote a specific group of ItemTenderRestrictions which are part of the SellingRule.
ID_MF Identity int N Y Y A unique identifier to denote the ITEM MANUFACTURER.
FC_FMY_MF ProductCodeFamily char(3) N Y Y The UPC designated three digit coupon family code for the manufacturer item.
ID_RU_DS Identity int N Y Y A unique system assigned identifier for the deposit rule which is part of the ItemSellingRule
SC_ITM_SLS Code2Status char(2) N N Y Defines the selling status of the item. Examples include active, discontinued, seasonal, to be
discontinued, held for future release, etc.
DC_ITM_SLS DateCalendar datetime N N Y The date the current item selling status code became effective.
FL_CPN_RST Flag bit N N Y A flag to indicate whether a coupon can be redeemed for this ITEM
FL_CPN_ELTNC Flag bit N N Y A flag to denote whether an electronic coupon us available for this ITEM. The value of the coupon is
automatically applied to the purchase, no coupon media is exchanged.
FL_ENR_PRC_RQ Flag bit N N Y A flag to denote that the retail price is to be manually entered when this ITEM is sold.
FL_ENT_WT_RQ Flag bit N N Y A flag to indicate that the weight of the Item being sold, has to be entered into the system (either
manually or automatically) to derive the retail price.
FL_DSC_EM_ALW Flag bit N N Y A flag that enables or disables price derivation rule eligibility to all employees for this Item.
FL_FD_STP_ALW Flag bit N N Y A flag to inicate whether food stamps can be tendered for this Item.
FL_CPN_ALW_MULTYFlag bit N N Y A flag that enables or disables multiple coupon promotions. Used to enable or disable double or triple
coupon promotions.
QU_UN_BLK_MXM QuantityShortCount decimal(3,0) N N N Defines the maximum number of retail sale units that may be purchased in a single RetailTransaction.
Typically this is used for "rationed " merchandise. (Eg: Nintendo 64 in Christmas 1995)
FL_KY_PRH_RPT Flag bit N N Y A flag to prohibit the use of the Repeat key when selling this Item. This flag forces the operator to scan
or separately enter each instance of an Item rather than use a Repeat key to ensure inventory integrity
and avoid arithmetic errors.
FL_PRC_VS_VR Flag bit N N Y A flag to denote whether the operator must verify the price on the Item with the price dervied from the
price lookup table.
FL_PNT_FQ_SHPR Flag bit N N Y A flag to denote that the Item is eligible for frequent shopper points.
QU_PNT_FQ_SHPR Quantity decimal(9,2) N N N The number of frequent shopper points awarded for the purchase of the Item.
FL_KY_PRH_QTY Flag bit N N Y A flag denoting that the Quantity key may not be used when selling this Item.
FL_RTN_PRH Flag bit N N Y A flag to denote whether or not this item may be returned. (Eg: Freezer or Chilled merchandise)
FL_ITM_WIC Flag bit N N Y A flag denoting if this Item is allowed in a WIC transaction
FL_ITM_GWY Flag bit N N Y A flag denoting whether this item may be given away free as part of a promotion.
ItemShelfLabel
Definition: AS_LB_ITM_SH
Definition: A type of ITEM LABEL that provides a means of conveying information about a RETAIL ITEM to the CUSTOMER and/or EMPLOYEE. The label is sited adjacent
to the item, usually in front of the merchandise where it can easily be seen by the customer.
ItemSubstitution
Definition: CO_SBST_ITM
Definition: A 3-way join of Items, MemberID within CombinedItemID may be substituted with SubstituteID.
ID_ITM_CLN Identity int Y Y N The retailers SKU or unique item identifier for an Item which is a collection of other items.
ID_ITM_MBR Identity int Y Y N The retailers SKU or unique item identifier for an Item which is a member of the collection Item.
ID_ITM_SBST Identity int Y Y N The retailers SKU or unique item identifier for items sold or returned.
QU_ITM_SBST QuantityShortCount decimal(3,0) N N Y The number of Substitute Items that constitute a fair replacement of a Member Item within the
Combined Item.
MO_PRC_ADJT MoneyShortRetail decimal(8,3) N N Y A monetary value being the change in price for the Combined Item that occurs when the substitution
occurs.
ItemTenderRestrictionGroup
Definition: CO_RST_ITM_TND
Definition: A collection of ITEMs which share a common restriction on the kind of tender that may be used to pay for them at a store.
LU_GP_TND_RST Code2 char(2) Y N N A code to denote a specific group of ITEM TENDER RESTRICTIONs.
DE_GP_TND_RST DescriptionShort varchar(255) N N Y The description of a group of TENDER RESTRICTIONs which apply to specific ITEMs.
NA_GP_TND_RST Name varchar(40) N N Y The name of a specific group of TENDER RESTRICTIONs which apply to specific ITEMs, eg WICs
cannot be used to purchase tobacco or alcohol ITEMs.
ItemTenderRestrictionRule
Definition: RU_RST_ITM_TND
Definition: An association between ITEM TENDER RESTRICTION GROUP and TENDER which constrains the use of a specific type of tender in the settlement of a sale for a
specific ITEM.
LU_GP_TND_RST Code2 char(2) Y Y N A code to denote a specific group of ITEM TENDER RESTRICTIONs.
NM_RU_TND_RST Name varchar(40) N N Y The rule that prohibits the purchase of certain ITEMs by certain tender types.
DE_RU_TND_RST DescriptionShort varchar(255) N N Y A description of the rule that prohibits the purchase of specific ITEMs with certain tender types.
DC_RST_TND_EF DateCalendar datetime N N Y The date on which the ITEM TENDER RESTRICTION becomes effective.
DC_RST_TND_EP DateCalendar datetime N N Y the date on which the tender restriction on specific STOCK ITEM expires.
SC_RU_TND_RST Code2Status char(2) N N Y A code to indicate whether the restriction rule applies to a certain ITEM or not.
ItemTicket
Definition: AS_TK_ITM
Definition: A type of ITEM LABEL that provides a means of conveying information about a RETAIL ITEM to the CUSTOMER or EMPLOYEE.The ITEM TICKET typically
takes the form of either as an adhesive ticket or hanging tag.
Job
Definition: ST_JOB
Definition: Defines the functions, duties, responsibilities and authority delegated to one or more positions within the retail enterprise.
CD_JOB Code6 char(6) Y N N A unique identifier for a JOB or funcation.
NM_JOB Name varchar(40) N N Y A name or label that describes a JOB.
DE_JOB DescriptionNarrative text N N Y A narrative that describes the functions and responsibilities of a JOB.
KeyCustomer
Definition: PA_KY_CT
Definition: An individual, collection of individuals, company, or public institution that may purchase (and return goods) and services from a retailer and that has a persistent
relationship with that retailer. A persistent relationship is one that exists apart from and transcends specific purchase and return transactions. A persistent relationship is evidenced
by some kind of an account with the retailer.
KeyCustomerClient
Definition: PA_KY_CT_CLNT
Definition: Represents the "super customer " relationship between a KEY CUSTOMER and any other CUSTOMER. This relationship may be that of a personal shopper, a
mechanic that purchase parts on behalf of his/her customer, or any other agent type relationship.
ID_CT_KY Identity int Y Y N A unique identifier for a customer.
TY_CLNT_KY_CT String varchar(20) N N Y A grouping of clients based on the relationship between the key customer and the client.
Language
Definition: CO_LGE
Definition: An infrastructural entity defining Languages for which the system keeps some string translations.
ID_LGE Code4External char(4) Y N N A combination of ISO-639-1 and ISO-3661-1 to denote a lanuage as spoken in a particular country.
NM_LGE Name varchar(40) N N Y The name of the language (in the language itself) eg: English, Francais, Deutch
LicenseSalesRestriction
Definition: RU_RST_LSC_SLS
Definition: A restriction or limitation on the sales of a class of items based on the purchasers profession, license, or other certification.
DE_RST_LSC_SLS String varchar(20) N N Y A narrative that describes the restriction of sales to those holding a license or certification.
LoyaltyAccountAgreement
Definition: DO_ACNT_LYLT_AGMT
Definition: An agreement between the loyalty account member and the enterprise.
ID_PRGM_LYLT Identity int Y Y N A artificial, unique identifier for a loyalty program.
LoyaltyAccountTerm
Definition: DO_ACNT_LYLT_TRM
Definition: Terms and conditions associated with a promotional program.
ID_PRGM_LYLT Identity int Y Y N A system assigned unique identifier for a loyalty program.
ID_ACNT_LYLT_TRM Identity int Y N N A system assigned unique identifier for the Loyalty Program Terms & Conditions being defined.
DE_ACNT_LYLT_TRM DescriptionNarrative text N N Y A human readable description of the terms & conditions.
LoyaltyAward
Definition: CO_AW_PRM
Definition: The identification of a reward that the customer receives for satisfying the requirements of a promotion. Examples include premium gifts given when a customer has
purchased $N worth of merchandise over a promotional period.
ID_AW_PRM Identity int Y N N A unique system generated identifier for the LoyaltyAward.
ID_ITM Identity int N Y Y The retailers SKU or unique item identifier for the item that is being given away as a LoyaltyAward.
TY_AW_PRM Code2 char(2) N N Y Indicates the type of promotional award given. For example the award may be an item, a gift certificate,
as savings bond, etc.
LoyaltyProgram
Definition: CO_PRGM_LYLT
Definition: A membership-based customer incentive initiative.
ID_PRGM_LYLT Identity int Y N N A artificial, unique identifier for a loyalty program.
NM_PRGM_LYLT Name varchar(40) N N Y A name or tradename for a loyalty program.
DE_PRGM_LYLT DescriptionNarrative text N N Y Text that describes a loyalty program.
DC_PRGM_LYLT_EF DateCalendar datetime N N Y The date that a loyalty program becomes available.
DC_PRGM_LYLT_EX DateCalendar datetime N N Y The date that a loyalty program is no longer available.
Manufacturer
Definition: PA_MF
Definition: The external party that manufactures the ITEM.
ID_MF Identity int Y N N A unique identifier to denote the ITEM MANUFACTURER.
NM_MF Name varchar(40) N N Y The name of the MANUFACTURERs organization.
ManufacturerBrand
Definition: ID_BRN_MF
Definition: An associative (many-to-many) entity that links MANUFACTURER and BRAND. Brands, such as private label merchandise, can be produced by different
MANUFACTURERs and a MANUFACTURER can produce different BRANDs
NM_BRN Name varchar(40) Y Y N A unique name to denote a class of ITEMs as a product of a single supplier or manufacturer. The
ID_MF Identity int Y Y N A unique identifier to denote the ITEM MANUFACTURER.
ManufacturerCouponFamily
Definition: CO_FMY_MF_CPN
Definition: Code assigned by the manufacturer to classify product for promotion purposes. In the ARTS model it is used to validate manufacturers coupons.
ID_MF Identity int Y Y N A unique identifier to denote the ITEM MANUFACTURER.
FC_FMY_MF ProductCodeFamily char(3) Y N N The UPC designated three digit coupon family code for the manufacturer item.
TY_CPN Code2 char(2) N Y Y A code to denote the type of coupon, e.g. raincheck, manufacturer coupon, electronic coupon.
DE_FMY_MF DescriptionShort varchar(255) N N Y The description for a coupon family code for the manufacturer item.
ManufacturerPriceDerivationRuleEligibility
Definition: CO_EL_MF_PRDV
Definition: Defines an association between a MANUFACTURER and PRICE DERIVATION RULE and the conditions which govern the application of the associated rule to an
item falling under the merchandise structure at the time an instance of the item is recorded as a line item in a sale.
ID_MF Identity int N Y N A unique identifier to denote the ITEM MANUFACTURER.
MerchandiseHierarchyFunction
Definition: CO_MRHRC_FNC
Definition: A business function for which new MerchandiseHierarchy classifications are created.
ID_MRHRC_FNC Identity int Y N N A unique system assigned identifier for the MerchandiseHierarchyFunction
NM_MRHRC_FNC DescriptionShort varchar(255) N N Y The name of MerchandiseHierarchyFunction
MerchandiseHierarchyGroup
Definition: CO_MRHRC_GP
Definition: An aggregation level for rolling ITEM sales and units for reporting purposes and for mapping item-level activity into the retailers merchandise structure.
ID_MRHRC_GP Identity int Y N N Unique identifier for a merchandise structure.
ID_PST Identity int N Y Y A unique identifier for a specific job. This may or may not be controlled by a centralized HR function.
NM_MRHRC_GP Name varchar(40) N N Y The business name for the merchandise structure.
DE_MRHRC_GP DescriptionShort varchar(255) N N Y A brief text description of the merchandise structure.
MerchandiseHierarchyLevel
Definition: CO_MRHRC_LV
Definition: Establishes the levels of the merchandise hierarchy structure for rolling up sales units and financial amounts for ITEMs.
ID_MRHRC_FNC Identity int Y Y N A unique system assigned identifier for the MerchandiseHierarchyFunction
ID_MRHRC_LV Code4 char(4) Y N N A unique system assigned identifier for the Level within the merchandise hierarchy tree.
ID_MRHRC_LV_PRNT Code4 char(4) N Y Y Identifies a hierarchy level within a summarization tree structure for merchandise sales analysis and
merchandise classification. The values for this attribute will be standardized within the ARTS Data
Model.
DE_MRHRC_LV Name varchar(40) N N Y The retailer-specific description associated with a merchandise-hierarchy-level-code. This attribute
allows retailers to assign any description they choose to each level.
MerchandiseHierarchySalesPlan
Definition: CO_MRHRC_SLS_PLN
Definition: Budgeted sales for a MerchandiseHierarchy by different ReportingPeriods
ID_MRHRC_GP Identity int Y Y N Unique identifier for a merchandise structure.
TP_SLS_NT_SLS_BDGMoney decimal(14,3) N N N The net sales amount which has been budgeted for the RETAIL STORE. This budget is normally set at
certain merchandise hierarchical levels to enable the RETAIL STORE to better identify the sales
contribution of the various merchandise groups.
MerchandiseHierarchySalesSummary
Definition: LE_SMY_MRHRC_SLS
Definition: Sales accumulations for MERCHANDISE HIERARCHY points by different FISCAL PERIODs.
MO_SLS_ITM Money decimal(14,3) N N N The cumulative gross item sales recorded by the RETAIL STORE. These sales are recorded at the
various merchandise hierarchy levels for each REPORTING PERIOD.
QU_SLS_ITM QuantityShortCount decimal(3,0) N N N The cumulative number of ITEMs sold by the RETAIL STORE. The ITEMs are recorded at the various
merchandise hierarchy for each REPORTING PERIOD.
QU_SLS_TRN QuantityTransactionCount decimal(7,0) N N N The cumulative number of transactions involving item sales. The item sales are recorded at the various
MERCHANDISE HIERARCHY levels for each REPORTING PERIOD.
MO_RTN_ITM Money decimal(14,3) N N N The cumulative monetary value of item returns for the RETAIL STORE, recorded at the various
merchandise hierarchy levels, for each REPORTING PERIOD.
QU_RTN_ITM QuantityShortCount decimal(3,0) N N N The cumulative number of item returns for the RETAIL STORE, recorded at the various merchandise
hierarchy levels, for each REPORTING PERIOD.
QU_RTN_TRN QuantityTransactionCount decimal(7,0) N N N The cumulative number of item returns for the RETAIL STORE, recorded at the various merchandise
MO_DSC_ITM Money decimal(14,3) N N N The cumulative monetary value of miscellaneous item discounts recorded by the RETAIL STORE.
These markdowns will be recorded at the various merchandise hierarchy levels for each REPORTING
PERIOD.
QU_DSC_ITM QuantityShortCount decimal(3,0) N N N The cumulative number of miscellaneous item discounts recorded by the RETAIL STORE. These
markdowns will be recorded at the various merchandise hierarchy levels for each REPORTING
PERIOD.
QU_DSC_TRN QuantityTransactionCount decimal(7,0) N N N The cumulative number of item discounts which have been applied at the transaction level. These
discounts will be recorded at the various merchandise hierarchy levels for each REPORTING PERIOD.
MO_DSC_EM_ITM Money decimal(14,3) N N N The cumulative monetary value of employee item discounts recorded by the RETAIL STORE. These
PERIOD.
QU_DSC_EM_ITM QuantityShortCount decimal(3,0) N N N The cumulative number of employee item discounts recorded by the RETAIL STORE. These
PERIOD.
QU_DSC_EM_TRN QuantityTransactionCount decimal(7,0) N N N The cumulative number of item employee discounts which have been applied at the transaction level.
These discounts will be recorded at the various merchandise hierarchy levels for each REPORTING
PERIOD.
MO_CPN_STR_ITM Money decimal(14,3) N N N The cumulative monetary value of item store coupons received by the RETAIL STORE. These
coupons are recorded at the various merchandise hierarchy levels for each REPORTING PERIOD.
QU_CPN_STR_ITM QuantityShortCount decimal(3,0) N N N The cumulative number of item store coupons received by the RETAIL STORE. These coupons are
recorded at the various hierarchy levels for each REPORTING PERIOD.
QU_CPN_STR_TRN QuantityTransactionCount decimal(7,0) N N N The cumulative number of item store coupons received by the RETAIL STORE. These coupons are
recorded at the various hierarchy levels for each REPORTING PERIOD.
MO_RFD_STR_ITM Money decimal(14,3) N N N The cumulative monetary value of item refunds for the RETAIL STORE, recorded at the various
QU_RFD_STR_ITM QuantityShortCount decimal(3,0) N N N The cumulative number of item refunds for the RETAIL STORE, recorded at the various merchandise
QU_RFD_STR_TRN QuantityTransactionCount decimal(7,0) N N N The cumulative number of transaction refunds for the RETAIL STORE, recorded at the various
MO_MKD_ITM Money decimal(14,3) N N N The cumulative monetary value of markdowns recorded by the RETAIL STORE. These markdowns are
recorded at the various merchandise hierarchy levels for each REPORTING PERIOD.
QU_MKD_ITM QuantityShortCount decimal(3,0) N N N The cumulative number of markdowns recorded by the RETAIL STORE. These markdowns are
recorded at the various merchandise hierarchy levels for each REPORTING PERIOD.
QU_MKD_TRN QuantityTransactionCount decimal(7,0) N N N The cumulative number of transactions which have been marked down by the RETAIL STORE. These
markdowns are recorded at the various merchandise hierarchy levels for each REPORTING PERIOD.
QU_TRN QuantityTransactionCount decimal(7,0) N N N The cumulative number of transactions for the RETAIL STORE, recorded at the various merchandise
QU_DY_PRM_CM QuantityTransactionCount decimal(7,0) N N N The cumulative number of days where item promotions are run. These days are recorded at the
various merchandise hierarchy levels for each REPORTING PERIOD.
MerchandiseStructureLevelSalesRestriction
Definition: RU_MRHRC
Definition: A restriction that limits a particular levels eligibility for sale.
MerchandiseStructureLevelSize
Definition: CO_MRHRC_SZ
Definition: A cross reference of SIZEs that are available for a specific MERCHANDISE STRUCTURE LEVEL, specifically the department level.
ED_SZ Code6 char(6) Y Y N A code to designate the size of the ITEM. It is proposed to use the 5 apparel and miscellaneous coding
MerchandiseStructurePriceDerivationRuleEligibility
Definition: CO_EL_MRHRC_PRDV
Definition: Defines an association between a MERCHANDISE STRUCTURE LEVEL and PRICE DERIVATION RULE and the conditions which govern the application of the
associate rule to an item falling under the merchandise structure at the time an instance of the item is recorded as a line item in a sale.
ID_MRHRC_GP Identity int N Y N Unique identifier for a merchandise structure.
TY_TH Code4 char(4) N N Y A code for the type of threshold wich applies to a price derivation rule eligibility.
QU_TH Quantity decimal(9,2) N N Y A quanity of items within a single merchandise structure level required to be purchased to trigger this
MO_TH Money decimal(14,3) N N N A monetary amount within a single merchandise structure level required to be purchased to trigger this
QU_INTV Quantity decimal(9,2) N N N An interval quantiy for which this price derivation rulle eligible.
MO_INTV Money decimal(14,3) N N N An interval monetary armount for which this price derivation rulle eligible.
QU_LM Quantity decimal(9,2) N N N The maximum number of items within a merchanidise structure level for which this price deriviation rule
is eligible.
MO_LM Money decimal(14,3) N N N The maximum monetary amount within a merchanidise structure level for which this price deriviation
rule is eligible.
MiscellaneousFee
Definition: TR_FE_MSC
Definition: A fee paid by the CUSTOMER for a service, normally associated with the purchase of a STOCK ITEM. An example would be delivery charge, gift wrapping service,
etc.
ID_ACNT_LDG Identity int N Y N The reference for the STORE FINANCIAL LEDGER ACCOUNT
DE_FE_MSC DescriptionShort varchar(255) N N Y Describes this miscellaneous fee
FL_DPSN_CT_PY_FR Code4 char(4) N N Y Flag that determines whether the customer is charged for this misc. fee or the store absorbs it as an
expense.
MiscellaneousFeeLineItem
Definition: TR_LTM_MSC_FE
Definition: A line item component of a RETAIL TRANSACTION that records a fee added to the transaction net total and reflects a non-item income or reimbursable expense to
the retailer.
MO_FE_MSC Money decimal(14,3) N N N The amount of the miscellaneous fee to be booked.
MissingVolumeEvent
Definition: EV_VOL_MSSG
Definition: An audit event recording the fact that the comparison of two STOCK METER READINGs has raised the possibility of one or more FUELLING TRANSACTIONs
having been performed without being recorded by the system.
ID_STR_RT Identity int N Y N A unique retailer assigned identifier for a RetailStore
ID_MTR_STK Identity int N Y N A unique identifier for the stock meter
AI_RDG_FS Number int N Y N The first StockMeter value that was used to deduce the missing volume event.
AI_RDG_SCN Number int N Y N The second StockMeter value that was used to deduce the missing volume event.
RC_DTCTN String varchar(20) N N Y A 2 character code denoting the reason the comparison was performed.
QV_MSSG Number int N N Y The value of the missing volume detected in the comparison
MixAndMatchPriceDerivationItem
Definition: TR_ITM_MXMH_PRDV
Definition: Specifies matching items that may be used to trigger a MIX AND MATCH PRICE DERIVATION RULE. In situations like Buy item A and get items B, C or D at
50% off, items B, C and D would be the matching items. Item A would be the trigger item scanned in at the point of sale.
ID_PDT_PRM Identity int Y Y N A unique identifier for a Promotional Product.
CD_RDN_MTH Code2 char(2) N N Y A code denoting the method for calculating the new price for the item. Possible values include, Amount
Reduction, Percent Reduction, New Price, and Cost Price Plus.
PE_RDN_PRC Percent decimal(5,2) N N N The percentage markdown each time this rule is applied.
MO_RDN_PRC Money decimal(14,3) N N N The monetary amount of the markdown each time this rule is applied.
MO_NW_PRC Money decimal(14,3) N N N A reduction expressed as a new price.
PE_ALN_MKD Percent decimal(5,2) N N N The percentage of the total markdown from the PROMOTION that is to be applied to this item.
Example: Burger normally costs $2.00 with Fries & Coke normally $1.00 each. When combined in a
Mix n Match Promotion at $3.50 the missing 50cents may need to be allocated back to the constituent
parts for taxation and other reasons.
MixAndMatchPriceDerivationRule
Definition: RU_PRDV_MXMH
Definition: A type of PRICE DERIVATION RULE that defines combinations of items and item counts that when purchased together result in a price revision (generally a
reduction). A mix and match price derivation rule affects prices of items OTHER than those that triggered the eligibility.
QU_LM_MXMH Quantity decimal(9,2) N N N The maximum number of mix and matched items that may be purchased along with the item that
triggered the price derivation rule. For example a break maker may be sold with an offer to acquire any
3 of 24 varieties of bread mix for half price. The 3 varieties represent the mix-and-match-limit-count.
MultiplePriceDerivationRuleEligibility
Definition: CO_EL_MLP_PRDV
Definition: A recursive associative entity linking a parent PriceDerivationRuleEligibility with a child PriceDerivationRuleEligibility. The parent will be of type
CombinatonPriceDerivationRuleEntity - which defines the combination function for the children Eg: AND, OR, XOR
ID_EL_PRDV_PRNT Identity int Y Y N A unique identifier for a Price Derivation Rule Eligibility.
ID_EL_PRDV_CHLD Identity int Y Y N A unique identifier for a Price Derivation Rule Eligibility.
MultipleUnitThreshold
Definition: CO_TH_MPR_UN
Definition: This defines a threshold associated with a MULTIPLE UNIT PRICE CHANGE. When the threshold-unit-count is reached in a retail transaction, this price derivation
rule is triggered resulting in a new sell price. This price derivation rule is usually associated with price reductions for promotions.
ID_LV_TH Identity int Y N N The identifier for a specific MULTIPLE UNIT THRESHOLD.
QU_CNT_UN Quantity decimal(9,2) N N N The number of retail sale units of this item that earn the price reduction specified in this MULTIPLE
UNIT THRESHOLD entity instance.
MO_VL_TH Money decimal(14,3) N N N The monetary value of retail sale units of this item that earn the price reduction specified in this
MULTIPLE UNIT THRESHOLD entity instance.
MO_RDN_TH_PR Money decimal(14,3) N N N The monetary amount price reduction to be applied through this MULTIPLE UNIT THRESHOLD price
derivation rule.
PE_RDN_TH_PR Percent decimal(5,2) N N N The percent of the base retail price reduction to be applied through this MULTIPLE UNIT THRESHOLD
NonProfitEnterprise
Definition: PA_CMY_NPFT
Definition: An organization that has been designated as non-profit or not-for-profit for tax purposes.
ID_RGST_NPFT DescriptionShort varchar(255) N N Y A tax or other government identifier that is assigned to non-profit organization.
NonStandardAddress
Definition: LO_ADS_NSTD
Definition: An address that is not covered by address postal standards.
ID_ADS Identity int Y Y N A unique identifier for a location and mail address.
A1_ADS Address varchar(40) N N Y A generic holder of non-standardized address infomration.
A2_ADS Address varchar(40) N N Y A generic holder of non-standardized address infomration.
NM_UN Name varchar(40) N N Y An appartment, suite, office or other locations ID.
TE_NM Name varchar(40) N N Y A state, provice, or other region within a country.
CO_NM Name varchar(40) N N Y The name of a country or territory.
PC_NM PostalCode varchar(15) N N Y A code assigned by the postal authority and used for mail delivery.
Nozzle
Definition: AS_NZL
Definition: That part of the FUELING POINT that blends and measures the volume of fuel dispensed during a FUELING TRANSACTION.
ID_NZL Identity int Y N N A unique identifier for the Nozzle
ID_MTR_SLS Identity int N Y Y A system-assigned unique identifier for a sales meter.
NozzleFuelingTransactionHistory
Definition: LE_HST_NZL_TRN
Definition: The total number, volume and monetary value of all FuelingTransactions performed on a particular LogicalNozzle during a particular ReportingPeriod. Totals are
separated by Prepay and Postpay FuelingTransactions
ID_LV_SV Identity int Y Y N A unique identifier for the service level
ID_LV_PRC Identity int Y Y N A unique identifier for the price level
ID_GP_TM Identity int Y Y N A unique identifier for the time group
QU_TRN_FUEL_PSPYQuantity decimal(9,2) N N Y The number of FuellingTransactions performed at the LogicalNozzle during the ReportingPeriod
QV_TRN_FUEL_PSPY Quantity decimal(9,2) N N Y The total volume of FuellingTransactions performed at the LogicalNozzle during the ReportingPeriod
MO_TRN_FUEL_PSPYMoney decimal(13,2) N N Y The total monetary amount of FuellingTransactions performed at the LogicalNozzle during the
ReportingPeriod
QU_TRN_FUEL_PRPYQuantity decimal(9,2) N N Y The count of fueling transactions prepaid at the logical nozzle during the reporting period.
QV_TRN_FUEL_PRPYQuantity decimal(9,2) N N Y The total volume of fueling transactions prepaid at the logical nozzle during the reporting period.
MO_TRN_FUEL_PRPYMoney decimal(13,2) N N Y The total monetary amount of FuellingTransactions prepaid at the LogicalNozzle during the
ReportingPeriod
NozzleHistory
Definition: LE_HST_NZL
Definition: The total number, volume and monetary value of all FuelingTransactions performed on a particular LogicalNozzle during a time period bounded by two consecutive
ForecourtSettlementTransactions Totals are separated by Prepay and Postpay FuelingTransactio
QU_TRN_FUEL_PSPYQuantity decimal(9,2) N N Y The number of PostpayFuelingTransactions performed on the LogicalNozzle during the period of time
covered by the ForecourtSettlementTransaction
QV_TRN_FUEL_PSPY Quantity decimal(9,2) N N Y The number of Postpay FuelingTransactions performed on the LogicalNozzle during the period of time
MO_TRN_FUEL_PSPYMoney decimal(13,2) N N Y The total monetary amount of FuellingTransactions performed at the LogicalNozzle during the period of
time covered by the ForecourtSettlementTransaction
QU_TRN_FUEL_PRPYQuantity decimal(9,2) N N N The number of PrePayFuelingTransactions performed on the LogicalNozzle during the period of time
QV_TRN_FUEL_PRPYQuantity decimal(9,2) N N N The number of Prepay FuelingTransactions performed on the LogicalNozzle during the period of time
MO_TRN_FUEL_PRPYMoney decimal(13,2) N N N The total monetary amount of FuellingTransactions prepaid at the LogicalNozzle during the period of
time covered by the ForecourtSettlementTransaction
OccasionRecommendation
Definition: ST_RCM_OCCN
Definition: A cross reference of items that are recommended to CUSTOMERs for inclusion in their GIFT REGISTRY, based on the type of occasion being celebrated or observed.
Operator
Definition: PA_OPR
Definition: An employee or any other authorized individual who may enter transactions into the stores workstations. The OPERATOR is accountable for the tender collected and
dispensed while assigned to a WORKSTATION.
ID_OPR Identity int Y N N A unique, automatically assigned number used to identify a workstation OPERATOR.
PW_ACS_OPR Password varchar(20) N N Y A security password entered by an operator and used to verify his/her identity when signing on to a
WORKSTATION.
OperatorGroup
Definition: CO_GP_OPR
Definition: EMPLOYEE GROUP assigns an EMPLOYEE to a specific work GROUP. There is no limitation as to the number of work GROUPs a given EMPLOYEE may be
assigned to, nor to the limit of EMPLOYEEs assigned to a specific GROUP.
ID_GP_WRK Identity int Y Y N A unique identifier for a work classification group to which EMPLOYEEs are assigned.
OperatorHistory
Definition: LE_HST_OPR
Definition: A collection of monetary and operational totals used to track the activity volume of an operator during a reporting period.
QU_LON_TND_TOT QuantityTransactionCount decimal(7,0) N N N The total number of tender loans recorded against the workstation OPERATOR for each REPORTING
PERIOD.
CP_SLS_GS_PSTV_TOT Money decimal(14,3) N N N The total monetary amount of positive gross sales recorded by OPERATOR for each REPORTING
PERIOD. Positive gross sales exclude returns.
CP_SLS_GS_NG_TOTMoney decimal(14,3) N N N The total monetary amount of negative gross sales recorded by OPERATOR for each REPORTING
PERIOD. This total only includes returns made to the RETAIL STORE.
QU_TRN_TOT QuantityTransactionCount decimal(7,0) N N N The total number of transactions recorded by OPERATOR for each REPORTING PERIOD.
CP_VD_LN_ITM_TOT Money decimal(14,3) N N N The total monetary amount of line item voids made by OPERATOR for each REPORTING PERIOD.
QU_LTM_VD_TOT QuantityTransactionCount decimal(7,0) N N N The total number of line item voids made by OPERATOR for each REPORTING PERIOD.
CP_VD_PST_TRN_TOTMoney decimal(14,3) N N N The total monetary amount of post transaction voids by OPERATOR for each REPORTING PERIOD.
QU_VD_PST_TRN_TOTQuantityTransactionCount decimal(7,0) N N N The total number of disbursement line items made by OPERATOR for each REPORTING PERIOD.
MO_VD_TRN_TOT Money decimal(14,3) N N N The total number of transaction voids recorded by OPERATOR for each REPORTING PERIOD.
QU_VD_TRN_TOT QuantityTransactionCount decimal(7,0) N N N The total number of transaction voids recorded by OPERATOR for each REPORTING PERIOD.
QU_PKP_TND_TOT QuantityTransactionCount decimal(7,0) N N N The total number of tender pickups recorded against the workstation OPERATOR for each
REPORTING PERIOD.
CP_PKP_TND_TOT Money decimal(14,3) N N N The total monetary amount of tender pickups by OPERATOR for each REPORTING PERIOD.
CP_LON_TND_TOT Money decimal(14,3) N N N The total monetary amount of tender loans by OPERATOR for each REPORTING PERIOD.
CP_RTN_TOT Money decimal(14,3) N N N The total monetary amount of returns made by OPERATOR for each REPORTING PERIOD.
QU_RTN_TOT QuantityTransactionCount decimal(7,0) N N N The total number of item returns received by OPERATOR for each REPORTING PERIOD.
CP_RFD_TOT Money decimal(14,3) N N N The total monetary amount of refunds made by OPERATOR for each REPORTING PERIOD.
QU_RFD_TOT QuantityTransactionCount decimal(7,0) N N N The total number of item refunds actioned by OPERATOR for each REPORTING PERIOD.
CP_DS_EM_TOT Money decimal(14,3) N N N The total monetary amount of employee discounts actioned by OPERATOR for each REPORTING
PERIOD.
QU_DSC_EM_TOT QuantityTransactionCount decimal(7,0) N N N The total number of line item employee discounts recorded by OPERATOR for each REPORTING
PERIOD.
CP_DS_MSC_TOT Money decimal(14,3) N N N The total monetary amount of miscellaneous discounts recorded by OPERATOR for each
REPORTING PERIOD.
QU_DS_MSC_TOT QuantityTransactionCount decimal(7,0) N N N The total number of miscellaneous discounts actioned by OPERATOR for each REPORTING PERIOD.
CP_CPN_STR_TOT Money decimal(14,3) N N N The total monetary amount of store coupons accepted by OPERATOR for each REPORTING
PERIOD.
QU_CPN_STR_TOT QuantityTransactionCount decimal(7,0) N N N The total number of store coupons accepted by OPERATOR for each REPORTING PERIOD.
CP_DS_RDM_CNR_TOT Money decimal(14,3) N N N The total monetary amount of container deposits redeemed by OPERATOR for each REPORTING
PERIOD.
QU_DS_RDM_CNR QuantityTransactionCount decimal(7,0) N N N The total number of disbursement line items made by OPERATOR for each REPORTING PERIOD.
CP_MRK_TOT Money decimal(14,3) N N N The total monetary amount of price markdowns made by OPERATOR for each REPORTING PERIOD.
QU_MKD_TOT QuantityTransactionCount decimal(7,0) N N N The total number of item markdowns actioned by OPERATOR for each REPORTING PERIOD.
CP_SLS_NT_TOT Money decimal(14,3) N N N The total monetary amount of net sales recorded by OPERATOR for each REPORTING PERIOD.
CP_FE_MSC_TOT Money decimal(14,3) N N N The total monetary amount of miscellaneous fees recorded by OPERATOR for each REPORTING
PERIOD.
QU_FE_MSC_TOT QuantityTransactionCount decimal(7,0) N N N The total number of miscellaneous fee item sales recorded by OPERATOR for each REPORTING
PERIOD.
CP_DS_CNR_TOT Money decimal(14,3) N N N The total monetary amount of container discounts collected by OPERATOR for each REPORTING
PERIOD.
QU_DS_CNR_TOT QuantityTransactionCount decimal(7,0) N N N The total number of container deposits collected by OPERATOR for each REPORTING PERIOD.
CP_PYM_CLT_TOT Money decimal(14,3) N N N The total monetary amount of payments collected by OPERATOR for each REPORTING PERIOD.
QU_PYM_CLT_TOT QuantityTransactionCount decimal(7,0) N N N The total number of payments on account received by OPERATOR for each REPORTING PERIOD.
CP_PYM_LY_CLT_TOTMoneyShortCost decimal(10,5) N N N The total monetary amount of layaway payments collected by OPERATOR for each REPORTING
PERIOD.
QU_PYM_LY_CLT_TOTQuantityTransactionCount decimal(7,0) N N N The total number of layaways payments collected by OPERATOR for each REPORTING PERIOD.
CP_DSB_PTY_CSH_TOT Money decimal(14,3) N N N The total monetary amount of petty cash disbursements by OPERATOR for each REPORTING
PERIOD.
QU_DSB_PTY_LN_ITMQuantityTransactionCount decimal(7,0) N N N The total number of disbursement line items made by OPERATOR for each REPORTING PERIOD.
CP_SLS_GS_EX_TX Money decimal(14,3) N N N The total monetary amount of gross sales excluding tax recorded by OPERATOR for each
REPORTING PERIOD.
CP_TX_TOT Money decimal(14,3) N N N The total tax amount recorded by OPERATOR for each REPORTING PERIOD.
CP_TX_EXM_TOT Money decimal(14,3) N N N The total tax exempt amount recorded by OPERATOR for each REPORTING PERIOD.
QU_TRN_TX_EXM_TOTQuantityTransactionCount decimal(7,0) N N N The total number of tax exempt transactions recorded by OPERATOR for each REPORTING PERIOD.
QU_LTM_OVRD_TOT QuantityTransactionCount decimal(7,0) N N N The total number of line item overrides made by OPERATOR for each REPORTING PERIOD.
QU_ITM_LN_WT_TOT QuantityTransactionCount decimal(7,0) N N N The total number of weighed line items recorded by OPERATOR for each REPORTING PERIOD.
QU_LTM_KY_TOT QuantityTransactionCount decimal(7,0) N N N The total number of ITEMs keyed at the point of sale by OPERATOR for each REPORTING PERIOD.
QU_LTM_SC_TOT QuantityTransactionCount decimal(7,0) N N N The total number of ITEMs scanned by OPERATOR for each REPORTING PERIOD.
PE_LTM_KY_TOT Percent decimal(5,2) N N N The percentage of ITEMs keyed at the point of sale compared to the total sold ITEMs by the
OPERATOR for each REPORTING PERIOD.
PE_LTM_SC_TOT Percent decimal(5,2) N N N The percentage of ITEMs scanned compared to the total sold ITEMs by the OPERATOR for each
REPORTING PERIOD.
QU_LTM_DPT_TOT QuantityTransactionCount decimal(7,0) N N N The number of ITEMs recorded through an open department by OPERATOR for each REPORTING
PERIOD.
PE_LTM_DPT_TOT Percent decimal(5,2) N N N The percentage of ITEMs recorded through an open department compared to the total ITEMs by
OPERATOR for each REPORTING PERIOD.
QU_TRN_NO_SLS QuantityTransactionCount decimal(7,0) N N N The total number of no sale transactions recorded by OPERATOR for each REPORTING PERIOD.
IN_RNG_TOT QuantityShortCountSeconds decimal(5,0) N N N The total time expressed in minutes spent scanning or keying ITEMs by OPERATOR for each
REPORTING PERIOD.
IN_IDL_TOT QuantityShortCountSeconds decimal(5,0) N N N The total time expressed in minutes by operator where no sales are being recorded for each
REPORTING PERIOD.
IN_LCK_OPR QuantityShortCountSeconds decimal(5,0) N N N The time expressed in minutes when the WORKSTATION is locked even though the OPERATOR has
signed on for each REPORTING PERIOD.
QU_LTM_SLS_TOT QuantityTransactionCount decimal(7,0) N N N The total number of line item sales recorded by OPERATOR for each REPORTING PERIOD.
QU_SGN_ON_TOT QuantityTransactionCount decimal(7,0) N N N The total number of sign-offs made by OPERATOR for each REPORTING PERIOD.
QU_SGN_OFF_TOT QuantityTransactionCount decimal(7,0) N N N The total number of sign-on made by OPERATOR for each REPORTING PERIOD.
CP_TND_OVR_TOT Money decimal(14,3) N N N The total monetary amount of tender overages recorded against the workstation OPERATOR for each
REPORTING PERIOD.
CP_MD_TND_PKP_TOTMoney decimal(14,3) N N N The total monetary amount of tender shortages recorded by OPERATOR for each REPORTING
PERIOD.
QU_RCN_INTN_TND QuantityTransactionCount decimal(7,0) N N N The total number of intermediate tender reconciliations for an OPERATOR for each REPORTING
PERIOD.
CP_CHK_SND_TOT Money decimal(14,3) N N N The total monetary amount of send checks recorded by OPERATOR for each REPORTING PERIOD.
QU_CHK_SND_TOT QuantityTransactionCount decimal(7,0) N N N The total number of send checks recorded by OPERATOR for each REPORTING PERIOD.
CP_SLS_SPN_TOT Money decimal(14,3) N N N The total number of TRANSACTIONs suspended by OPERATOR for each REPORTING PERIOD.
QU_TRN_SPN_TOT QuantityTransactionCount decimal(7,0) N N N The total monetary amount of TRANSACTIONs suspended by OPERATOR for each REPORTING
PERIOD.
CP_SLS_RSM_TOT Money decimal(14,3) N N N The total monetary amount of TRANSACTIONs resumed by OPERATOR for each REPORTING
PERIOD.
QU_SLS_RSM_TRN_TOT QuantityTransactionCount decimal(7,0) N N N The total number of resumed transactions recorded by OPERATOR for each REPORTING PERIOD.
OperatorResourceAccess
Definition: CO_ACS_OPR_RS
Definition: This entity defines the rules which permits an OPERATOR to gain access to a specific RESOURCE within the RETAIL STORE.
PS_ACS_RD Code2AccessControl char(2) N N Y An indicator to signify that read access is granted to the referenced OPERATOR for the corresponding
resource identified in this record. Read access limitation may be set by, for example, no access, group
access, user access, etc.
PR_ACS_WR Code2AccessControl char(2) N N Y An indicator to signify that write access is granted to the referenced OPERATOR for the corresponding
resource identified in this record. Write access limitation may be set by, for example, no access, group
OperatorTaxHistory
Definition: LE_HST_OPR_TX
Definition: A collection of tax totals for a tax authority by operator for a reporting period.
government body.
CP_TX_CLT_TOT Money decimal(14,3) N N N The total monetary amount of tax recorded by OPERATOR for each REPORTING PERIOD.
CP_SLS_TX_TOT Money decimal(14,3) N N N The total monetary amount of taxable sales recorded by OPERATOR for each REPORTING PERIOD.
CP_SLS_TX_EXM_TOTMoney decimal(14,3) N N N The total monetary amount of tax exempt sales recorded by OPERATOR for each REPORTING
PERIOD.
QU_TRN_TX_EXM_TOTQuantityTransactionCount decimal(7,0) N N N The total number of tax exempt sales recorded by OPERATOR for each REPORTING PERIOD.
OperatorTenderHistory
Definition: LE_HST_OPR_TND
Definition: A collection of tender type accumulators by operator for a reporting period. This entity is used to support employee tender accountability.
QU_MD_TND_TOT QuantityTransactionCount decimal(7,0) N N N The total number of tender media units counted by operator for each REPORTING PERIOD.
QU_MD_TND_OVR_TOT QuantityTransactionCount decimal(7,0) N N N The total tender overage recorded against an operator for each REPORTING PERIOD.
QU_MD_TND_SHRT_TOT QuantityTransactionCount decimal(7,0) N N N The total monetary value of tender shortages recorded for that OPERATOR for each REPORTING
PERIOD.
QU_MD_TND_BGN_TOT QuantityTransactionCount decimal(7,0) N N N The open balance of the number of tender media units for that OPERATOR for each REPORTING
PERIOD.
QU_MD_TND_LN_TOTQuantityTransactionCount decimal(7,0) N N N The total number of tender media units loaned by operator for each REPORTING PERIOD.
CP_MD_LON_TND_TOT Money decimal(14,3) N N N The total monetary amount of tender media units loaned by operator for each REPORTING PERIOD.
QU_MD_TND_PKP_TOT QuantityTransactionCount decimal(7,0) N N N The total number of tender media units picked up by operator for each REPORTING PERIOD.
CP_MD_TND_PKP_TOTMoney decimal(14,3) N N N The total monetary amount of tender media units picked up by operator for each REPORTING
PERIOD.
CP_DS_TND_TOT Money decimal(14,3) N N N The total monetary value of tender media deposited in the EXTERNAL DEPOSITORY by OPERATOR
for each REPORTING PERIOD.
QU_MD_TND_DS_TOTQuantityTransactionCount decimal(7,0) N N N The total number of tender media units deposited in the EXTERNAL DEPOSITORY by OPERATOR for
each REPORTING PERIOD.
CP_TND_OVR_TOT Money decimal(14,3) N N N The total monetary value of tender overages recorded by OPERATOR for each REPORTING PERIOD.
CP_TND_SHRT_TOT Money decimal(14,3) N N N The total monetary value of tender shortages recorded for that OPERATOR for each REPORTING
PERIOD.
OrderDocument
Definition: DO_OR
Definition: A type of INVENTORY CONTROL DOCUMENT that is a record of agreement made with a supplier that includes a detailed list of retail items, cost discount terms,
method of shipping, delivery dates, delivery location and other pertinent terms and conditions governing the acquisition.
ID_BYR Identity int N N Y The BUYER_ID specifies the corporate buyer responsible for the purchase of merchandise specified in
the order document.
TY_ORD Code2 char(2) N N Y A code to denote the type of purchase order, eg close out, consignment, etc. This code relates to the
UCC Purchase Order Type Code, Data Element 92.
TY_EV_ORD Code2 char(2) N N Y A code that characterizes an order based on the event causing its creation. Examples include orders
generated on a regular basis, orders generated as part of a promotion and orders generated for a
season.
Organization
Definition: PA_ORGN
Definition: A company, association, institution, or other enterprise of interest to a retail store or retail enterprise.
NM_ORGN Name varchar(40) N N Y An ORGANIZATIONs legal trade name.
ID_TX_ORGN DescriptionShort varchar(255) N N Y A tax or other number assigned by a governing body that is unique to all ORGANIZATIONs within that
governing bodys jurisdiction.
SC_ORGN_LG Code2Status char(2) N N Y A code that indicates the ORGANIZATIONs legal or tax status. For example, this may be Commercial
Corporation, Not-for-profit, Non-profit, Academic, Government, etc.
ID_TX_FDL DescriptionShort varchar(255) N N Y A tax or other number assigned by a federal government that is unique to all ORGANIZATIONs within
that federal governments jurisdiction.
ID_TX_ST DescriptionShort varchar(255) N N Y A tax or other number assigned by a state government that is unique to all ORGANIZATIONs within
that state governments jurisdiction.
OrganizationalAffiliation
Definition: ST_ORGN_AFLN
Definition: A non-hierarchical affiliation of organizations.
ID_PRTY_ORGN_AF Identity int Y Y N A unique, automatically assigned identity for a PARTY.
OrganizationalStructure
Definition: ST_ORGN_STRC
Definition: The hierarchical reporting or ownership relationship within an organization
ID_PRTY_ORGN_PRNTIdentity int Y Y N A unique, automatically assigned identity for a PARTY.
ID_PRTY_ORGN_SUB Identity int N Y Y A unique, automatically assigned identity for a PARTY.
PackingSlip
Definition: DO_SP_PCKG
Definition: A document that identifies the merchandise items a supplier claims to be shipping to the store against one or more purchase orders.
ID_SP_PCKG Identity int Y N N the unique identifier for the packing slip, typically the reference number.
DC_ORD_FLF DateCalendar datetime N N Y The date on which the order is fulfilled by the SUPPLIER.
DC_SHP_OTB DateCalendar datetime N N Y The date on which the fulfilled order is shipped from the SUPPLIER to the RETAIL STORE.
PackItem
Definition: AS_ITM_PCK
Definition: A set of two or more of the same STOCK ITEM which are sold together, although they can be broken apart and sold separately if required. e.g. Carton of cigarettes or
6-pack of soda.
QU_UN_PCK_ITM Quantity decimal(9,2) N N Y The number of units within the PACK ITEM
QU_CB_PCK_ITM Quantity decimal(9,2) N N Y The volume of the PACK ITEM
QW_PCK_ITM Quantity decimal(9,2) N N Y The acual weight of the PACK ITEM including tare.
Party
Definition: PA_PRTY
Definition: An individual or firm that exchanges information and/or goods and services with the store.
ID_PRTY Identity int Y N N A unique, automatically assigned identity for a PARTY.
LU_ORG_LG Code2 char(2) N N Y Describes the type of organization from the legal aspect, ie company which is either private, public,
limited liability, etc.
TY_PRTY Code2 char(2) N N Y Defines the type of party a store is dealing with (e.g. a supplier, carrier, customer, etc.)
PartyAddress
Definition: LO_ADS_PRTY
Definition: A specific partys address.
TY_RO_PRTY Code6 char(6) Y Y N A code that identifies a group of PARTY ROLES. This is used for subtyping the PARTY ROLEs.
SC_PRTY_ADS Code2Status char(2) N N Y An indicator of the addresss currency. For instance, this address may be valid, invalid, temporary, etc.
DC_EF DateCalendar datetime N N Y The date that a PARTYs address is valid for that PARTY.
DC_EP DateCalendar datetime N N Y The date that a PARTYs address is no longer valid for that PARTY.
PartyAffiliation
Definition: CO_AFLN_PTY
Definition: A relationship between two Partys that has some meaning to the Retailer.
CD_TYP_PTY_AFLN Code2 char(2) Y Y N A unique retailer assigned 2 leter code denoting the type of affiliation between two Partys.
ID_PRTY_MSTR Identity int Y Y N A unique, automatically assigned identity for a PARTY.
ID_PRTY_SUB Identity int Y Y N A unique, automatically assigned identity for a PARTY.
PartyAffiliationType
Definition: CO_TYP_PTY_AFLN
Definition: A type code defining a potential relationship between two Partys that has some meaning to the retailer.
CD_TYP_PTY_AFLN Code2 char(2) Y N N A unique retailer assigned 2 leter code denoting the type of affiliation between two Partys.
DE_TYP_PTY_AFLN DescriptionShort varchar(255) N N Y A human readable description of the Party Affiliation reason.
PartyIdentification
Definition: PA_IDTN
Definition: An official number that may be used to identify a Party. People have multiple forms of such identification: Drivers License number , Passport number, Credit / Debit
Card number, Social Security number, Tax number, etc... Businesses may also have multiple identifiers to prove that they are a legal entity: Company Incorporation number, Tax
number, etc....
TY_PRTY_ID Code2 char(2) Y Y N A code denoting a form of identification that the customer uses to identify themselves.
LU_ID_PRTY Identity int N N Y The number on the Identification that identifies the Party.
DC_ID_PRTY_EP DateCalendar datetime N N Y The date after which the identification is no longer valid.
PartyIdentificationType
Definition: PA_TYP_IDTN
Definition: A particular type of Party Identification eg: Drivers License, Passport, Credit/Debit Card etc...
TY_PRTY_ID Code2 char(2) Y N N A code denoting a form of identification that the customer uses to identify themselves.
DE_PRTY_ID DescriptionShort varchar(255) N N Y A short text string describing the PartyIdentificationType
PartyRole
Definition: PA_RO_PRTY
Definition: A type of relationship that a person or organization has with the enterprise.
DC_RO_PRTY_EF DateCalendar datetime N N Y The date that this role is valid.
DC_RO_PRTY_EP DateCalendar datetime N N Y The date that this role is no longer valid.
PartyRoleStatus
Definition: PA_RO_PRTY_STS
Definition: The current state of a PARTY ROLE.
SC_RO_PRTY_TYP Code6 char(6) Y Y N A unique code that will identify a group of party roles.
PartyRoleType
Definition: PA_RO_PRTY_TYP
Definition: A categorization of PARTY ROLEs.
TY_RO_PRTY Code6 char(6) Y N N A code that identifies a group of PARTY ROLES. This is used for subtyping the PARTY ROLEs.
NM_RO_PRTY Name varchar(40) N N Y A name or label for a group of party roles.
DE_RO_PRTY DescriptionNarrative text N N Y A narrative that describes this group of party roles.
PartyRoleTypeState
Definition: PA_RO_PRTY_TYP_ST
Definition: This dependent entity defines ALL valid states that a specific PARTY ROLE TYPE may assume.
SC_RO_PRTY_TYP Code6 char(6) Y N N A unique code that will identify a group of party roles.
NM_RO_PRTY_ST Name varchar(40) N N Y A name or label for a status of a PARTY ROLE
DE_RO_PRTY_ST DescriptionNarrative text N N Y A narrative that describes the status of a PARTY ROLE.
PaymentOnAccountLineItem
Definition: TR_LTM_PYAN
Definition: A detail line item recording a payment for a product or service purchased on an installment account basis. These line items are different from those charged to a house
account. In this case the account normally has to be completely paid off within a specific time period. The account exists only until the installment sale is completely extinguished.
AI_ACNT_CT_CRD Number int N Y Y A unique retailer assigned identifier for a CustomerAccountCard.
FL_PYM_RCV Flag bit N N Y A flag to denote that payment is outstanding on the account.
MO_PYM_AGT_RCV Money decimal(14,3) N N N The monetary payment on account received from the CUSTOMER.
LU_ACNT_PYMAGT_RCV Code4 char(4) N N Y A code to denote the type of payment on account, eg layaway, house, etc.
ID_ACNT_PYMAGT_RCV Identity int N N Y The unique identifier for the customer account .
PeriodCloseTransaction
Definition: TR_CL_PRD
Definition: A transaction that declares the end of a BusinessDay at the RetailStore where it is conducted.
PermanentPriceChange
Definition: TR_CHN_PRN_PRC
Definition: A price change that modifies the inventory value for the ITEMs included in the EVENT. This price change normally only has a start date.
MO_CHN_PRN_UN_PRC MoneyShortRetail decimal(8,3) N N N The amount (either monetary or percent) to be used to change or replace the current selling price for a
sale unit of the item.
TY_CHN_PRN_UN_PRCCode2 char(2) N N Y A code to define how the temporary-price-change-sale-unit-amount is to be interpreted. Valid values
include: PCT percent of current retail price to be added to or subtracted from the current retail to arrive
at a selling price; AMT, flat monetary amount to be added to or subtracted from the current retail to
arrive at a selling price; and AMTREPL, a retail sale unit price amount that is to replace the current
selling price.
PermanentPriceChangeItem
Definition: MA_ITM_PRN_PRC_ITM
Definition: This association between a PERMANENT PRICE CHANGE and ITEM establishes the application of a new permanent price (or percentage or monetary increase or
decrease) for an item. A PERMANENT PRICE CHANGE is posted to an ITEM and is not contingent on conditions or events that occur at the point of sale.
MO_PRC_NW MoneyShortRetail decimal(8,3) N N N The new Permanent Retail Price to be applied to the Item in all stores in the RetailStoreGroup as a
consequence of the PriceChangeEvent
Person
Definition: PA_PRS
Definition: A individual of interest to the retail store or retail enterprise.
NM_PRS_SLN Name varchar(40) N N Y Extra words that don t form part of the persons name but are normally printed before the FirstName as
a courtesy title. For instance, Mr. Ms., Miss, Dr., Prof. etc.
FN_PRS Name varchar(40) N N N A persons first name. In western cultures, this is the given name, in other cultures it may be the family
name.
TY_NM_FS Code2 char(2) N N Y A code denoting what kind of name the FirstName is, possible values include: GivenName,
OtherGivenName, FamilyName, Patronymic
MD_PRS Name varchar(40) N N Y One or more middle names, that are printed between the persons first and last names.
TY_NM_MID Code2 char(2) N N Y A code denoting what kind of name the MiddleName is, possible values include: GivenName,
LN_PRS Name varchar(40) N N N A persons last name. In western cultures, this is the family (or patronymic) name, in other cultures it
may be the given name.
TY_NM_LS Code2 char(2) N N Y A code denoting what kind of name the LastName is, possible values include: GivenName,
NM_PRS_SFX Name varchar(40) N N Y Extra words that don t form part of the persons name but are normally printed after the LastName to
help identify the person. Example values include, Sr, Jr, III
TY_GND_PRS Code2 char(2) N N Y A code for specifying a persons gender.
DC_PRS_BRT DateCalendar datetime N N Y A persons date of birth.
NM_PRS_SR Name varchar(40) N N Y A culturally sensitive version of the persons name that is used when producing a sorted list of names.
Examples: Jones, W S McGrigor, S F Tryggvi, T
NM_PRS_ML Name varchar(40) N N Y A culturally sensitive version of the persons name that is used when contacting them Examples: Bill
Jones, Stuey McGrigor Tryggvi Thordarson
NM_PRS_OFCL Name varchar(40) N N Y A culturally sensitive version of the persons name that is used for all legal documents. Examples:
William Stephen Jones Stuart Fergus McGrigor Tryggvi Magnus Thordarson
PersonOrgAffiliationType
Definition: ST_AFLN_PRS_ORGN_T
Definition: A categorization of relationships between a PERSON and an ORGANIZATION.
NM_AFLN_PRS_ORGN_T String varchar(20) Y N N A name or label for a group of affiliations of people and organizations. For instance, this might be
employment .
DE_TYP DescriptionNarrative text N N Y A narrative for a group of affiliations of people and organizations.
PersonOrganizationAffiliation
Definition: ST_AFLN_PRS_ORGN
Definition: A relationship between a person and an organization that is of interest to the retailer.
NM_AFLN_PRS_ORGN_T String varchar(20) Y Y N A name or label for a group of affiliations of people and organizations. For instance, this might be
employment .
DC_AFLN_PRS_ORGNDateCalendar datetime Y N N The start date of a PERSONs affiliation with an organization.
PhysicalCountDocument
Definition: DO_CNT_PHY
Definition: The document on which the actual ITEM counts are recorded on the day of the Physical Inventory. This is raw/ unedited data captured during the Inventory.
ID_DCM_PHY_CNT Identity int Y N N The identifier for the physical count document on which the actual item counts are recorded.
PhysicalCountLineItem
Definition: TR_LTM_PHY_CNT
Definition: The line detail which records the number of units counted during the Physical Inventory. This is raw/ unedited data captured and will compared to the book stock to
determine the actual unit and financial discrepancy for that ITEM.
ID_DCM_PHY_CNT Identity int Y Y N The identifier for the physical count document on which the actual item counts are recorded.
IC_CNT_PHY_ITM Identity int Y N N The physical count line item.
ID_TNK Identity int N Y Y A unique identifier for the Tank that was measured by the reading.
ID_PBE_TNK Identity int N Y Y A system assigned unique identifier for the TankProbe that was used for the reading.
AI_RDG LineNumber smallint N Y Y A unique identifier for this particular reading on this TankProbe
PhysicalInventoryEvent
Definition: CO_EV_PHY_INV
Definition: An EVENT at which time the physical inventory occurs.
PhysicalLocation
Definition: LO_LCN_PHY
Definition: A location of interest due to delivery or other service provision.
TY_CRDN Code2AccessControl char(2) Y Y N A categorization of co-ordinate systems.
CD_LCN_PHY Code6 char(6) Y N N A code that identifies a specific physical location.
PhysicalLocationAddress
Definition: LO_ADS_LCN_PHY
Definition: A physical locations use of an address.
CD_LCN_PHY Code6 char(6) Y Y N A code that identifies a specific physical location.
TY_CRDN Code2AccessControl char(2) Y Y N A categorization of co-ordinate systems.
POSDepartment
Definition: ID_DPT_PS
Definition: A grouping of items with similar point of sale control and processing attributes. This entity type may also be used to control sales that are not properly identified at the
item-level.
ID_DPT_PS Identity int Y N N A unique system-assigned identifier for the POSDepartment
ID_DPT_PS_PRNT Identity int N Y Y A unique system-assigned identifier for the parent POSDepartment.
NM_DPT_PS Name varchar(40) N N Y The human readable name for the POSDepartment
POSDepartmentHistory
Definition: LE_HST_PS_DPT
Definition: A collection of monetary and operational totals used to track the activity volume for a POS DEPARTMENT during a reporting period.
ID_DPT_PS Identity int Y Y N A unique system-assigned identifier for the POSDepartment
CP_VD_LN_ITM_TOT Money decimal(14,3) N N N The total monetary amount of line item voids by POS department for each REPORTING PERIOD.
QU_LTM_VD_TOT QuantityTransactionCount decimal(7,0) N N N The total number of line item voids by POS department for each REPORTING PERIOD.
CP_VD_PST_TRN_TOTMoney decimal(14,3) N N N The total monetary amount of items cancelled by a post transaction void by POS department for each
REPORTING PERIOD.
QU_VD_PST_TRN_TOTQuantityTransactionCount decimal(7,0) N N N The total number of items cancelled by a post transaction void by POS department for each
REPORTING PERIOD.
CP_VD_TRN_TOT Money decimal(14,3) N N N The total monetary amount of items cancelled by transaction void by POS department for each
REPORTING PERIOD.
QU_VD_TRN_TOT QuantityTransactionCount decimal(7,0) N N N The total number of items cancelled by transaction void by POS department for each REPORTING
PERIOD.
CP_RTN_TOT Money decimal(14,3) N N N The total monetary amount of returns by POS department for each REPORTING PERIOD.
QU_RTN_TOT QuantityTransactionCount decimal(7,0) N N N The total number of returns by POS department for each REPORTING PERIOD.
CP_RFD_TOT Money decimal(14,3) N N N The total monetary amount of refunds by POS department for each REPORTING PERIOD.
QU_RFD_TOT QuantityTransactionCount decimal(7,0) N N N The total number of refunds by POS department for each REPORTING PERIOD.
CP_DSC_EM_TOT Money decimal(14,3) N N N The total monetary amount of employee discounts by POS department for each REPORTING
PERIOD.
QU_DSC_EM_TOT QuantityTransactionCount decimal(7,0) N N N The total number of employee discounted items by POS department for each REPORTING PERIOD.
CP_DSC_MSC_TOT Money decimal(14,3) N N N The total monetary amount of miscellaneous discounts by POS department for each REPORTING
PERIOD.
QU_DSC_MSC_TOT QuantityTransactionCount decimal(7,0) N N N The total number of miscellaneous discounted items by POS department for each REPORTING
PERIOD.
CP_CPN_STR_TOT Money decimal(14,3) N N N The total monetary amount of lines purchased in part or in full by store coupons by POS department for
QU_CPN_STR_TOT QuantityTransactionCount decimal(7,0) N N N he total number of lines purchased in part or in full by store coupons by POS department for each
REPORTING PERIOD.
CP_DS_RDM_CNR_TOT Money decimal(14,3) N N N The total monetary amount of redeemed container deposits by POS department for each REPORTING
PERIOD.
QU_DS_RDM_CNR_TOT QuantityTransactionCount decimal(7,0) N N N he total number of redeemed container deposits by POS department for each REPORTING PERIOD.
CP_MKD_TOT Money decimal(14,3) N N N The total monetary amount of markdowns by POS department for each REPORTING PERIOD.
QU_MKD_TOT QuantityTransactionCount decimal(7,0) N N N The total number of markdowns by POS department for each REPORTING PERIOD.
CP_SLS_NT_ITM_TOTMoney decimal(14,3) N N N The total monetary amount of net item sales by POS department for each REPORTING PERIOD.
CP_FE_MSC_TOT Money decimal(14,3) N N N The total monetary amount of miscellaneous fees by POS department for each REPORTING PERIOD.
QU_FE_MSC_TOT QuantityTransactionCount decimal(7,0) N N N The total number of miscellaneous fees by POS department for each REPORTING PERIOD.
CP_DS_CNR_TOT Money decimal(14,3) N N N The total monetary amount of container deposits by POS department for each REPORTING PERIOD.
QU_DS_CNR_TOT QuantityTransactionCount decimal(7,0) N N N The total number of container deposits by POS department for each REPORTING PERIOD.
CP_TX_TOT Money decimal(14,3) N N N The total monetary amount of tax item sales by POS department for each REPORTING PERIOD.
CP_TX_EXM_TOT Money decimal(14,3) N N N The total monetary amount of tax exempt item sales by POS department for each REPORTING
PERIOD.
QU_TRN_TX_EXM QuantityTransactionCount decimal(7,0) N N N The total number of tax exempt item sales by POS department for each REPORTING PERIOD.
QU_LTM_OVRD_TOT QuantityTransactionCount decimal(7,0) N N N The total number of line item overrides by POS department for each REPORTING PERIOD.
QU_ITM_LN_WT_TOT QuantityTransactionCount decimal(7,0) N N N The total number of weighed item sales by POS department for each REPORTING PERIOD.
QU_LTM_KY_TOT QuantityTransactionCount decimal(7,0) N N N The total number of keyed item sales by POS department for each REPORTING PERIOD.
QU_LTM_SC_TOT QuantityTransactionCount decimal(7,0) N N N The total number of scanned item sales by POS department for each REPORTING PERIOD.
PE_LTM_KY_TOT Percent decimal(5,2) N N N The number of items keyed as a percentage of total items sold by POS department for each
REPORTING PERIOD.
PE_LTM_SC_TOT Percent decimal(5,2) N N N The number of items scanned as a percentage of total items sold by POS department for each
REPORTING PERIOD.
QU_LTM_DPT_TOT QuantityTransactionCount decimal(7,0) N N N The total number of items sold by a POS department for each REPORTING PERIOD.
PE_LTM_DPT_TOT Percent decimal(5,2) N N N The number of items sold through a department key as a percentage of total items sold by POS
department for each REPORTING PERIOD.
QU_LTM_SLS_TOT QuantityTransactionCount decimal(7,0) N N N The total number of item sales by POS department for each REPORTING PERIOD.
POSDepartmentTaxHistory
Definition: LE_HST_PS_DPTS_TX
Definition: A collection of tax totals for a tax authority for a POS DEPARTMENT for a reporting period.
government body.
CP_TX_CLT_TOT Money decimal(14,3) N N N The total amount of tax collected by POS department for each REPORTING PERIOD.
CP_SLS_TX_TOT Money decimal(14,3) N N N The total amount of taxable sales by POS department for each REPORTING PERIOD.
CP_SLS_TX_EXM_TOTMoney decimal(14,3) N N N The total amount of tax exempt sales by POS department for each REPORTING PERIOD.
QU_TRN_TX_EXM_TOTQuantityTransactionCount decimal(7,0) N N N The total number of tax exempt sales by POS department for each REPORTING PERIOD.
POSIdentity
Definition: ID_PS
Definition: A simple cross-reference between the barcode, point of sale scan code or other keyed identifying number used at POS and the internal stock keping ItemID for the
item. The POSItemID 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 Identity int Y N N 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_QFR Identity int Y N N 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.
Position
Definition: CO_PST
Definition: A job or role that employees fill.
ID_PST Identity int Y N N A unique identifier for a specific job. This may or may not be controlled by a centralized HR function.
CD_JOB Code6 char(6) N Y Y A unique identifier for a JOB or funcation.
DE_PST DescriptionNarrative text N N Y A narrative that describes the POSTION or job.
NM_PST_TTL Name varchar(40) N N Y A job title associated with a POSITION.
CD_PYRL_TYP Code6 char(6) N N Y A code indicating how this position is paid.
FL_PST_SHR Flag bit N N Y An indicator for whether or not this position is eligible for job sharing.
FL_CMN Flag bit N N Y An indicatory of whether or not this position is eligible for commission.
CD_ACS_LV Code6 char(6) N N Y A code that indicates what access privileges are granted to a position.
PositionAllocation
Definition: CO_PST_ALCT
Definition: The allotment of POSITIONs that have been approved for a specific RETAIL STORE.
ID_STR_RT Identity int Y N N A unique identifier for a specific RETAIL STORE within the organization. Typically, STOREs are given
a unique reference number.
ID_LCN Identity int Y N N A unique identifier for a specific LOCATION within the RETAIL STORE.
DC_EF DateCalendar datetime N N Y The starting date for an allotment of positions to a retail store.
DC_EP DateCalendar datetime N N Y The ending date for an allotment of positions to a retail store.
PositionHierarchy
Definition: ST_HRC_PST
Definition: The reporting structure of POSTIONs.
ID_PST_SUB Identity int Y Y N A unique identifier for a specific job. This may or may not be controlled by a centralized HR function.
ID_PST_SPVR Identity int Y Y N A unique identifier for a specific job. This may or may not be controlled by a centralized HR function.
DC_EF DateCalendar datetime N N Y The valid start date for a positions reporting structure
DC_EX DateCalendar datetime N N Y The date that a positions reporting structure is no longer valid.
PositionWorkSchedule
Definition: CO_SCH_PST_WRK
Definition: A shift schedule for a position
WD_PST_WRK_SCH Name varchar(40) Y N N The name of the day that this schedule is for.
TM_STR Time datetime N N Y The beginning time for this schedule.
TM_FNS Time datetime N N Y The ending time for this schedule.
HH_HR Number int N N Y Total hours for this schedule.
POSLockTransaction
Definition: TR_LCK_PS
Definition: A non sales POS transaction which secures the WORKSTATION while an EMPLOYEE is absent from the WORKSTATION. The WORKSTATION cannot be
operated unless the EMPLOYEE enters the relevant ACCESS CODE. It is different from SIGN OFF in that the WORKSTATION is not disassociated from the EMPLOYEE.
POSNoSaleTransaction
Definition: TR_SLS_PS_NO
Definition: A non salesTRANSACTION that conducts no business, but causes the till drawer to open. The WORKSTATION accumulates the number of times by EMPLOYEE
this facility is used
PostVoidTransaction
Definition: TR_VD_PST
Definition: A non sales transaction that cancels a prior SALES/ RETURN TRANSACTION. The workstation will normally record each individual instance of this
TRANSACTION by EMPLOYEE.
ID_WS_VD Identity int N Y Y The unique identifier for the WORKSTATION, typically the serial number.
DC_DY_BSN_VD DateCalendar datetime N Y Y The calendar date of the BusinessDay.
AI_TRN_VD Identity int N Y Y A unique, non-significant, automatically assigned sequential number used to identify a TRANSACTION
POSUnlockTransaction
Definition: TR_UNLK_PS
Definition: A type of CONTROL TRANSACTION that changes the state of a WORKSTATION from an inaccessible (locked) state to an accessible (unlocked) state for entering
transactions.
PreferenceType
Definition: PA_PRFC_TYP
Definition: A grouping of preferences. For instance, clothing style -related preferences may be grouped together under a type.
TY_PRFC Code2 char(2) Y N N A unique code for a group of preferences. For instance, all the types of material (clothing) preferences
may be grouped together.
DE_PRFC_TYP DescriptionNarrative text N N Y A narrative that describes the group of preferences.
PreparedItem
Definition: AS_ITM_PPR
Definition: A sub-type of Item that is manufactured (or prepared) for sale from a set of BulkItem via a Recipe. The distinction from StockItem being that PreparedItem is not
booked into inventory when the item is manufactured; nor is it removed from inventory when it is sold; rather the inventory for the BulkItem constituent parts as defined by the
recipe is reduced when the PreparedItem is sold.
TM_HLDR_FD_ITM QuantityShortCountMinutes decimal(4,0) N N Y The number of minutes that a prepared food item may be held ready for sale. At the end of this time,
the item must not be sold to a customer.
PrepayHistory
Definition: LE_HST_PRPY
Definition: The total number and monetary value of all Prepay and PrepayRefund FuelSaleLineItems that were sold to a FuelingPoint during a ReportingPeriod.
ID_PNT_FUEL Identity int Y Y N A unique identifier for the FuelingPoint at a particular retail store
QU_TRN_FUEL_PSPYQuantity decimal(9,2) N N N The number of prepay FuellingTransactions performed at the FuellingPoint during the ReportingPeriod
MO_TRN_FUEL_PSPYMoney decimal(13,2) N N Y The total monetary amount of prepay FuellingTransactions performed at the FuellingPoint during the
ReportingPeriod
QU_RFD_FUEL_PSPYQuantity decimal(9,2) N N Y The number of prepay refund FuellingTransactions performed at the FuellingPoint during the
ReportingPeriod
MO_RFD_FUEL_PSPYMoney decimal(13,2) N N Y The total monetary value of prepay refund FuellingTransactions performed at the FuellingPoint during
the ReportingPeriod
PriceDerivationRule
Definition: RU_PRDV
Definition: The specification of a method to be used to transform the current sell unit retail amount to the retail price actually paid by a customer at the point of sale.
ID_RU_PRDV Identity int Y N N A identifier for a specific price derivation rule.
NM_RU_PRDV Name varchar(40) N N Y Price derivation rule name
DE_RU_PRDV DescriptionShort varchar(255) N N Y Business description for this price derivation rule.
LU_CBRK_PRDV_TRNCode2 char(2) N N Y This is a special code that determines when, during the entry of a sale transaction, this rule will be
applied. For example a price change rule may be applied on a line item by line item basis (which is
DETAIL TIME), a price change rule may be triggered after a transaction is totaled -- but before tax and
tender entry (i.e. MERCHANDISE SUBTOTAL TIME).
SC_RU_PRDV Code2Status char(2) N N Y Defines the current status for the price derivation rule. Examples of valid codes include: Pending,
Active, Canceled, Inactive
TY_RU_PRDV Code2 char(2) N N Y Defines the type of price derivation rule.
PriceDerivationRuleEligibility
Definition: CO_EL_PRDV
Definition: Defines the conditions which govern the application of a PRICE DERIVATION RULE to a sale
ID_EL_PRDV Identity int Y N N A unique identifier for a Price Derivation Rule Eligibility.
TY_EL_PRDV Code4 char(4) N N Y A code that indicates the type of Price Derivation Rule Eligibility.
PriceDerivationRuleEligibilityMaintenance
Definition: MA_RU_PRDV_EL
Definition: A type of DataMaintenanceEvent that results in the creation, update or deletion of a PriceDerivationRuleEligibility.
ID_EL_PRDV Identity int N Y Y A unique identifier for a Price Derivation Rule Eligibility.
LU_RU_PRDV_MNT Code4 char(4) N N Y Defines the maintenance function to be performed. Valid values include creation, update or deletion of
a price derivation rule eligibility
PriceDerivationRuleMaintenance
Definition: MA_RU_PRDV
Definition: A type of DataMaintenanceEvent that results in the creation, update or deletion of a PriceDerivationRule.
ID_RU_PRDV Identity int N Y N A identifier for a specific price derivation rule.
LU_RU_PRDV_MNT Code4 char(4) N N Y Defines the maintenance function to be performed. Valid values include creation, update or deletion of
a price derivation rule.
PriceLine
Definition: AS_LN_PRC
Definition: A defined range of retail prices delineated by a low retail and a high retail price. For example price line A may be bounded by a low of $.01 to a high of $.99 (the
"Dollar Line "), price line B may be bounded by a low of $1.00 and a high of $4.99 and so on. Price lines allow the retail store to group items around retail price ranges for price
management purposes.
ID_LN_PRC Identity int Y N N A unique identifier for this price point.
LL_LN_PRC Money decimal(14,3) N N N The low end of a price range that bounds a price line.
UL_LN_PRC Money decimal(14,3) N N N The high end of a price range that bounds a price line.
PriceLinePriceDerivationRuleEligibility
Definition: CO_EL_PRC_LN_PRDV
Definition: Defines an association between a MERCHANDISE STRUCTURE PRICE DERIVATION RULE and a PRICE LINE for the purposes of triggering a PRICE
DERIVATION RULE.
ID_MRHRC_GP Identity int N Y N Unique identifier for a merchandise structure.
ID_LN_PRC Identity int N Y N A unique identifier for this price point.
Promotion
Definition: CO_PRM
Definition: A collection of eligibilities and price derivation rules, during a specific time group.
ID_PRM Identity int Y N N The unique identifier for a promotion.
DC_PRM_EF Datetime datetime N N N The first date and time that this promotion is effective.
DC_PRM_EP Datetime datetime N N N The last date and time that this promotion is effective.
CD_MLP_EL Code2 char(2) N N Y When a promotion consists of more than one pairing of PriceDerivationRuleEligibility and
PriceDerivationRule then how are the multiple pairings to be combined.
TY_CNCRN Code2 char(2) N N N A code denoting how this promotion works in relation to other promotions.
TY_UP_SELL Code2 char(2) N N N A code that indicates how up selling is to be performed.
NM_PRM_OPR Name varchar(40) N N N Text to be displayed to the Operator.
NM_PRM_CT Name varchar(40) N N N Text to be displayed to the customer.
NM_PRM_PRT Name varchar(40) N N N Text to be printed on the receipt
DP_ACNT Code4 char(4) N N Y A code that determines how the price change made as a result of this PROMOTION is to be treated for
stock ledger accounting purposes. This code allows price change modifiers to be treated as discounts
(expenses below the gross margin line) OR as markdowns (treated as changes to the inventory value
which alter the stock ledgers cumulative markon for the item).
PromotionalLineItem
Definition: TR_LTM_PRM
Definition: A detail line item of TRANSACTION that records the crediting or debiting of a CUSTOMER PROMOTIONAL ACCOUNT with points/dollars/miles.
ID_PRM Identity int N Y Y The unique identifier for a promotion.
PromotionalProduct
Definition: CO_PDT_PRM
Definition: Something that is given for free or at a discount. This can be an Item, a Gift Certificate, or any other member of a specific Merchandise Structure Level.
ID_PDT_PRM Identity int Y N N A unique identifier for a Promotional Product.
ID_NMB_SRZ_GF_CF Name varchar(40) N Y Y The serial number that uniquely identifies a GIFT CERTIFICATE.
ID_MRHRC_GP Identity int N Y Y Unique identifier for a merchandise structure.
TY_PDT_PRM Code2 char(2) N N N A cod that indicates the type of Promotional Product that is being given away as a result of the
promotion. Possible values include: Gift Certificate, Item, Merchandise Hierarchy. Frequent Shopper
Points
PromotionPriceDerivationRule
Definition: RU_PRM_PRDV
Definition: An entity that associates a Price Derivation Rule Eligibility and a Price Derivation Rule together with a valid Time Group to be part of a Promotion
ID_PRM Identity int Y Y N The unique identifier for a promotion.
ID_GP_TM Identity int N Y Y A unique identifier for the time group
PromotionPromotionType
Definition: CO_PRM_TYP_PRM
Definition: An associative entity resolving the many-to-many relationship between Promotion and PromotionType. This allows Promotions to be grouped together for reporting
purposes.
ID_PRM_TYP Identity int Y Y N A system assigned unique identifier for the PromotionType
ID_PRM Identity int Y Y N The unique identifier for a promotion.
PromotionType
Definition: CO_TYP_PRM
Definition: An infrastructural entity defining types of Promotions which allows Promotions to be grouped together for reporting purposes.
ID_PRM_TYP Identity int Y N N A system assigned unique identifier for the PromotionType
DE_PRM_TYP DescriptionShort varchar(255) N N Y A human readable descripton of the Promotion Type.
Prospect
Definition: PA_PRSP
Definition: An individual, collection of individuals, company, or public institution that does not currently purchase merchandise or services from the retailer, but who may in the
future. A prospect has no recorded relationship with the retailer.
PurchaseOrderInfo
Definition: DO_PCH_ORD_INF
Definition: Customer issued purchase order data that is collected as part of the process of tendering a RetailTransaction with a CustomerAccount
ID_PTY_CNCT Identity int N Y Y A unique, automatically assigned identity for a PARTY.
ID_PCH_ORD Identity int N N Y The identifier on the customer supplied purchase order, that is being used to tender this transaction.
MO_AZN_AMT MoneyShortRetail decimal(8,3) N N Y The monetary amount included on the purchase order
RawMaterialComponent
Definition: CO_COM_RAW_MTR
Definition: An abstract standardized Recipe ingredient that is re-used in many recipes. Used to define a common quantity & UnitOfMeasure for the Ingredient. Eg: "5oz Tomato
Ketchup " which may be used once in a small hamburger and twice or three times in a large hamburger, and BBQ sauce is an acceptable substitute.
ID_COM Identity int Y N N A unique system assigned identifier for the RawMaterialComponent
MO_UN_AMT QuantityShortCount decimal(3,0) N N Y The amount of the RawItem that make up a single serving of the RawMaterialComponent
DE_COM DescriptionShort varchar(255) N N Y A short description denoting what the ingredient is. Eg: 5oz Ketchup/BBQ
RawMaterialComponentItem
Definition: CO_COM_RAW_MTR_ITM
Definition: An associative entity that denotes an acceptable substitution for a particular RawMaterialComponent an a Recipe. Eg: BBQ Sauce is an acceptable substitute for
Ketchup.
ID_COM Identity int Y Y N A unique system assigned identifier for the RawMaterialComponent
ReceivingDocument
Definition: DO_RCV
Definition: A type of INVENTORY CONTROL DOCUMENT that is used by a store to record its acceptance of items shipped to it by a supplier against an ORDER and the
SUPPLIERs packing slip.
ID_CRR Identity int N Y Y The carrier presenting the bill of lading.
ID_BL_FRGT Identity int N Y Y The carrier-assigned shipping document number
Recipe
Definition: ST_RCP
Definition: The Recipe or Bill of Materials that is used to assemble a PreparedItem from other (usually Bulk) Items. A recursive relationship "variations produce " allows recipe
variations to be recorded.
ID_RCPE Identity int Y N N A system assigned unique identifier for the recipe
CD_VRT Identity int N Y Y A system assigned unique identifier for the recipe which this recipe is a variation of
DC_CHN_LS DateCalendar datetime N N Y The date the recipe was last changed.
DC_CRT DateCalendar datetime N N Y The date the recipe was created
SC_RCPE Code2 char(2) N N Y The status of the recipe, possible values include Active, Inactive, Testing
DE_RCPE DescriptionNarrative text N N Y A short narrative description describing the recipe. When the recipe is a variant of another recipe, the
description includes a description of the variation.
RecipeLineItem
Definition: ST_LTM_RCP
Definition: A single ingredient in a Recipe
ID_RCPE Identity int Y Y N A system assigned unique identifier for the recipe
ID_COM Identity int Y Y N A unique system assigned identifier for the RawMaterialComponent that goes into the Recipe
QU_CNT_SRV QuantityShortCount decimal(3,0) N N Y The number of servings of a component that make up the Ingredient.
FL_CST_INC Flag bit N N Y A flag denoting if the cost of the ingredient is (or is not) included in the cost of the completed
PreparedItem
FL_WST Flag bit N N Y A flag denoting if the recipe ingredient is wasted when the PreparedItem is discarded. e.g. When a
piece of cake is discarded the whipped cream & spoon that are included with the cake when it is sold,
are not discarded
FL_IGDT_KY Flag bit N N Y A flag denoting that the ingredient is required to make up the PreparedItem. e.g. Patties are key
ingredients in a burger, but pickles are not.
RegisteredItemClass
Definition: AS_ITM_RGST_CLS
Definition: The registration of a desired class or group of items at a level above a SKU.
DE_ITM_RGST_CLS DescriptionNarrative text N N Y A description of a class or group of items that have been added to a gift registry for a customer.
RelatedItemAssociation
Definition: CO_ASCTN_RLTD_ITM
Definition: An association between two items that are generally sold together. For each association between related items, transaction and sales summaries will be calculated to
analyze how frequently they are purchased together in a sale and how frequently they are purchased separately.
ID_ITM Identity int Y Y N The retailers SKU or unique item identifier for the main item in the related item association.
ID_ITM_RLTD Identity int Y Y N The retailers SKU or unique item identifier for the associated item in the related item association.
NM_ASCTN_RLTD_ITMName varchar(40) N N Y The name to denote the type of association between the two RELATED ITEMs.
RelatedItemAssociationSalesSummary
Definition: LE_SLS_RLTD_ASCTN
Definition: A collection of accumulators for an association between two items that are generally sold together. For each association between related items, transaction and sales
summaries will be calculated to analyze how frequently they are purchased together in a sale and how frequently they are purchased separately.
ID_ITM Identity int Y Y N The retailers SKU or unique item identifier for the main item in the related item association.
ID_ITM_RLTD Identity int Y Y N The retailers SKU or unique item identifier for the associated item in the related item association.
QU_TRN_ASCTN_SD_TG QuantityTransactionCount decimal(7,0) N N N A count of the number of transactions in which the items in the item association were sold together.
QU_ITM_SD_SPRTLY QuantityTransactionCount decimal(7,0) N N N Count of transactions in which the item is sold without the associated item.
QU_TRN_SLD_SPRTLYQuantityTransactionCount decimal(7,0) N N N Count of transactions in which the associated item is sold without the item.
QU_TRN_SLS_TOT QuantityTransactionCount decimal(7,0) N N N Total sale transaction count for the same period as the item association accumulators - used to
calculate ratios and percentages.
RentalService
Definition: AS_SV_RNT
Definition: The terms and conditions that apply to the rental of a RentalService item.
ID_TRM_RNT Identity int Y N N A retailer assigned unique identifier for the set of terms and conditions governing the rental of
RentalService
TY_PR_RNT Code2 char(2) N N Y A code to denote the rental and overdue periods; Hour, Day, Week, etc...
QU_PR_RNT QuantityDayCount decimal(3,0) N N N The number of rental periods the item may be rented by the customer; as well as the number of rental
periods per penalty charge.
MO_DS_RNT_SV Money decimal(14,3) N N N A deposit related to the value of the RENTAL OBJECT which is paid by the CUSTOMER and is
refundable if the ITEM is returned in the same condition.
PE_DS_RNT_SV Percent decimal(5,2) N N N The percentage of the value of the RENTAL OBJECT which is charged as a refundable deposit to the
CUSTOMER.
CD_MTH_PNTY Code2 char(2) N N Y A code denoting how the penalty is calculated, using PenaltyAmount or PenaltyPercent.
MO_PNTY Money decimal(14,3) N N N The penalty amount which is imposed by the RETAILER if the CUSTOMER fails to meet the rental
terms.
PE_PNTY Percent decimal(5,2) N N N The percentage penalty which is imposed if the terms of the rental are abused by the CUSTOMER, eg
if the rental item is delivered late the penalty is 10% of the rental fee for each date late.
RentalUnit
Definition: ID_UN_RNT
Definition: An associative entity denoting which SerializedItems may be rented via a particular RentalService
ID_TRM_RNT Identity int Y Y N A retailer assigned unique identifier for the set of terms and conditions governing the rental of
RentalService
ReportingPeriod
Definition: CA_PRD_RP
Definition: A time interval bounded by a starting and ending calendar period, used as the basis of all financial and performance reporting. This entity is included to resolve the 5
columns defining the start and end CalendarPeriod into a single ReportingPeriodID.
ID_PRD_RP Identity int Y N N The identifier for a particular REPORTING PERIOD.
ID_CLD Identity int N Y N A unique system assigned identifier for the Calendar.
ID_CLD_LV Identity int N Y N A unique system assigned identifier for the CalendarLevel.
ID_CLD_PRD_SRT Identity int N Y N A unique system assigned identifier for this CalendarPeriod
ID_CLD_PRD_END Identity int N Y N A unique system assigned identifier for this CalendarPeriod
NM_PRD_RP Name varchar(40) N N Y The business name for the reporting period.
RequestForDebitCreditDocument
Definition: DO_CRDB_RQS_FR
Definition: A type of INVENTORY CONTROL DOCUMENT initiated by the store advising the supplier of a discrepancy in: the number of items delivered versus the number
indicated in a packing slip and/or - the confirmed ORDER price versus the invoiced price. This document requests an adjustment to the stores account.
TY_RQS_DB_CR Code2 char(2) N N Y A code to denote whether the request is for a debit or credit. This code refers to the UCC code,
Credit/Debit Flag Code, data element 478.
ID_EM_RQS_DB_CR Identity int N N Y The EMPLOYEE requesting the debit or credit
RC_RQS_DB_CR Code2 char(2) N N Y Reason code for debit or credit request. This code refers to the UCC code, Adjustment Reason Code,
data element 426.
LU_ADJN_DB_CR_RQSCode4 char(4) N N Y Adjudication to the request for credit or debit.
ID_APVL_DB_CR_RQSIdentity int N N Y The serial number of the document approving the request for debit or credit.
Resource
Definition: PA_RS
Definition: RESOURCE entity contains all identifiable applications, functions, screens, and fields available for user and GROUP access.
ID_RS Identity int Y N N A code to uniquely identify a given application or application component.
ID_RS_PRNT Identity int N Y N The next highest ownership level for a given RESOURCE. For example, a field resource is owned by
the application screen resource to which that field is assigned.
DE_RS DescriptionShort varchar(255) N N Y A textual description of the application RESOURCE. Examples include descriptions of application
invocation functions, screens and fields.
RestrictionValidationModifier
Definition: CO_VLD_RST
Definition: A modifier to a SaleReturnLineItem denoting how a particular SalesRestriction was validated. Eg: In some jurisdictions it is a legal requirement to record the
Customers fire-arms license number in order to sell ammunition.
ID_QST_RST_VLD Identity int N Y Y A unique identifer for the restriction validation question.
NA_ANS DescriptionShort varchar(255) N N Y The answer given by the customer to the given question.
RestrictionValidationQuestion
Definition: CO_VLD_RST_QST
Definition: A standard question that may be asked of a Customer as part of the process of negotiating a SalesRestriction that has been placed upon a class of items.
ID_QST_RST_VLD Identity int Y N N A unique identifer for the restriction validation question.
NA_QST_RST_VLD DescriptionShort varchar(255) N N Y The text of the question that the customer is to be asked when validating a restriction.
RetailPriceModifier
Definition: CO_MDFR_RTL_PRC
Definition: A line item modifier that reflects a modification of the retail selling price. It is provided by PLU through the application of a predefined price change rule that depends
on parameters provided during the sale transaction. Examples of the kinds of par
AI_MDFR_RT_PRC Identity int Y N N The sequence number for this RetailPriceModifier allowing more than one price modification to occur
on each retail transaction line item.
ID_PRM Identity int N Y Y The unique identifier for a promotion.
RC_MDFR_RT_PRC Code2 char(2) N N Y A code that describes why the price modifier is applied to the line item. Possible values include
PROMOTION fired and Price label is always right.
PE_MDFR_RT_PRC Percent decimal(5,2) N N N The percent reduction that was applied to the unit retail price to arrive at the modified selling price.
MO_MDFR_RT_PRC Money decimal(14,3) N N N The flat amount of the price reduction that was removed from the unit selling price to arrive at the
modified selling price.
DP_LDG_STK_MDFR Code4 char(4) N N Y A code that determines how the price change reflected in this modifier is to be treated for stock ledger
accounting purposes. This code allows price change modifiers to be treated as discounts (expenses
below the gross margin line) OR as markdowns (treated as changes to the inventory value which alter
the stock ledgers cumulative markon for the item). This code reflects the setting of
AccountingDispositionCode in the PROMOTION that caused the price modification at the time of the
RETAIL TRANSACTION.
MO_PRV_PRC MoneyShortRetail decimal(8,3) N N Y The unit price that was used as the basis of the price modification.
MO_NW_PRC MoneyShortRetail decimal(8,3) N N Y The unit price that was the result of the price modification.
RetailStore
Definition: PA_STR_RTL
Definition: An organization that sells merchandise and services through a physical location, catalog, web page or other channel.
ID_STR_RT Identity int Y N N A unique retailer assigned identifier for a RetailStore
ID_STRGP Identity int N Y Y A unique system-assigned identifier for the RetailStoreGroup
DC_OPN_RT_STR DateCalendar datetime N N Y The opening date for the RETAIL STORE
DC_CL_RT_STR DateCalendar datetime N N Y The closing date for the RETAIL STORE
QU_SZ_STR Quantity decimal(9,2) N N N The size of the RETAIL STORE. This is usually split by the non-sales and sales areas.
QU_SZ_AR_SL Quantity decimal(9,2) N N N The size of the selling floor. in a large STORE this is further split by the sales floor and by the
merchandise departments.
RetailStoreClient
Definition: PA_CLNT_RTL_STR
Definition: A CUSTOMER who has a closer relationship to a retail store or employee.
ID_CLNT_RTL Identity int N N Y An alternate ID assigned to a clienteling customer.
RetailStoreGroup
Definition: CO_STRGP
Definition: A particular group of retail stores, such as Group, Cluster, Region, State, Territory, Country, Zone, etc... The lowest level of RetailStoreGroup is in a one-to-one
relationship with RetailStore. IE: The lowest level of each RetailStoreGroupFunction hierarchy is a RetailStoreGroup containing one & only one RetailStore.
ID_STRGP Identity int Y N N A unique system-assigned identifier for the RetailStoreGroup
ID_LGE Code4External char(4) N Y Y A combination of ISO-639-1 and ISO-3661-1 to denote a lanuage as spoken in a particular country.
NM_STRGP Name varchar(40) N N Y The name of a RetailStoreGroup
RetailStoreGroupFunction
Definition: CO_STRGP_FNC
Definition: A business function for which RetailStores are placed into a separate grouping hierarchies. Taxation: The stores are placed into groups along the boundaries of various
TaxAuthorities. Eg: State, County & City. Merchandising: The stores are placed into groups along the boundaries of various climactic regions, Eg: East Coast, Mid-West, Pacific
NorthWest. With the implication being that umbrellas sell very well in Washington state all year round, while they don t sell at all in Texas.
ID_STRGP_FNC Identity int Y N N A unique system-assigned identifier for the RetailStoreGroupFunction
NM_STRGP_FNC Name varchar(40) N N Y The human readable name of the RetailStoreGroupFunction
RetailStoreGroupItem
Definition: AS_STRGRP_ITM
Definition: Lists the Items that are carried by a particular RetailStoreGroup
SC_ITM_SLS Code2Status char(2) N N Y Defines the selling status of the item. Examples include active, discontinued, seasonal, to be
discontinued, held for future release, etc.
SC_ITM Code2Status char(2) N N Y This code defines the current state of an item within the retail store. An items state limits what actions
may be taken on an item in terms of ordering, receiving, selling, returns, transfers, counting and so on.
Sample statuses include active, inactive, discontinued, pending, etc.
DC_ITM_SLS DateCalendar datetime N N Y The date the current item selling status code became effective.
FL_STK_UPDT_ON_HDFlag bit N N Y A flag that determines whether the POS sale or return of an item will be posted to the stock ledger for
each transaction so that a perpetual inventory for that item can be maintained. For SERVICE ITEMs
the flag will be set to .FALSE. For most merchandise carried on the stock ledger the flag will be set to
.TRUE. For consignment items, the supplier may assume responsibility for maintaining a perpetual
inventory and the store may set the flag to .FALSE.
RetailStoreGroupLevel
Definition: CO_STRGP_LV
Definition: A grouping level for sets of retail stores, such as District, Group, Cluster, Region, State, Territory, Country, Zone etc...
ID_STRGP_FNC Identity int Y Y N A unique system-assigned identifier for the RetailStoreGroupFunction
ID_STRGP_LV Identity int Y N N A unique system assigned identifier, for a level within the RetailStoreGroup hierarchy
ID_STRGP_LV_PRNT Identity int N Y Y A unique system assigned identifier, for the Parent level of a particular level within the
RetailStoreGroup hierarchy
NM_STRGP_LV Name varchar(40) N N Y The name of the Level within the RetailStoreGroup hierarchy.
RetailStoreGroupRecipe
Definition: CO_STRGP_RCP
Definition: An associative entity denoting which Recipes for a particular PreparedItem are valid in a particular group of RetailStores. Eg: A recipe variation for a hamburger may
call for the use of a patty made from Lamb rather than Beef. RetailStores in areas with a high Hindu population may have this recipe variation.
ID_STRGP Identity int Y Y N A unique system-assigned identifier for the RetailStoreGroup which makes use of the Recipe
ID_RCPE Identity int Y Y N A system assigned unique identifier for the Recipe that the RetailStoreGroup uses.
DC_RCPE_EF DateCalendar datetime Y N N The date from which the RetailStoreGroup makes use of the Recipe
DC_RCPE_EP DateCalendar datetime N N Y The date at which the RetailStoreGroup (will) cease to use the Recipe
RetailStoreLocationEvent
Definition: CO_EV_RTL_STR_LCN
Definition: An EVENT that is scheduled for a specific LOCATION (or LOCATIONs) within the RETAIL STORE.
RetailStorePOSDepartment
Definition: ID_DPT_PS
Definition: An associative entity showing which POSDepartments are valid in which RetailStoreGroups
NM_DPT_POS Name varchar(40) N N Y The title or label given to a point-of-sale department.
RetailTransaction
Definition: TR_RTL
Definition: A type of TRANSATION that records the business conducted between the RETAIL STORE and another party involving the exchange in ownership and/or
accountability for merchandise and/or tender or involving the exchange of tender for services.
ID_CT Identity int N Y Y A unique identifier for the customer that conducted the RetailTransaction.
IN_RNG_ELPSD QuantityShortCountSeconds decimal(5,0) N N N The total time elapsed between commencement of the RetailTransaction and the commencement of
the transaction tendering process.
IN_TND_ELPSD QuantityShortCountSeconds decimal(5,0) N N N The total time taken to receive all the tender and complete the RetailTransaction.
IN_ELPSD_IDL QuantityShortCountSeconds decimal(5,0) N N N The total time taken that a particular Workstation was idle between completion of the previous and
commencement of the current RetailTransaction
IN_LCK_ELPSD QuantityShortCountSeconds decimal(5,0) N N N The total time the workstation is in lock mode, ie securement of the WORKSTATION to prevent misuse
by another party, between the previous and current RetailTransactions.
QU_UN_RTL_TRN QuantityShortCount decimal(3,0) N N Y The total number of individual ITEMs which are sold in the transaction
QU_ITM_LN_SC QuantityTransactionCount decimal(7,0) N N N The total number of individual ITEMs which are scanned at the point of sale, in comparison to those
keyed.
PE_ITM_LN_SC Percent decimal(5,2) N N N The total number of individual ITEMs which are scanned at the point of sale, as a percentage of the
total data capture time.
QU_ITM_LN_KY QuantityTransactionCount decimal(7,0) N N N the total number of ITEMs which are keyed at the point of sale in comparison to scanned.
PE_ITM_LN_KY Percent decimal(5,2) N N N The total number of individual ITEMs which are keyed at the point of sale, as a percentage of the total
data capture time.
QU_DPT_KY QuantityTransactionCount decimal(7,0) N N N The total number of ITEMs which are keyed by department at the point of sale.
PE_DPT_KY Percent decimal(5,2) N N N The total number of individual ITEMs which are keyed by department at the point of sale, as a
ercentage of the total data capture time.
FL_SPN Flag bit N N Y A flag denoting that the transaction is suspended, and may be resumed and completed at some time in
the near future.
RetailTransactionLineItem
Definition: TR_LTM_RTL_TRN
Definition: A detail line item of a RetailTransaction that records the business conducted between the retail store and another party involving the exchange in ownership and/or
accountability for merchandise and/or tender or involving the exchange of tender for services.
AI_LN_ITM LineNumber smallint Y N N The sequence number of line item within the context of this RetailTransaction.
AI_LN_ITM_VD LineNumber smallint N Y Y The sequence number of another line item within the transaction - THAT THIS LINE ITEM voids.
TY_LN_ITM Code2 char(2) N N Y A code to denote the type of retail transaction line item, such as Sale/Return, Void, miscellaneous fee,
etc.
TS_LN_ITM_BGN TimeStampEffective datetime N N Y The start time of the RETAIL TRANSACTION line item.
FL_VD_LN_ITM Flag bit N N Y Flag that determines whether this line item has been voided/reversed by another line item in the
transaction.
TS_LN_ITM_END TimeStampExpiration datetime N N Y The end time of the RETAIL TRANSACTION line item.
LU_MTH_LTM_RTL_TRN Code varchar(20) N N Y A retailer assigned code to denote how the ReteailTransactionLineItem was entered at the
Workstation. Example values include: Keyed, Scanned, MICR, MSR, SmartCard, RFID.
RetailTransactionLineItemOverride
Definition: TR_LTM_RTL_TRN_OVR
Definition: A supervisory authorization for overriding a transaction parameter such as price or quantity limits.
ID_OPR Identity int N Y N A unique, automatically assigned number used to identify a workstation OPERATOR.
TS_LTM_RTL_TRN_OVR TimeStampAudit datetime N N Y The date and time that a transaction line item is being overridden.
RC_LTM_RTL_TRN_OVR DescriptionShort varchar(255) N N Y Descriptive narrative about the reason a transaction line item is being overridden.
RetailTransactionShipment
Definition: TR_SHP_RTL
Definition: The record of a shipment which was made to deliver the goods purchased in a particular RetailTransaction to the customers shipping address(es)
ID_SHP_RTL_TRN Identity int Y N N A unique, retailer supplied identifier for a RetailTransactionShipment.
ID_CRR Identity int N Y Y The carrier who does the actual shipping of the RetailTransactionShipment
ID_ADS Identity int N Y Y A unique identifier for a location and mail address.
ID_PRTY Identity int N Y Y A unique, automatically assigned identity for a PARTY.
TY_RO_PRTY Code6 char(6) N Y Y A code that identifies a group of PARTY ROLES. This is used for subtyping the PARTY ROLEs.
ID_TRCK_SHP Identity int N N Y A tracking number provided by the service provider who actually delivers the shipment.
UR_URL_TRCK_SHP DescriptionShort varchar(255) N N Y A URL to the service providers website, which allows interested parties to track the shipment.
TY_LV_SV Code2 char(2) N N Y A code denoting the level of delivery service that is being used to deliver this shipment
TS_DT_PRFC Datetime datetime N N Y The preferred delivery date & time
MO_PYM_RQ MoneyShortRetail decimal(8,3) N N Y How much is required to be paid for COD shipment?
LU_PYM_MTH Code2 char(2) N N Y A code denoting which payment method was used when paying for a COD shipment.
NA_INST_SPL DescriptionNarrative text N N Y Narrative text, giving special delivery instructions.
RetailTransactionShipmentItem
Definition: TR_ITM_RTL_SHP
Definition: A associative entity that relates a particular item sale to a the Shipment that was used to deliver the merchandise to the Customers shipping address(es)
ID_SHP_RTL_TRN Identity int Y Y N A unique, retailer supplied identifier for a RetailTransactionShipment.
AI_LTM_SHP_RTL_TRNLineNumber smallint Y N N A unique, non-significant, automatically assigned sequential number used to identify this item within
the context of the RetailTransactionShipment.
DC_DY_BSN DateCalendar datetime N Y N The calendar date of the BusinessDay.
AI_TRN Identity int N Y N A unique, non-significant, automatically assigned sequential number used to identify a TRANSACTION
AI_LN_ITM LineNumber smallint N Y N The sequence number of line item within the context of this RetailTransaction.
QU_ITM_SHP QuantityShortCount decimal(3,0) N N Y Denotes how many of the items in the relevant SaleReturnLineItem are to be delivered in this
shipment. The implication being that one may purchase more than one of an item in a single
SaleReturnLineItem and each instance of the item purchased may be shipped to a different address.
RetailTransactionTotal
Definition: TR_TOT_RTL
Definition: A monetary or unit count total for the RetailTransaction. Ususally TotalTaxableAmount, TotalTaxCollected, TotalAmountPaid, TotalItemCount, etc...
TY_TRN_TOT Code varchar(20) Y Y N A unique assigned mnemonic identifier that identifies the TransactionTotalType
MO_TOT_RTL_TRN Number int N N Y The monetary total being recorded, for this RetailTransaction.
ReturnAgent
Definition: PA_AGNT_RTN
Definition: A third party to which DEPOSIT ITEMs are sent for recycling or refurbishment.
ID_AGNT_RTN Identity int Y N N The company to whom the returns for ITEMs, such as empty bottles, are made.
NM_AGNT_RTN Name varchar(40) N N Y The name of the company to whom returns on which a deposit was paid are returned.
ReturnAuthorizationRequest
Definition: DO_RQS_RTN_AZN
Definition: A type of INVENTORY CONTROL DOCUMENT that makes a request to a supplier to grant permission to return merchandise that is received and found to be
unsuitable for sale or other use at the store.
LU_RQS_AZN Code2 char(2) N N Y The code to indicate the nature of the request, eg return to vendor, transfer to another store, etc.
ID_RQS_AZN_BY_EM Identity int N N Y The individual who originates the AUTHORIZATION REQUEST.
ID_EM_AZN_GRN Identity int N N Y The individual who approves the AUTHORIZATION REQUEST.
RC_RQS_AZN Code2 char(2) N N Y The reason code for the RETURN AUTHORIZATION REQUEST, eg excess stock, faulty merchandise,
etc. This code refers to the UCC code, Return Request Reason Code, data element 1293.
LU_ADJN_AZN_RQS Code4 char(4) N N Y The code to denote authorization by the receiving agent.
ID_DCM_RQS_RTN_AZN Identity int N N Y The reference number of the authorization document.
ReturnDocument
Definition: DO_RTN
Definition: A type of INVENTORY CONTROL DOCUMENT that lists the merchandise items to be returned by the store to the supplier as a result of: - Errors in delivery against
the stores purchase order; substitutions in shipment; late delivery; defective materials, workmanship or fit; or other breaches of contract
SafeTransferTransaction
Definition: TR_TSF_SF
Definition: A type of TENDER CONTROL TRANSACTION that records the movement of tender from one STORE SAFE to another.
ID_RPSTY_TND_FM Identity int N Y Y The unique identifier for the TENDER RESPOSITORY.
ID_RPSTY_TND_TO Identity int N Y Y The unique identifier for the TENDER RESPOSITORY.
SalariedEmployee
Definition: PA_EM_SLR
Definition: An employee whose compensation package is based on a flat dollar amount.
SaleReturnLineItem
Definition: TR_LTM_SLS_RTN
Definition: A line item component of a RETAIL TRANSACTION 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.
ID_STR_RT_ORG Identity int N Y Y A unique retailer assigned identifier for a RetailStore
ID_WS_ORG Identity int N Y Y The unique identifier for the WORKSTATION, typically the serial number.
DC_DY_BSN_ORG DateCalendar datetime N Y Y The calendar date of the BusinessDay.
AI_TRN_ORG Identity int N Y Y A unique, non-significant, automatically assigned sequential number used to identify a TRANSACTION
AI_LN_ITM_ORG LineNumber smallint N Y Y The sequence number of line item within the context of this RetailTransaction.
ID_ITM_PS_STRGP Identity int N Y Y A unique system-assigned identifier for the RetailStoreGroup
ID_ITM_PS Identity int N Y Y 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_QFR Identity int N Y Y 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_DPT_PS Identity int N Y Y A unique system-assigned identifier for the POSDepartment
TY_ITM Code4 char(4) N N Y Meta-Data denoting the kind of item being sold (or returned) in the line item
MO_PRC_REG MoneyShortRetail decimal(8,3) N N N The regular or lookup per-unit price for the item before any discounts have been applied.
MO_PRC_ACT MoneyShortRetail decimal(8,3) N N Y 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.
QU_ITM_LM_RTN_SLSQuantity decimal(9,2) N N N 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_UN Quantity decimal(9,2) N N Y The number of units sold, when selling bulk merchandise. Eg: A sale of 20 Gallons of Gas: Quantity=1,
Units=20, UnitOfMeasure=Ga Eg: A sale of 3 cans of Beans: Quantity=3, Units=1, UnitOfMeasure=Ea
MO_EXTND Money decimal(14,3) N N N The product of multiplying Quantity by the retail selling unit price derived from price lookup (and any
applicable price derivation rules). This retail sale unit price excludes sales and/or value added tax.
RC_RTN_MR Code2 char(2) N N Y A code that describes why a customer is returning merchandise.
LU_MTH_ID_ENR Code4 char(4) N N Y A code that describes how this line items item identification is being entered (e.g. it is scanned, keyed
SKU, keyed department, etc.)
LU_ENR_RT_PRC Code4 char(4) N N Y A code that describes how this line items retail selling unit price is being entered (e.g. it is manually
keyed, obtained from price lookup, etc.)
LU_PRC_RT_DRVN Code4 char(4) N N Y A code that documents how the selling unit retail prices were derived for this line item.
LU_ACTN_CD Code2 char(2) N N Y A code denoting how the item is being treated in the item.
SaleReturnTaxExemptionModifier
Definition: TR_MDFR_SLS_TX_EXM
Definition: A line item modifier to the SaleReturnTaxLineItem component of a RetailTransaction that provides supplementary data regarding tax exemptions.
government body.
MO_EXM_TXBL MoneyShortRetail decimal(8,3) N N Y The Taxable amount which the customer would ve been liable to pay tax on had they not been granted
this exemption.
MO_EXM_TX MoneyShortRetail decimal(8,3) N N Y The amount of tax that the customer would ve been liable to pay had thus TaxExemption not been
granted.
RC_EXM_TX Code2 char(2) N N Y A retailer assigned code denoting why this TaxExemption was granted.
ID_CF_TX_EXM Identity int N N Y A unique identifier taken from the TaxExemption Certificate that the customer presented in order to get
this Tax Exemption.
NM_CF_HLDR Name varchar(40) N N Y The Customer name taken from the TaxExemption Certificate that the customer presented in order to
get this Tax Exemption.
SaleReturnTaxLineItem
Definition: TR_LTM_SLS_RTN_TX
Definition: A Line Item to record taxation implications of a single SALE RETURN LINE ITEM rather than an entire RETAIL TRANSACTION.
government body.
MO_TXBL_RTN_SLS Money decimal(14,3) N N N The monetary amount for which tax is applicable.
MO_TX_RTN_SLS Money decimal(14,3) N N N The monetary value tax that is being collected by this LineItem.
SaleReturnTaxOverideModifier
Definition: TR_MDFR_SLS_TX_OVRD
Definition: A line item modifier to the SaleReturnTaxLineItem component of a RetailTransaction that provides supplementary data regarding tax overrides. (Where the amount of
tax collected is reduced rather than exempted).
government body.
MO_TX_ORGL MoneyShortRetail decimal(8,3) N N Y The Original amount of Tax that should ve been collected but wasn t because of this
TaxOverrideModifier.
RC_TX_OVRD Code2 char(2) N N Y A retailer assigned reason code denoting why this TaxOverride is being granted.
ID_CF_TX_OVRD Identity int N N Y A unique identifier taken from a TaxOverride certificate that was presented by the Customer in order to
claim the TaxOverride.
NM_CF_HLDR Name varchar(40) N N Y The name of the Customer taken from a TaxOverride certificate that was presented by the Customer in
order to claim the TaxOverride.
SalesMeter
Definition: AS_MTR_SLS
Definition: A mechanical or electronic meter that counts the monetary value or volume of blended ITEM dispensed during all FUELLING TRANSACTIONS ever.
ID_MTR_SLS Identity int Y N N A system-assigned unique identifier for a sales meter.
ID_MTR_DVC Number int N N Y The MeterID the FuelingPoint uses to identify this SalesMeter. Cannot use this MeterID as the Primary
Key because Meters break and need to be replaced.
SC_MTR Code2Status varchar(20) N N Y A code denoting the status of the SalesMeter. Possible values include Active and InActive.
SalesMeterReading
Definition: DO_RDG_MTR_SLS
Definition: The value of a SALES METER recorded at a particular time for a particular reason.
ID_MTR_SLS Identity int Y Y N A system-assigned unique identifier for the sales meter that was used to take this reading.
AI_RDG Number int Y N N A sequential number uniquely identifying this particular reading within the context of the SaleMeter
being used.
QY_RDG Number int N N Y The Meter Reading value.
TS_RDG Datetime datetime N N Y The date & time the meter reading was taken
RC_RDG Code2 varchar(20) N N Y A 2 character code denoting the reason the meter reading was taken
SalesRestriction
Definition: RU_RST_SLS
Definition: A type of limitation that restricts the sale of a particular class of item.
CD_RST_SLS Code6 char(6) Y N N A unique, automatically assigned code for a specific limitation on an ITEMs sale.
TY_RST_SLS Code4 char(4) Y N N A unique code for a group of SALES RESTRICTIONS.
ID_QST Identity int N Y Y A unique identifer for the restriction validation question.
SatelliteNozzle
Definition: AS_NZL_STLTE
Definition: A physical nozzle which dispenses fuel during a FUELING TRANSACTION. The SatelliteNozzle does not measure any fuel dispensed, that is left to the NOZZLE
that it is attached to. The SatelliteNozzle can however, be addressed, and enabled or disabled during a FUELING TRANSACTION
ID_NZL_STLTE Identity int Y N N A unique identifier for a physical nozzle.
SeasonPriceDerivationRuleEligibility
Definition: CO_EL_SN_PRDV
Definition: Defines an association between a SEASON and PRICE DERIVATION RULE and the conditions which govern the application of the associated rule to an item falling
under the merchandise structure at the time an instance of the item is recorded as a line item in a sale.
SerializedItem
Definition: AS_ITM_SRZ
Definition: Extra attributes for a StockItem that can be identified by a (normally) Manufacturer assigned Serial Number.
FL_VLD_SRZ_ITM Flag bit N N Y An indicator used to identify if the SERIALIZED ITEM requires operator validation after payment has
been made and prior to customer pickup.
LU_WRTY_STR_SRZ Code4 char(4) N N Y A code to signify the type of warranty offered by the RETAIL STORE. This warranty normally
supplements the warranty offered by the MANUFACTURER
LU_WRTY_MF_SRZ_ITM Code4 char(4) N N Y A code to denote the type of warranty offered on the SERIALIZED ITEM by the MANUFACTURER
DE_SZ_MF_SRZ_ITM DescriptionShort varchar(255) N N Y A code to signify the maufacturers size reference.
CY_MDL_SRZ_ITM DateCalendarYear char(4) N N Y The year of release or production of the SERIALIZED ITEM
NM_NMB_SRZ_ITM Name varchar(40) N N Y The model reference for a specific SERIALIZED ITEM.
DE_CLR_MF_SRZ_ITMDescriptionShort varchar(255) N N Y The code to signify the manufacturers color shade.
SerializedUnit
Definition: AS_UN_SRZ
Definition: A specific instance of a SERIALIZED ITEM with a unique serial number, usually allocated by the manufacturer, and is used for tracking the ITEM through the supply
chain.
ID_NMB_SRZ Name varchar(40) Y N N A unique code, which can be either alpha, numeric or alpha-numeric, to identify an individual ITEM.
TY_ITM_SRZ Code2 char(2) N N Y A code to indicate the type of SERIAL ITEM, eg TV, refrigerator, PC, etc.
LU_WRTY_SRZ_UN Code2 char(2) N N Y A code to signify the type of warranty associated with the SERIAL ITEM. This code will include the
length of the warranty.
SerializedUnitModifer
Definition: CO_MDFR_SRZ
Definition: A record of the serial number of some item that is related to a particular SaleItem. Eg: Sale of camera & service contract may result in two SaleReturnLineItems each
with an instance of SerializedUnitSaleModeifier - one for the camera and one for the related service contract
ID_NMB_SRZ Name varchar(40) N Y Y A unique code, which can be either alpha, numeric or alpha-numeric, to identify an individual ITEM.
TY_SRZ Code2 char(2) N N Y A code denoting if this is a sale, rental or sale of a related item (eg: Service Contract)
Server
Definition: PA_SRV
Definition: An employee or any other authorized individual who conducts FoodServiceTransactions.
ID_SRV Identity int Y N N A unique identifier for the Server
ServiceItem
Definition: AS_ITM_SV
Definition: A type of ITEM that provides a detailed identifier and description for a service offered for sale to a customer in the retail store. This entity also identifies and describes
rental items and other tangible items that are used by a customer for a contracted period of time but not purchased.
LU_TRM_SV Code2 char(2) N Y Y The type of service terms and conditions
DE_ITM_SV DescriptionShort varchar(255) N N Y A textual description of the SERVICE ITEM.
TY_ITM_SV Code2 char(2) N N Y A code to denote the type of SERVICE ITEM.
CP_BS_SV_ITM Money decimal(14,3) N N N The base cost amount of the SERVICE ITEM. This cost excludes all promotional allowances.
CP_NT_SV_ITM Money decimal(14,3) N N N The net cost price of the SERVCE ITEM. this cost includes all promotional allowances.
DC_CST_EST_SV_ITMDateCalendar datetime N N Y The effective date of the current cost price for the SERVICE ITEM.
ServiceItemProvider
Definition: PA_PVR_SV_ITM
Definition: The association between a SERVICE ITEM sold by a retail store and the third party SERVICE PROVIDER who actually performs the service.
ID_PVR_SV Identity int Y Y N A unique identifier for the service provider.
LU_UN_OF_SV_PVR Code2 char(2) N N Y A code to denote the type of service provided by the SUPPLIER.
MO_UN_OF_SV_PVR MoneyShortRetail decimal(8,3) N N N The retail amount of each unit of service offered by the service provider.
ServiceProvider
Definition: PA_PVR_SV
Definition: A third party that provides a service.
ID_PVR_SV Identity int Y N N A unique identifier for the service provider.
NM_PVR_SV Name varchar(40) N N Y The name of the service providers company.
DU_PVR_SV IdentityDunsIdentifier char(9) N N Y The identifier assigned by Dun & Bradstreet for the purposes of corporate identification in the retail
community and credit worthiness.
ServiceTermsAndConditions
Definition: CO_TRMCD_SV
Definition: The terms and conditions that apply to the provision of any services either by the RETAIL STORE or by arrangement through a third party. The terms and conditions
are normally listed in a separate document which the customer is requested to sign as acceptance of these terms.
LU_TRM_SV Code2 char(2) Y N N The type of service terms and conditions
DE_TRM_SV DescriptionShort varchar(255) N N Y A description of the service terms and conditions
DC_TRM_SV_EF DateCalendar datetime N N Y The date when the service terms and conditions become effective.
DC_TRM_SV_EP DateCalendar datetime N N Y The date on which the service terms and conditions will expire.
NM_ISSR_SV_TRM Name varchar(40) N N Y The issuer of the service terms and conditions associated with this ITEM.
Session
Definition: CO_SSN
Definition: A transient association between an OPERATOR, and a WORKSTATION, that must exist to enable the creation of a RETAIL TRANSACTION or FINANCIAL
TRANSACTION that involves the receipt, disbursement, pick up or loan of tender. A SESSION is created when an OPERATOR signs on to a WORKSTATION and is terminated
when an OPERATOR signs off of a WORKSTATION. This entity exists to support tender reconciliation and accountability at an OPERATOR level.
ID_STR_RT Identity int Y Y N A unique retailer assigned identifier for the RetailStore at which the SignOnTransaction was performed.
ID_WS Identity int Y Y N The unique identifier for the Workstation, typically the serial number. at which the SignOnTransaction
was peformed.
TS_TM_SRT TimeStampAudit datetime Y N N The time and date at the start of the SESSION.
DC_DY_BSN_SRT DateCalendar datetime N Y Y The calendar date of the BusinessDay on which the SignOnTransaction was performed.
AI_TRN_SRT Identity int N Y Y A unique, non-significant, automatically assigned sequential number used to identify the
SignOnTransaction within the context of a Workstation and a BusinessDay.
DC_DY_BSN_END DateCalendar datetime N Y Y The calendar date of the BusinessDay on which the SignOffTransaction was performed.
AI_TRN_END Identity int N Y Y A unique, non-significant, automatically assigned sequential number used to identify the
SignOffTransaction within the context of a Workstation, BusinessDay & Retailstore.
TS_END TimeStampAudit datetime N N N The time and date recorded at the end of the SESSION.
CP_SLS_GS_PSTV_TOT Money decimal(14,3) N N N The total monetary positive gross sales amount recorded by SESSION.
CP_SLS_GS_NG_TOTMoney decimal(14,3) N N N The total monetary gross negative sales amount recorded by SESSION.
QU_TRN_TOT QuantityTransactionCount decimal(7,0) N N N The total number of transactions recorded by SESSION.
CP_VD_LN_ITM_TOT Money decimal(14,3) N N N The total monetary amount of line item voids made by SESSION.
QU_VD_LN_ITM_TOT QuantityTransactionCount decimal(7,0) N N N The total number of line item voids recorded by SESSION.
CP_VD_PST_TRN_TOTMoney decimal(14,3) N N N The total monetary amount of post transactions actioned by SESSION.
QU_VD_PST_TRN_TOTQuantityTransactionCount decimal(7,0) N N N The total number of post transaction voids recorded by SESSION.
CP_VD_TRN_TOT Money decimal(14,3) N N N The total monetary amount of transaction voids by SESSION.
QU_VD_TRN_TOT QuantityTransactionCount decimal(7,0) N N N The total number of transaction voids by SESSION.
CP_LON_TND_TOT Money decimal(14,3) N N N The total monetary amount of tender loans by SESSION.
QU_LON_TND_TOT QuantityTransactionCount decimal(7,0) N N N The total number of tender loans by SESSION.
CP_PKP_TND_TOT Money decimal(14,3) N N N The total monetary amount of tender pickups by SESSION.
QU_PKP_TND_TOT QuantityTransactionCount decimal(7,0) N N N The total number of tender pickups by SESSION.
CP_RTN_TOT Money decimal(14,3) N N N The total monetary amount of returns recorded by SESSION.
QU_RTN_TOT QuantityTransactionCount decimal(7,0) N N N The total number of returns recorded by SESSION.
CP_RFD_TOT Money decimal(14,3) N N N The total monetary amount of refunds recorded by SESSION.
QU_RFD_TOT QuantityTransactionCount decimal(7,0) N N N The total number of refunds recorded by SESSION.
CP_DS_EM_TOT Money decimal(14,3) N N N The total monetary amount of employee discounts recorded by SESSION.
QU_DSC_EM_TOT QuantityTransactionCount decimal(7,0) N N N The total number of employee line item discounts recorded by SESSION.
CP_DS_MSC_TOT Money decimal(14,3) N N N The total monetary amount of miscellaneous discounts recorded by SESSION.
QU_DSC_MSC_TOT QuantityTransactionCount decimal(7,0) N N N The total number of line item miscellaneous discounts recorded by SESSION.
CP_CPN_STR_TOT Money decimal(14,3) N N N The total monetary amount of store coupons recorded by SESSION.
QU_CPN_STR_TOT QuantityTransactionCount decimal(7,0) N N N The total number of store coupons recorded by SESSION.
CP_DS_RDM_CNR Money decimal(14,3) N N N The total monetary amount of container deposits redeemed by SESSION.
QU_DS_RDM_CNR QuantityTransactionCount decimal(7,0) N N N The total number of container deposits redeemed by SESSION.
CP_MKD_TOT Money decimal(14,3) N N N The total monetary amount of price markdowns made by SESSION.
QU_MKD_TOT QuantityTransactionCount decimal(7,0) N N N The total number of price markdowns made by SESSION.
CP_SLS_NT_TOT Money decimal(14,3) N N N The total monetary amount of net sales recorded by SESSION.
CP_FE_MSC_TOT Money decimal(14,3) N N N The total monetary amount of miscellaneous fees recorded by SESSION.
QU_FE_MSC_TOT QuantityTransactionCount decimal(7,0) N N N The total number of miscellaneous fees recorded by SESSION.
CP_DS_CNR_TOT Money decimal(14,3) N N N The total monetary amount of container deposits collected by SESSION.
QU_DS_CNR_TOT QuantityTransactionCount decimal(7,0) N N N The total number of container deposits collected by SESSION.
CP_PYM_CLT_TOT Money decimal(14,3) N N N The total monetary amount of payments on account collected by SESSION.
QU_PYM_CLT_TOT QuantityTransactionCount decimal(7,0) N N N The number of payments on account collected by SESSION.
CP_PYM_LY_CLT_TOTMoney decimal(14,3) N N N The total monetary amount of layaway payments collected by SESSION.
QU_PYM_LY_CLT_TOTQuantityTransactionCount decimal(7,0) N N N The total number of layaway payments collected by SESSION.
CP_DSB_PTY_CSH_TOT Money decimal(14,3) N N N The total monetary amount of petty cash payments disbursed by SESSION.
QU_DSB_PTY_CSH_ITM QuantityTransactionCount decimal(7,0) N N N The total number of petty cash line item payments disbursed by SESSION.
CP_SLS_EX_TX_GS Money decimal(14,3) N N N The total monetary amount of gross sales excluding tax recorded by SESSION.
CP_TX_TOT Money decimal(14,3) N N N The total tax amount recorded by SESSION.
CP_TX_EXM_TOT Money decimal(14,3) N N N The total tax exempt amount recorded by SESSION.
QU_TRN_TX_EXM_TOTQuantityTransactionCount decimal(7,0) N N N The total number of tax exempt transactions recorded by SESSION.
QU_OVRD_LN_ITM_TOT QuantityTransactionCount decimal(7,0) N N N The total number of line item overrides made by SESSION.
QU_LN_ITM_WT_TOT QuantityTransactionCount decimal(7,0) N N N The total number of weighed line items by SESSION.
QU_ITM_LN_KY_TOT QuantityTransactionCount decimal(7,0) N N N The total number of ITEMs keyed at the point of sale by SESSION.
QU_LN_ITM_SC_TOT QuantityTransactionCount decimal(7,0) N N N The total number of ITEMs scanned by SESSION.
PE_ITM_LN_KY_TOT Percent decimal(5,2) N N N The percentage of ITEMs keyed compared to the total sold ITEMs by SESSION.
PE_LN_ITM_SC_TOT Percent decimal(5,2) N N N The percentage of ITEMs scanned compared to the total sold ITEMs by SESSION.
QU_DPT_OPN_LN_ITMQuantityTransactionCount decimal(7,0) N N N The number of ITEMs recorded through an open department by SESSION.
PE_DPT_OPN_LN_ITMPercent decimal(5,2) N N N The percentage of ITEMs sold through an open department compared to the total sold ITEMs by
SESSION.
QU_TRN_NO_SLS_TOTQuantityTransactionCount decimal(7,0) N N N The total number of no sale transactions recorded by SESSION.
IN_RNG_TOT QuantityShortCountSeconds decimal(5,0) N N N the total time expressed in minutes spent either scanning or keying ITEMs into the WORKSTATION by
SESSION.
IN_IDL_TOT QuantityShortCountSeconds decimal(5,0) N N N The total time expressed in minutes by SESSION where no sales are being recorded at the
WORKSTATION.
IN_LCK_TOT QuantityShortCountSeconds decimal(5,0) N N N The total time expressed in minutes when the WORKSTATION is locked but the OPERATOR is logged
on the WORKSTATION by SESSION.
QU_ITM_LN_SLS_TOTQuantityTransactionCount decimal(7,0) N N N The total number of sale line items by SESSION.
SessionTax
Definition: LE_TX_SSN
Definition: A collection of tax totals for a tax authority by operator workstation session for a tender reconciliation period.
government body.
was peformed.
TS_TM_SRT TimeStampAudit datetime Y Y N The time and date at the start of the SESSION.
CP_TX_CLT_TOT Money decimal(14,3) N N N The total monetary amount of tax collected by SESSION.
CP_SLS_TX_TOT Money decimal(14,3) N N N The total monetary amount of taxable sales by SESSION..
CP_SLS_TX_EXM_TOTMoney decimal(14,3) N N N The total monetary amount of taxable sales by SESSION.
QU_TRN_TX_EXM QuantityTransactionCount decimal(7,0) N N N The total number of tax exempt transactions by SESSION
SessionTender
Definition: LE_TND_SSN
Definition: A collection of tender type accumulators by operator-workstation-session for a tender reconciliation period. This entity is used to support operator-workstation-session
tender accountability.
was peformed.
TS_TM_SRT TimeStampAudit datetime Y Y N The time and date at the start of the SESSION.
QU_MD_OVR_TND_TOT QuantityTransactionCount decimal(7,0) N N N The total number of tender media overages by SESSION.
QU_MD_SHRT_TND_TOT QuantityTransactionCount decimal(7,0) N N N The total number of tender media shortages by SESSION.
QU_MD_TND_BGN_TOT QuantityTransactionCount decimal(7,0) N N N The opening balance of tender units at the beginning of the SESSION.
QU_MD_TND_LON_TOT QuantityTransactionCount decimal(7,0) N N N The total number of tender loan media units by SESSION.
CP_MD_TND_LON_TOT Money decimal(14,3) N N N Total monetary amount of loans made by media type by SESSION.
QU_MD_TND_PKP_TOT QuantityTransactionCount decimal(7,0) N N N The total number of tender pickup media units by SESSION.
CP_MD_TND_PKP_TOTMoney decimal(14,3) N N N Total monetary amount of pickups made by media type by SESSION.
CP_DS_TND_TOT Money decimal(14,3) N N N The total monetary value of tender media deposited in the EXTERNAL DEPSITORY by SESSION.
QU_MD_TND_DS_TOTQuantityTransactionCount decimal(7,0) N N N The total number of tender media deposited in the EXTERNAL DEPOSITORY by SESSION.
CP_TND_OVR_TOT Money decimal(14,3) N N N The total amount of tender overages by SESSION.
CP_TND_SHRT_TOT Money decimal(14,3) N N N The total monetary amount of tender pickup media unit shortages by SESSION.
ShelfItem
Definition: AS_ITM_SH
Definition: Extra attributes for Items that are placed upon shelves for display before being sold. These attributes are used when creating Shelving plans for the store as well as
managing perishable StockItems.
LU_UOM_WT Code2 char(2) N Y Y The code used to specify the units in which a value is being expressed, or manner in which a
LU_UOM_SZ Code2 char(2) N Y Y The code used to specify the units in which a value is being expressed, or manner in which a
FL_RQ_UN_PRC Flag bit N N Y An indicator to identify if the SHELF ITEM needs to be individually priced rather than conveyed through
a shelf lable. Examples include high priced merchandise and variable weight products.
QU_FCG Quantity decimal(9,2) N N Y The number of units that can be containied in one facing. For example, if you can fit 30 units of a
product on a shelf and there are 3 facings, then the units per facing is 10.
TY_ITM_STPL_PRSH Code2 char(2) N N Y A code to indicate whether the SHELF ITEM is a staple or perishable product.
DI_PRD_SH_LF QuantityDayCount decimal(3,0) N N Y The number of business days the SHELF ITEM may be displayed for sale to customers and after
which must be removed. This attribute is for perishable produce items, drugs, and other time sensitive
items (like newspapers).
FL_DSD_AZN Flag bit N N Y An indicator used to identify whether the RETAIL STORE is authorized to accept the SHELF ITEM as a
direct store delivery (DSD) item.
QL_DPTH_PCKG_CNSQuantity decimal(9,2) N N Y The dimension from front to back of the consumer package on the shelf.
QL_WD_PCKG_CNS Quantity decimal(9,2) N N Y The dimension from left to right of the consumer package on the shelf.
QL_HT_PCKG_CNS Quantity decimal(9,2) N N Y The dimension from top to bottom of the consumer package on the shelf
QL_WT_PCKG_CNS Quantity decimal(9,2) N N Y The weight of the consumer package when placed upon the shelf.
ShipmentContainer
Definition: AS_CNR_SHP
Definition: A specific instance of a CONTAINER within a SHIPMENT.
ID_BL_FRGT Identity int Y Y N The carrier-assigned shipping document number
IC_BL_FRGT LineNumber smallint Y N N The line number on the FREIGHT BILL to which this particular shipment container applies.
LU_MTR_PCKG Code4External char(4) N Y Y A UCC defined code that describes the material used to fabricate the CONTAINER TYPE. This code
LU_FRM_PCKG Code4External char(4) N Y Y The UCC code to denote the type of packaging from the UCC 103 packaging code data element list..
ShipmentContainerMerchandiseLineItem
Definition: TR_LTM_SHP_CNR_MR
Definition: An association between a SHIPMENT CONTAINER and an INVENTORY CONTROL DOCUMENT MERCHANDISE LINE ITEM. This association describes
which container a specific item is being shipped in to the store.
ID_BL_FRGT Identity int Y Y N The carrier-assigned shipping document number
IC_BL_FRGT LineNumber smallint Y Y N The line number on the FREIGHT BILL to which this particular shipment container applies.
QU_PCK_SHP_CNR Quantity decimal(9,2) N N N The standard number of packs in each CONTAINER.
ShippingTaxAuthorityRule
Definition: RU_TX_ATHY_SHP
Definition: An associative entity which provides a list of TaxAuthorities that have jurisdiction when merchandise is being shipped to a particular Address.
ID_STRGP Identity int Y Y N A unique system-assigned identifier for the group of stores from which the goods are being shipped.
PC_TX_GP_RU Identity int Y Y N The PostalCode (or other suitable identifier) that uniquely identifies the TaxJurisdiction to which the
goods are being shipped.
ID_ATHY_TX_APLY Identity int Y Y N A specific TAX AUTHORITY that establishes the tax rate. The TAX AUTHORITY is normally a
government body.
Shopper
Definition: PA_SHPR
Definition: An individual that may purchase (and return goods) and services from a retailer and without establishing a persistent relationship with that retailer. A shoppers
relationship with the retailer is limited to each retail transaction.
SignOffTransaction
Definition: TR_SGN_OFF
Definition: A non sales transaction that no longer assigns TRANSACTIONS to that particular EMPLOYEE.
ID_STR_RT Identity int Y Y N A unique retailer assigned identifier for the RetailStore where the SignOffTransaction was performed
ID_WS Identity int Y Y N The unique identifier for the WORKSTATION, typically the serial number, at which the
SignOffTransaction was performed.
DC_DY_BSN DateCalendar datetime Y Y N The calendar date of the BusinessDay on which the SignOffTransaction was performed.
AI_TRN Identity int Y Y N A unique, non-significant, automatically assigned sequential number used to identify the
SignOffTransaction within the context of a Workstation, BusinessDay & Retailstore.
SignOnTransaction
Definition: TR_SGN_ON
Definition: A non sales transaction that establishes a SESSION and enables a WORKSTATION to accept RETAIL TRANSACTIONs, TENDER CONTROL TRANSACTIONs,
FINANCIAL TRANSACTIONs and other CONTROL TRANSACTIONs.
was peformed.
DC_DY_BSN DateCalendar datetime Y Y N The calendar date of the BusinessDay on which the SignOnTransaction was performed.
AI_TRN Identity int Y Y N A unique, non-significant, automatically assigned sequential number used to identify the
SignOnTransaction within the context of a Workstation and a BusinessDay.
Size
Definition: CO_SZ
Definition: This entity type is a further classification of the STOCK ITEM and is typically referred to as an option of style.
ED_SZ Code6 char(6) Y N N A code to designate the size of the ITEM. It is proposed to use the 5 apparel and miscellaneous coding
ED_TB_SZ Code2 char(2) N N Y The first character of the size code as designated by the NRF (1-9). This first digit refers to the size
table, for example 1=adult male clothing, 5=footwear and 7=home decorating accessories. Retailers
using proprietary in-house size codes use a "0 " size table.
NM_TB_SZ Name varchar(40) N N Y The name of the size table code, eg size code 4=infants and childrens clothing.
DE_TB_SZ DescriptionShort varchar(255) N N Y A description of the apparel cataegories encompassed within the size table code.
ED_SZ_ACT Code4 char(4) N N Y The last four characters of the NRF size code. This code uniquely identifies a particular size, eg dress
size 12 or combination of sizes, eg pants, waist size 36, inseam 31.
DE_TYP_ACT_SZ Name varchar(40) N N Y A description of the industry convention typically used to signify the size to the customer, eg waist used
for pants, body for coats, neck for shirts, chest for sweaters, etc.
DE_PRPTN_ACT_SZ DescriptionShort varchar(255) N N Y The proportions typically used to measure this particular ITEM type, eg 36 (waist) x 31(inseam).
StandardizedAddress
Definition: LO_ADS_STD
Definition: An address that has be standardized via a postal standardization system.
TY_FRG_DMS Code2 char(2) N N Y A code that categorizes an Address into Foreign or Domestic.
StandardizedDomesticAddress
Definition: LO_ADS_STD_DMS
Definition: A non-foreign address that conforms to postal standards.
A1_ADS Address varchar(40) N N Y The first line of the address, normally the street number and name.
A2_ADS Address varchar(40) N N Y The second line of an address, normally the Flat or Building Suite number.
CI_CNCT City varchar(30) N N Y The city component of an address
ST_CNCT State char(2) N N Y The state component of an address
PC_CNCT PostalCode varchar(15) N N Y The postal or zip code of an address
StandardizedForeignAddress
Definition: LO_ADS_STD_FRG
Definition: A non-domestic address that conforms to postal address standards.
A1_ADS Address varchar(40) N N Y The first line of the address, normally the street number & name.
A2_ADS Address varchar(40) N N Y The second line of the address, normally Building Suite or Flat number.
CI_CNCT City varchar(30) N N Y The city of the address
TE_CNCT Address varchar(40) N N Y The state, province, prefecture or other administrative area of the address
CO_CNCT Address varchar(40) N N Y The CountryCode of the address
PC_CNCT Address varchar(40) N N Y The postal code of the address.
StockItem
Definition: AS_ITM_STK
Definition: A unit of merchandise that may be sold to a customer or used by the RETAIL STORE.
TY_ITM_STK Code2 char(2) N N Y A code to indicate the STOCK ITEM type, ie SHELF ITEM, APPAREL ITEM, SERIALIZED ITEM, etc.
LU_CNT_SLS_WT_UNCode2 char(2) N N Y A code to indicate whether the STOCK ITEM is sold by weight or as an unit.
TY_PKP_CT_STK_ITMCode2 char(2) N N Y A code that defines where and how a customer may pickup this item. For examples a refrigerator may
have to be picked up at the shipping dock or at the retailers warehouse.
FA_PRC_UN_STK_ITMQuantity decimal(9,2) N N N The number of units of measure per selling unit. Used as the divisor when calculating the STOCK
ITEMs unit retail price, eg $1.67 per pound or $2.59 for 32 floz.
DC_AVLB_FR_SLS DateCalendar datetime N N Y The date when this STOCK ITEM becomes available for sale. For example, certain books have
specific publication dates, music entertainment release dates.
TY_ENV_STK_ITM Code2 char(2) N N Y A code that defines the temperature, relative humidity, lighting and other physical or climatic
environmental requirements for storing and displaying the item.
TY_SCTY_RQ Code2 char(2) N N Y A code that defines the security environment and procedures required for receiving, displaying and
selling the item. This is for high-priced merchandise like jewelry, certain prescription drugs, ordinance,
fireworks, etc.
TY_MTR_HZ_STK_ITMCode2 char(2) N N Y This code defines the relevant hazardous material handling properties of the item. This code is
provided for oil products, petsicides, swimming pool suppliers, fertilizers (especially bomb grade), etc.
LU_MTH_INV_ACNT Code2 char(2) N N Y A code to define the inventory accounting method to be used for the item. Examples of methods
include the retail method, cost method, etc.
CP_UN_SL_LS_RCV_BS MoneyShortCost decimal(10,5) N N N The base cost per sell unit derived from the last receipt of this item. The base cost excludes
allowances, discounts, charges and other amounts that may change the item cost.
CP_CST_NT_LS_RCV MoneyShortCost decimal(10,5) N N N The net cost per sell unit derived from the last receipt of this item. The base cost includes allowances,
discounts, charges and other amounts that may change the item cost. Where there are no allowances,
etc. the net cost will equal the base cost for an item.
CP_UN_SL_LND MoneyShortCost decimal(10,5) N N N The cost of the item plus the insurance, drayage, cartage, delivery, insurance, customs duties, etc.
which add up to the full delivered cost of an imported item to the store.
DC_CST_EST_LS_RCVDateCalendar datetime N N Y The date the last received costs (net and base) were established.
FL_SHRK_SH_ITM Flag bit N N Y A flad to denote if the STOCK ITEM could loose weight from the time of order until the time of receipt.
FL_SWL_SH_ITM Flag bit N N Y A flag used to indicate if the STOCK ITEM may gain weight or swell from time of order to time of
receipt.
StockItemConsumerProductLabel
Definition: AS_LB_STK_ITM_PDT
Definition: Identifies and describes the stock item for presentation on a label designed to inform or warn consumers about the product.
LU_UOM_SRV_SZ Quantity decimal(9,2) N N N The unit of measure assigned to the item for serving size counts.
TY_LB_CNS Code2 char(2) N N Y Defines the type of information to be carried on the label. Examples include nutritional information,
hazard warnings, OSHA warnings, handling warnings, laundering instructions, etc.
QU_UOM_SRV_SZ Quantity decimal(9,2) N N N The count or number of serving unit of measures in a serving.
QU_UN_RT_SRV Quantity decimal(9,2) N N N Number of servings in a retail sale unit for the item.
QU_CLRS Quantity decimal(9,2) N N N A count of the number of calories in the serving unit.
QU_CLRS_FRM_FAT Quantity decimal(9,2) N N N The number of calories derived from fat for the serving unit of the item
QU_FAT_GM_TOT Quantity decimal(9,2) N N N Total fat weight in grams for the serving of the item.
PE_INTK_DLY_FAT_TOT Percent decimal(5,2) N N N The input percentage of fat based on the total-fat-grams amount.
QW_FAT_STRT_GM Quantity decimal(9,2) N N N Total saturated fat weight in grams for the serving of the item.
PE_FAT_STRT Percent decimal(5,2) N N N The input percentage of saturated fat based on the total-fat-grams amount.
QW_CHT_MG Quantity decimal(9,2) N N N The weight (in milligrams) of cholesterol found in a serving.
PE_CHT Percent decimal(5,2) N N N The percent of daily recommended allowance for cholesterol in a serving.
QW_SDM_MG Quantity decimal(9,2) N N N The weight (in milligrams) of sodium found in a serving.
PE_SDM Percent decimal(5,2) N N N The percent of daily recommended allowance for sodium in a serving.
QW_CBHYD_MG_TOTQuantity decimal(9,2) N N N The weight (in milligrams) of carbohydrate found in a serving.
PE_CBHYD_TOT Percent decimal(5,2) N N N The percent of daily recommended allowance for carbohydrate in a serving.
QW_FB_GM Quantity decimal(9,2) N N N The weight in grams of the dietary fiber contained in a serving
QW_SGR_GM Quantity decimal(9,2) N N N The weight in grams of sugars for a serving.
QW_PRTN Quantity decimal(9,2) N N N The weight of protein, in grams, for a serving
PE_VTM_A_DLY_MNMPercent decimal(5,2) N N N The percentage of minimum daily requirement for Vitamin A
PE_VTM_B_DLY_MNMPercent decimal(5,2) N N N The percentage of minimum daily requirement for Vitamin B
PE_VTM_C_DLY_MNMPercent decimal(5,2) N N N The percentage of minimum daily requirement for Vitamin C
PE_CA_DY_MNM Percent decimal(5,2) N N N The percentage of minimum daily requirement for Calcium
PE_IR_DLY_MNM Percent decimal(5,2) N N N The percentage of minimum daily requirement for iron
NA_NTR_TXT DescriptionNarrative text N N Y General text description for nutritional information.
FL_MTR_HZ Flag bit N N Y A flag to denote whether this product is classified as a hazardous item.
TY_MTR_HZ Code4 char(4) N N Y A code to denote the type of hazardous material, eg fireworks.
StockLedgerAccount
Definition: LE_ACNT_STKG
Definition: A unit record of a LOCATION inside a store where a STOCK ITEM is stored or displayed for sale, and for which an item stock on hand count and dollar value is
maintained.
LU_MTH_ACNT_STK Code2 char(2) N N Y This code defines the accounting method used by the store, ie the retail or cost method of accounting.
QU_UN_BGN QuantityTransactionCount decimal(7,0) N N N The number of units present at the beginning of the accounting period.
MO_VL_BGN_RT Money decimal(14,3) N N N The monetary value of the units present at the beginning of the accounting period.
MO_MKN_CM Money decimal(14,3) N N N The markon amount at the beginning of the period ( initial markon).
PE_MKN_CM Percent decimal(5,2) N N N The markon percentage at the beginning of the period ( initial markon).
PE_SHRK_BGN_BDG Percent decimal(5,2) N N N The amount of budgeted shrink expressed as a percentage of sales that is likely to occur over the
length of the period.
TY_SHRK_BGN_BDG Code2 char(2) N N Y A code that defines how a retailer will calculate their budgeted shrink. For example a retailer may
calculate their budgeted shrink based on gross sales or on net sales (gross_sales - returns).
DC_RST_BGN_BLNC DateCalendar datetime N N Y The date at which the STOCK LEDGER ACCOUNT is reset. This normally coincides with the end of
the accounting period.
QU_RCV QuantityTransactionCount decimal(7,0) N N N The cumulative number of units received for a particular ITEM since the beginning of the period.
QU_SLS_GS_CM QuantityTransactionCount decimal(7,0) N N N The cumulative unit sales for a specific ITEM since the beginning of the period, excluding any returns.
QU_RTN_CM QuantityTransactionCount decimal(7,0) N N N The cumulative number of units returned of a specific ITEM since the beginning of the season.
QU_TSF_IN_CM QuantityTransactionCount decimal(7,0) N N N The cumulative number of units of a specific ITEM transferred into the RETIL STORE since the
beginning of the period.
QU_TSF_OT_CM QuantityTransactionCount decimal(7,0) N N N The cumulative number of units of a specific ITEM transferred out to other RETIL STOREs or other
FACILITYs within the retail enterprise since the beginning of the period.
QU_RTN_TO_VN QuantityTransactionCount decimal(7,0) N N N The cumulative number of units of a specific ITEM returned to the vendor since the beginning of the
period.
QU_UN_ADJT_CM QuantityTransactionCount decimal(7,0) N N N The cumulative adjustment made to the on hand amount of an ITEM since the start of the period.
TP_RCV Money decimal(14,3) N N N The cumulative retail value of units received for a particular ITEM since the beginning of the period.
TC_RCV_CM Money decimal(14,3) N N N The cumulative cost value of units received for a particular ITEM since the beginning of the period.
TP_SLS_GS_CM Money decimal(14,3) N N N The cumulative gross sales for a specific ITEM since the beginning of the period. The gross figure
excludes returns.
TP_RTN Money decimal(14,3) N N N The cumulative retail value of merchandise that is returned by customers to the store.
MO_TSF_IN_CM Money decimal(14,3) N N N The cumulative retail value of merchandise transferred into the store from other stores or distribution
centers.
MO_TSF_OT_CM Money decimal(14,3) N N N The cumulative retail value of merchandise transferred from the store to another store or distribution
center.
TP_RTN_TO_VN Money decimal(14,3) N N N The cumulative retail value of merchandise returned to the vendor from the store.
MO_ADJT_RT_CM Money decimal(14,3) N N N The cumulative retail value of inventory adjustments (overages and shortages) made to the stock
ledger account.
MO_MKD_PRN_CM Money decimal(14,3) N N N The cumulative value of permanent markdowns taken against this item.
MO_MKD_TMP_CM Money decimal(14,3) N N N The cumulative temporary or promotional markdown value taken against this item either as a price
change or through the application of price derivation rules at the point of sale.
MO_MKP_PRN_CM Money decimal(14,3) N N N The cumulative value of permanent markups taken against this item.
MO_MKP_TMP_CM Money decimal(14,3) N N N The cumulative temporary or promotional markup value taken against this item either as a price
MO_DSC_EM_CM Money decimal(14,3) N N N Cumulative value of employee discounts granted for the item
MO_DSC_AF_CMY_CMMoney decimal(14,3) N N N Cumulative discount amount granted to non-employee store affiliates. This accumulator is used to
track discounts granted to employees of business partners and other parties as determined by the
store and/or home office.
MO_DPC_DM_CM_ITMMoney decimal(14,3) N N N Cumulative retail value lost due to damage to stock.
MO_DPC_OT_OF_DT Money decimal(14,3) N N N Cumulative retail value lost due to stock aging past its sell-by date.
DC_CNT_PHY DateCalendar datetime N N Y The date this item was last physically counted
QU_UN_PHY_CNT QuantityTransactionCount decimal(7,0) N N N The retail sale unit count determined by the last physical inventory for this item.
MO_VLN_RT_PHY_CNTMoney decimal(14,3) N N N The retail valuation of the current physical count based on the retail method of accounting.
CP_UN_AV_WT MoneyShortCost decimal(10,5) N N N The weighted average cost for each retail sale unit of this item. The weighted average cost is updated
each time a shipment of this item is received.
StockLedgerAccountFiscalPeriodHistory
Definition: LE_HST_STKG_FSP
Definition: A reporting period historical record of the beginning balance and cumulative activity for an ITEM - STOCK LEDGER ACCOUNT.
QU_UN_BGN QuantityTransactionCount decimal(7,0) N N N The number of units present at the beginning of the accounting period.
MO_VL_BGN_RT Money decimal(14,3) N N N The monetary value of the units present at the beginning of the accounting period.
MO_MKN_CM Money decimal(14,3) N N N The markon amount at the beginning of the period ( initial markon).
PE_MKN_CM Percent decimal(5,2) N N N The markon percentage at the beginning of the period ( initial markon).
PE_SHRK_BGN_BDG Percent decimal(5,2) N N N The amount of budgeted shrink expressed as a percentage of sales that is likely to occur over the
length of the period.
TY_SHRK_BGN_BDG Code2 char(2) N N Y A code that defines how a retailer will calculate their budgeted shrink. For example a retailer may
calculate their budgeted shrink based on gross sales or on net sales (gross_sales - returns).
DC_RST_BGN_BLNC DateCalendar datetime N N Y The date at which the STOCK LEDGER ACCOUNT is reset. This normally coincides with the end of
the accounting period.
QU_RCV QuantityTransactionCount decimal(7,0) N N N The cumulative number of units received for a particular ITEM since the beginning of the period.
QU_SLS_GS_CM QuantityTransactionCount decimal(7,0) N N N The cumulative unit sales for a specific ITEM since the beginning of the period, excluding any returns.
QU_RTN_CM QuantityTransactionCount decimal(7,0) N N N The cumulative number of units returned of a specific ITEM since the beginning of the season.
QU_TSF_IN_CM QuantityTransactionCount decimal(7,0) N N N The cumulative number of units of a specific ITEM transferred into the RETIL STORE since the
beginning of the period.
QU_TSF_OT_CM QuantityTransactionCount decimal(7,0) N N N The cumulative number of units of a specific ITEM transferred out to other RETIL STOREs or other
FACILITYs within the retail enterprise since the beginning of the period.
QU_RTN_TO_VN QuantityTransactionCount decimal(7,0) N N N The cumulative number of units of a specific ITEM returned to the vendor since the beginning of the
period.
QU_UN_ADJT_CM QuantityTransactionCount decimal(7,0) N N N The cumulative adjustment made to the on hand amount of an ITEM since the start of the period.
TP_RCV Money decimal(14,3) N N N The cumulative retail value of units received for a particular ITEM since the beginning of the period.
TC_RCV_CM Money decimal(14,3) N N N The cumulative cost value of units received for a particular ITEM since the beginning of the period.
TP_SLS_GS_CM Money decimal(14,3) N N N The cumulative gross sales for a specific ITEM since the beginning of the period. The gross figure
excludes returns.
TP_RTN Money decimal(14,3) N N N The cumulative retail value of merchandise that is returned by customers to the store.
MO_TSF_IN_CM Money decimal(14,3) N N N The cumulative retail value of merchandise transferred into the store from other stores or distribution
centers.
MO_TSF_OT_CM Money decimal(14,3) N N N The cumulative retail value of merchandise transferred from the store to another store or distribution
center.
TP_RTN_TO_VN Money decimal(14,3) N N N The cumulative retail value of merchandise returned to the vendor from the store.
MO_ADJT_RT_CM Money decimal(14,3) N N N The cumulative retail value of inventory adjustments (overages and shortages) made to the stock
ledger account.
MO_MKD_PRN_CM Money decimal(14,3) N N N The cumulative value of permanent markdowns taken against this item.
MO_MKD_TMP_CM Money decimal(14,3) N N N The cumulative temporary or promotional markdown value taken against this item either as a price
MO_MKP_PRN_CM Money decimal(14,3) N N N The cumulative value of permanent markups taken against this item.
MO_MKP_TMP_CM Money decimal(14,3) N N N The cumulative temporary or promotional markup value taken against this item either as a price
MO_DSC_EM_CM Money decimal(14,3) N N N Cumulative value of employee discounts granted for the item
MO_DSC_AF_CMY_CMMoney decimal(14,3) N N N Cumulative discount amount granted to non-employee store affiliates. This accumulator is used to
track discounts granted to employees of business partners and other parties as determined by the
store and/or home office.
MO_DPC_DM_CM_ITMMoney decimal(14,3) N N N Cumulative retail value lost due to damage to stock.
MO_DPC_OT_OF_DT Money decimal(14,3) N N N Cumulative retail value lost due to stock aging past its sell-by date.
DC_CNT_PHY DateCalendar datetime N N Y The date this item was last physically counted
QU_UN_PHY_CNT QuantityTransactionCount decimal(7,0) N N N The retail sale unit count determined by the last physical inventory for this item.
MO_VLN_RT_PHY_CNTMoney decimal(14,3) N N N The retail valuation of the current physical count based on the retail method of accounting.
CP_UN_AV_WT MoneyShortCost decimal(10,5) N N N The weighted average cost for each retail sale unit of this item. The weighted average cost is updated
each time a shipment of this item is received.
StockMeter
Definition: AS_MTR_STK
Definition: A mechanical or electronic meter that counts the monetary value or volume of unblended BULK ITEM dispensed during all FUELLING TRANSACTIONS ever.
ID_MTR_STK Identity int Y N N A unique identifier for the stock meter
ID_MTR_DVC Number int N N Y The MeterID the FuelingPoint uses to identify this StockMeter. Cannot use this MeterID as the Primary
Key because Meters break and need to be replaced.
SC_MTR Code2Status varchar(20) N N Y A code denoting the status of the StockMeter. Possible values include Active and InActive.
StockMeterReading
Definition: DO_RDG_MTR_STK
Definition: The value of a STOCK METER recorded at a particular time for a particular reason.
ID_MTR_STK Identity int Y Y N A unique identifier for the stock meter
AI_RDG Number int Y N N A sequential number for a stock meter reading.
QY_RDG Number int N N Y The value of the STOCK METER at the time of the reading
TS_RDG Datetime datetime N N Y The date & time the meter reading was taken
RC_RDG Code2 varchar(20) N N Y A 2character code denoting the reason the meter reading was taken
StoreFinancialLedgerAccount
Definition: LE_ACNT_STR_FN
Definition: An organized collection of data in which the monetary transactions of the RETAIL STORE are posted in the form of debits and credits reflecting the income, expenses,
current assets and current liabilities created through the regular conduct of business.
ID_ACNT_LDG Identity int Y N N The reference for the STORE FINANCIAL LEDGER ACCOUNT
TY_ACNT_FN_LDG Code2 char(2) N N Y A code to denote the account type on the STORE FINANCIAL LEDGER.
DE_ACNT_FN_LDG DescriptionShort varchar(255) N N Y Description of the account type on the STORE FINANCIAL LEDGER.
MO_BLNC_BGN_FN_LDG Money decimal(14,3) N N N The beginning balance on the STORE FINANCIAL LEDGER ACCOUNT.
MO_BLNC_CRT_FN_LDG Money decimal(14,3) N N N The current financial balance on the STORE FINANCIAL LEDGER ACCOUNT.
StoreFinancialLedgerFiscalPeriodHistory
Definition: LE_HST_STR_FN_FSP
Definition: A reporting period historical record of the beginning balance and cumulative activity for a STORE FINANCIAL LEDGER ACCOUNT.
ID_ACNT_LDG Identity int Y Y N The reference for the STORE FINANCIAL LEDGER ACCOUNT
MO_BGN_FSC_PRD Money decimal(14,3) N N N The opening balance for each account for a specific fiscal period on the STORE FINNCIAL LEDGER.
MO_CM_FSC_PRD Money decimal(14,3) N N N The cumulative monetary amount of each account for a specific fiscal period on the STORE FINNCIAL
LEDGER.
SC_PRD Code2Status char(2) N N Y A code to denote the status of the STORE FINANCIAL LEDGER for a specific fiscal period, ie open or
closed.
StoreHistory
Definition: LE_HST_STR
Definition: A collection of monetary and operational totals used to track the activity volume for the entire store during a REPORTING PERIOD.
QU_LON_TND_TOT QuantityTransactionCount decimal(7,0) N N N The total number of tender loans by the RETAIL STORE for each REPORTING PERIOD.
TP_SLS_GS_PSTV_TOT Money decimal(14,3) N N N The total monetary positive gross sales amount recorded by RETAIL STORE for each REPORTING
PERIOD.
TP_SLS_GS_NG_TOT Money decimal(14,3) N N N The total monetary negative gross sales amount recorded by RETAIL STORE for each REPORTING
PERIOD.
QU_TRN_TOT QuantityTransactionCount decimal(7,0) N N N The total number of transactions recorded by the RETAIL STORE for each REPORTING PERIOD.
MO_VD_LN_ITM_TOT Money decimal(14,3) N N N The total monetary amount of line item voids made by RETAIL STORE for each REPORTING
PERIOD.
QU_VD_LN_ITM_TOT QuantityTransactionCount decimal(7,0) N N N The total number of line item voids recorded by RETAIL STORE for each REPORTING PERIOD.
MO_VD_PST_TRN_TOTMoney decimal(14,3) N N N The total monetary amount of post transaction voids recorded by RETAIL STORE for each
REPORTING PERIOD.
QU_VD_PST_TRN_TOTQuantityTransactionCount decimal(7,0) N N N The total number of post transaction voids recorded by RETAIL STORE for each REPORTING
PERIOD.
MO_VD_TRN_TOT Money decimal(14,3) N N N The total monetary amount of transaction voids recorded by RETAIL STOREfor each REPORTING
PERIOD.
QU_VD_TRN_TOT QuantityTransactionCount decimal(7,0) N N N The total number of transactions voids by RETAIL STORE for each REPORTING PERIOD.
QU_PKP_TND_TOT Money decimal(14,3) N N N The total number of tender pickups from this RETAIL STORE for each REPORTING PERIOD.
MO_LON_TND_TOT Money decimal(14,3) N N N The total monetary amount of tender loans by the RETAIL STORE for each REPORTING PERIOD.
MO_PKP_TND_TOT Money decimal(14,3) N N N The total monetary amount of tender pickups by the RETAIL STORE for each REPORTING PERIOD.
MO_RTN_TOT Money decimal(14,3) N N N The total monetary amount of returns by RETAIL STORE for each REPORTING PERIOD.
QU_RTN_TOT QuantityTransactionCount decimal(7,0) N N N The total number of returns by RETAIL STORE for each REPORTING PERIOD.
MO_RFD_TOT Money decimal(14,3) N N N The total monetary amount refunded by RETAIL STORE for each REPORTING PERIOD.
QU_RFD_TOT QuantityTransactionCount decimal(7,0) N N N The total number of refunds by RETAIL STORE for each REPORTING PERIOD.
MO_DSC_EM_TOT Money decimal(14,3) N N N The total monetary amount of employee discounts by RETAIL STORE for each REPORTING PERIOD.
QU_DSC_EM_TOT QuantityTransactionCount decimal(7,0) N N N The total number of employee discount line items by RETAIL STORE for each REPORTING PERIOD.
MO_DSC_MSC_TOT Money decimal(14,3) N N N The total monetary amount of miscellaneous discounts by RETAIL STORE for each REPORTING
PERIOD.
QU_DS_MSC_TOT QuantityTransactionCount decimal(7,0) N N N The total number of miscellaneous line items by RETAIL STORE for each REPORTING PERIOD.
MO_CPN_STR_TOT Money decimal(14,3) N N N The total monetary amount of store coupons by RETAIL STORE for each REPORTING PERIOD.
QU_CPN_STR_TOT QuantityTransactionCount decimal(7,0) N N N The total number of store coupons by RETAIL STORE for each REPORTING PERIOD.
MO_DS_RDM_CNR_TOT Money decimal(14,3) N N N The total monetary amount of container deposits redeemed by RETAIL STORE for each REPORTING
PERIOD.
QU_DS_RDM_CNR QuantityTransactionCount decimal(7,0) N N N The total number of container deposits redeemed by RETAIL STORE for each REPORTING PERIOD.
MO_MKD_TOT Money decimal(14,3) N N N The total monetary amount of line item markdowns made by RETAIL STORE for each REPORTING
PERIOD.
QU_MKD_TOT QuantityTransactionCount decimal(7,0) N N N The total number of line item markdowns made by RETAIL STORE for each REPORTING PERIOD.
MO_SLS_NT_TOT Money decimal(14,3) N N N The total monetary amount of net sales recorded by RETAIL STORE for each REPORTING PERIOD.
MO_FE_MSC_TOT Money decimal(14,3) N N N The total monetary amount of miscellaneous fees recorded by RETAIL STORE for each REPORTING
PERIOD.
QU_FE_MSC_TOT QuantityTransactionCount decimal(7,0) N N N The total number of miscellaneous fees recorded by RETAIL STORE for each REPORTING PERIOD.
MO_DS_CNR_TOT Money decimal(14,3) N N N The total monetary amount container deposits collected by RETAIL STORE for each REPORTING
PERIOD.
QU_DS_CNR_TOT QuantityTransactionCount decimal(7,0) N N N The total number of container deposits collected by RETAIL STORE for each REPORTING PERIOD.
MO_PYM_CLT_TOT Money decimal(14,3) N N N The total monetary amount of payments collected by RETAIL STORE for each REPORTING PERIOD.
QU_PYM_CLT_TOT QuantityTransactionCount decimal(7,0) N N N The total number of payments on account collected by RETAIL STORE for each REPORTING
PERIOD.
MO_PYM_LY_CLT_TOTMoney decimal(14,3) N N N The total monetary amount of layaway payments collected by RETAIL STORE for each REPORTING
PERIOD.
QU_PYM_LY_CLT_TOTQuantityTransactionCount decimal(7,0) N N N The total number of layaway payments collected by RETAIL STORE for each REPORTING PERIOD.
MO_DSB_PTY_CSH_TOT Money decimal(14,3) N N N The total monetary amount of petty cash line disbursements by RETAIL STORE for each REPORTING
PERIOD.
QU_DSB_PTY_LN_ITMQuantityTransactionCount decimal(7,0) N N N he total number of petty cash line disbursements by RETAIL STORE for each REPORTING PERIOD.
TP_SLS_EX_TX_TOT Money decimal(14,3) N N N The total gross sales excluding tax recorded by RETAIL STORE for each REPORTING PERIOD.
MO_TX_TOT Money decimal(14,3) N N N The total tax recorded by RETAIL STORE for each REPORTING PERIOD.
MO_TX_EXM_TOT Money decimal(14,3) N N N The total monetary amount of tax exempt transactions by RETAIL STORE for each REPORTING
PERIOD.
QU_TRN_TX_EXM_TOTMoney decimal(14,3) N N N The total number of tax exempt transactions by RETAIL STORE for each REPORTING PERIOD.
QU_OVRD_LN_ITM_TOT QuantityTransactionCount decimal(7,0) N N N The total number of line item overrides by RETAIL STORE for each REPORTING PERIOD.
QU_ITM_LN_WT_TOT QuantityTransactionCount decimal(7,0) N N N The total number of weighed line items by RETAIL STORE for each REPORTING PERIOD.
QU_ITM_LN_KY_TOT QuantityTransactionCount decimal(7,0) N N N The total number of ITEMs keyed at the point of sale by RETAIL STORE for each REPORTING
PERIOD.
QU_SC_LN_ITM_TOT QuantityTransactionCount decimal(7,0) N N N The total number of ITEMs scanned by RETAIL STORE for each REPORTING PERIOD.
PE_ITM_LN_KY_TOT Percent decimal(5,2) N N N The percentage of ITEMs keyed at the point of sale compared to the total sold ITEMs by RETAIL
STORE for each REPORTING PERIOD.
PE_SC_LN_ITM_TOT Percent decimal(5,2) N N N The percentage of ITEMs keyed at the point of sale compared to the total sold ITEMs by RETAIL
STORE for each REPORTING PERIOD.
QU_DPT_LN_ITM_TOTQuantityTransactionCount decimal(7,0) N N N The number of ITEMs recorded through an open department by RETAIL STORE for each
REPORTING PERIOD.
PE_DPT_LN_ITM_TOTPercent decimal(5,2) N N N The number of ITEMs recorded through an open department by RETAIL STORE for each
REPORTING PERIOD.
QU_TRN_NO_SLS_TOTQuantityTransactionCount decimal(7,0) N N N The total number of no sale transactions recorded by RETAIL STORE for each REPORTING PERIOD.
IN_RNG_TOT QuantityShortCountSeconds decimal(5,0) N N N The total time expressed in minutes spent scanning or keying ITEMs by RETAIL STORE for each
REPORTING PERIOD.
IN_IDL_TOT QuantityShortCountSeconds decimal(5,0) N N N The total time expressed in minutes spent scanning or keying ITEMs by RETAIL STORE for each
REPORTING PERIOD.
IN_LCK_TOT QuantityShortCountSeconds decimal(5,0) N N N he total time expressed in minutes when the WORKSTATION is locked even though an OPERATOR is
signed on by RETAIL STORE for each REPORTING PERIOD.
QU_ITM_LN_SLS_TOTQuantityTransactionCount decimal(7,0) N N N The total number of line item sales recorded by RETAIL STORE for each REPORTING PERIOD.
QU_SGN_ON_TOT QuantityTransactionCount decimal(7,0) N N N The total number of operator sign-ons on this RETAIL STORE for each REPORTING PERIOD.
QU_SGN_OFF_TOT QuantityTransactionCount decimal(7,0) N N N The total number of operator sign-offs on this RETAIL STORE for each REPORTING PERIOD.
CP_TND_OVR_TOT Money decimal(14,3) N N N The total number of operator sign-ons on this RETAIL STORE for each REPORTING PERIOD.
CP_TND_UND_TOT Money decimal(14,3) N N N The total monetary amount of shortages by RETAIL STORE for each REPORTING PERIOD.
QU_RCN_INTM_TND QuantityTransactionCount decimal(7,0) N N N The total number of intermediate tender reconciliations performed on the RETAIL STORE for each
REPORTING PERIOD.
CP_CHK_SND_TOT Money decimal(14,3) N N N The total monetary amount of send checks by RETAIL STORE for each REPORTING PERIOD.
QU_CHK_SND_TOT QuantityTransactionCount decimal(7,0) N N N The total number of send checks by RETAIL STORE for each REPORTING PERIOD.
MO_SLS_SPN_TOT Money decimal(14,3) N N N The total monetary value of suspended transactions made by RETAIL STORE for each REPORTING
PERIOD.
QU_TRN_SPN_TOT Quantity decimal(9,2) N N N The total number of suspended transactions made by RETAIL STORE for each REPORTING
PERIOD.
MO_SLS_RSM_TOT Money decimal(14,3) N N N The total monetary value of suspended transactions resumed by RETAIL STORE for each
REPORTING PERIOD.
QU_TRN_RSM_TOT QuantityTransactionCount decimal(7,0) N N N The total number of suspended transactions resumed by RETAIL STORE for each REPORTING
PERIOD.
StoreSafe
Definition: AS_SF_STR
Definition: A repository within the store for safekeeping TENDER removed from the TILL. Also used to secure petty cash and till loans.
DE_SF_STR DescriptionShort varchar(255) N N Y A textual description of the SAFE. The term safe can apply to any repository within the office.
StoreSafeHistory
Definition: LE_HST_STR_SF
Definition: A record of the TRANSACTIONs involving the movement of TENDER.
StoreSafeSettlementTransaction
Definition: TR_STLM_STR_SF
Definition: A transaction that records closing of the ledger for the store safe. A new ledger will be opened with a new beginning onhand accountability, and zero incremental
accumulators (pickup, loan, deposit, etc.)
StoreSafeTender
Definition: LE_TND_STR_SF
Definition: A set of tender repository totals for each type of tender in a STORE SAFE.
MO_BLNC_OPN_TOT Money decimal(14,3) N N N The opening monetary balance amount in the STORE SAFE in each REPORTING PERIOD.
MO_LON_SF_TND_TOTMoney decimal(14,3) N N N The total monetary value of tender loan media made to the WORKSTATION from the STORE SAFE in
QU_LON_TND_TOT QuantityTransactionCount decimal(7,0) N N N The total number of tender loans made to the WORKSTATION from the STORE SAFE in each
REPORTING PERIOD.
MO_PKP_SF_TND_TOTMoney decimal(14,3) N N N The total monetary value of tender pickup media from the STORE SAFE in each REPORTING
PERIOD.
QU_PKP_TND_TOT QuantityTransactionCount decimal(7,0) N N N The total number of tender pickups from the STORE SAFE in each EPORTING PERIOD.
MO_DS_SF_TND_TOTMoney decimal(14,3) N N N The total monetary amount deposited in the EXTERNAL DEPOSITORY from the STORE SAFE in
MO_RCV_SF_TND_TOT Money decimal(14,3) N N N The total monetary receipts made in the STORE SAFE in each REPORTING PERIOD.
MO_DSCP_SF_TND_OVR Money decimal(14,3) N N N The total monetary amount of tender overages in the STORE SAFE in each REPORTING PERIOD.
MO_DSCP_TNDUND_TOT Money decimal(14,3) N N N The total monetary amount of tender shortages reported from the STORE SAFE in each REPORTING
PERIOD.
MO_DSB_SF_PTY_CSHMoney decimal(14,3) N N N The total monetary amount of petty cash disbursements made from the STORE SAFE in each
REPORTING PERIOD.
QU_TRN_DSB_PTY_CSH QuantityTransactionCount decimal(7,0) N N N The total number of petty cash disbursements made from the STORE SAFE in each REPORTING
PERIOD.
StoreSafeTenderHistory
Definition: LE_HST_STR_SF_TND
Definition: An accumulator for various tender amounts and units held and transferred to and from the STORE SAFE.
MO_BLNC_OPN_TND Money decimal(14,3) N N N The monetary amount of the opening balance of the STORE SAFE TENDER by REPORTING
PERIOD.
MO_LON_TND_TOT Money decimal(14,3) N N N The total monetary amount of the tender loans made to the SAFE in each REPORTING PERIOD.
QU_LON_TND_TOT QuantityTransactionCount decimal(7,0) N N N The total number of tender loans to the SAFE in each REPORTING PERIOD.
MO_PKP_TND_TOT Money decimal(14,3) N N N The total monetary amount of the tender pickups loans made from the SAFE in each REPORTING
PERIOD.
QU_PKP_TND_TOT QuantityTransactionCount decimal(7,0) N N N The total number of tender pickups from the SAFE in each REPORTING PERIOD.
MO_DS_TND_TOT Money decimal(14,3) N N N The total monetary amount of the tender deposits made from the SAFE to the EXTERNAL
DEPOSITORY in each REPORTING PERIOD.
MO_RCV_TND_TOT Money decimal(14,3) N N N The total monetary amount of the tender receipts made to the SAFE from the EXTERNAL
DEPOSITORY in each REPORTING PERIOD.
MO_DSCP_TND_OVR_TOT Money decimal(14,3) N N N The total monetary amount of tender overages recorded for the SAFE for each REPORTING PERIOD.
MO_DSCP_TND_UND Money decimal(14,3) N N N The total monetary amount of tender shortages recorded for the SAFE for each REPORTING PERIOD.
MO_DSB_PTY_CSH_TOT Money decimal(14,3) N N N The total monetary amount of cash disbursements made from the SAFE for each REPORTING
PERIOD.
QU_TRN_DSB_PTY_CSH QuantityTransactionCount decimal(7,0) N N N The total number of cash disbursements made from the SAFE for each REPORTING PERIOD.
StoreTaxHistory
Definition: LE_HST_STR_TX
Definition: A collection of tax totals for a tax authority for the store for a REPORTING PERIOD.
ID_PRD_RP Identity int Y Y N The identifier for a particular ReportingPeriod that delimits the store tax history.
government body.
MO_SLS_TX_TOT Money decimal(14,3) N N N The total monetary amount of tax collected by the RetailStore.
MO_SLS_TXBL_TOT Money decimal(14,3) N N N The total monetary amount of taxable sales recorded by the RetailStore.
MO_SLS_TX_EXM_TOTMoney decimal(14,3) N N N The total monetary amount of tax exempt sales recorded by the RetailStore.
QU_SLS_TX_EXM QuantityTransactionCount decimal(7,0) N N N The total number of tax exempt transactions recorded by the RetailStore.
MO_PCH_TX_TOT Money decimal(14,3) N N Y The total monetary amount of tax paid by the RetailStore on supply-side purchases.
MO_PCH_TXBL_TOT Money decimal(14,3) N N Y The total monetary amount of taxable purchases made by the RetailStore on the s upply-side of the
business.
MO_PCH_TX_EXM_TOT Money decimal(14,3) N N Y The total monetary amount of tax exempt pruchases made by the RetailStore on the s upply-side of the
business.
QU_PCH_TX_EXM Money decimal(14,3) N N Y The number of tax exempt purchases made by the Retailer on the s upply-side of the business.
PE_TX_RT Percent decimal(5,2) N N N The percentage of the TaxRateRule being summarized.
MO_TX_RT MoneyShortRetail decimal(8,3) N N N The flat-tax amount of the TaxRateRule being summarized.
StoreTenderHistory
Definition: LE_HST_STR_TND
Definition: A collection of tender type accumulators for the store for a REPORTING PERIOD. This entity is used to support store-level tender accountability.
QU_MD_TND_TOT QuantityTransactionCount decimal(7,0) N N N The total number of tender media units by RETAIL STORE for each REPORTING PERIOD.
QU_MD_TND_OVR_TOT QuantityTransactionCount decimal(7,0) N N N The total monetary value of tender overages recorded by the RETAIL STORE for each REPORTING
PERIOD.
QU_MD_TND_SHRT_TOT QuantityTransactionCount decimal(7,0) N N N The total monetary value of tender shortages recorded by the RETAIL STORE for each REPORTING
PERIOD.
QU_MD_TND_BGN_TOT QuantityTransactionCount decimal(7,0) N N N The opening balance of the number of tender media units recorded by the RETAIL STORE for each
REPORTING PERIOD.
QU_MD_TND_LN_TOTQuantityTransactionCount decimal(7,0) N N N The total number of tender loan media units recorded by the RETAIL STORE for each REPORTING
PERIOD.
MO_MD_LON_TND_TOT Money decimal(14,3) N N N The total monetary value of tender loans recorded by the RETAIL STORE for each REPORTING
PERIOD.
QU_MD_TND_PKP_TOT QuantityTransactionCount decimal(7,0) N N N The total number of tender pickup media units by the RETAIL STORE for each REPORTING PERIOD.
MO_MD_TND_PKP_TOT Money decimal(14,3) N N N The total monetary value of tender pickup recorded by the RETAIL STORE for each REPORTING
PERIOD.
MO_DS_TND_TOT Money decimal(14,3) N N N The total monetary value of tender media deposited by the RETAIL STORE for each REPORTING
PERIOD.
QU_MD_TND_DS_TOTQuantityTransactionCount decimal(7,0) N N N The total number of tender media units deposited by the RETAIL STORE for each REPORTING
PERIOD.
MO_TND_OVR_TOT Money decimal(14,3) N N N The total monetary value of tender overages recorded by the RETAIL STORE for each REPORTING
PERIOD.
MO_TND_SHRT_TOT Money decimal(14,3) N N N The total monetary value of tender shortages recorded by the RETAIL STORE for each REPORTING
PERIOD.
Style
Definition: CO_STYL
Definition: This entity type identifies and describes the general appearance of retail items.
LU_STYL Code4 char(4) Y N N A code that uniquely identifies the specific appearance type or variety in which an APPAREL ITEM is
available.
DE_STYL DescriptionShort varchar(255) N N Y A textual description of the appearance type denoted by the STYLE CODE.
NM_STYL Name varchar(40) N N Y The descriptive name given to the STYLE CODE.
SubseasonPriceDerivationRuleEligibility
Definition: CO_EL_SBSN_PRDV
Definition: Defines an association between a SUBSEASON and PRICE DERIVATION RULE and the conditions which govern the application of the associated rule to an item
falling under the merchandise structure at the time an instance of the item is recorded as a line item in a sale.
Supplier
Definition: PA_SPR
Definition: An external party that acts as a source for merchandise and services offered for sale through the RETAIL STORE, or for supplies and services consumed by the store in
conducting its business.
ID_SPR Identity int Y N N A code assigned by the retailer to uniquely identify the supplier.
NM_SPR Name varchar(40) N N Y The name of the suppler.
DU_SPR IdentityDunsIdentifier char(9) N N Y The non-indicative nine-digit number assigned and maintained by Dun & Bradstreet to identify unique
business establishements, worldwide. For each reference number ( or " address "), Dun & Bradsheet
hold detailed marketing and credit information.
FL_MF_SPR_IS Flag bit N N Y A flag that indicates that this supplier is the MANUFACTURER of an item.
SupplierItem
Definition: AS_ITM_SPR
Definition: This entity type assigns a supplier-specific item identifier to a retail item and provides the supplier-specific attributes of the item. The supplier item entity type is used
to order merchandise items from a supplier price list, catalogue, etc. It provides the suppliers view of an item and uses the suppliers nomenclature in describing the items attributes.
ID_ITM_SPR Identity int Y N N The code assigned by the supplier to uniquely identify the ITEM
LU_UOM_RTL Code2 char(2) N Y Y The code used to specify the units in which a value is being expressed, or manner in which a
LU_UOM_LNR Code2 char(2) N Y Y The code used to specify the units in which a value is being expressed, or manner in which a
UC_CS_NMB_UPC_EAN ProductCodeGlobal char(14) N N Y The UPC/EAN case code, eg UPC/EAN-14, EAN-128.
DE_ITM_SPR DescriptionShort varchar(255) N N Y The description of the SUPPLIER ITEM.
DE_CLR DescriptionShort varchar(255) N N Y The suppliers color description of the SUPPLIER ITEM.
DE_SZ DescriptionShort varchar(255) N N Y The size dimensions of the SUPPLIER ITEM.
DE_STYL DescriptionShort varchar(255) N N Y The style description of the SUPPLIER ITEM.
FL_ORD_STR_ALW Flag bit N N Y A flag to indicate that the RETAIL STORE is permitted to order a particular SUPPLIER ITEM.
FL_RCV_STR_ALW Flag bit N N Y An indicator to signify whether the RETAIL STORE is permitted to receive the SUPPLIER ITEM.
FL_OVRD_MRK_CST_ALW Flag bit N N Y A flag that indicates (if true) that this SUPPLIER ITEM catalog cost may be superceded by a market
cost (known only when the item is received). This flag is intended to support produce, fresh seafood
and other perishable items with market costs that vary with every receipt.
SC_AVLB_SPR_ITM Code2 char(2) N N Y A code to signify the availability of the SUPPLIER ITEM.
ID_BYR_RSP Identity int N N Y The buyer responsible for the procurement of this SUPPLIER ITEM.
QU_UN_SLS_PR_PCKQuantity decimal(9,2) N N N The number of retail sale units in the supplier item pack. For example 24 cans of Coke (the retail sale
units) in a case (supplier item pack) or 4 six packs (the retail sale units) in a case (supplier item pack).
SupplierItemCatalogBaseCost
Definition: AS_CST_SPR_ITM_BS
Definition: The suppliers catalog base cost (the cost before any promotions, allowances, charges, discounts, etc.) for the SUPPLIER ITEM. .
TY_UN_CST Code2 char(2) Y N N Defines the unit type the owned attribute costs are assigned to for this item. Valid unit types include:
CP_UN_BS MoneyShortCost decimal(10,5) N N N The published cost, excluding any allowances for discounts, for the SUPPLIER ITEM.
CP_UN_NT MoneyShortCost decimal(10,5) N N N The published unit cost including allowances and charges for the item.
SupplierItemCatalogBaseCostBreak
Definition: CO_BRK_SPR_ITM_BS
Definition: The suppliers quantity adjusted catalog base cost (the cost before any promotions, allowances, charges, discounts, etc.) for the SUPPLIER ITEM. This entity supports
price breaks provided for buying larger quantities of an item.
QU_PNT_UND_BRK Quantity decimal(9,2) Y N N The break point in units at which a further discount can be attained by the retailer.
CP_PNT_BRK_BS_CSTMoneyShortCost decimal(10,5) N N N The revised cost price for each unit when the break point has been attained.
SupplierItemReceivingLevel
Definition: CO_LV_SPR_ITM_RCV
Definition: Defines the valid supplier item receiving levels supported within a store. For example 02-Retail Sale Unit, 04-Inner Pack Unit, 06-Outer Pack Unit and 08-Lading Unit.
This is a lowest to highest level illustration.
LU_LV_MTR_RCV Code4 char(4) Y N N A code to denote the level at which the item is received where level refers to a pallet, carton, or some
other aggregation. This code is equivalent to the UCC-735 hierarchical-level-code.
NM_LV_MTR_RCV Name varchar(40) N N Y The name of the type of material used for shipping the product to store.
DE_LV_MTR_RCV DescriptionShort varchar(255) N N Y A description of the type of material used for shipping the product to store. .
SupplierItemReceivingUnit
Definition: AS_UNI_SPR_ITM_RCV
Definition: Defines and describes valid material handling units for a supplier item. Material handling unit refers to how a supplier item is packed for shipping, receiving and
breakdown into retail sale units.
LU_FRM_PCKG Code4External char(4) Y Y N The UCC code to denote the type of packaging from the UCC 103 packaging code data element list..
LU_MTR_PCKG Code4External char(4) Y Y N A UCC defined code that describes the material used to fabricate the CONTAINER TYPE. This code
LU_LV_MTR_RCV Code4 char(4) N Y Y A code to denote the level at which the item is received where level refers to a pallet, carton, or some
other aggregation. This code is equivalent to the UCC-735 hierarchical-level-code.
QL_UN_RCV_DPTH Quantity decimal(9,2) N N N Defines the depth of a supplier item pack unit in supplier-item-linear-measure-unit-codes.
QL_UN_RCV_WD Quantity decimal(9,2) N N N Defines the width of a supplier item pack unit in supplier-item-linear-measure-unit-codes.
QL_UN_RCV_HT Quantity decimal(9,2) N N N Defines the height of a supplier item pack unit in supplier-item-linear-measure-unit-codes.
SupplierItemReceivingUnitConversionRule
Definition: RU_CVN_SPR_ITM_UN
Definition: Defines a conversion rule to explode a higher level material receiving unit into a lower level. For example a pallet may be exploded into 24 cases and each case may be
exploded into 24 retail sale units. Each of these conversions is defined in a conversion rule entity type instance
ID_ITM_TO Identity int Y Y N The retailers SKU or unique item identifier for items sold or returned.
LU_FRM_PCKG_TO Code4External char(4) Y Y N The UCC code to denote the type of packaging from the UCC 103 packaging code data element list
wich denotes the package size of the Item being extracted from the SupplierReceivingUnit by the
conversion rule.
LU_MTR_PCKG_TO Code4External char(4) Y Y N A UCC defined code that describes the material used to fabricate the CONTAINER TYPE. This code
uses the UCC 103 packaging code date element value list for packaging materials, denoting the
packaging materials for the Item being extracted from the SupplierReceivingUnit by the conversion
rule.
ID_ITM_FM Identity int Y Y N The retailers SKU or unique item identifier for items sold or returned.
LU_FRM_PCKG_FM Code4External char(4) Y Y N The UCC code to denote the type of packaging from the UCC 103 packaging code data element list,
denoting the package size of the SupplierReceivingUnit being broken down by the conversion rule.
LU_MTR_PCKG_FM Code4External char(4) Y Y N A UCC defined code that describes the material used to fabricate the CONTAINER TYPE. This code
uses the UCC 103 packaging code date element value list for packaging materials, denoting the
packaging material for the SupplierReceivingUnit being broken down by the conversion rule.
FA_FCT_CVN Quantity decimal(9,2) N N N The number of units within each shipment container. This factor is multiplied by the number of
containers to provide the total number of units.
FA_SL_CVN_TO_RT Quantity decimal(9,2) N N N The number of retail units calculated by multiplying the conversion factor count and the number of
containers.
SupplierItemStockItem
Definition: ST_ITM_SPR_STK
Definition: This entity identifies an association between a STOCK ITEM identified and managed internally by the retail store and a SUPPLIER ITEM with the intent of providing
a cross reference between the internal and supplier view of a STOCK ITEM.
QU_SLS_UN_LS_RCV QuantityTransactionCount decimal(7,0) N N N A count of retail sale units last received from a particular supplier for an item.
CP_SLS_UN_LS_RCV MoneyShortCost decimal(10,5) N N N The unit base cost (i.e. the cost excluding charges and allowances) of a retail sale unit of an item when
it was last received from a particular supplier. This is used to develop average cost when a given
STOCK ITEM is supplied by several suppliers.
FL_ASRT Flag bit N N Y A code to signify the assortment contained within the receiving pack, eg assorted colors, assorted
sizes, etc. The retailer will normally predetermine the assortment with the supplier.
DE_ASRT DescriptionShort varchar(255) N N Y The description of the assortment the item belongs to.
SupplierPricePromotionZone
Definition: CO_ZN_SPR_PRC_PRM
Definition: An association between the RETAIL STORE and a SUPPLIER used to describe the price and promotional geographical zone a store has been assigned to by a supplier.
LU_ZN_PR Code4 char(4) N N Y A code to signify the pricing policy for a specific geographic zone
LU_ZN_PRM Code4 char(4) N N Y A code to signify the pricing promotion policy for a specific geographic zone
LU_ZN_SPR_FRGT Code4 char(4) N N Y A code to signify the freight charges to retail stores within a specific geographic zone
SurveyQuestion
Definition: DO_SRVY_QST
Definition: An inquiry of a customers opinion.
Tank
Definition: LO_TNK
Definition: A kind of Location used to store a FuelItem that is measured & dispensed by one or more FuelingPoints
ID_TNK Identity int Y N N A unique identifier for this Tank
ID_LCN Identity int N Y N A unique system assigned identifier for a specific InventoryLocation within the retail enterprise.
QL_DMTR_TNK Quantity decimal(9,2) N N Y The diameter of the tank
QV_CPC_SHL Quantity decimal(9,2) N N Y The largest volume of product that a tank can hold.
QV_CPC_MXM Quantity decimal(9,2) N N Y The largest capacity that the tank safely holds, taking temperature effects into consideration.
QV_CPC_LW Quantity decimal(9,2) N N Y The volume to which a tank may be emptied without prumping vapour into the line. The amount of
product that just reaches the entrance of the suction pipe.
QL_LV_HGH Quantity decimal(9,2) N N Y The level at which the TankLevelGauge will set off the High Level Alarm .
QL_LV_LW Quantity decimal(9,2) N N Y The level at which the TankLevelGuage will set off the Low Level Alarm
QL_LV_LW_LW Quantity decimal(9,2) N N Y The level at which the TankLevelGuage will set off the Low Low Level Alarm This alarm is the I really
mean it this time, and you better do something real soon Low Level Alarm
QL_LV_WTR_HGH Quantity decimal(9,2) N N Y The level at which the TankLevelGuage will set off the High Water Alarm
QL_LV_STRP Quantity decimal(9,2) N N Y The Strap Level Height (a technical term)
QV_STRP Quantity decimal(9,2) N N Y The volume of product stored in the Tank when the height reading is equal to the StrapLevel
TankLevelGauge
Definition: AS_GGE_TNK_LV
Definition: A piece of equipment that takes measurements from TANK_PROBEs to report the amount of Fuel in TANK.
ID_GGE_TNK_LV Identity int Y N N A unique identifier for the Tank Level Gauge
LU_UOM Code2 char(2) N Y N The code used to specify the units in which a value is being expressed, or manner in which a
QU_TEMP_RFC QuantityShortCount decimal(3,0) N N Y The temperature value used in the caluclations to adjust TotalObservedVolume into the temperature
corrected GrossObservedVolume In Europe this is 15C in the U.S.A this is 60F
TankProbe
Definition: AS_PBE_TNK
Definition: A device that is housed in the Tank and periodically (or on demand) returns height (and/or volume) readings to the TankLevelGuage to which it is connected.
ID_TNK Identity int Y Y N A unique identifier for the Tank that houses the TankProbe
ID_PBE_TNK Identity int Y N N A system assigned unique identifier for the TankProbe
TY_TNK_PBE Code4 char(4) N N Y A manufacturer specific ID that specifies the type of probe that is installed.
QL_OFST_TNK Quantity decimal(9,2) N N Y The height offset that should be added to the measured fuel and water heights to account for the fact
that the TankProbe is not installed in the centre of the Tank.
TankReading
Definition: DO_RDG_TNK
Definition: A reading of the height (and/or volumes) of Fuel and Water measurements of the contents of a Tank.
ID_TNK Identity int Y Y N A unique identifier for the Tank that was measured by the reading.
ID_PBE_TNK Identity int Y Y N A system assigned unique identifier for the TankProbe that was used for the reading.
AI_RDG LineNumber smallint Y N N A unique identifier for this particular reading on this TankProbe
TS_RDG TimeStampAudit datetime N N Y The date & time the reading was taken
QU_LV_PDT Quantity decimal(9,2) N N Y The measured level of the product in the Tank
QV_OBS Quantity decimal(9,2) N N Y The volume of product (including free water) in the tank.
QV_GS_STD Quantity decimal(9,2) N N Y The volume, excluding the free water in the tank, corrected to reference temperature.
QU_TEMP_AV Quantity decimal(9,2) N N Y The average temperature of the product in the tank
QU_DNSTY_OBS Quantity decimal(9,2) N N Y The average density of the product
TankTemperatureReading
Definition: DO_RDG_TNK_TEMP
Definition: A reading of the temperature of the Fuel that is stored in a Tank.
ID_TNK Identity int Y Y N A unique identifier for this Tank
ID_SNSR_TNK_TEMP Identity int Y Y N A unique identifier for the TemperatureSensor in a particular Tank
AI_RDG Number int Y N N A unique identifier for this reading of a particular TankTemperatureSensor
TS_RDG Datetime datetime N N N The date & time the TemperatureReading was taken.
QU_TEMP Quantity decimal(9,2) N N N The measured temperature
TankTemperatureSensor
Definition: AS_SNSR_TEMP
Definition: A device that is housed in the Tank and periodically (or on demand) returns temperature readings for the FuelItem that is stored there.
ID_TNK Identity int Y Y N A unique identifier for this Tank
ID_SNSR_TNK_TEMP Identity int Y N N A unique identifier for the TemperatureSensor in a particular Tank
QL_HT Quantity decimal(9,2) N N Y The height of the temperature sensor from the bottom of the Tank
Tare
Definition: AS_TR
Definition: TARE defines the weight of the container that must be subtracted from the gross weight in order to calculate net selling weight for items priced and purchased in
weight unit of measures.
ID_TR_BLK_ITM Identity int Y N N Uniquely identifies the tare property. This normally represented by a numeric code.
QW_WT_TR Quantity decimal(9,2) N N N Defines the number of weight units of measure for the tare.
DE_WT_TR DescriptionShort varchar(255) N N Y Describes the tare.
TaxableGroup
Definition: CO_GP_TX_ITM
Definition: A group of Items for which a TaxAuthority defines TaxGroupRules
ID_GP_TX Identity int Y N N A unique retailer assigned identifier for the TaxGroup
NM_GP_TX Name varchar(40) N N Y The name of the tax group.
DE_GP_TX DescriptionShort varchar(255) N N Y A description of the taxes represented in the group
CD_RCPT_PRT Code2 char(2) N N Y A short code that is printed on a receipt to denote items that are in this TaxableGroup
TaxAuthority
Definition: PA_ATHY_TX
Definition: A government authority that levies sales taxes and on whose behalf the store collects these sales taxes.
ID_ATHY_TX Identity int Y N N A specific TAX AUTHORITY that establishes the tax rate. The TAX AUTHORITY is normally a
government body.
NM_ATHY_TX Name varchar(40) N N Y The name of the TAX AUTHORITY.
SC_RND Code2 char(2) N N Y A code that indicates how tax is to be rounded when calculated.
QU_DGT_RND Quantity decimal(9,2) N N N The number of digits to which rounding is to be calculated.
TaxAuthorityRule
Definition: RU_TX_ATHY
Definition: An associative entity that provides a list of Tax Authorities that all the stores in a particular RetailStoreGroup are governed by.
government body.
TaxExemptionModifier
Definition: CO_MDFR_TX_EXM
Definition: A line item modifier to the TaxLineItem component of a RetailTransaction that provides supplementary data regarding tax exemptions.
MO_EXM_TXBL MoneyShortRetail decimal(8,3) N N Y The value of tax exampt goods that the Customer is purchasing.
MO_EXM_TX Money decimal(14,3) N N N The amount of TAX the CUSTOMER is exempt from paying.
RC_EXM_TX Code2 char(2) N N Y A reason code for the tax exemption. Typically the CUSTOMER belongs a special group, such foreign
diplomats, religious bodies, etc. The bearer must have a certificate to qualify for the tax exemption.
AUTHORITY.
ID_CF_TX_EXM Identity int N N Y The certificate number assigned to a purchaser by a TaxAuthority exempting the purchaser from tax in
that aurhority.
NM_HLDR_TX_EXM_CF Name varchar(40) N N Y The name of the individual or organization who holds the tax exemption certificate.
TaxExemptOrganization
Definition: PA_CMY_TX_EXM
Definition: An organization whose purchases are exempt from sales tax.
TY_TX_EXM_ORGN Code2 char(2) N N Y An indicator of the type of tax exemption this organization holds.
TaxGroupRule
Definition: RU_TX_GP
Definition: A rule that prescribes how a particular tax is to be applied to a group Items.
government body.
ID_ACNT_LDG Identity int N Y Y The unique identifier for the GLAccount where taxes collectected by this TaxGroupRule are
accumulated.
NM_RU_TX Name varchar(40) N N Y The name of the TaxGroupRule
DE_RU_TX DescriptionShort varchar(255) N N Y A longer description of the how & when the TaxGroupRule is applied
AI_CMPND LineNumber smallint N N Y A sequential number that indicates the order to which multiple applicable TaxGroupRules should be
applied. Example: City, County & State TaxGroupRules are not compounding - All three rules will
contain zero (or NULL) for this value Example: PST & GST TaxGroupRules are to be applied in a
compounding fashion with PST going first - The rule for PST will contain 1 for this value, the rule for
GST will contain 2 for this value.
FL_TX_GS_AMT Flag bit N N Y A flag denoting that the TaxGroupRule is to be applied to the gross amount of the items being sold ie:
before any discounts, price-rules or deals have been applied to the regular retail price.
LU_MTH_CLC Code varchar(20) N N Y A code denoting how the TaxGroupRule is to be applied in a single transaction. Possible values
include: 1 - Calculate & round at transaction level 2 - Calculate at line item level & round at transaction
level 3 - Calcualte & round at line item unit level There is no default value, as this setting is dictated by
the TaxAuthority who defines the rule.
LU_USG_TX_RT_RU Code varchar(20) N N Y A code denoting how theTaxRateRules are to be applied within the confines of this TaxGroupRule.
Possible values are: 1 - Pick one (default) 2 - Use as taxation table
TaxGroupRuleMaintenance
Definition: MA_TX_GP_RU
Definition: A type of TaxMaintenanceEvent that results in the creation, update or deletion of a TaxGroupRule
government body.
TaxJurisdiction
Definition: CO_JRDT_TX
Definition: A geographical area over which one or more TaxAuthoritys have jurisdiction.
PC_TX_GP_RU Identity int Y N N The PostalCode (or other suitable identifier) that uniquely identifies the TaxJurisdiction.
TaxLineItem
Definition: TR_LTM_TX
Definition: A line item component of a RETAIL TRANSACTION that records the charging and offsetting liability credit for sales tax on merchandise items and services sold by
the store or debit for merchandise returned to the store.
government body.
MO_TXBL Money decimal(14,3) N N N The amount of the line for which tax is applicable.
MO_TX Money decimal(14,3) N N Y The monetary amount of sales TAX calculated by applying a set percentage to the line item. These
percentages can vary by county, state and country.
TaxMaintenanceEvent
Definition: MA_TX
Definition: A type of DataMaintenanceEvent that results in the creation, update or deletion of a TaxGroupRule or TaxRateRule.
TaxOverrideModifier
Definition: CO_MDFR_TX_OVRD
Definition: A line item modifier to the TaxLineItem component of a RetailTransaction that provides supplementary data regarding tax overrides. (Where the amount of tax
collected is reduced rather than exempted).
government body.
MO_TX_ORGL MoneyShortRetail decimal(8,3) N N Y The original amount of tax that does not have to be collected.
RC_TX_OVRD Code2 char(2) N N Y A code denoting the reason this tax override was performed.
ID_CF_TX_OVRD Identity int N N Y The certificate number assigned to a purchaser by a TaxAuthority, validating the overriding the normal
taxation rules.
NM_CF_HLDR Name varchar(40) N N Y The name on the certificate validating the overriding of the normal taxation rules.
TaxRateRule
Definition: RU_TX_RT
Definition: A rule denoting what percentage or dollar amount of tax is applied to a particular taxable total in a RetailTransaction
government body.
AI_TX_RT_RU MoneyShortRetail decimal(8,3) Y N N A squential number for theTaxRateRule, denoting the order of creation of the rules.
TY_TX_RT_RU Code2 char(2) N N Y A code denoting the kind of TaxRateRule. Possible values include: 1 - Calculate percentage of taxable
amount (default) 2 - Apply a flat amount
MO_TXBL_MNM Money decimal(14,3) N N Y The minimum taxable amount that this TaxRateRule applies to
MO_TXBL_MXM Money decimal(14,3) N N Y The maximum taxable amount that this TaxRateRule applies to
TaxRateRuleMaintenance
Definition: MA_TX_RT_RU
Definition: A type of TaxMaintenanceEvent that results in the creation, update or deletion of a TaxRateRule
government body.
AI_TX_RT_RU MoneyShortRetail decimal(8,3) N Y Y A squential number for theTaxRateRule, denoting the order of creation of the rules.
Telephone
Definition: LO_PH
Definition: A telephone, cellular, pager, fax or other telecommunication device number.
ID_PH_TYP Identity int Y Y N A category or telephone (number) types (cell, fax, voice, etc.)
CC_PH PhoneNumberCountryCode char(3) N N Y A code assigned by the telephone industry to a country or other region.
TA_PH PhoneNumberAreaCodechar(5) N N Y A code that identifies a geographic grouping of telephone numbers within the US and Canada.
TL_PH PhoneNumberLocal char(8) N N Y A number that is used to contact a PARTY via a telephone or device.
PH_EXTN PhoneNumberExtensionchar(5) N N Y Addtional numbers required to reach a person, extension, or voice mailbox.
TelephoneType
Definition: LO_PH_TYP
Definition: A classification of telephone numbers according to what they are assigned to - telephone, cell phone, pager, fax, TTY, etc.
ID_PH_TYP Identity int Y N N A category or telephone (number) types (cell, fax, voice, etc.)
DE_PH_TYP DescriptionNarrative text N N Y A description of a categortization of telephones or other devices.
TemporaryPriceChange
Definition: TR_CHN_TMP_PRC
Definition: A type of ITEM - MAINTENANCE EVENT that is a temporary change to the current retail price for a specific time period, usually for the duration of a promotion.
The WORKSTATION will record the net sales of these ITEMs.
RP_UN_TMP_PRC_CHN MoneyShortRetail decimal(8,3) N N N The amount (either monetary or percent) to be used to change or replace the current selling price for a
sale unit of the item.
TY_UN_TMP_PRC_CHNCode2 char(2) N N Y A code to define how the temporary-price-change-sale-unit-amount is to be interpreted. Valid values
include: PCT percent of current retail price to be added to or subtracted from the current retail to arrive
at a selling price; AMT, flat monetary amount to be added to or subtracted from the current retail to
arrive at a selling price; and AMTREPL, a retail sale unit price amount that is to replace the current
selling price.
TemporaryPriceChangeItem
Definition: MA_ITM_TMP_PRC_CHN
Definition: This association between a TEMPORARY PRICE CHANGE and ITEM establishes the application of a new permanent price (or percentage or monetary increase or
decrease) for an item. A TEMPORARY PRICE CHANGE is posted to an ITEM for a predefined period of time marked by beginning and ending date and time. TEMPORARY
PRICE CHANGEs are posted to an item and are applied in all transaction involving that item.
MO_PRC_NW MoneyShortRetail decimal(8,3) N N N The new Temporary Retail Price to be applied to the Item in all stores in the RetailStoreGroup as a
consequence of the PriceChangeEvent
Tender
Definition: AS_TND
Definition: Tender includes all the forms of payment that are accepted by the RETAIL STORE in settling sales and other transactions.
TY_TND Code4 char(4) Y N N A code which uniquely identifies the type of tender, ie cash, check, credit card, etc.
LU_CLS_TND Code2 char(2) N Y Y A code to denote a group of tenders with common characteristics, eg charge cards, certificates, etc.
DE_TND DescriptionShort varchar(255) N N Y Description of the tender type.
FL_NMB_SRZ_IDN_RQFlag bit N N Y A flag to signify that the serial number of the tender type has to be captured as part of the tender
process. Examples include gift certificates, checks, etc.
FL_AZN_RQ Flag bit N N Y A flag that signifies whether authorization is required before a specific tender can be accepted.
LU_MTH_AZN Code2 char(2) N N Y A code to signify the method of authorization. For example, checks may be authorized by either a third
party or by validation against the customers driving license.
FL_DT_AZN_EP_RQ Flag bit N N Y Defines a requirement that this type of tender requires an authorization expiration date and that it must
be recorded at the time of settlement.
IN_WIT_AZN_MXM_ALWQuantity decimal(9,2) N N N Maximum time delay (measured in seconds) allowed to wait for external tender authorization for this
TENDER type.
FL_IDTN_RQ_CT Flag bit N N Y A flag to signify that customer identification is required, such as drivers license.
FL_ID_PRSL_RQ Flag bit N N Y A flag that requires the customer to enter a personal identification number (PIN) to validate the method
of payment. PINs are normally required for debit card payments.
FL_SGNTR_CT_RQ Flag bit N N Y A flag that requires the customer to sign the tender( check) or resultant voucher (card) in the presence
of the operator.
FL_ACNT_ID_RQ Flag bit N N Y A flag to signify that the status of the account has to be checked before this method of tender can be
accepted.
MO_APVL_TNDFLR_ONMoney decimal(14,3) N N N The value of an individual tender above which authorization has to be sought before acceptance. This
limit is normally referred to as the floor limit and may vary by merchandise and store.
MO_APVL_TNDCE_ONMoney decimal(14,3) N N N The maximum amount of an individual tender type that can be authorized either in-house or by a third
party. This especially applies to checks where the check authorization company sets a ceiling by
retailer.
MO_APVL_TNDFLR_OFF Money decimal(14,3) N N N The value of an individual tender below which approval is not required.
MO_APVL_TNDCE_OFF Money decimal(14,3) N N N The maximum value of an individual tender that can be accepted without authorization.
LL_ACPT_TND Money decimal(14,3) N N N The minimum value that can be accepted for an individual tender. For example, certain retailers will not
accept card payments below $5.
LU_ACPT_TND Money decimal(14,3) N N N The maximum amount that can be accepted for a specific tender type.
UL_OVRD_TRGR Money decimal(14,3) N N N A trigger to override the maximum amount normally accepted for a specific tender type.
FL_PRMS_TND_LON Flag bit N N Y A flag to signify whether a specific transaction can be paid for on credit.
FL_RST_APLY Flag bit N N Y A flag to signify that specific groups of items cannot be purchased using certain tender types. For
example, food stamps cannot be used to purchase alcohol or tobacco items.
FL_AVLB_LCL_CNY Flag bit N N Y A flag to signify that change can be offered to the customer in the currency tendered.
FL_UPDT_RLTM_BLNCFlag bit N N Y A flag to signify that the customers account is updated in real-time.
FL_ENDSM_RQ Flag bit N N Y A flag to signify that an endorsement, normally the customers signature, is required before a specific
tender type can be accepted.
FL_DRW_OPN_CSH_RQ Flag bit N N Y A flag that signifies that the cash drawer opens if a certain specific tender type is offered by the
customer. For example, cash. Other forms of tender, such as checks, can be inserted into the till
through a slit in the cash drawer door without the cash drawer opening, or alternatively, into a separate
security device adjacent to the register.
MO_TH_TND_CHN Money decimal(14,3) N N N The maximum change that can be offered to a customer for a specific tender type.
FL_RQ_TND_UN_CNT Quantity decimal(9,2) N N N A flag to signify that specific tender types need to be counted and recorded by the operator prior to a
pickup.
FL_POA_TND_ACTPN Flag bit N N Y A flag to signify that a certain tender type can be accepted to credit a customers account.
FL_MSR_RQ Flag bit N N Y A flag to signify that the tender type has to be inserted into the magnetic card reader. For example,
credit and debit cards.
FL_CHK_ENC Flag bit N N Y A flag to denote whether a check is encoded with the bank deposit account and the reserve and transit
number to facilitate automated handling by the EXTERNAL DEPOSITORY.
TenderAccountApprovalReference
Definition: CO_RFC_TND_APVL
Definition: Repository of external account numbers against which an individual tender can be approved or rejected depending on the status of that account.
ID_ACNT_NMB Identity int Y N N The CUSTOMERs account number against which previous tender authorization is held.
FL_PRMS Flag bit N N Y Flag that grants or revokes permission to accept this tender for this account.
LU_ACTN_FLW_UP Code2 char(2) N N Y A retailer defined code that indicates that follow up action may be required by the retailer after
accepting or rejecting a customer tender.
UL_APVL_TND Money decimal(14,3) N N N The monetary amount up to which approval can be sought.
LU_ACTN_LS Code2 char(2) N N Y A retailer defined code that indicates the last action taken on this approval reference. Examples include
an increase or decrease in the ceiling limit amount.
ID_BK_TND_ISSG Identity int N N Y The bank or financial services organization that issued the credit or debit card.
TS_CRT_TND_APVL TimeStampAudit datetime N N N The date and time this tender approval reference was created.
TS_UPDT_LS_APVL TimeStampAudit datetime N N N The date and time the tender approval reference was last modified.
TS_APVL_TND_LS_GVN TimeStampAudit datetime N N N The date and time this tender approval reference last approved a tender payment at the store.
TenderAuthorization
Definition: CO_AZN_TND
Definition: A request to an external agency to authorize the use of some form of tender to complete a RetailTransaction. Eg: Cheques, Credit & Debit Cards, Gift Certificates or
Vouchers.
AI_TND_AZN LineNumber smallint Y N N A unique sequence number for this TenderAuthorization. Required because a particular
TenderLineItem may have more than one TenderAuthorization attempt.
ID_PRV Identity int N Y Y A unique identifier for the external agency that is providing this TenderAuthorization
ID_AZN_PRE LineNumber smallint N Y Y A unique sequence number for the TenderAuthorization that "Pre-Authorized " this TenderAuthorization
MO_RQS MoneyShortRetail decimal(8,3) N N Y The monetary value of the purchases for which an authorization is being requested.
MO_RQS_CHN MoneyShortRetail decimal(8,3) N N Y The monetary value cash-back for which an authorization is being requested
LU_ADJN_TND_AZN Code varchar(20) N N Y The adjudication code returned by the external agency to this TenderAuthorizationRequest
ID_RFC_TND_AZN Identity int N N Y A unique identifier (which may be assigned by the external authorization agency) for this
TenderAuthorization
TS_TM_DT Datetime datetime N N Y The Date and Time the TenderAuthorization was made. This may be assigned by the external agency
that is providing the TenderAuthorization.
ID_RQS_TML Identity int N N Y A unique identifier (usually assigned by an external agency that provides TenderAuthorizations) that
identifies the financial terminal that is making this TenderAuthorization
FL_HOS_AZN Flag bit N N Y A flag denoting that this TenderAuthorization was authorized by an external agency.
BM_SGN Flag bit N N Y A bitmap image of the customers signature that was captured as part of the TenderAuthorization
process.
NA_HOS DescriptionShort varchar(255) N N Y Narrative text provided by the external agency for inclusion on any reciepts printed as a result of the
TenderAuthorization
FL_CT_PRST Flag bit N N Y A flag denoting whether the Customer was or was not present during the transaction. This flag would
be False for Phone, Web & Mail-Order sales.
TenderAuthorizationProvider
Definition: PA_TND_AZN_PVR
Definition: An external party that authorizes the use of a particular tender via electronic & telephone means.
ID_PRV Identity int Y N N A unique system defined identifier for the Provider.
TenderAuthorizationReversal
Definition: TR_TND_AZN_RVS
Definition: A request to an external agency to revers a previously requested authorization of the use of some form of tender to complete a RetailTransaction. Eg: Cheques, Credit
& Debit Cards, Gift Certificates or Vouchers.
AI_TND_AZN LineNumber smallint Y Y N A unique sequence number for this TenderAuthorization. Required because a particular
TenderLineItem may have more than one TenderAuthorization attempt.
AI_RVS_TND_AZN Identity int Y N N A unique sequence number for this TenderAuthorizationReversal. Required because a particular
TenderAuthorization may have more than one reversal attempt.
LU_ADJN Money decimal(14,3) N N Y The adjudication code returned by the external agency for this TenderAuthorizationReversal
TS_TM_DT Datetime datetime N N Y The date and time that this reversal was performed.
ID_RFC Identity int N N Y The identifying reference number for this reversal. (Usually assigned by the external agency that
performs TenderAuthorizations).
NA_HOS DescriptionShort varchar(255) N N Y Narrative text provided by the external agency for inclusion on any reciepts printed as a result of the
TenderAuthorizationReversal
TenderChangeLineItem
Definition: TR_LTM_TND_CHN
Definition: A line item component of a POS TRANSACTION that records the tender returned to a customer as change as part of the settlement of a TRANSACTION.
TY_TND Code4 char(4) N Y Y A code which uniquely identifies the type of tender, ie cash, check, credit card, etc.
MO_LN_ITM_TND_CHNMoney decimal(14,3) N N N A line item for the monetary amount due back to a CUSTOMER when an overtender is made in
exchange for ITEMs.
TenderClass
Definition: CO_CLS_TND
Definition: A type of tender with common characteristics.
LU_CLS_TND Code2 char(2) Y N N A code to denote a group of tenders with common characteristics, eg charge cards, certificates, etc.
DE_CLS_TND DescriptionShort varchar(255) N N Y A description of a group of tenders with common characteristics.
TenderControlTransaction
Definition: TR_CTL_TND
Definition: A type of TRANSACTION that records the physical movement of tender from one tender repository to another.
TY_TND_CTL Code2 char(2) N N Y A code to denote the type of FINANCIAL ACCOUNTING TRANSACTION, e.g. tender loan or pickup.
RC_TND_CTL Code2 char(2) N N Y A 2 character code denoting why this tender control transaction was performed
TenderControlTransactionTenderLineItem
Definition: TR_LTM_TND_CTL_TND
Definition: This is a line item in financial transactions involving tender transfers into or out of the store safe that are NOT part of the pickup and loan tender transfer between tills
and the store safe.
ID_DNM Identity int N Y Y An identifier which uniquely identifies the quantitative value of a specific currency, e.g. $100, 50, etc.
MO_TND_FN_TRN Money decimal(14,3) N N N The monetary amount of the FINANCIAL ACCOUNTING TRANSACTION LINE ITEM.
QU_TND_FN_TRN QuantityTransactionCount decimal(7,0) N N N The number of tender units involved in the FINANCIAL ACCOUNTING TRANSACTION LINE ITEM, eg
20x$100 bills.
TenderDepositTransaction
Definition: TR_DS_TND
Definition: A type of TENDER CONTROL TRANSACTION that records the movement of tender from a STORE SAFE to an EXTERNAL REPOSITORY
TenderLineItem
Definition: TR_LTM_TND
Definition: A line item component of a POS TRANSACTION that records the settlement of that transaction with an offsetting, valid tender type.
TY_TND Code4 char(4) N Y Y A code which uniquely identifies the type of tender, ie cash, check, credit card, etc.
ID_ACNT_NMB Identity int N Y Y The CUSTOMERs account number against which previous tender authorization is held.
ID_ACNT_TND Identity int N N Y The account number of the customer tendering the TENDER. This account number is retained as a
means of an authorization history against which future payments can be referenced.
MO_FRG_CY MoneyShortRetail decimal(8,3) N N N The monetary value (in the currency submitted by the Customer) of the tender submitted by the
Customer.
MO_ITM_LN_TND Money decimal(14,3) N N N The monetary value (in the default currency of the RetailStore) of the tender submitted by the
Customer.
TY_VR_ADS Code2 char(2) N N Y A code denoting how the customers address was verified.
TenderLoanTransaction
Definition: TR_LON_TND
Definition: A TENDER CONTROL TRANSACTION that records the movement of tender from the store safe to a till.
TenderPickupTransaction
Definition: TR_PKP_TND
Definition: A type of TENDER CONTROL TRANSACTION that records the movement of tender from a till to the store safe.
TenderRepository
Definition: AS_RPSTY_TND
Definition: Describes the types of physical tender containers used in a RETAIL STORE. Tender repository generally includes assets like, store safe(s), tills, etc.
ID_RPSTY_TND Identity int Y N N The unique identifier for the TENDER RESPOSITORY.
TY_RPSTY_TND Code2 char(2) N Y Y A code to denote the type of TENDER REPOSITORY.
NM_RPSTY_TND Name varchar(40) N N Y The name of the TENDER RESPOSITORY.
DE_TND_RPSTY DescriptionShort varchar(255) N N Y The textual description of the TENDER REPOSITORY.
TenderRepositoryClass
Definition: CO_CLS_TND_RPSTY
Definition: Defines the type of TENDER REPOSITORY, eg SAFEs, TILLs, etc.
TY_RPSTY_TND Code2 char(2) Y N N A code to denote the type of TENDER REPOSITORY.
DS_CLS_TND_RPSTY DescriptionShort varchar(255) N N Y The description of the type of TENDER REPOSITORY.
TenderRepositoryTenderAccount
Definition: LE_ACNT_TND_RPSTY
Definition: An account held on the STORE FINANCIAL LEDGER of all TENDER movements by repository.
TestDelivery
Definition: TR_DV_TST
Definition: A type of TRANSATION that records the clearing of a FUELLING TRANSACTION without accepting payment because the fuelling transaction was for testing or
calibrating the FUELLING POINT. The fuel delivered may or may not have been put back into a storage
RC_DV_TST Code2 char(2) N N Y A ReasonCode denoting why the TEST DELIVERY was performed.
ThirdPartyCustomerIdentification
Definition: DO_IDTN_CT_TPRTY
Definition: A specific KEY CUSTOMERs identification number or card.
NM_IDTN_CT_TPRTY_T Name varchar(40) Y Y N The name or label given to a a third party ID.
ID_IDTN_ITM_CT LineNumber smallint Y N N A sequential number used to distinguish one THIRD PARTY CUSTOMER ID.
CH_IDTN_CT DescriptionShort varchar(255) N N Y The account, member, or other number on a third party ID.
DC_IDTN_EP DateCalendar datetime N N Y The date that a CUSTOMERs third party ID is no longer valid.
ThirdPartyCustomerIdentificationType
Definition: DO_IDTN_CT_TPRTY_T
Definition: A categorization of 3rd party customer identification cards or numbers given by a customer to identify himself.
NM_IDTN_CT_TPRTY_T Name varchar(40) Y N N The name or label given to a a third party ID.
DE_IDTN_CT_TPRTY_TDescriptionNarrative text N N Y A description of a categorization of third party IDs.
Till
Definition: AS_TL
Definition: A type of TENDER REPOSITORY that is a drawer insert, operationally associated with a WORKSTATION and optionally an EMPLOYEE. It is used to keep cash
and other TENDER collected through RETAIL TRANSACTIONS and used to make change.
SC_TL Code2 char(2) N N Y A status code to denote the status of the TILL, eg active, inactive.
TS_STS_TL TimeStampAudit datetime N N N A time and date stamp to denote the last change in the status of the TILL.
CP_BLNC_DFLT_OPN Money decimal(14,3) N N N The opening TENDER balance with which the TILL will typically start.
LU_TND_MXM_ALW Money decimal(14,3) N N N The maximum amount of TENDER allowed in the TILL at any one time.
TillHistory
Definition: LE_HST_TL
Definition: A collection of monetary and operational totals used to track the activity volume of a till between TILL SETTLEMENT TRANSACTIONS. The period covered by
TILL HISTORY is delineated by a TILL SETTLEMENT TRANSACTION which when initiated sets a TILL state to reconciling and when completed resets the state of a TILL to
cleared for business.
QU_LON_TND_TOT QuantityTransactionCount decimal(7,0) N N N The total number of tender loans by TILL for each REPORTING PERIOD.
TP_SLS_GS_PSTV_TOT Money decimal(14,3) N N N The total monetary amount of positive sales by TILL for each REPORTING PERIOD.
TP_SLS_GS_NG_TOT Money decimal(14,3) N N N The total monetary amount of negative sales by TILL for each REPORTING PERIOD.
QU_TRN_TOT QuantityTransactionCount decimal(7,0) N N N The total number of transactions by TILL for each REPORTING PERIOD.
CP_VD_LN_ITM_TOT Money decimal(14,3) N N N The total monetary amount of line item voids by TILL for each REPORTING PERIOD.
QU_VD_LN_ITM_TOT QuantityTransactionCount decimal(7,0) N N N The total number of line item voids by TILL for each REPORTING PERIOD.
CP_VD_PS_TRN Money decimal(14,3) N N N The total monetary amount of post transaction voids by TILL for each REPORTING PERIOD.
QU_VD_PST_TRN_TOTQuantityTransactionCount decimal(7,0) N N N The total number of post-transaction voids by TILL for each REPORTING PERIOD.
CP_VD_TRN_TOT Money decimal(14,3) N N N The total monetary amount of transaction voids by TILL for each REPORTING PERIOD.
QU_VD_TRN_TOT QuantityTransactionCount decimal(7,0) N N N The total number of transaction voids by TILL for each REPORTING PERIOD.
QU_PKP_TND_TOT QuantityTransactionCount decimal(7,0) N N N The total number of tender pickups by TILL for each REPORTING PERIOD.
CP_LON_TND_TOT Money decimal(14,3) N N N The total monetary amount of tender loans by TILL for each REPORTING PERIOD.
CP_PKP_TND_TOT Money decimal(14,3) N N N The total monetary amount of tender pickups by TILL for each REPORTING PERIOD.
CP_RTN_TOT Money decimal(14,3) N N N The total monetary amount of returns by TILL for each REPORTING PERIOD.
QU_RTN_TOT QuantityTransactionCount decimal(7,0) N N N The total number of returns by TILL for each REPORTING PERIOD.
CP_RFD_TOT Money decimal(14,3) N N N The total monetary amount of refunds by TILL for each REPORTING PERIOD.
QU_RFD_TOT QuantityTransactionCount decimal(7,0) N N N The total number of refunds by TILL for each REPORTING PERIOD.
CP_DS_EM_TOT Money decimal(14,3) N N N The total monetary amount of employee discounts by TILL for each REPORTING PERIOD.
QU_DSC_EM QuantityTransactionCount decimal(7,0) N N N The number of employee discount line items by TILL for each REPORTING PERIOD.
CP_DSC_MSC_TOT Money decimal(14,3) N N N The total monetary amount of miscellaneous discounts by TILL for each REPORTING PERIOD.
QU_DSC_MSC_TOT QuantityTransactionCount decimal(7,0) N N N The total number of miscellaneous discount line items by TILL for each REPORTING PERIOD.
CP_CPN_STR_TOT Money decimal(14,3) N N N The total monetary amount of store coupons accepted by TILL for each REPORTING PERIOD.
QU_CPN_STR_TOT QuantityTransactionCount decimal(7,0) N N N The total number of store coupons accepted by TILL for each REPORTING PERIOD.
CP_DS_RDM_CNR_TOT Money decimal(14,3) N N N The total monetary amount of container deposits redeemed by TILL for each REPORTING PERIOD.
QU_DS_RDM_CNR QuantityTransactionCount decimal(7,0) N N N The total number of container deposits redeemed by TILL for each REPORTING PERIOD.
CP_MKD_TOT Money decimal(14,3) N N N The total monetary amount of markdowns by TILL for each REPORTING PERIOD.
QU_MKD_TOT QuantityTransactionCount decimal(7,0) N N N The total number of markdowns recorded by TILL for each REPORTING PERIOD.
CP_SLS_NT_TOT Money decimal(14,3) N N N The total monetary amount of net sales by TILL for each REPORTING PERIOD.
CP_FE_MSC_TOT Money decimal(14,3) N N N The total monetary amount of miscellaneous fees by TILL for each REPORTING PERIOD.
QU_FE_MSC_TOT QuantityTransactionCount decimal(7,0) N N N The total number of miscellaneous fees line items by TILL for each REPORTING PERIOD.
CP_DS_CNR_TOT Money decimal(14,3) N N N The total monetary amount of container deposits collected by TILL for each REPORTING PERIOD.
QU_DS_CNTR_TOT QuantityTransactionCount decimal(7,0) N N N The total number of container deposits collected by TILL for each REPORTING PERIOD.
CP_PYM_CLT_TOT Money decimal(14,3) N N N The total monetary amount of payments on account collected by TILL for each REPORTING PERIOD.
QU_PYM_CLT_TOT QuantityTransactionCount decimal(7,0) N N N The total number of payments on account collected by TILL for each REPORTING PERIOD.
CP_PYM_LY_CLT_TOTMoney decimal(14,3) N N N The total monetary amount of layaway payments collected by TILL for each REPORTING PERIOD.
QU_PYM_LY_CLT QuantityTransactionCount decimal(7,0) N N N The total number of layaway payments on account collected by TILL for each REPORTING PERIOD.
CP_DSB_PTY_CSH_TOT Money decimal(14,3) N N N The total monetary amount of cash disbursements by TILL for each REPORTING PERIOD.
QU_DSB_PTY_LN_ITMQuantityTransactionCount decimal(7,0) N N N The total number of cash disbursement line items by TILL for each REPORTING PERIOD.
TP_SLS_EX_TX_TOT Money decimal(14,3) N N N The total monetary amount of gross sales excluding tax by TILL for each REPORTING PERIOD.
CP_TX_TOT Money decimal(14,3) N N N The total tax amount recorded by TILL for each REPORTING PERIOD.
CP_TX_EXM_TOT Money decimal(14,3) N N N The total tax exempt amount by TILL for each REPORTING PERIOD.
QU_TRN_TX_EXM_TOTQuantityTransactionCount decimal(7,0) N N N The total number of tax exempt transactions by TILL for each REPORTING PERIOD.
QU_OVRD_LN_ITM_TOT QuantityTransactionCount decimal(7,0) N N N The total number of line item overrides by TILL for each REPORTING PERIOD.
QU_ITM_LN_WT_TOT QuantityTransactionCount decimal(7,0) N N N The total number of weighed line items by TILL for each REPORTING PERIOD.
QU_KY_LN_ITM_TOT QuantityTransactionCount decimal(7,0) N N N The total number of ITEMs keyed at the point of sale by TILL for each REPORTING PERIOD.
QU_SC_LN_ITM_TOT QuantityTransactionCount decimal(7,0) N N N The total number of ITEMs scanned by TILL for each REPORTING PERIOD.
PE_KY_LN_ITM_TOT Percent decimal(5,2) N N N The percentage of ITEMs keyed at the point of sale compared to the total sold ITEMs by TILL for each
REPORTING PERIOD.
PE_SC_LN_ITM_TOT Percent decimal(5,2) N N N The percentage of ITEMs scanned compared to the total sold ITEMs by TILL for each REPORTING
PERIOD.
QU_DPT_OPN_LN_ITMQuantityTransactionCount decimal(7,0) N N N The number of ITEMs recorded through an open department by TILL for each REPORTING PERIOD.
PE_DPT_OPN_LN_ITMPercent decimal(5,2) N N N The percentage of ITEMs recorded through an open department compared to the total ITEMs by TILL
for each REPORTING PERIOD.
QU_TRN_NO_SLS_TOTQuantityTransactionCount decimal(7,0) N N N The total number of no sale transactions by TILL for each REPORTING PERIOD.
IN_RNG_TOT QuantityShortCountSeconds decimal(5,0) N N N The total time expressed in minutes of the time taken to either scan or key line item sales by TILL for
IN_IDL_TOT QuantityShortCountSeconds decimal(5,0) N N N The total time expressed in minutes by TILL where no sales are being recorded for each REPORTING
PERIOD.
IN_LCK_TOT QuantityShortCountSeconds decimal(5,0) N N N The total time expressed in minutes where a WORKSTATION is locked even though an OPERATOR
remains signed-on by TILL for each REPORTING PERIOD.
QU_ITM_LN_SLS_TOTQuantityTransactionCount decimal(7,0) N N N The total number of line item sales by TILL for each REPORTING PERIOD.
TillSettlementTransaction
Definition: TR_STLM_TL
Definition: A transaction that records the closing balances for the till. This is associated with the cash count of the TILL and reconciliation with the sales recorded by the
WORKSTATION for that EMPLOYEE.
TillTaxHistory
Definition: LE_HST_TL_TX
Definition: A collection of tax totals for a tax authority by till for a tender reconciliation period.
government body.
CP_TX_CLT_TOT Money decimal(14,3) N N N The total monetary amount of tax collected by TILL for each REPORTING PERIOD.
CP_SLS_TX_TOT Money decimal(14,3) N N N The total monetary amount of taxable sales by TILL for each REPORTING PERIOD.
CP_SLS_TX_EXM_TOTMoney decimal(14,3) N N N The total monetary amount of tax exempt sales by TILL for each REPORTING PERIOD.
QU_TRN_TX_EXM QuantityTransactionCount decimal(7,0) N N N The total number of tax exempt transactions by TILL for each REPORTING PERIOD.
TillTender
Definition: LE_TND_TL
Definition: A set of tender repository totals for each type of tender in a TILL
QU_OPN_TND_MD QuantityTransactionCount decimal(7,0) N N N The number of tender media units by TILL at the start of the REPORTING PERIOD.
CP_OPN_TND Money decimal(14,3) N N N The monetary amount of till tender by TILL at the start of the REPORTING PERIOD.
QU_MD_TND_LON QuantityTransactionCount decimal(7,0) N N N The total number of tender media units loaned by TILL in each REPORTING PERIOD.
CP_LON_TND Money decimal(14,3) N N N The total monetary amount loaned by TILL between each REPORTING PERIOD.
QU_MD_PKP_UN QuantityTransactionCount decimal(7,0) N N N The monetary amount of pickups made by TILL at the end of the REPORTING PERIOD.
CP_PKP_TND Money decimal(14,3) N N N The monetary amount of pickups made by TILL at the end of the REPORTING PERIOD.
CP_DS_TND_TOT Money decimal(14,3) N N N The total monetary amount of till tender deposited by TILL between each REPORTING PERIOD.
QU_MD_DS_TND_TOTQuantityTransactionCount decimal(7,0) N N N The total number of tender media units deposited by TILL between each REPORTING PERIOD.
QU_CL_TND_MD QuantityTransactionCount decimal(7,0) N N N The number of tender media units by TILL at the end of the REPORTING PERIOD.
CP_CL_TND_TOT Money decimal(14,3) N N N The monetary amount of till tender by TILL at the end of the REPORTING PERIOD.
CP_TND_OVR Money decimal(14,3) N N N The monetary amount of of tender overages by TILL at the end of the REPORTING PERIOD.
CP_TND_SHRT Money decimal(14,3) N N N The monetary amount of of tender shortages by TILL at the end of the REPORTING PERIOD.
QU_MD_TND_OVR_TOT QuantityTransactionCount decimal(7,0) N N N The number of tender media overage units by TILL at the end of the REPORTING PERIOD.
QU_MD_TND_SHRT_TOT QuantityTransactionCount decimal(7,0) N N N The number of tender media shortage units in the TILL at the end of the REPORTING PERIOD.
TillTenderHistory
Definition: LE_HST_TL_TND
Definition: A collection of tender type accumulators by till tender accumulation period. This entity is used to support till tender accountability.
QU_MD_TND_TOT QuantityTransactionCount decimal(7,0) N N N The total number of tender media units by TILL for each REPORTING PERIOD.
QU_MD_TND_OVR_TOT QuantityTransactionCount decimal(7,0) N N N The number of tender media overage units by TILL for each REPORTING PERIOD.
QU_MD_TND_SHRT_TOT QuantityTransactionCount decimal(7,0) N N N The number of tender media underage units in the TILL for each REPORTING PERIOD.
QU_MD_BGN_TND QuantityTransactionCount decimal(7,0) N N N The opening balance of tender media units for each REPORTING PERIOD.
QU_MD_TND_LN_TOTQuantityTransactionCount decimal(7,0) N N N The total number of tender media units loaned to the TILL for each REPORTING PERIOD.
CP_MD_TND_LON MoneyShortRetail decimal(8,3) N N N The total monetary amount of tender loaned to the TILL for each REPORTING PERIOD.
QU_MD_TND_PKP_TOT QuantityTransactionCount decimal(7,0) N N N The total number of tender pickups by TILL for each REPORTING PERIOD.
CP_MD_TND_PKP_TOTMoneyShortRetail decimal(8,3) N N N The total monetary amount of tender picked up from the TILL for each REPORTING PERIOD.
CP_DS_TND_TOT MoneyShortRetail decimal(8,3) N N N The total number of tender media units deposited by TILL for each REPORTING PERIOD.
QU_MD_TND_DS_TOTQuantityTransactionCount decimal(7,0) N N N The number of tender media units deposited by TILL for each REPORTING PERIOD.
CP_TND_OVR_TOT MoneyShortRetail decimal(8,3) N N N The total amount of overage recorded by TILL for each REPORTING PERIOD.
CP_TND_SHRT_TOT MoneyShortRetail decimal(8,3) N N N The total amount of underage recorded by TILL. for each REPORTING PERIOD.
TimeGroup
Definition: CO_GP_TM
Definition: A set of times on particular days of the week.
ID_GP_TM Identity int Y N N A unique identifier for the time group
DE_GP_TM DescriptionShort varchar(255) N N Y The human readable description for the time group
TimeGroupTimePeriod
Definition: CO_GP_PD_TM
Definition: A many-to-many resolving entity
ID_PD_TM Identity int Y Y N A unique identifier for the time period.
ID_GP_TM Identity int Y Y N A unique identifier for the time group
TimePeriod
Definition: CO_PD_TM
Definition: A period of time on a particular day of the week.
ID_PD_TM Identity int Y N N A unique identifier for the time period.
NM_PD_TM Name varchar(40) N N Y A human readable name for the time period
WD Code varchar(20) N N Y A 2 character code denoting the day of the week that the time period falls on
TM_SRT Datetime datetime N N Y The time of day that the time period commences
SI_DRN QuantityShortCountMinutes decimal(4,0) N N Y The number of minutes included in the time period from the StartTime.
TotalPurchaseMarketBasketEligibilityRule
Definition: RU_EL_PCH_MRBK
Definition: A generic rule that defines sell unit count and/or sell unit retail value trigger points for triggering the application of a price derivation rule in a sale transaction. This
rule is based on the sales volume of a customers total purchase and is not dependent on any specific item or items. This rule specifies the criteria for applying price derivation rules
-- not the rules them selves.
ID_RU_MRBK Identity int Y N N A unique identifier for the market basket eligibility rule.
TY_PRC_CHN_TRGR Code2 char(2) N N Y Identifies the type of trigger (i.e. the condition that causes this rule to be applied to a point of sale
transaction). The trigger type for example may be based on a transaction total sell unit count for an
item or it may be based on the total retail value being purchased (before application of this rule).
QU_TRGR_QTY Quantity decimal(9,2) N N N The number of sell units required to cause application of this price change rule.
MO_TRGR_RT_TOT Money decimal(14,3) N N N The extended retail value of sell units required to cause application of this price change rule -- before
application of this rule.
TY_MTH_TRGR_TRN_RN Code2 char(2) N N Y Defines the method to be used to determine market basket eligibility that is determined by a random
drawing or rub off ticket or some other random number based approach to choosing a price change to
be applied to a complete customer purchase.
TotalPurchaseMarketBasketPriceDerivationRuleEligibility
Definition: CO_EL_MRBK_PRDV
Definition: This entity associates a market basket eligibility rule with a specific price derivation rule. This association links the rule with the condition triggering its application.
ID_RU_PRC_CHN Identity int Y N N A type of price change rule.
ID_RU_MRBK Identity int N Y N A unique identifier for the market basket eligibility rule.
Trade-In-KindTenderLineItem
Definition: TR_LTM_TRDN_TND
Definition: Support retailers who accept various goods in part-payment for merchandise. Eg: white-ware retailers will give $100.00 credit an an old (working) appliance, when
purchasing a new similar appliance
TY_TRD_IN Code2 char(2) N Y Y Defines the permitted trade-in type
MO_VLN_TRD_IN Money decimal(14,3) N N N The monetary valuation of the traded-in item. The valuation can be either valued instore, to a central
location or a third party.
ID_CF_TRD_IN Identity int N N Y The unique identifier of the certificate bearing the agreed valuation amount of the traded-in item. This
certificate will be accepted in part or whole exchange of another item in this or another company store.
NM_TRD_IN Name varchar(40) N N Y The name of the person offering the traded-in item.
A1_TRD_IN Address varchar(40) N N Y The first line of the address of the person offering the traded-in item.
A2_TRD_IN Address varchar(40) N N Y The second line of the address of the person offering the traded-in item.
CI_TRD_IN City varchar(30) N N Y The city component of the address of the person offering the traded-in item.
ST_TRD_IN State char(2) N N Y Thestate component of the address of the person offering the traded-in item.
PC_TRD_IN PostalCode varchar(15) N N Y The postal address or zip code of the address offering the person of the traded-in item.
CC_TRD_IN PhoneNumberCountryCode char(3) N N Y The telephone country code of the person of the traded-in item.
TA_TRD_IN PhoneNumberAreaCodechar(5) N N Y The telephone area code of the person of the traded-in item.
TL_TRD_IN PhoneNumberCountryCode char(3) N N Y The telephone local number of the person of the traded-in item.
TY_IDN_PRF_TRD_IN Code2 char(2) N N Y A code to signify the nature of the proof of identity proffered by the customer to confirm name, address
and ownership of the trade-in item.
ID_IDN_PRF_TRD_IN Identity int N N Y A unique reference id from the proof of identity proffered by the customer.
Trade-InType
Definition: CO_TYP_TRDN
Definition: Defines valid types of trade-ins accepted by the store in exchange for merchandise.
TY_TRD_IN Code2 char(2) Y N N Defines the permitted trade-in type
DE_TYP_TRD_IN Name varchar(40) N N Y A text description of the traded-in item.
Transaction
Definition: TR_TRN
Definition: A record of business activity that involves a financial and/or merchandise unit exchange or the granting of access to conduct business at a specific device, at a specific
point in time for a specific employee.
was peformed.
AI_TRN Identity int Y N N A unique, non-significant, automatically assigned sequential number used to identify a TRANSACTION
TS_TM_SRT TimeStampAudit datetime N Y N The time and date at the start of the SESSION.
TY_TRN Code6 char(6) N Y Y A code to denote the type of TRANSACTION, eg CONTROL, FINANCIAL, and RETAIL.
TS_TRN_BGN TimeStampEffective datetime N N Y The time and date a transaction is initiated.
TS_TRN_END TimeStampExpiration datetime N N Y The time and date stamp a transaction is completed.
FL_CNCL Flag bit N N Y A flag denoting that this entire transaction has been cancelled BEFORE it was completed at the POS.
Various business rules may surround the setting of this flag, Eg: Perhaps all sub-ordinate
RetailTransactionLineItems must have the VoidFlag set.
FL_VD Flag bit N N Y A flag denoting that this entire transaction has been voided (and reversed) after it was completed at the
POS via a PostVoidTransaction. Various business rules may surround the setting of this flag. Eg: May
only use PostVoid at the same POS as the voided transaction, and may only PostVoid the last
transaction performed, and it must be done before starting a new transaction.
FL_TRG_TRN Flag bit N N Y A flag to signify whether the workstation is in training mode.
FL_KY_OFL Flag bit N N Y An indicator as to whether or not this transaction data was captured during a regular on-line POS
session or was entered during an off-line period.
TransactionTotalType
Definition: TR_TOT_TYP
Definition: One of many different kinds of Total kept in a RetailTransaction. Ususally TotalTaxableAmount, TotalTaxCollected, TotalAmountPaid, TotalItemCount, etc...
TY_TRN_TOT Code varchar(20) Y N N A unique assigned mnemonic identifier that identifies the TransactionTotalType
NM_TYP_TRN_TOT Name varchar(40) N N Y The human readable name for the TransactionTotalType
TransactionType
Definition: CO_TYP_TRN
Definition: A specific action that may be captured through a work station.
TY_TRN Code6 char(6) Y N N A code to denote the type of TRANSACTION, eg CONTROL, FINANCIAL, and RETAIL.
ID_RS Identity int N Y Y A code to uniquely identify a given application or application component.
TransferInDocument
Definition: DO_TSFN
Definition: A type of INVENTORY CONTROL DOCUMENT that is completed when there is no accompanying transfer-out document with the shipment of merchandise being
received from another store. It is an exception document much like a receiving document without a Purchase Order.
TransferOutDocument
Definition: DO_TSFT
Definition: A type of INVENTORY CONTROL DOCUMENT prepared by the originating store listing the items it is sending to the receiving store.
TranslationItem
Definition: I8_ITM
Definition: An infrastructural entity, mirroring Item, and providing translations of any natural language string attributes in Item.
ID_LGE Code4External char(4) Y Y N A combination of ISO-639-1 and ISO-3661-1 to denote a lanuage as spoken in a particular country.
NM_ITM Name varchar(40) N N Y The name of the Item translated into the nominated Language.
DE_ITM_TSL DescriptionShort varchar(255) N N Y The description of the Item translated into the nominated Language.
TranslationTender
Definition: I8_TND
Definition: An infrastructural entity, mirroring Tender, and providing translations of any natural language string attributes in Tender.
ID_LGE Code4External char(4) Y Y N A combination of ISO-639-1 and ISO-3661-1 to denote a lanuage as spoken in a particular country.
DE_TND DescriptionShort varchar(255) N N Y The Description of the tender translated into the nominated Language.
UnitOfMeasure
Definition: CO_UOM
Definition: Identifies and describes valid units of measure that are used throughout the model.
LU_UOM Code2 char(2) Y N N The code used to specify the units in which a value is being expressed, or manner in which a
TY_UOM Code2 char(2) N N Y Indicates what this unit of measure entity type instance measures. Examples include weight or mass,
length, cube (length x width x depth), volume, discrete items (each), etc.
FL_UOM_ENG_MC Flag bit N N Y Indicates whether this unit of measure is part of the English or Metric system of measurements.
NM_UOM Name varchar(40) N N Y Name assigned to this unit of measure.
DE_UOM DescriptionShort varchar(255) N N Y Description assigned to this unit of measure.
UnitOfMeasureConversion
Definition: CO_CVN_UOM
Definition: Provides the multplication factor required to convert one UnitOfMeasure to another. Eg: 1in = 2.54cm
CD_CVN_UOM_FM Code2 char(2) Y Y N The code used to specify the units in which a value is being expressed, or manner in which a
CD_CVN_UOM_TO Code2 char(2) Y Y N The code used to specify the units in which a value is being expressed, or manner in which a
MO_UOM_CVN Quantity decimal(9,2) N N Y The multiplier that converts the FromUOM to the ToUOM
Worker
Definition: PA_WRKR
Definition: A person who provides services to a retail store.
TY_WRKR Code2 char(2) Y N N A unique retailer assigned code denoting the kind of Worker.
WorkGroup
Definition: CO_GP_WRK
Definition: WORK GROUP entity contains job classifications for purposes of grouping EMPLOYEEs
ID_GP_WRK Identity int Y N N A unique identifier for a work classification group to which EMPLOYEEs are assigned.
ID_GP_WRK_PRNT Identity int N Y N The WORK GROUP this WORK GROUP belongs to. This pointer allows a store to establish a
hierarchy of work groups to facilitate making mass changes to operator access control privileges.
DE_GP_WRK DescriptionShort varchar(255) N N Y Describes the classification for the grouping of store EMPLOYEEs. Examples may include cashier,
sales associate, manager, regional manager.
Workstation
Definition: AS_WS
Definition: A device used as an as interface to any store business function . This includes the capture and storage of TRANSACTIONS and operational performance reporting
ID_WS Identity int Y N N The unique identifier for the WORKSTATION, typically the serial number.
NM_WS_MF Name varchar(40) N N Y The name of the MANUFACTURER of the WORKSTATION. Currently most MANUFACTURERs
simply assembly the components and place their badge on the device.
NM_MDL_WS_TML Name varchar(40) N N Y The model number of the WORKSTATION.
SC_TML_WS Code2Status char(2) N N Y The status code of the WORKSTATION, i.e. active, closed, off-line, etc.
QU_TL_WS QuantityShortCount decimal(3,0) N N N The number of tills that can be supported through the one WORKSTATION. In most instances each
WORKSTATION has one. In cases such as duty free stores or where the retailer wants to maintain
operator accountability there may be two.
TY_WS Code4 char(4) N N Y A code to denote the type or use of WORKSTATION, such as POS register, goods receipt terminal.
FL_MOD_TRG Flag bit N N Y A flag to denote whether the WORKSTATION is in normal operation or training mode. In the latter
none of the history accumulators are updated.
FL_WS_OTSD Flag bit N N Y A flag denoting that this Workstation is positioned outside the store (Perhaps at a FuelingPosition in
the Forecourt business segment)
NM_ADS_DVC Name varchar(40) N N Y The device address of this WORKSTATION
WorkstationHistory
Definition: LE_HST_WS
Definition: A collection of accumulators by WORKSTATION for a REPORTING PERIOD This entity is used to support WORKSTATION accountability.
QU_LON_TND_TOT QuantityTransactionCount decimal(7,0) N N N The total number of tender loans made to the WORKSTATION for each REPORTING PERIOD.
TP_SLS_GS_PSTV_TOT Money decimal(14,3) N N N The total monetary positive gross sales amount recorded by WORKSTATION for each REPORTING
PERIOD.
TP_SLS_GS_NG_TOT Money decimal(14,3) N N N The total monetary gross negative sales amount recorded by WORKSTATION for each REPORTING
PERIOD.
QU_TRN_TOT QuantityTransactionCount decimal(7,0) N N N The total number of transactions by WORKSTATION for each REPORTING PERIOD.
CP_VD_LN_ITM_TOT Money decimal(14,3) N N N The total monetary amount of line item voids made by WORKSTATION for each REPORTING
PERIOD.
QU_LTM_VD_TOT QuantityTransactionCount decimal(7,0) N N N The total number of line item voids recorded by WORKSTATION for each REPORTING PERIOD.
CP_VD_PST_TRN_TOTMoney decimal(14,3) N N N The total monetary value of post-transaction voids by WORKSTATION for each REPORTING
PERIOD.
QU_VD_PST_TRN_TOTQuantityTransactionCount decimal(7,0) N N N The total number of the transaction voids by WORKSTATION for each REPORTING PERIOD.
CP_VD_TRN_TOT Money decimal(14,3) N N N The total monetary value of transaction voids by WORKSTATION for each REPORTING PERIOD.
QU_VD_TRN_TOT QuantityTransactionCount decimal(7,0) N N N The total number of transaction voids by WORKSTATION for each REPORTING PERIOD.
QU_PKP_TND_TOT QuantityTransactionCount decimal(7,0) N N N The total number amount of tender pickups from this WORKSTATION for each REPORTING PERIOD.
CP_PKP_TND_TOT Money decimal(14,3) N N N The total monetary value of tender pickups by WORKSTATION for each REPORTING PERIOD.
CP_LON_TND_TOT Money decimal(14,3) N N N The total monetary value of tender pickups by WORKSTATION for each REPORTING PERIOD.
CP_RTN_TOT Money decimal(14,3) N N N The total monetary amount of returns recorded by WORKSTATION for each REPORTING PERIOD.
QU_RTN_TOT QuantityTransactionCount decimal(7,0) N N N The total number of returns recorded by WORKSTATION for each REPORTING PERIOD.
CP_RFD_TOT Money decimal(14,3) N N N The total monetary amount of refunds recorded by WORKSTATION for each REPORTING PERIOD.
QU_RFD_TOT QuantityTransactionCount decimal(7,0) N N N The total number of refunds recorded by WORKSTATION for each REPORTING PERIOD.
CP_DS_EM_TOT Money decimal(14,3) N N N The total monetary amount of employee discounts by WORKSTATION for each REPORTING
PERIOD.
QU_DSC_EM_TOT QuantityTransactionCount decimal(7,0) N N N The total number of employee item line discounts by WORKSTATION for each REPORTING PERIOD.
CP_DSC_MSC_TOT Money decimal(14,3) N N N The total monetary amount of miscellaneous discounts by WORKSTATION for each REPORTING
PERIOD.
QU_DSC_MSC_TOT QuantityTransactionCount decimal(7,0) N N N The total number of miscellaneous line items by WORKSTATION for each REPORTING PERIOD.
CP_CPN_STR_TOT Money decimal(14,3) N N N The total monetary amount of store coupons accepted by WORKSTATION for each REPORTING
PERIOD.
QU_CPN_STR_TOT QuantityTransactionCount decimal(7,0) N N N The total number of store coupons accepted by WORKSTATION for each REPORTING PERIOD.
CP_DS_RDM_CNR_TOT Money decimal(14,3) N N N The total monetary amount of container deposits redeemed by WORKSTATION for each REPORTING
PERIOD.
QU_DS_RDM_CNR QuantityTransactionCount decimal(7,0) N N N The total number of container deposits redeemed by WORKSTATION for each REPORTING PERIOD.
CP_MKD_TOT Money decimal(14,3) N N N The total monetary amount of price markdowns made by WORKSTATION for each REPORTING
PERIOD.
QU_MKD_TOT QuantityTransactionCount decimal(7,0) N N N The total number of price markdowns made by WORKSTATION for each REPORTING PERIOD.
TP_SLS_NT_TOT Money decimal(14,3) N N N The total monetary amount of net sales recorded by WORKSTATION for each REPORTING PERIOD.
CP_FE_MSC_TOT Money decimal(14,3) N N N The total monetary amount of miscellaneous fees recorded by WORKSTATION for each REPORTING
PERIOD.
QU_FE_MSC_TOT QuantityTransactionCount decimal(7,0) N N N The total number of miscellaneous fees recorded by WORKSTATION for each REPORTING PERIOD.
MO_DS_CNR_TOT Money decimal(14,3) N N N The total monetary amount of deposit container deposits collected by WORKSTATION for each
REPORTING PERIOD.
QU_DS_CNR_TOT QuantityTransactionCount decimal(7,0) N N N The total number of deposit container deposits collected by WORKSTATION for each REPORTING
PERIOD.
CP_PYM_CLT_TOT Money decimal(14,3) N N N The total monetary amount of payments collected by WORKSTATION for each REPORTING PERIOD.
QU_PYM_CLT_TOT QuantityTransactionCount decimal(7,0) N N N The total number of payments collected by WORKSTATION for each REPORTING PERIOD.
CP_PYM_LY_CLT_TOTMoney decimal(14,3) N N N The total monetary amount of layaway payments collected by WORKSTATION for each REPORTING
PERIOD.
QU_PYM_LY_CLT_TOTQuantityTransactionCount decimal(7,0) N N N The total number of layaway payments collected by WORKSTATION for each REPORTING PERIOD.
CP_DSB_PTY_CSH_TOT Money decimal(14,3) N N N The total monetary amount of petty cash payments disbursed by WORKSTATION for each
REPORTING PERIOD.
QU_DSB_PTY_LN_ITMQuantityTransactionCount decimal(7,0) N N N The total number of petty cash line item payments disbursed by WORKSTATION for each
REPORTING PERIOD.
TP_SLS_EX_TX_TOT Money decimal(14,3) N N N The total gross sales excluding tax recorded by WORKSTATION for each REPORTING PERIOD.
CP_TX_TOT Money decimal(14,3) N N N The total tax amount recorded by WORKSTATION for each REPORTING PERIOD.
CP_TX_EXM_TOT Money decimal(14,3) N N N The total tax exempt amount recorded by WORKSTATION for each REPORTING PERIOD.
QU_TRN_TX_EXM_TOTQuantityTransactionCount decimal(7,0) N N N The total number of tax exempt transactions recorded by WORKSTATION for each REPORTING
PERIOD.
QU_LTM_SC_TOT QuantityTransactionCount decimal(7,0) N N N The total number of line item overrides recorded by WORKSTATION for each REPORTING PERIOD.
QU_ITM_LN_WT_TOT QuantityTransactionCount decimal(7,0) N N N The total number of weighed line items recorded by WORKSTATION for each REPORTING PERIOD.
QU_LTM_KY_TOT QuantityTransactionCount decimal(7,0) N N N The total number of ITEMs keyed at the point of sale by WORKSTATION for each REPORTING
PERIOD.
QU_SC_LN_ITM_TOT QuantityTransactionCount decimal(7,0) N N N The total number of ITEMs scanned by WORKSTATION for each REPORTING PERIOD.
PE_LTM_KY_TOT Percent decimal(5,2) N N N The percentage of ITEMs keyed at the point of sale compared to the total sold ITEMs by
WORKSTATION for each REPORTING PERIOD.
PE_LTM_SC_TOT Percent decimal(5,2) N N N The percentage of ITEMs scanned compared to the total sold ITEMs by WORKSTATION for each
REPORTING PERIOD.
QU_LTM_DPT_OPN QuantityTransactionCount decimal(7,0) N N N The number of ITEMs recorded through an open department by WORKSTATION for each
REPORTING PERIOD.
PE_LTM_DPT_OPN Percent decimal(5,2) N N N The percentage of ITEMs recorded through an open department compared to the total ITEMs by
WORKSTATION for each REPORTING PERIOD.
QU_TRN_NO_SLS_TOTQuantityTransactionCount decimal(7,0) N N N The total number of no sale transactions by WORKSTATION for each REPORTING PERIOD.
IN_RNG_TOT QuantityShortCountSeconds decimal(5,0) N N N The total time expressed in minutes spent scanning or keying line items into the WORKSTATION for
IN_IDL_TOT_TOT QuantityShortCountSeconds decimal(5,0) N N N The total time expressed in minutes by WORKSTATION where no sales are being recorded for each
REPORTING PERIOD.
IN_LCK_TOT QuantityShortCountSeconds decimal(5,0) N N N The total time expressed in minutes when the WORKSTATION is locked but the OPERATOR is logged
onto the WORKSTATION for each REPORTING PERIOD.
QU_ITM_LN_SLS_TOTQuantityTransactionCount decimal(7,0) N N N The total number of line item sales by WORKSTATION for each REPORTING PERIOD.
QU_SGN_ON_TOT QuantityTransactionCount decimal(7,0) N N N The total number of operator sign-ons on this WORKSTATION for each REPORTING PERIOD.
QU_SGN_OFF_TOT QuantityTransactionCount decimal(7,0) N N N The total number of operator sign-offs on this WORKSTATION for each REPORTING PERIOD.
CP_TND_OVR_TOT Money decimal(14,3) N N N The total monetary amount of tender overages by WORKSTATION for each REPORTING PERIOD.
CP_TND_UND_TOT Money decimal(14,3) N N N The total monetary amount of tender shortages by WORKSTATION for each REPORTING PERIOD.
QU_RCN_INTM_TND QuantityTransactionCount decimal(7,0) N N N The total number of intermediate tender reconciliation counts by WORKSATION for each REPORTING
PERIOD.
CP_CHK_SND_TOT Money decimal(14,3) N N N The total monetary amount of send checks recorded by WORKSTATION for each REPORTING
PERIOD.
QU_CHK_SND_TOT QuantityTransactionCount decimal(7,0) N N N The total number of send checks recorded by WORKSTATION for each REPORTING PERIOD.
CP_SLS_SPN_TOT Money decimal(14,3) N N N The total monetary amount of suspended transactions by WORKSTATION for each REPORTING
PERIOD.
QU_TRN_SPN QuantityTransactionCount decimal(7,0) N N N The total number of suspended transactions by WORKSTATION for each REPORTING PERIOD.
CP_SLS_RSM_TOT Money decimal(14,3) N N N The total monetary amount of suspended transactions resumed by WORKSTATION for each
REPORTING PERIOD.
QU_TRN_RSM QuantityTransactionCount decimal(7,0) N N N The total number of suspended transactions resumed by WORKSTATION for each REPORTING
PERIOD.
WorkstationResource
Definition: ST_WS_RS
Definition: WORKSTATION-RESOURCE defines the resources that can be performed on the WORKSTATION.
PS_ACS_RD Code2 char(2) N N Y An indicator to signify that read access is granted to the referenced WORKSTATION for the
corresponding resource identified in this record. Read access limitation may be set by, for example, no
access, group access, user access, etc.
PS_ACS_WR Code2 char(2) N N Y An indicator to signify that write access is granted to the WORKSTATION for the corresponding
resource identified in this record. Write access limitation may be set by, for example, no access, group
WorkstationRule
Definition: RU_WS
Definition: A rule governing the type and size of transactions that may be performed at a WORKSTATION.
ID_GP_WS Identity int Y N N A unique identifier for a group of WORKSTATIONs. This could refer to the WORKSTATIONs at the
checkout, delicatessen, customer service or in the goods receiving area of the store.
TY_RU_WS Code2 char(2) Y N N A code that refers to a specific WORKSTATION RULE type.
ID_RU_WS Identity int Y N N A reference number for a specific WORKSTATION RULE.
NM_RU_WS Name varchar(40) N N Y A label for a rule that may limit sales at a specific workstation.
LL_RU_WS Money decimal(14,3) N N N A WORKSTATION RULE that refers to a lower limit amount, below which supervisory approval is
required.
UL_RU_WS Money decimal(14,3) N N N A WORKSTATION RULE that refers to an upper limit amount, above which supervisory approval is
required. This can apply to individual item sale or the whole TRANSACTION.
TY_ACTN_RQ_BLW_LMCode2 char(2) N N Y A code that specifies the type of supervisory action required when the WORKSTATION records an
item movement below a lower limit.
TY_ACTN_RQ_ABV_LMCode2 char(2) N N Y A code that specifies the type of supervisory action required when the WORKSTATION records an
item movement above an upper limit.
TY_ACTN_APVL_BY Code2 char(2) N N Y A code to signify the type of approval granted.
CP_MPR_WS_RU Quantity decimal(9,2) N N N A rule that specifies the amount by which a certain monetary amount can be multiplied. For example
coupons can be tripled in value as part of a promotion.d
TY_MPD_MPR_WS_RUCode2 char(2) N N Y A code to signify how much a multiplicand can be multiplied. For example coupons can be doubled in
value up to a coupon value of 50c. Beyond that value the coupon is accepted at its face value.
WorkstationRuleApplication
Definition: CO_APLN_WS_RU
Definition: An association indicating applicability of a rule to a workstation.
TY_RU_WS Code2 char(2) Y Y N A code that refers to a specific WORKSTATION RULE type.
ID_RU_WS Identity int Y Y N A reference number for a specific WORKSTATION RULE.
ID_GP_WS Identity int Y Y N A unique identifier for a group of WORKSTATIONs. This could refer to the WORKSTATIONs at the
DC_APLN_EF DateCalendar datetime N N Y The date on which a specific WORKSTATION RULE becomes effective.
DC_APLN_EP DateCalendar datetime N N Y The date on which a specific WORKSTATION RULE expires.
TS_APLN_CRT TimeStampEffective datetime N N Y The time and date on which a specific WORKSTATION RULE is created.
WorkstationRuleOverrideHistory
Definition: LE_HST_WS_RU_OVRD
Definition: A transaction record of which WORKSTATION RULES are overriden and by which EMPLOYEE.
FL_OVRD_WS_RU Flag bit N N Y A flag to signify that a certain limit has been overriden.
WorkstationRuleTender
Definition: RU_TND_WS
Definition: A limitation for a specific WORKSTATION on what types of tenders may be accepted. For instance, a workstation without a card reader may be restricted to cash and
checks only.
WorkstationTaxHistory
Definition: LE_HST_WS_TX
Definition: A collection of tax totals for a tax authority by workstation for a reporting period.
government body.
CP_TX_CLT_TOT Money decimal(14,3) N N N The total monetary amount of tax collected by WORKSTATION for each REPORTING PERIOD.
CP_SLS_TX_TOT Money decimal(14,3) N N N The total monetary amount of taxable sales by WORKSTATION for each REPORTING PERIOD.
CP_SLS_TX_EXM_TOTMoney decimal(14,3) N N N The total monetary amount of tax exempt sales by WORKSTATION for each REPORTING PERIOD.
QU_TRN_TX_EXM QuantityTransactionCount decimal(7,0) N N N The total number of tax exempt transactions by WORKSTATION for each REPORTING PERIOD.
WorkstationTenderHistory
Definition: LE_HST_WS_TND
Definition: A collection of tender type accumulators by WORKSTATION for a REPORTING PERIOD. This entity is used to support workstation tender accountability.
QU_MD_TND_TOT QuantityTransactionCount decimal(7,0) N N N The total number of tender pickup media units recorded by WORKSTATION for each REPORTING
PERIOD.
QU_MD_TND_OVR_TOT QuantityTransactionCount decimal(7,0) N N N The total number of tender media unit overages recorded by WORKSTATION for each REPORTING
PERIOD.
QU_MD_TND_SHRT_TOT QuantityTransactionCount decimal(7,0) N N N The total number of tender media unit shortages recorded by WORKSTATION for each REPORTING
PERIOD.
QU_MD_BGN_TND QuantityTransactionCount decimal(7,0) N N N The opening balance of the number of tender media units for that WORKSTATION for each
REPORTING PERIOD.
QU_MD_TND_LN_TOTQuantityTransactionCount decimal(7,0) N N N The total number of tender loan media units collected from WORKSTATION for each REPORTING
PERIOD.
CP_MD_TND_LON_TOT Money decimal(14,3) N N N The total monetary value of tender media loans recorded by WORKSTATION for each REPORTING
PERIOD.
QU_MD_TND_PKP_TOT QuantityTransactionCount decimal(7,0) N N N The total number of tender pickup media units recorded by WORKSTATION for each REPORTING
PERIOD.
CP_MD_TND_PKP_TOTMoney decimal(14,3) N N N The total monetary value of tender media pickups recorded by WORKSTATION for each REPORTING
PERIOD.
CP_DS_TND_TOT Money decimal(14,3) N N N The total monetary value of tender pickup media recorded by WORKSTATION for each REPORTING
PERIOD.
QU_MD_TND_DS_TOTQuantityTransactionCount decimal(7,0) N N N The total number of tender media units deposited on behalf of that WORKSTATION for each
REPORTING PERIOD.
CP_TND_OVR_TOT Money decimal(14,3) N N N The total monetary value of tender overages recorded by WORKSTATION for each REPORTING
PERIOD.
CP_TND_SHRT_TOT Money decimal(14,3) N N N The total monetary value of tender underages recorded for that WORKSTATION for each
REPORTING PERIOD.
WorkstationTimeActivityHistory
Definition: LE_HST_WS_TMACV
Definition: A set of time-bounded totals used to track the operational performance of a workstation primarily for workforce planning and service level planning. The time-bounded
totals typically are for 6, 10 or 15 minute intervals.
DC_WS DateCalendar datetime Y N N The actual date recorded by the WORKSTATION.
IN_PRD_TM_HR Time datetime Y N N The time periods expressed in hours to measure line and transaction activity.
QU_INTV_PR_MN_PRDQuantityShortCountMinutes decimal(4,0) Y N N The number of intervals in minutes for measuring line and transaction activity.
QU_INTV_PR_HR_PRDQuantityShortCount decimal(3,0) Y N N The number of time intervals per hour for measuring line and transaction activity.
CP_SLS_NT Money decimal(14,3) N N N The net sales amount recorded by the WORKSTATION in the defined time period intervals.
QU_SLS_LN_ITM QuantityTransactionCount decimal(7,0) N N N The total number of line items sold by the WORKSTATION in the defined time period intervals.
QU_TRN_TOT QuantityTransactionCount decimal(7,0) N N N A WORKSATION accumulator for holding the number of TRANSACTIONs across the defined time
intervals.
MI_SGN_ON QuantityTransactionCount decimal(7,0) N N N The number of minutes since the OPERATOR signed on the WORKSTATION.
WorkstationTimeActivityTenderHistory
Definition: LE_HST_TMACV_TND
Definition: A historical record of ITEM and TRANSACTION movement by pre-defined time intervals so as to measure WORKSTATION productivity.
IN_PRD_TM_HR Time datetime Y Y N The time periods expressed in hours to measure line and transaction activity.
QU_INTV_PR_MN_PRDQuantityShortCountMinutes decimal(4,0) Y Y N The number of intervals in minutes for measuring line and transaction activity.
QU_INTV_PR_HR_PRDQuantityShortCount decimal(3,0) Y Y N The number of time intervals per hour for measuring line and transaction activity.
DC_WS DateCalendar datetime Y Y N The actual date recorded by the WORKSTATION.
CP_TND_NT Money decimal(14,3) N N N The monetary amount of tender taken by the WORKSTATION in the defined time period intervals.

NearPhysical VolumeII

Caricato da

Informazioni sul documento

Descrizione originale:

Titolo originale

Copyright

Formati disponibili

Condividi questo documento

Condividi o incorpora il documento

Opzioni di condivisione

Hai trovato utile questo documento?

Questo contenuto è inappropriato?

Copyright:

Formati disponibili

NearPhysical VolumeII

Caricato da

Copyright:

Formati disponibili

ARTS Data Model Committee

Retail Data Model Near Physical View

Potrebbero piacerti anche