Version 7.2 to Version 7.3 Entity-Attribute Changes

Top  Previous  Next

The next table lists new attributes.  The list includes the entity name and is ordered by entity name and attribute name.

Figure 89 - New Version 7.3 Attributes (by Entity.Attribute)

V73_ET_AT_NAME

V73_TBL_COL_NAME

V73_AT_DEF

V73_DOMAIN_NAME

V73_AT_DATA_TYPE

BounceBackCouponDocument.RetailTransactionDocumentID

DO_BNC_BK_CPN_DCM.ID_RTL_TRN_DCM

A token identifier for a RetailTransactionDocument instance.

Identity

integer

BrandedTenderMediaPromotionRewardEligibility.RewardDerivationRuleEligibilityID

RU_BRN_TND_MD_EL.ID_EL_PRDV

A unique identifier for a Reward Derivation Rule Eligibility.

Identity

integer

BrandedTenderMediaPromotionRewardEligibility.TenderMediaBrandID

RU_BRN_TND_MD_EL.ID_TND_MD_BRN

Token identifier for a tender media brand.

Identity

integer

BrandedTenderMediaPromotionRewardEligibility.TenderTypeCode

RU_BRN_TND_MD_EL.TY_TND

A code which uniquely identifies the type of tender, ie cash, check, credit card, etc.

 

Sample Values:

 

CASH - currency

CREDIT - credit card

DEBIT - debit card

CUST_ACCT - customer credit account with retailer

EBT - electronic benefits transfer

CHEQUE - personal or business cheque

STORED_VALUE - gift cert. or gift card

COUPON - mfg coupon

VOUCHER - retailer issued debit (e.g. coinstar voucher)

SEND_CHECK - paid out/refund via acct pay.

TRADEIN - trade in kind/trade in debit

OTHER - other debit offset tender type

Code

varchar(20)

BrandRewardDerivationRuleEligibility.BrandName

CO_EL_BRN_PRDV.NM_BRN

A unique name to denote a class of ITEMs as a product. The brand can include private label ITEMs.

Name

varchar(40)

BrandRewardDerivationRuleEligibility.RewardDerivationRuleEligibilityID

CO_EL_BRN_PRDV.ID_EL_PRDV

A unique identifier for a Price Derivation Rule Eligibility.

Identity

integer

CalendarPeriodRewardDerivationRuleEligibility.CalendarID

CO_EL_CLD_PRDV.ID_CLD

A unique system assigned identifier for the Calendar.

Identity

integer

CalendarPeriodRewardDerivationRuleEligibility.CalendarLevelID

CO_EL_CLD_PRDV.ID_CLD_LV

A unique system assigned identifier for the CalendarLevel.

Identity

integer

CalendarPeriodRewardDerivationRuleEligibility.CalendarPeriodID

CO_EL_CLD_PRDV.ID_CLD_PRD

A unique system assigned identifier for this CalendarPeriod

Identity

integer

CalendarPeriodRewardDerivationRuleEligibility.RewardDerivationRuleEligibilityID

CO_EL_CLD_PRDV.ID_EL_PRDV

A unique identifier for a Price Derivation Rule Eligibility.

Identity

integer

Campaign.BusinessDevelopmentProgram

CO_CMPGN.ID_BSN_DVLPMNT_PRGM

The name of an overarching program to acquire new customers, retain and grow sales from existing customers and reactivate in active customers.

Name

varchar(40)

CarrierAccount.CarrierAccountNumber

LE_CRR_ACNT.ID_CRR_ACNT

The account number assigned to the retailer by the Carrier for invoicing and delivery service ordering purposes.

Identity

integer

CarrierAccount.CarrierID

LE_CRR_ACNT.ID_CRR

A unique system assigned identifier for the Carrier.

Identity

integer

CarrierAccount.EffectiveDate

LE_CRR_ACNT.DC_EF_DT

Date and time a CarrierAccount is active for tansportation management and tracking purposes.

EffectiveDate

date

CarrierAccount.ExpirationDate

LE_CRR_ACNT.DC_EP_DT

Date and time a CarrierAccount is no longer active for tansportation management and tracking purposes.

ExpirationDate

datetime

CarrierAccount.PartyContactMethodID

LE_CRR_ACNT.ID_PRTY_CNCT_MTH

A token identifier for a PartyContactMethod entity type instance.

Identity

integer

CarrierService.CarrierID

CO_CRR_SV.ID_CRR

A unique system assigned identifier for the Carrier.

Identity

integer

CarrierService.CarrierServiceID

CO_CRR_SV.ID_CRR_SV

Token identifier for a CarrierService instance

Identity

integer

CarrierService.Description

CO_CRR_SV.DE_DSCR

A short description of the ServiceCode value for reporting purposes

DescriptionShort

varchar(255)

CarrierService.ServiceCode

CO_CRR_SV.CD_SV

Designates a category of transportation-related service provided by a carrier. Example include:

 

- COLLECT_SIGNATURE

- INSURED_DELIVERY

etc,

 

Th specific values will vary by carrier.

Code

varchar(20)

CarrierStandardParcelSize.CarrierID

CO_CRR_STD_PRCL_SZ.ID_CRR

A unique system assigned identifier for the Carrier.

Identity

integer

CarrierStandardParcelSize.ContainerHeightQuantity

CO_CRR_STD_PRCL_SZ.QL_CNR_HT_QTY

The height of a container. Used to define dimensions for load configuration.

Quantity

DECIMAL(9,3)

CarrierStandardParcelSize.ContainerLengthQuantity

CO_CRR_STD_PRCL_SZ.QL_CNR_LNG_QTY

The length of a container. Used to define dimensions for load configuration.

Quantity

DECIMAL(9,3)

CarrierStandardParcelSize.ContainerWidthQuantity

CO_CRR_STD_PRCL_SZ.QL_CNR_WD_QTY

The width of a container. Used to define dimensions for load configuration.

Quantity

DECIMAL(9,3)

CarrierStandardParcelSize.DimensionalWeightQuantity

CO_CRR_STD_PRCL_SZ.QW_DMNSNL_WT_QTY

Dimensional weight, also known as volumetric weight, is a pricing technique for commercial freight transport (including courier and postal services), which uses an estimated weight that is calculated from the length, width and height of a package. Shipping costs have historically been calculated on the basis of gross weight in kilograms or pounds. By charging only by weight, lightweight, low density packages become unprofitable for freight carriers due to the amount of space they take up in the truck/aircraft/ship in proportion to their actual weight. The concept of dimensional weight has been adopted by the transportation industry worldwide as a uniform means of establishing a minimum charge for the cubic space a package occupies. In fact, UPS[1] and Fedex[2] have recently announced that starting 2015, shipping charges on all shipments (air and ground) will be determined by greater of the actual weight and dimensional weight of a package. Prior to this announcement, dimensional weight charges were only applicable to packages of a specific size range.

 

Dimensional weight is a calculation of a theoretical weight of a package. This theoretical weight is the weight of the package at a minimum density chosen by the freight carrier. If the package is below this minimum density, then the actual weight is irrelevant as the freight carrier will charge for the volume of the package as if it were of the chosen density (what the package would weigh at the minimum density). Furthermore, the volume used to calculate the dimensional weight may not be absolutely representative of the true volume of the package. The freight carrier will measure the longest dimension in each of the three axis (X, Y, Z) and use these measurements to determine the package volume. If the package is a right-angled rectangular box (cuboid), then this will be equal to the true volume of the package. However, if the package is of any other shape, then the calculation of volume will be more than the true volume of the package.

Dimensional weight is also known as DIM weight, volumetric weight, or cubed weight. Freight carriers utilize the greater of the actual weight or dimensional weight to calculate shipping charges. Dimensional weight is calculated as (length × width × height) / (dimensional factor). Measurements can be made all in inches or all in centimeters, but the appropriate shipping factor must also be used.

Quantity

DECIMAL(9,3)

CarrierStandardParcelSize.GrossWeightQuantity

CO_CRR_STD_PRCL_SZ.QW_GS_WT_QTY

The gross weight of the ShipmentContainer including merchandise plus the weight of the container itself

Quantity

DECIMAL(9,3)

CarrierStandardParcelSize.Linear

CO_CRR_STD_PRCL_SZ.CD_UOM_LNR

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.

Code

varchar(20)

CarrierStandardParcelSize.ParcelStandardSizeCode

CO_CRR_STD_PRCL_SZ.CD_PRCL_STD_SZ

A carrier-specific code that designates a standard size and accompanying pricing for transporting a package.

 

Examples:

Federal Express

01 - FedEx Customer Packaging

02 - FedEx Pak

03 - FedEx Box

04 - FedEx Tube

08 - FedEx Packet (select markets)

 

UPS

10 or 22 10kg or 22 lbs. box

25 or 55 25kg or 55 lbs. box

 

US Postal Service

FLT - Flat

LTP or 06 - Priority mail letter pack

LTR or 06 - Letter

FSB - Priority Mail Small Flat Rate Box

FRB - Priority Mail (Regular) Flat Rate Box

IRG - Irregular Parcel

 

Other carriers will have their own codes

Code

varchar(20)

CarrierStandardParcelSize.StandardParcelSizeID

CO_CRR_STD_PRCL_SZ.ID_STD_PRCL_SZ

Token identifier for a CarrierStandardParcelSize entity type instance

Identity

integer

CarrierStandardParcelSize.Weight

CO_CRR_STD_PRCL_SZ.CD_UOM_WT

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.

Code

varchar(20)

CarrierStandardParcelSize.WeightQuantity

CO_CRR_STD_PRCL_SZ.QW_WT_QTY

The weight of the merchandise without the container.

Quantity

DECIMAL(9,3)

ChannelRewardDerivationRuleEligibility.ChannelID

RU_CHNL_PRC_DRVN_EL.ID_CHNL

Token Identifier for a channel instance

Identity

integer

ChannelRewardDerivationRuleEligibility.RewardDerivationRuleEligibilityID

RU_CHNL_PRC_DRVN_EL.ID_EL_PRDV

A unique identifier for a Reward Derivation Rule Eligibility.

Identity

integer

CombinationRewardDerivationRuleEligibility.CombinationCode

CO_EL_CMBN_PRDV.CD_CMBN

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

Code2

char(2)

CombinationRewardDerivationRuleEligibility.RewardDerivationConditionGroupName

CO_EL_CMBN_PRDV.DE_RWD_DRVN_CN_GP_NM

A short name used to identify this COMBINED eligibility rule for reporting and inqiury purposes.

DescriptionShort

varchar(255)

CombinationRewardDerivationRuleEligibility.RewardDerivationRuleEligibilityID

CO_EL_CMBN_PRDV.ID_EL_PRDV

A unique identifier for a Price Derivation Rule Eligibility.

Identity

integer

ContainerType.ContainerTypeCode

ID_TYP_CNR.CD_CNR_TYP

A category of container that defines what it is made of, its type (primarily its material handling category - e.g. 55 gallon drums, pallets, cases, etc.) and its shape.

Code

varchar(20)

ContainerType.PackageTypeCode

ID_TYP_CNR.CD_PKG_TYP

A code used to classify packages for transportation purposes.

Code

varchar(20)

ContainerType.PackagingShapeCode

ID_TYP_CNR.CD_PCKGNG_SHPE

Designated code used to characterize the geometric form of a ShipmentContainer or package.

Code

varchar(20)

Contribution.CustomerAccountID

TR_CNTRBTN.ID_CTAC

A unique identifier for a customer account.

Identity

integer

CustomerAccountInvoice.Invoiced

DO_INVC_CTAC.Invoiced

A unique identifier for a customer account.

Identity

integer

CustomerAccountJournal.CreateDateTime

JL_CT_ACNT_JR.DT_CRT

The date and time a jounal entry is created.

AuditDateTime

datetime

CustomerAccountJournal.CustomerAccountID

JL_CT_ACNT_JR.ID_CTAC

A unique identifier for a customer account.

Identity

integer

CustomerAccountJournal.CustomerAccountInvoiceID

JL_CT_ACNT_JR.ID_INVC_CTAC

A unique system assigned identifier for the CustomerAccountInvoice

Identity

integer

CustomerAccountJournal.CustomerAccountTypeCode

JL_CT_ACNT_JR.TY_CTAC

Determines what kind of customer account this is. Examples include a trade account, a school account, a not-for-profit, regular customer, etc.

 

LOYALTY - customer loyalty account for tracking points earned/redeemed

 

REBATE -Customer reward account that pays customers based on cumulative net purchases over a deisgnated period of time

 

TRADE - customer business credit account

 

CONSUMER_CHG - customer individual consumer credit extended by retailer

 

INSTALLMENT - credit account set up for one time purchase

 

LAYAWAY - cash time payment account (not credit)

 

RENTAL - customer rental for videos, equipment

 

WORKORDER - account for handling services like installation and set up

 

BACKORDER - account for handling backorder deposit and adjustments.

 

 

 

 

Code2

char(2)

CustomerAccountJournal.CustomerOrderID

JL_CT_ACNT_JR.ID_ORD

A unique system assigned identifier for the CustomerOrder.

Identity

integer

CustomerAccountJournal.CustomerOrderLineItemSequenceNumber

JL_CT_ACNT_JR.IC_OR_LTM

A unique system assigned identifier for the LineItem within the confines of the CustomerOrder.

LineNumber

smallint

CustomerAccountJournal.JournalEntryID

JL_CT_ACNT_JR.ID_JR_ENR

Token identification number for a CustomerAccountJournal entry

Identity

integer

CustomerAccountJournal.JournalEntryMonetaryAmount

JL_CT_ACNT_JR.MO_JR_ENR_MNTY_AMT

The monetary value captured i this journal entry. This is used to capture the financial impact of transaction activity on a CustomerAccount.

Money

decimal(16,5)

CustomerAccountJournal.JournalEntryQuantity

JL_CT_ACNT_JR.QU_JR_ENR

The quantity (with fractional units) associated with this journal entry. This is intended to caputre and accumulate statistical information related to product and service activity volumes. Examples include litres purchased, kilograms purchased, square meters purchased, etc.

 

In addition to such physical volume related quantities, this attribute can be used to capture points and other derived loyalty quantities that are accumulated over time.

 

It is separated from MonetaryAmount to clarify the nature of the journal entry measurement

Quantity

DECIMAL(9,3)

CustomerAccountJournal.ReportingClassificationCode

JL_CT_ACNT_JR.CD_RP_CLSFN

A code used to classify the monetary values, unit counts and quantities that are accumulated in the CustomerAccountLedger and CustomerAccountJournal.

 

The range of values varies depending on the CustomerAccountType and varieites of financial, non-finanicl unit counts and other quantities tracked by a retailer.

 

Some samples include

SALES $'s and units

RETURN $;s and units

TRANSACTION_COUNTs

etc.

 

It is up to each retailer to design its ledger categories for reporting and analyizing its business.

Code

varchar(20)

CustomerAccountJournal.ReportingPeriodID

JL_CT_ACNT_JR.ID_PRD_RP

The unique system assigned identifier for a particular ReportingPeriod.

Identity

integer

CustomerAccountJournal.RetailTransactionLineItemSequenceNumber

JL_CT_ACNT_JR.IC_LN_ITM

The sequence number of line item within the context of this RetailTransaction.

LineNumber

smallint

CustomerAccountJournal.StatusCode

JL_CT_ACNT_JR.CD_STS

The status of this CustomerAccountJournal row (journal entry). Valid values are:

 

P - Posted

T - Tentative (incomplete)

Code

varchar(20)

CustomerAccountJournal.TransactionID

JL_CT_ACNT_JR.ID_TRN

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members.

IdentityUUID

char(32)

CustomerAccountLedger.BeginningMonetaryBalanceAmount

LE_CT_ACNT_LDG.MO_BGNNNG_MNTY_BLNC_AMT

The current period beginning monetary balance derived from closing balance of prior period.

Money

decimal(16,5)

CustomerAccountLedger.BeginningQuantity

LE_CT_ACNT_LDG.QU_BGNNNG_QTY

The current period beginning quantity balance derived from closing balance of prior period.

Quantity

DECIMAL(9,3)

CustomerAccountLedger.CreateDate

LE_CT_ACNT_LDG.DT_CRT

The date a CustomerAccountLedger instance is created.

AuditDateTime

datetime

CustomerAccountLedger.CurrentPeriodCumulativeMonetaryAmount

LE_CT_ACNT_LDG.MO_CRT_PRD_CUM_MNTY_AMT

The cumulative value posted for the current period. This is the sum of journal entries posted to the current reporting period.

Money

decimal(16,5)

CustomerAccountLedger.CurrentPeriodCumulativeQuantity

LE_CT_ACNT_LDG.QU_CRT_PRD_CUM_QTY

The cumulative quantity value posted for the current period. This is the sum of journal entries posted to the current reporting period.

Quantity

DECIMAL(9,3)

CustomerAccountLedger.CustomerAccountID

LE_CT_ACNT_LDG.ID_CTAC

A unique identifier for a customer account.

Identity

integer

CustomerAccountLedger.CustomerAccountTypeCode

LE_CT_ACNT_LDG.TY_CTAC

Determines what kind of customer account this is. Examples include a trade account, a school account, a not-for-profit, regular customer, etc.

 

LOYALTY - customer loyalty account for tracking points earned/redeemed

 

REBATE -Customer reward account that pays customers based on cumulative net purchases over a deisgnated period of time

 

TRADE - customer business credit account

 

CONSUMER_CHG - customer individual consumer credit extended by retailer

 

INSTALLMENT - credit account set up for one time purchase

 

LAYAWAY - cash time payment account (not credit)

 

RENTAL - customer rental for videos, equipment

 

WORKORDER - account for handling services like installation and set up

 

BACKORDER - account for handling backorder deposit and adjustments.

 

 

 

 

Code2

char(2)

CustomerAccountLedger.LastUpdateDate

LE_CT_ACNT_LDG.DT_LS_UPDT

The date a CustomerAccountLedger instance was last updated

AuditDateTime

datetime

CustomerAccountLedger.ReportingClassificationCode

LE_CT_ACNT_LDG.CD_RP_CLSFN

A code used to classify the monetary values, unit counts and quantities that are accumulated in the CustomerAccountLedger and CustomerAccountJournal.

 

The range of values varies depending on the CustomerAccountType and varieites of financial, non-finanicl unit counts and other quantities tracked by a retailer.

 

Some samples include

SALES $'s and units

RETURN $;s and units

TRANSACTION_COUNTs

etc.

 

It is up to each retailer to design its ledger categories for reporting and analyizing its business.

Code

varchar(20)

CustomerAccountLedger.StatusCode

LE_CT_ACNT_LDG.CD_STS

Designates the current state of the CustomerAccountLedger. Valid values are OPEN or CLOSED.

 

OPEN refers to a current period that is activly being updated with summary information.

 

CLOSED refers to an inactive period that is to be transferred to CustomerAccountLedgerHistory.

 

Period as used here refers to the ReportingPeriod used for reporting and analytic purposes.

Code2Status

char(2)

CustomerAccountLedgerHistory.BeginningBalanceAmount

LE_CT_ACNT_LDG_HSTRY.MO_BGNNNG_BLNC_AMT

The beginning balance for a reporting period in the CustomerAccountLedgerHistory entity. This value will typically be replicated from the prior period ending balance during a reporting period control break process.

Money

decimal(16,5)

CustomerAccountLedgerHistory.CreateDate

LE_CT_ACNT_LDG_HSTRY.DT_CRT

The date this CustomerAccountLedgerHistory instance is created.

AuditDateTime

datetime

CustomerAccountLedgerHistory.CustomerAccountID

LE_CT_ACNT_LDG_HSTRY.ID_CTAC

A unique identifier for a customer account.

Identity

integer

CustomerAccountLedgerHistory.CustomerAccountTypeCode

LE_CT_ACNT_LDG_HSTRY.TY_CTAC

Determines what kind of customer account this is. Examples include a trade account, a school account, a not-for-profit, regular customer, etc.

 

LOYALTY - customer loyalty account for tracking points earned/redeemed

 

REBATE -Customer reward account that pays customers based on cumulative net purchases over a deisgnated period of time

 

TRADE - customer business credit account

 

CONSUMER_CHG - customer individual consumer credit extended by retailer

 

INSTALLMENT - credit account set up for one time purchase

 

LAYAWAY - cash time payment account (not credit)

 

RENTAL - customer rental for videos, equipment

 

WORKORDER - account for handling services like installation and set up

 

BACKORDER - account for handling backorder deposit and adjustments.

 

 

 

 

Code2

char(2)

CustomerAccountLedgerHistory.LastUpdateDate

LE_CT_ACNT_LDG_HSTRY.DT_LS_UPDT

The date this CustomerAccountLedgerHistory instance was last updated.

AuditDateTime

datetime

CustomerAccountLedgerHistory.PeriodToDateCumulativeAmount

LE_CT_ACNT_LDG_HSTRY.MO_PRD_TO_DT_CUM_AMT

The cumulative amount for a reporting period. When added to the beginning balance it yields the current reporting period balance and at the end of the reporting period a period end balance.

Money

decimal(16,5)

CustomerAccountLedgerHistory.ReportingClassificationCode

LE_CT_ACNT_LDG_HSTRY.CD_RP_CLSFN

A code used to classify the monetary values, unit counts and quantities that are accumulated in the CustomerAccountLedger and CustomerAccountJournal.

 

The range of values varies depending on the CustomerAccountType and varieites of financial, non-finanicl unit counts and other quantities tracked by a retailer.

 

Some samples include

SALES $'s and units

RETURN $;s and units

TRANSACTION_COUNTs

etc.

 

It is up to each retailer to design its ledger categories for reporting and analyizing its business.

Code

varchar(20)

CustomerAccountLedgerHistory.ReportingPeriodID

LE_CT_ACNT_LDG_HSTRY.ID_PRD_RP

The unique system assigned identifier for a particular ReportingPeriod.

Identity

integer

CustomerAccountLedgerHistory.StatusCode

LE_CT_ACNT_LDG_HSTRY.CD_STS

Designates the current state of the CustomerAccountLedger. Valid values are OPEN or CLOSED.

 

OPEN refers to a current period that is activly being updated with summary information.

 

CLOSED refers to an inactive period that is to be transferred to CustomerAccountLedgerHistory.

 

Period as used here refers to the ReportingPeriod used for reporting and analytic purposes.

Code2Status

char(2)

CustomerAccountLinkage.AccountLinkagePurposeNarrative

LE_CT_ACNT_LNKG.NA_ACNT_LNKG_PRPS

A short description of how a customer account linkage (basically a join between two customer account types) is to be used.

DescriptionNarrative

varchar(4000)

CustomerAccountLinkage.AccountLinkageTypeCode

LE_CT_ACNT_LNKG.CD_ACNT_LNKG_TYP

Defines a category or type of linkage created to tie two different instances of CustomerAccounts together.

 

This is a retailer defined code.

 

Its intent is to allow retailers to link different kinds of customer accounts together. For example they can link a customer membership account to an installment payment account. By design, this is a very open ended association so retailers can establish linkages that are appropriate for their business.

Code

varchar(20)

CustomerAccountLinkage.CustomerAccountLinkageID

LE_CT_ACNT_LNKG.ID_CT_ACNT_LNKG

Token ID for a CustomerAccountLinkage instance.

Identity

integer

CustomerAccountLinkage.From

LE_CT_ACNT_LNKG.ID_CTAC_FR

A unique identifier for a customer account.

Identity

integer

CustomerAccountLinkage.To

LE_CT_ACNT_LNKG.ID_CTAC_TO

A unique identifier for a customer account.

Identity

integer

CustomerAccountPaymentAccount.AccountNumber

LE_ENCRYPTD_CT_PYM_ACNT.ID_ACNT_DB_CR_CRD

The account number appearing on a debit/credit card and identifying the card issuer's customer account to be charged or credited for the transaction. This information must be encrypted.

Name

varchar(40)

CustomerAccountPaymentAccount.CardExpirationDate

LE_ENCRYPTD_CT_PYM_ACNT.DC_EP_CRD

The expiration date of the Credit or Debit card, as taken from the card in MMYY format.

Code4

char(4)

CustomerAccountPaymentAccount.CardHolderName

LE_ENCRYPTD_CT_PYM_ACNT.NM_CRD_HLD

The name of the cardholder, as taken from the card.

Name

varchar(40)

CustomerAccountPaymentAccount.CardIssuerCode

LE_ENCRYPTD_CT_PYM_ACNT.ID_ISSR_TND_CRD

The first six digits from the Credit/Debit card. It identifies the bank or other financial institution that issued the debit/credit card used in the transaction.

Code6

char(6)

CustomerAccountPaymentAccount.CardIssuerSequenceNumber

LE_ENCRYPTD_CT_PYM_ACNT.AI_CRD_ISS

The IssueSequnce number of the credit card being used assigned by the Credit/Debit Card issuer.

Identity

integer

CustomerAccountPaymentAccount.CardStartDate

LE_ENCRYPTD_CT_PYM_ACNT.DT_CRD_SRT

The commencement date of the Credit or Debit card, as taken from the card in MMYY format.

Code4

char(4)

CustomerAccountPaymentAccount.CreditDeibitCardTypeCode

LE_ENCRYPTD_CT_PYM_ACNT.TY_CRD

A code denoting which kind of card is being accepted. Sample values include:

 

DEBIT

CREDIT

EBT

FLEET

OTHER

Code6

char(6)

CustomerAccountPaymentAccount.CustomerAccountID

LE_ENCRYPTD_CT_PYM_ACNT.ID_CTAC

A unique identifier for a customer account.

Identity

integer

CustomerAccountPaymentAccount.EffectiveDate

LE_ENCRYPTD_CT_PYM_ACNT.DC_EF_DT

The date an EncryptedCustomerAccountPaymentAccount becomes active.

EffectiveDateTime

datetime

CustomerAccountPaymentAccount.ExpirationDate

LE_ENCRYPTD_CT_PYM_ACNT.DC_EP_DT

The date an EncryptedCustomerAccountPaymentAccount becomes inactive.

ExpirationDate

date

CustomerAccountPaymentAccount.PaymentAccountSequence

LE_ENCRYPTD_CT_PYM_ACNT.AI_PYM_ACNT_SQN

A sequence number to distinguish between payment accounts tied to a CustomerAccount. A value of 1 is always used to indicate the PRIMARY, default account.

LineNumber

smallint

CustomerAccountPaymentAccount.ReconciliationCode

LE_ENCRYPTD_CT_PYM_ACNT.CD_RCN

A code used to indicate if thie credit/debit card instance is reconciled or not.

Identity

integer

CustomerAccountPaymentAccount.ServiceCode

LE_ENCRYPTD_CT_PYM_ACNT.CD_SV

The value of the service field from the card.

 

In XML this is referred to as a SecurityCode. The names vary from one credit debit card provider to another. Both are the same thing - a 3-4 digit code used to validate a card at the POS.

Code4

char(4)

CustomerAccountPaymentAccount.StatusCode

LE_ENCRYPTD_CT_PYM_ACNT.CD_STS

Indiates the status of this designated customer account payment account. Valid values are:

 

A - Active

N - Activated but not used

C - Canceled

S - Suspended

Code2Status

char(2)

CustomerAccountPaymentAccount.Track1CreditCardBitMap

LE_ENCRYPTD_CT_PYM_ACNT.DE_TRCK_1_BT_MP

Defines the bit pattern used on track 1 of the magnetic strip on the back of a credit card.

BitMap

binary(128)

CustomerAccountPaymentAccount.Track2CreditCardBitMap

LE_ENCRYPTD_CT_PYM_ACNT.DE_TRCK_2_BT_MP

Defines the bit pattern used on track 2 of the magnetic strip on the back of a credit card.

BitMap

binary(128)

CustomerAccountPaymentAccount.Track3CreditCardBitMap

LE_ENCRYPTD_CT_PYM_ACNT.DE_TRCK_3_BT

Defines the bit pattern used on track 3 of the magnetic strip on the back of a credit card.

BitMap

binary(128)

CustomerAccountPaymentAccount.Track4CreditCardBitMap

LE_ENCRYPTD_CT_PYM_ACNT.BM_CR_CRD_TRK_4

Defines the bit pattern used on track 4 of the magnetic strip on the back of a credit card.

BitMap

binary(128)

CustomerAccountRewardDerivationRuleEligibility.CustomerAccountID

CO_EL_CTAC_PRDV.ID_CTAC

A unique identifier for a customer account.

Identity

integer

CustomerAccountRewardDerivationRuleEligibility.RewardDerivationRuleEligibilityID

CO_EL_CTAC_PRDV.ID_EL_PRDV

A unique identifier for a Price Derivation Rule Eligibility.

Identity

integer

CustomerAccountRewardTierStatus.CustomerMemberProgramAccountID

CO_CT_ACNT_RWD_TR_STS.ID_CT_MBR_PRGM_ACNT

Token ID for a CustomerMemberProgramAccount.

Identity

integer

CustomerAccountRewardTierStatus.CustomerRewardProgramTierCode

CO_CT_ACNT_RWD_TR_STS.CD_CT_RWD_PRGM_TIER

A code that represents the relative value of a given CustomerRewardProgramTier

Code

varchar(20)

CustomerAccountRewardTierStatus.EffectiveDate

CO_CT_ACNT_RWD_TR_STS.DC_EF_DT

Date a CustomerRewardAccount becomes active.

EffectiveDate

date

CustomerAccountRewardTierStatus.ExpirationDate

CO_CT_ACNT_RWD_TR_STS.DC_EP_DT

Date a CustomerRewardProgramAccount becomes inactive

ExpirationDate

date

CustomerAccountRewardTierStatus.LevelNumber

CO_CT_ACNT_RWD_TR_STS.IC_LV_NMB

A whole number that establishes the relative value of a membership program level. The higer the value, the greater the level and its associated rewards and where applicable fees.

Number

integer

CustomerAccountRewardTierStatus.MembershipProgramID

CO_CT_ACNT_RWD_TR_STS.ID_CT_MBRSHP_PRGM

Token ID for a CustomerRewardProgram instance.

Identity

integer

CustomerAccountRewardTierStatus.StatusCode

CO_CT_ACNT_RWD_TR_STS.CD_STS

Current status of this CustomerRewardProgramAccount

 

Valid values are

A Active

I Inactive

Code2Status

char(2)

CustomerAccountTermsAndConditions.CustomerAccountContractNarrative

RU_CT_ACNT_TRM_CN.NA_CT_ACNT_CNTRT

A business narrative description of the contract and its terms and conditions.

DescriptionNarrative

varchar(4000)

CustomerAccountTermsAndConditions.CustomerAccountID

RU_CT_ACNT_TRM_CN.ID_CTAC

A unique identifier for a customer account.

Identity

integer

CustomerAccountTermsAndConditions.EffectiveDate

RU_CT_ACNT_TRM_CN.DC_EF_DT

Date this contract revision is in force.

EffectiveDate

date

CustomerAccountTermsAndConditions.ExpirationDate

RU_CT_ACNT_TRM_CN.DC_EP_DT

Date this contract revision is no longer in force

ExpirationDate

date

CustomerAccountTermsAndConditions.RevisionNumber

RU_CT_ACNT_TRM_CN.AI_RVSN_NMB

The sequential version of a CustomerAccountTermsAndConditions agreement. Used to track different versions of a base document. This can be important where previous versions of a contract are in place along with newer versions.

Number

integer

CustomerAccountTermsAndConditions.StatusCode

RU_CT_ACNT_TRM_CN.CD_STS_CD

Current status of this contract revision.

 

Retailers need to exercise care in assigning status codes. While a contract may be modified prior versions tied to older customer accounts may remain in force.

 

Retailers need to define an appropriate contract life cycle management strategy as part of implementing this entity.

Code2Status

char(2)

CustomerAccountType.CustomerAccountTypeCode

CO_CT_ACNT_TYP.TY_CTAC

Determines what kind of customer account this is. Examples include a trade account, a school account, a not-for-profit, regular customer, etc.

 

LOYALTY - customer loyalty account for tracking points earned/redeemed

 

REBATE -Customer reward account that pays customers based on cumulative net purchases over a deisgnated period of time

 

TRADE - customer business credit account

 

CONSUMER_CHG - customer individual consumer credit extended by retailer

 

INSTALLMENT - credit account set up for one time purchase

 

LAYAWAY - cash time payment account (not credit)

 

RENTAL - customer rental for videos, equipment

 

WORKORDER - account for handling services like installation and set up

 

BACKORDER - account for handling backorder deposit and adjustments.

 

 

 

 

Code2

char(2)

CustomerAccountType.CustomerAccountTypeDescription

CO_CT_ACNT_TYP.DE_CT_ACNT_TYP

Short business description of the CustomerAccountType.

DescriptionShort

varchar(255)

CustomerAccountType.CustomerIdentityRequiredFlag

CO_CT_ACNT_TYP.FL_IDN_CT_RQ

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.

Flag

integer

CustomerAccountType.CustomerIdentityTypeCode

CO_CT_ACNT_TYP.TY_IDN_CT

Determines the type of customer identification proof required. Examples include drivers license, store charge card, trade association identification card, etc.

Code2

char(2)

CustomerAccountValuationUnitType.CustomerAccountValuationUnitTypeCode

CO_CT_ACNT_VLN_UN_TYP.CD_CT_ACNT_VLN_UN_TYP

A code that identifies a kind of valuation unit.

 

Examples include:

MONEY

POINTS

MILES

GALLONS

VISITS

others that are relevant to a retailer

Code

varchar(20)

CustomerAccountValuationUnitType.Description

CO_CT_ACNT_VLN_UN_TYP.DE_DSCR

A short business description of the AccountingValuationType used for reporting and inquries.

DescriptionShort

varchar(255)

CustomerAccountValuationUnitType.NarrativeText

CO_CT_ACNT_VLN_UN_TYP.NA_NRTV_TXT

A short narrative that explains what the unit measures and how it is to be used.

DescriptionNarrative

varchar(4000)

CustomerConsignmentAccount.CustomerAccountID

LE_CT_CNSGNMNT_ACNT.ID_CTAC

A unique identifier for a customer account.

Identity

integer

CustomerDeliveryInstruction.CarrierServiceID

CO_CT_DV_INSTR.ID_CRR_SV

Token identifier for a CarrierService instance

Identity

integer

CustomerDeliveryInstruction.EstimatedCollectOnDeliveryAmount

CO_CT_DV_INSTR.MO_ESTM_CLLCT_ON_DV_AMT

The estimated monetary value due to be collected from a customer at the time of delivery. This value is determined by the retailer and may include the cost of merchandise plus applicable taxes plus shipping and handling charges. Care must be exer

Money

decimal(16,5)

CustomerDeliveryInstruction.EstimatedShippingHandlingFeeAmount

CO_CT_DV_INSTR.MO_PYM_RQ

The estimated monetary amount of the total shipping and handling costs associated with this CustomerDelivery.

 

This value only includes shipping and handling fees it does NOT include the cost of merchandise, taxes and non-transport related charges.

MoneyShortRetail

decimal(7,2)

CustomerDeliveryInstruction.Requested

CO_CT_DV_INSTR.CD_TRNSPRT_PYM_MTH

A designated code and enumerated value list that categorizes different ways of paying for transporation services related to a shipment/delivery of merchandise.

 

These typically apply to COD or scenarios where the merchandise is paid for through another means but the customer must pay transport fees on delivery.

 

GS1 examples include:

 

BANK_CHEQUE

BANK_GIRO

BANKERS_DRAFT

BOOKENTRY_CREDIT

BOOKENTRY_DEBIT

BOP

CASH

CERTIFIED_CHEQUE

CHEQUE

CREDIT_CARD

DEBIT_CARD

ELECTRONIC_CREDIT_ACH

ELECTRONIC_DEBIT_ACH

FED_WIRE_NON_REPETITIVE

FED_WIRE_REPETITIVE

INTERNATIONAL_WIRE

LETTER_OF_CREDIT

POSTGIRO

WIRE_TRANSFER_CREDIT

WIRE_TRANSFER_DEBIT

Name

varchar(40)

CustomerDeliveryInstruction.RequestedLevel

CO_CT_DV_INSTR.CD_RQSD_LV

Identifies a transportation service level type used to distinguish faster from slower delivery plus additional tracking and ancillary services.

 

Sample GS1 code values:

AUTHORIZED_RETURN_SERVICE

CONSIGNEE_BILLING_SERVICE

DELIVERY_CONFIRMATION

EXPEDITED_SERVICE

EXPEDITED_SERVICE_WORLDWIDE

EXPRESS_SERVICE

EXPRESS_SERVICE_PLUS

GROUND

GROUND_CX_EXPRESS_SERVICE

MULTIWEIGHT

MUTUALLY_DEFINED

NEXT_DAY_AIR

NEXT_DAY_PM

NEXT_MORNING

PRIMARY_SERVICE_AREA_NEXT_DAY_BY_1030

PRIMARY_SERVICE_AREA_NEXT_DAY_BY_1700

RETURN_SERVICE

SAME_DAY

SATURDAY

SATURDAY_PICKUP

SECOND_DAY_AIR

SECOND_MORNING

STANDARD_GROUND_HUNDRED_WEIGHT

STANDARD_SERVICE

THREE_DAY_SERVICE

Code

varchar(20)

CustomerDeliveryInstruction.ShipmentID

CO_CT_DV_INSTR.ID_SHP

A unique, retailer supplied identifier for a RetailTransactionShipment.

Identity

integer

CustomerDeliveryInstruction.ShipMethodID

CO_CT_DV_INSTR.ID_SHP_MTH

Token identifier for a ShipMethodInstance

Identity

integer

CustomerDeliveryInstruction.TransportBillingMethodCode

CO_CT_DV_INSTR.CD_TRNSPRT_BLLNG_MTH

Retailer designated code that indicates how the transportation and handling fees for a shipment are to be billed.

 

Sample values (for domestic US shipments) include:

 

PREPAID = prepaid transportation fees

COL = collect upon delivery from receipient

BRC = Bill the receiver

B3P = Bill 3rd party

 

Others may be added as required for international shipping and other kinds of shipping arrangements.

Code

varchar(20)

CustomerDeliveryPreference.PrimaryDeliverBeforeAfterCode

CO_CT_DV_PRFC.CD_DV_BFR_OR_AFT

Indicates if the preferred delivery time is before DeliverTime or after DeliverTime.

 

Sample values:

 

BEFORE

AFTER

Code

varchar(20)

CustomerDeliveryPreference.PrimaryDeliverTime

CO_CT_DV_PRFC.DT_DV_PRFC

Preferred time of day for a delivery to occur on the RequestedDeliveryDate specified in CustomerDeliveryPreference.

Time

datetime

CustomerDeliveryPreference.RequestedDeliveryDate

CO_CT_DV_PRFC.TS_DV_PRFC

Requested delivery date to define the day a customer wants goods in an order delivered.

DateCalendar

datetime

CustomerDeliveryPreference.RequestedDeliveryTo

CO_CT_DV_PRFC.ID_PRTY_CNCT_MTH

A token identifier for a PartyContactMethod entity type instance.

Identity

integer

CustomerDeliveryPreference.SecondaryDeliverBeforeAfterCode

CO_CT_DV_PRFC.CD_SCNDRY_DV_BFR_AFT

Indicates if the preferred delivery time is before SecondaryDeliverTime or after SecondaryDeliverTime.

 

Sample values:

 

BEFORE

AFTER

Code

varchar(20)

CustomerDeliveryPreference.SecondaryDeliverTime

CO_CT_DV_PRFC.DT_SCNDRY_DV_TM

Secondary preference for a delivery time if the primary delivery time is not available.

Time

datetime

CustomerDonationAccount.CustomerAccountID

LE_CT_DNTN_ACNT.ID_CTAC

A unique identifier for a customer account.

Identity

integer

CustomerInstallmentPaymentAccount.AnnualInterestRatePercent

LE_ACNT_CT_INS_PYM.PE_ANN_INTRST_RT

The annual interest charged on a customer installment purchase.

Percent

decimal(7,4)

CustomerInstallmentPaymentAccount.InstallmentAccountAdministrationFeeAmount

LE_ACNT_CT_INS_PYM.MO_INS_ACNT_ADMN_FE_AMT

A flat monetary fee paid to set up and administer an installment payment account.

Money

decimal(16,5)

CustomerInstallmentPaymentAccount.InstallmentPaymentAmount

LE_ACNT_CT_INS_PYM.MO_INS_PYM_AMT

The installment payment amount (which is a fixed monetary value).

Money

decimal(16,5)

CustomerInstallmentPaymentAccount.LatePaymentPenaltyFeeAmount

LE_ACNT_CT_INS_PYM.MO_LT_PYM_PNTY_FE_AMT

A flat fee amount charged for late payments.

Money

decimal(16,5)

CustomerInstallmentPaymentAccount.MinimumDownPaymentAmount

LE_ACNT_CT_INS_PYM.MO_MNM_DWN_PYM_AMT

The minimum monetary value a customer must pay when setting up the installment payment account.

Money

decimal(16,5)

CustomerInstallmentPaymentAccount.MinimumDownPaymentPercent

LE_ACNT_CT_INS_PYM.PE_MNM_DWN_PYM

The minimum percent of a purchase value a customer must pay when setting up the installment payment account.

Percent

decimal(7,4)

CustomerInstallmentPaymentAccount.PaymentPeriodCode

LE_ACNT_CT_INS_PYM.CD_PYM_PRD

The type of payment period:

 

Examples include:

 

MONTHLY

QUARTERLY

BI-WEEKLY

 

InstallmentPaymentAmount is the monetary value that must be paid for each payment period.

Code

varchar(20)

CustomerInstallmentPaymentAccount.PaymentPeriodCount

LE_ACNT_CT_INS_PYM.QY_PYM_PRD_CNT

The number of installment periods specified for this installment account (loan account).

QuantityInteger

integer

CustomerInstallmentPaymentAccount.PenaltyAnnualInterestRatePercent

LE_ACNT_CT_INS_PYM.PE_PNTY_ANN_INTRST_RT

The annual interest rate charge on balances that are paid late.

Percent

decimal(7,4)

CustomerLayawayAccount.LayawayCancellationFeeAmount

LE_ACNT_CT_LY.MO_LY_CNCLLTN_FE_AMT

A flat fee charged by a retailer to cancel a layaway. The fee may be deducted from the money refunded to the customer.

 

In a layaway the money refunded is the balance paid into the account by the customer.

Money

decimal(16,5)

CustomerLayawayAccount.LayawayDefaultCancellationDate

LE_ACNT_CT_LY.DC_LY_DFLT_CNCLLTN_DT

The date this layaway account will be cancelled if it is not settled. This is a stop loss date. When a layaway purchase is not completed by this date, the account is cancelled, the merchandise is returned to inventory and a refund to the customer is issued (if possible) minus a layaway cancellation fee.

 

For situations where a refund to the customer cannot be made, the account balance is transferred to a liability account where it is carried until it can be taken as income under the local escheatment laws.

DateCalendar

date

CustomerLayawayAccount.LayawayFeeAmount

LE_ACNT_CT_LY.MO_LY_FE_AMT

A one time fee charged to administer a layaway account.

Money

decimal(16,5)

CustomerLayawayAccount.LayawayMinimumPaymentAmount

LE_ACNT_CT_LY.MO_LY_MNM_PYM_AMT

A minimum monetary amount required to make a payment against the reserved merchandise.

Money

decimal(16,5)

CustomerLayawayAccount.LayawayMinimumPurchaseAmount

LE_ACNT_CT_LY.MO_LY_MNM_PCH_AMT

The minimum monetary value of a purchase required to set up a layaway account.

 

For example a retailer may set up layaways only for purchases that exceed $20.00.

Money

decimal(16,5)

CustomerLayawayAccount.MinimumInitialPaymentAmount

LE_ACNT_CT_LY.MO_MNM_INT_PYM_AMT

The minimum monetary value required as a first payment to set up a layaway account.

 

Money

decimal(16,5)

CustomerLayawayAccount.MinimumInitialPaymentPercent

LE_ACNT_CT_LY.PE_MNM_INT_PYM

The minimum percentage of a purchase required as a first payment to set up a layaway account.

Percent

decimal(7,4)

CustomerLayawayAccount.RefundAllowedFlag

LE_ACNT_CT_LY.FL_RFD_ALW

A boolean indicator that if YES means that a customer may cancel a layaway account (in effect a kind of return from layaway reserve inventory) and receive a refund possibley reduced by a cancellation fee.

Flag

integer

CustomerLedgerReportingClassification.AccumulationTimeHorizonCode

CO_CT_LDG_RP_CLSFN.CD_ACCMLTN_TM_HRZN

Determines if this reporting classification is a LIFETIME accumulation or a REPORTING PERIOD accumulation.

 

Reporting period accumulations are transferrred to history and zeroed out at period end. Lifetime accumulations are not zeroed out at the end of a reporting period.

 

The intent of this code is to enable retailers to maintin lifetime customer balances for promotional program execution purposes (as opposed to pure analytics)

Code

varchar(20)

CustomerLedgerReportingClassification.CustomerAccountTypeCode

CO_CT_LDG_RP_CLSFN.TY_CTAC

Determines what kind of customer account this is. Examples include a trade account, a school account, a not-for-profit, regular customer, etc.

 

LOYALTY - customer loyalty account for tracking points earned/redeemed

 

REBATE -Customer reward account that pays customers based on cumulative net purchases over a deisgnated period of time

 

TRADE - customer business credit account

 

CONSUMER_CHG - customer individual consumer credit extended by retailer

 

INSTALLMENT - credit account set up for one time purchase

 

LAYAWAY - cash time payment account (not credit)

 

RENTAL - customer rental for videos, equipment

 

WORKORDER - account for handling services like installation and set up

 

BACKORDER - account for handling backorder deposit and adjustments.

 

 

 

 

Code2

char(2)

CustomerLedgerReportingClassification.CustomerAccountValuationUnitTypeCode

CO_CT_LDG_RP_CLSFN.CD_CT_ACNT_VLN_UN_TYP

A code that identifies a kind of valuation unit.

 

Examples include:

MONEY

POINTS

MILES

GALLONS

VISITS

others that are relevant to a retailer

Code

varchar(20)

CustomerLedgerReportingClassification.Name

CO_CT_LDG_RP_CLSFN.NM_RP_CLSFN

The business name used in reporting for the CustomerLedgerReportingClassification.

Name

varchar(40)

CustomerLedgerReportingClassification.ReportingClassificationCode

CO_CT_LDG_RP_CLSFN.CD_RP_CLSFN

A code used to classify the monetary values, unit counts and quantities that are accumulated in the CustomerAccountLedger and CustomerAccountJournal.

 

The range of values varies depending on the CustomerAccountType and varieites of financial, non-finanicl unit counts and other quantities tracked by a retailer.

 

Some samples include

SALES $'s and units

RETURN $;s and units

TRANSACTION_COUNTs

etc.

 

It is up to each retailer to design its ledger categories for reporting and analyizing its business.

Code

varchar(20)

CustomerLoyaltyProgram.LoyaltyProgramName

LE_CT_LYLTY_PRGM.NM_CT_LYLTY_PRGM

A promotional or trade name created to advertise and create awareness for a retailer loyalty type of CllubMembershipProgram.

Name

varchar(40)

CustomerLoyaltyProgram.LoyaltyThemeDescription

LE_CT_LYLTY_PRGM.DE_CT_LYLTY_PRGM_THM

A short narrative description of the common area of interest or topic for a loyalty program. Examples:

 

BABY_CLUB

PET_CLUB

 

These allow retailers to tailor loyalty programs to customers with specific kinds of interest.

DescriptionShort

varchar(255)

CustomerLoyaltyProgram.MembershipProgramID

LE_CT_LYLTY_PRGM.ID_CT_MBRSHP_PRGM

Token ID for a CustomerRewardProgram instance.

Identity

integer

CustomerMembershipAccount.CustomerAccountID

LE_CT_MBRSHP_ACNT.ID_CTAC

A unique identifier for a customer account.

Identity

integer

CustomerMembershipAccount.CustomerAccountInitiationFeeAmount

LE_CT_MBRSHP_ACNT.MO_CT_ACNT_INTTN_FE_AMT

Some Customer membership programs require a fee to be paid to sign up and join. This attribute captures that fee.

Money

decimal(16,5)

CustomerMembershipAccount.EffectiveDate

LE_CT_MBRSHP_ACNT.DC_EF

Date the Loyalty Account Enrollment is in effect.

EffectiveDate

date

CustomerMembershipAccount.ExpirationDate

LE_CT_MBRSHP_ACNT.DC_EP

Date the Loyalty Account Enrollment is no longer in effect.

ExpirationDate

date

CustomerMembershipAccount.StatusCode

LE_CT_MBRSHP_ACNT.CD_STS

Current status of this Loyalty Program Account Enrollment instance

Code2Status

char(2)

CustomerMembershipEarnedRewardTier.CustomerRewardProgramTierCode

CO_CT_MBRSHP_ERN_RWD_TIER.CD_CT_RWD_PRGM_TR

A code that represents the relative value of a given CustomerRewardProgramTier

Code

varchar(20)

CustomerMembershipEarnedRewardTier.EffectiveDate

CO_CT_MBRSHP_ERN_RWD_TIER.DC_EF

Date customer account joins this tier status.

EffectiveDate

date

CustomerMembershipEarnedRewardTier.ExpirationDate

CO_CT_MBRSHP_ERN_RWD_TIER.DC_EP

Date the customer account exits this CustomerLoyaltyAccountTierStatus

ExpirationDate

date

CustomerMembershipEarnedRewardTier.LevelNumber

CO_CT_MBRSHP_ERN_RWD_TIER.IC_LV_NMB

A whole number that establishes the relative value of a membership program level. The higer the value, the greater the level and its associated rewards and where applicable fees.

Number

integer

CustomerMembershipEarnedRewardTier.MembershipProgramID

CO_CT_MBRSHP_ERN_RWD_TIER.ID_CT_MBRSHP_PRGM

Token ID for a CustomerRewardProgram instance.

Identity

integer

CustomerMembershipEarnedRewardTier.PointsAccrualTypeCode

CO_CT_MBRSHP_ERN_RWD_TIER.CD_PNT_ACRL_TYP

Designates whether point earned may be accrued for tier assignment of a customer or accrued only for subsequent redemption.

 

Values:

 

QUALIFYING - point earned are accrued and count towards meeting tier thresholds. For example buy X and get 50 pts towards becoming a GOLD customer. This is similar to what airlines do.

 

REDEEMABLE - points earned are accrued for redemption. These are points that may be exchanged for discounts or free items.

Code

varchar(20)

CustomerMembershipEarnedRewardTier.PointsExpirationPeriodDayCount

CO_CT_MBRSHP_ERN_RWD_TIER.EP_PNT_PRD_DY_CNT

The number of days after points are earned until they expire. 0 means the points never expire.

QuantityInteger

integer

CustomerMembershipEarnedRewardTier.StatusCode

CO_CT_MBRSHP_ERN_RWD_TIER.CD_STS

Indicates the status of this CustomerLoyaltyAccountTierStatus.

 

Valid values are:

 

A = Active

I = Inactive

 

Only one instance of a CustomerLoyaltyAccountTierStatus may be active at at ime.

Code2Status

char(2)

CustomerMembershipEarnedRewardTier.TierAssignmentBasisCode

CO_CT_MBRSHP_ERN_RWD_TIER.CD_TR_ASGMT_BSS

A code that designates the type of measurement used to assign a customer to this CustomerRewardProgramTier. Typically tiers are based on the cumulative reward value earned by a customer. They may be in points, monetary value, miles or any other customer reward currency.

 

Code

varchar(20)

CustomerMembershipEarnedRewardTier.TierDescription

CO_CT_MBRSHP_ERN_RWD_TIER.DE_TR

Short business description this membership activity-based customer membership tier.

Name

varchar(40)

CustomerMembershipEarnedRewardTier.TierMaximumAmount

CO_CT_MBRSHP_ERN_RWD_TIER.MO_TR_MXM_AMT

The threshold vallue which when exceeded results in a customer being outside of this CustomerRewardTier (and typically means they are assigned to a higher leve tier).

Money

decimal(16,5)

CustomerMembershipEarnedRewardTier.TierMinimumAmount

CO_CT_MBRSHP_ERN_RWD_TIER.MO_TR_MNM_AMT

The threshold vallue which when reached results in a customer being assigned to this CustomerRewardProgramTier.

Money

decimal(16,5)

CustomerMembershipEarnedRewardTier.TierValueUnitCode

CO_CT_MBRSHP_ERN_RWD_TIER.CD_TR_VL_UN

Indicates the units that apply to the TierMinimumAmount and TierMaximumAmount. Sample values include:

 

MONETARY

POINTS

MILES

GALLONS

VISITS

RFM_SCORES

Code

varchar(20)

CustomerMembershipProgram.CustomerMembershipProgramFeeAmount

CO_CT_MBRSHP_PRGM.MO_FE

Monetary Value of the fee that is paid by a customer to enroll in the CustomerRewardProgram.

Money

decimal(16,5)

CustomerMembershipProgram.CustomerRewardProgramTypeCode

CO_CT_MBRSHP_PRGM.CD_CT_RWD_PRGM_TYP

A code used to indicate the class or category of customer reward related to this program. Valid values include:

 

LOYALTY_PROGRAM

CLUB_MEMBERSHIP_PROGRAM

Code

varchar(20)

CustomerMembershipProgram.Description

CO_CT_MBRSHP_PRGM.DE_PRGM_LYLT

Text that describes a club membership program.

DescriptionNarrative

varchar(4000)

CustomerMembershipProgram.EffectiveDate

CO_CT_MBRSHP_PRGM.DC_PRGM_LYLT_EF

The date that a loyalty program becomes available.

EffectiveDate

date

CustomerMembershipProgram.EnrollmentRenewalPeriodCode

CO_CT_MBRSHP_PRGM.CD_ENRLLMNT_RNWL_PRD

Designates a renewal period type for this program if its FeeChargedFlag is YES and its FeeRenewalTypeCode is 'RENEWABLE'. Valid values are:

 

CALENDAR_YEAR

ANNUAL_ANNIVERSERY_DATE

SEMIANNUAL

QUARTERLY

MONTHLY

Code

varchar(20)

CustomerMembershipProgram.ExpirationDate

CO_CT_MBRSHP_PRGM.DC_PRGM_LYLT_EX

The date after which the loyalty program is no longer available.

ExpirationDate

date

CustomerMembershipProgram.FeeChargedFlag

CO_CT_MBRSHP_PRGM.FL_FE_CHRGD

A boolean indicator that if YES means that a customer pays a fee to enroll in thie CustomerRewardProgram. If NO, they do not pay a fee.

 

Note that a customer always registers (i.e. in the ARTS model they must be a KeyCustomer and have an account relationship established.

Flag

integer

CustomerMembershipProgram.FeeRenewalTypeCode

CO_CT_MBRSHP_PRGM.CD_FE_RNWL_TYP

Designates the fee (if FeeChargedFlag is YES) renewal type. Valid values are:

 

ONETIME

RENEWABLE

Code

varchar(20)

CustomerMembershipProgram.MembershipProgramID

CO_CT_MBRSHP_PRGM.ID_CT_MBRSHP_PRGM

Token ID for a CustomerRewardProgram instance.

Identity

integer

CustomerMembershipProgram.MembershipProgramProcessorID

CO_CT_MBRSHP_PRGM.ID_CT_MBRSHP_PRGM_PCSR

Token ID for a CustomerRewardProgramProcessor

Identity

integer

CustomerMembershipProgram.MembershipProgramSponsorID

CO_CT_MBRSHP_PRGM.ID_MBRSHP_PRGM_SPNSR

Token ID for a CustomerRewardProgramSponsor

Identity

integer

CustomerMembershipProgram.Name

CO_CT_MBRSHP_PRGM.NM_PRGM_LYLT

Generic membership club name used primarily for internal reporting. Names used to advertis and promote a CustomerMembershipProgram are delegated to the subtype entities.

Name

varchar(40)

CustomerMembershipProgram.ProgramTypeCode

CO_CT_MBRSHP_PRGM.CD_PRGM_TYP

Designates a category of CustomerRewardProgram.

 

Sample values include:

 

LOYALTY

SUBSCRIPTION

Code

varchar(20)

CustomerMembershipProgram.ProrateFeeFlag

CO_CT_MBRSHP_PRGM.FL_PRRT_FE

A boolean indicator that if YES means that a calendar year (or other calendar based renewal period) fee will be prorated based on the actual program enrollment date.

 

For example customer X joins Y wholesale club on July 1 and Y has a calendar year based membership program -- customer X will pay half the annual fee to enroll. There after, the customer will pay a full year fee to remain a member in good standing.

Flag

integer

CustomerMembershipProgram.RedemptionInstantDeferredTypeCode

CO_CT_MBRSHP_PRGM.CD_RDM_INSTNT_DFR_TYP

A code that indicates of redemption of points is instant (based on rules fired at the point of sale) or deferred which requires a separate action on the part of the customer and/or retailer.

 

Valid Values:

DEFERRED

INSTANT

 

INSTANT redemption of points may happen any time after they are earned. Typically they are redeemed automatically using electronic coupons. Deferred redemptions mean that points may be redeemed at a later time based on a retailer defined event or trigger.

Code

varchar(20)

CustomerMembershipProgram.StatusCode

CO_CT_MBRSHP_PRGM.STS_CD

Indicates the status of this CustomerRewardProgram entity instance.

 

Sample values include:

 

A = Active

I = Inactive

Code2Status

char(2)

CustomerMembershipProgramAccount.CustomerAccountID

LE_CT_MBRSHP_PRGM_ACNT.ID_CTAC

A unique identifier for a customer account.

Identity

integer

CustomerMembershipProgramAccount.CustomerMemberProgramAccountID

LE_CT_MBRSHP_PRGM_ACNT.ID_CT_MBR_PRGM_ACNT

Token ID for a CustomerMemberProgramAccount.

Identity

integer

CustomerMembershipProgramAccount.EffectiveDate

LE_CT_MBRSHP_PRGM_ACNT.DC_EF_DT

Date a CustomerRewardAccount becomes active.

EffectiveDate

date

CustomerMembershipProgramAccount.ExpirationDate

LE_CT_MBRSHP_PRGM_ACNT.DC_EP_DT

Date a CustomerRewardProgramAccount becomes inactive

ExpirationDate

date

CustomerMembershipProgramAccount.LevelNumber

LE_CT_MBRSHP_PRGM_ACNT.IC_LV_NMB

A whole number that establishes the relative value of a membership program level. The higer the value, the greater the level and its associated rewards and where applicable fees.

Number

integer

CustomerMembershipProgramAccount.MembershipProgramID

LE_CT_MBRSHP_PRGM_ACNT.ID_CT_MBRSHP_PRGM

Token ID for a CustomerRewardProgram instance.

Identity

integer

CustomerMembershipProgramAccount.StatusCode

LE_CT_MBRSHP_PRGM_ACNT.CD_STS

Current status of this CustomerRewardProgramAccount

 

Valid values are

A Active

I Inactive

Code2Status

char(2)

CustomerMembershipProgramAccountRewardDerivationRuleEligibiliy.CustomerRewardProgramTierCode

CO_CT_LYLT_PRGM_PRC_DRVN_RU_EL.CD_CT_RWD_PRGM_TR

A code that represents the relative value of a given CustomerRewardProgramTier

Code

varchar(20)

CustomerMembershipProgramAccountRewardDerivationRuleEligibiliy.LevelNumber

CO_CT_LYLT_PRGM_PRC_DRVN_RU_EL.IC_LV_NMB

A whole number that establishes the relative value of a membership program level. The higer the value, the greater the level and its associated rewards and where applicable fees.

Number

integer

CustomerMembershipProgramAccountRewardDerivationRuleEligibiliy.MembershipProgramID

CO_CT_LYLT_PRGM_PRC_DRVN_RU_EL.ID_CT_MBRSHP_PRGM

Token ID for a CustomerRewardProgram instance.

Identity

integer

CustomerMembershipProgramAccountRewardDerivationRuleEligibiliy.RewardDerivationRuleEligibilityID

CO_CT_LYLT_PRGM_PRC_DRVN_RU_EL.ID_EL_PRDV

A unique identifier for a Reward Derivation Rule Eligibility.

Identity

integer

CustomerMembershipProgramLevel.LevelCode

CO_CT_MBRSHP_PRGM_LV.CD_LV

A code that identifies a membership level. Membership levels typically offer different kinds of rewards and, where fees are involved charge different fee amounts.

 

Examples of codes include:

 

PLATINUM

GOLD

SILVER

BRONZE

 

Code

varchar(20)

CustomerMembershipProgramLevel.LevelInitialFeeAmount

CO_CT_MBRSHP_PRGM_LV.MO_LV_INT_FE_AMT

The initial fee that is charged to join as a member.

 

Only applies if the CustomerMembershipProgram is a paid for program. Examples includ various chains like Costco, Sam's Club, BJ's - all charge a fee based on membership program level.

Money

decimal(16,5)

CustomerMembershipProgramLevel.LevelNumber

CO_CT_MBRSHP_PRGM_LV.IC_LV_NMB

A whole number that establishes the relative value of a membership program level. The higer the value, the greater the level and its associated rewards and where applicable fees.

Number

integer

CustomerMembershipProgramLevel.LevelPeriodicRenewalFeeAmount

CO_CT_MBRSHP_PRGM_LV.MO_LV_PRDC_RNWL_FE_AMT

The periodic renewal fee for a specific membership level.

 

Some shopping club memerships (e.g. Costco, Sam's, BJs) require an annual fee to renew membership.

 

Some programs (e.g. REI) require only a one time fee to join.

Money

decimal(16,5)

CustomerMembershipProgramLevel.MembershipProgramID

CO_CT_MBRSHP_PRGM_LV.ID_CT_MBRSHP_PRGM

Token ID for a CustomerRewardProgram instance.

Identity

integer

CustomerMembershipProgramProcessor.MembershipProgramProcessorID

PA_CT_MBRSHP_PRGM_PCSR.ID_CT_MBRSHP_PRGM_PCSR

Token ID for a CustomerRewardProgramProcessor

Identity

integer

CustomerMembershipProgramProcessor.PartyRoleAssignmentID

PA_CT_MBRSHP_PRGM_PCSR.ID_PRTY_RO_ASGMT

Token identifier for a PartyRoleAssignmentInstance.

Identity

integer

CustomerMembershipProgramSponsor.MembershipProgramSponsorID

PA_CT_MBRSHP_PRGM_SPNSR.ID_MBRSHP_PRGM_SPNSR

Token ID for a CustomerRewardProgramSponsor

Identity

integer

CustomerMembershipProgramSponsor.PartyRoleAssignmentID

PA_CT_MBRSHP_PRGM_SPNSR.ID_PRTY_RO_ASGMT

Token identifier for a PartyRoleAssignmentInstance.

Identity

integer

CustomerMembershipProgramTerms.CustomerAccountContractNarrative

CO_CT_MBRSHP_PRGM_TRM .NA_CT_ACNT_CNTRT_NRTV

Narrative text for the CustomerRewardLegalTermsAndConditions.

DescriptionNarrative

varchar(4000)

CustomerMembershipProgramTerms.EffectiveDate

CO_CT_MBRSHP_PRGM_TRM .DC_EF_DT

Date this program legal terms and provisions document revision is in force.

EffectiveDate

date

CustomerMembershipProgramTerms.ExpirationDate

CO_CT_MBRSHP_PRGM_TRM .DC_EP_DT

Date this program legal terms and provisions document revision is no longer in force.

ExpirationDate

date

CustomerMembershipProgramTerms.MembershipProgramID

CO_CT_MBRSHP_PRGM_TRM .ID_CT_MBRSHP_PRGM

Token ID for a CustomerRewardProgram instance.

Identity

integer

CustomerMembershipProgramTerms.RevisionNumber

CO_CT_MBRSHP_PRGM_TRM .AI_RVSN_NMB

The version number used to track modifications to the CustomerRewardProgramTermsAndConditions over time.

Number

integer

CustomerMembershipProgramTerms.StatusCode

CO_CT_MBRSHP_PRGM_TRM .CD_STS

Current status of this terms and conditions revision.

 

Retailers need to exercise care in assigning status codes. While a contract may be modified prior versions tied to older customer accounts may remain in force.

 

Retailers need to define an appropriate contract life cycle management strategy as part of implementing this entity.

Code2Status

char(2)

CustomerMembershipProgramType.ProgramTypeCode

CO_CT_MBRSHP_PRGM_TYP.CD_PRGM_TYP

Designates a category of CustomerRewardProgram.

 

Sample values include:

 

LOYALTY

SUBSCRIPTION

Code

varchar(20)

CustomerMembershipProgramType.ProgramTypeDescription

CO_CT_MBRSHP_PRGM_TYP.DE_PRGM_TYP

Short description of this CustomerRewardProgramType.

DescriptionShort

varchar(255)

CustomerOrder.CustomerAccountID

DO_CTORD.ID_CTAC

A unique identifier for a customer account.

Identity

integer

CustomerOrderAccount.CustomerAccountID

LE_CT_ORD_ACNT.ID_CTAC

A unique identifier for a customer account.

Identity

integer

CustomerOrderAccount.DefaultShipTo

LE_CT_ORD_ACNT.ID_PRTY_CNCT_MTH

A token identifier for a PartyContactMethod entity type instance.

Identity

integer

CustomerOrderLineItemType.CustomerOrderLineItemTypeCode

CO_CT_ORD_LN _ITM_TYP.CD_CT_ORD_LN_ITM_TYP

Identifies a valid CustomerOrderLineItemType. Examples include:

 

PRODUCT_LINEITM

Code

varchar(20)

CustomerOrderLineItemType.Description

CO_CT_ORD_LN _ITM_TYP.DE_CT_ORD_LN_ITM_TYP

Short business description of the line item type code.

DescriptionShort

varchar(255)

CustomerOrderProductGroup.Inventory

CO_CTORD_GRP.Inventory

A unique system assigned identifier for the InventoryLocation from which the Items in this CustomerOrderProductGroup being ordered are to be sourced.

Identity

integer

CustomerOrderProductLineItem.FulfilledItemQuantity

DO_CTOLTM_PDT.QU_FLF_CNT

The number of ordered items that have been made available for delivery to the Customer or pickup by the Customer.

Quantity

DECIMAL(9,3)

CustomerOrderProductLineItem.OrderedItemQuantity

DO_CTOLTM_PDT.QU_ORD_CNT

The number of Items being ordered.

Quantity

DECIMAL(9,3)

CustomerOrderProductSpecialInstructions.InstructionNarrative

CO_CTOLM_PDT_INSTR.NA_INSTR

Instructional narrative text.

DescriptionNarrative

varchar(4000)

CustomerOrderShipment.AccessoryFeeExpenseAmount

TR_SHP_CT_ORD.MO_ACCSSRY_FE_EXP_AMT

Extra fees added to total shipping expense for extra (accessory) services like extra insurance, signed receipt/confirmation, etc.

Money

decimal(16,5)

CustomerOrderShipment.ActualBillTo

TR_SHP_CT_ORD.ID_PRTY_CNCT_MTH

A token identifier for a PartyContactMethod entity type instance.

Identity

integer

CustomerOrderShipment.ActualDeliveryDateTime

TR_SHP_CT_ORD.TS_ACT_RCV

The actual date & time the shipment was received at the shipment address.

AuditDateTime

datetime

CustomerOrderShipment.ActualPaymentMethod

TR_SHP_CT_ORD.NM_ACT_PYM_MTH

A designated code and enumerated value list that categorizes different ways of paying for transporation services related to a shipment/delivery of merchandise.

 

These typically apply to COD or scenarios where the merchandise is paid for through another means but the customer must pay transport fees on delivery.

 

GS1 examples include:

 

BANK_CHEQUE

BANK_GIRO

BANKERS_DRAFT

BOOKENTRY_CREDIT

BOOKENTRY_DEBIT

BOP

CASH

CERTIFIED_CHEQUE

CHEQUE

CREDIT_CARD

DEBIT_CARD

ELECTRONIC_CREDIT_ACH

ELECTRONIC_DEBIT_ACH

FED_WIRE_NON_REPETITIVE

FED_WIRE_REPETITIVE

INTERNATIONAL_WIRE

LETTER_OF_CREDIT

POSTGIRO

WIRE_TRANSFER_CREDIT

WIRE_TRANSFER_DEBIT

Name

varchar(40)

CustomerOrderShipment.ActualPickupDateTime

TR_SHP_CT_ORD.TS_SHP_ACT

The actual date and time the shipment was picked up by the carrier (as opposed to being delivered to the customer).

AuditDateTime

datetime

CustomerOrderShipment.ActualServiceLevel

TR_SHP_CT_ORD.CD_SV_LV

Identifies a transportation service level type used to distinguish faster from slower delivery plus additional tracking and ancillary services.

 

Sample GS1 code values:

AUTHORIZED_RETURN_SERVICE

CONSIGNEE_BILLING_SERVICE

DELIVERY_CONFIRMATION

EXPEDITED_SERVICE

EXPEDITED_SERVICE_WORLDWIDE

EXPRESS_SERVICE

EXPRESS_SERVICE_PLUS

GROUND

GROUND_CX_EXPRESS_SERVICE

MULTIWEIGHT

MUTUALLY_DEFINED

NEXT_DAY_AIR

NEXT_DAY_PM

NEXT_MORNING

PRIMARY_SERVICE_AREA_NEXT_DAY_BY_1030

PRIMARY_SERVICE_AREA_NEXT_DAY_BY_1700

RETURN_SERVICE

SAME_DAY

SATURDAY

SATURDAY_PICKUP

SECOND_DAY_AIR

SECOND_MORNING

STANDARD_GROUND_HUNDRED_WEIGHT

STANDARD_SERVICE

THREE_DAY_SERVICE

Code

varchar(20)

CustomerOrderShipment.ActualShipTo

TR_SHP_CT_ORD.ID_PRTY_CNCT_MTH

A token identifier for a PartyContactMethod entity type instance.

Identity

integer

CustomerOrderShipment.AlternatePayment

TR_SHP_CT_ORD.ID_CRR_ACNT

The account number assigned to the retailer by the Carrier for invoicing and delivery service ordering purposes.

 

A designated alternate account number (not the retailer's CarrierAccountNumber) that is to be charged for transport-related fees and expenses for this shipment.

Identity

integer

CustomerOrderShipment.BaseShippingFeeExpenseAmount

TR_SHP_CT_ORD.MO_BS_SHPPNG_FE_EXP_AMT

Base shipping fee charged by the carrier exclusive of add-on fees for extra services.

Money

decimal(16,5)

CustomerOrderShipment.CarrierAccountNumber

TR_SHP_CT_ORD.ID_CRR_ACNT

The account number assigned to the retailer by the Carrier for invoicing and delivery service ordering purposes.

Identity

integer

CustomerOrderShipment.CarrierID

TR_SHP_CT_ORD.ID_CRR

A unique system assigned identifier for the Carrier.

Identity

integer

CustomerOrderShipment.CarrierServiceID

TR_SHP_CT_ORD.ID_CRR_SV

Token identifier for a CarrierService instance

Identity

integer

CustomerOrderShipment.CarrierTrackingNumber

TR_SHP_CT_ORD.ID_TRCK_SHP

A tracking number provided by the service provider who actually delivers the shipment.

IdentityAlphaNumeric

varchar(20)

CustomerOrderShipment.CollectOnDeliveryAmount

TR_SHP_CT_ORD.MO_CLLCT_ON_DV_AMT

The value a carrier must collect from the customer at the time merchandise is delivered. The COD amount typically includes the merchandise cost plus any shipping and handling fees expected to be paid for by the customer.

Money

decimal(16,5)

CustomerOrderShipment.CollectOnDeliveryFeeAmount

TR_SHP_CT_ORD.MO_CLLCT_ON_DV_FE_AMT

Collect on DeliveryFEE charged to cover collection service at the time of delivery. This is NOT the total collect on delivery amount, that is covered in a different attribute called CollectOnDeliveryAmount

Money

decimal(16,5)

CustomerOrderShipment.CustomerAccountInvoiceID

TR_SHP_CT_ORD.ID_INVC_CTAC

A unique system assigned identifier for the CustomerAccountInvoice

Identity

integer

CustomerOrderShipment.CustomerOrderGroupID

TR_SHP_CT_ORD.ID_CTORD_GRP

A unique system assigned identifier for the group of line items from a Customer placed order, recording how the Customer wishes the StockItems that have been orderd are to be given to the Customer.

Identity

integer

CustomerOrderShipment.DeliveryTypeCode

TR_SHP_CT_ORD.CD_DV_TYP

A designated category of delivery. Valid values are:

 

 

PARTIAL_DELIVERY Partial Delivery

COMPLETE_DELIVERY_ONLY complete delivery only

Name

varchar(40)

CustomerOrderShipment.EstimatedDeliveryDateTime

TR_SHP_CT_ORD.TS_ESTM_RCV

The estimated date & time the shipment will be received at the shipment address.

AuditDateTime

datetime

CustomerOrderShipment.FuelSurchargeAmount

TR_SHP_CT_ORD.MO_FUEL_SRCHRG_AMT

Additional charge for fuel that may be required by some carriers.

Money

decimal(16,5)

CustomerOrderShipment.ManifestDocumentNumber

TR_SHP_CT_ORD.%ColDomain

The identifying number for a manifest document which lists the containers being transported within a shipment.

IdentityAlphaNumeric

varchar(20)

CustomerOrderShipment.ResidentialSurchargeAmount

TR_SHP_CT_ORD.MO_RSDNTL_SRCHRG_AMT

A supplementary fee charged by some carriers to cover the additional cost of delivering packages to widely dispersed addresses.

Money

decimal(16,5)

CustomerOrderShipment.ScheduledDeliveryDateTime

TR_SHP_CT_ORD.TS_SCH_RCV

The scheduled date & time the shipment will be received at the shipment address.

AuditDateTime

datetime

CustomerOrderShipment.ShipmentID

TR_SHP_CT_ORD.ID_SHP

A unique, retailer supplied identifier for a RetailTransactionShipment.

Identity

integer

CustomerOrderShipment.ShipMethodID

TR_SHP_CT_ORD.ID_SHP_MTH

Token identifier for a ShipMethodInstance

Identity

integer

CustomerOrderShipment.SourceInventoryLocationID

TR_SHP_CT_ORD.ID_LCN_SRC

A unique system assigned identifier for the InventoryLocation from which the shipment was made.

Identity

integer

CustomerOrderShipment.SpecialInstructions

TR_SHP_CT_ORD.NA_INST_SPL

Narrative text, giving special delivery instructions.

DescriptionNarrative

varchar(4000)

CustomerOrderShipment.TrackingURI

TR_SHP_CT_ORD.UR_URL_TRCK_SHP

A URI to the service provider's website, which allows interested parties to track the shipment.

DescriptionShort

varchar(255)

CustomerOrderShipment.TransportBillingMethodCode

TR_SHP_CT_ORD.CD_TRNSPRT_BLLNG_MTH

Retailer designated code that indicates how the transportation and handling fees for a shipment are to be billed.

 

Sample values (for domestic US shipments) include:

 

PREPAID = prepaid transportation fees

COL = collect upon delivery from receipient

BRC = Bill the receiver

B3P = Bill 3rd party

 

Others may be added as required for international shipping and other kinds of shipping arrangements.

Code

varchar(20)

CustomerOrderShipmentContainer.AccessoryFeeExpenseAmount

AS_CT_ORD_SHPMT_CNR.MO_ACCSSRY_FE_EXP_AMT

Extra fees added to total shipping expense for extra (accessory) services like extra insurance, signed receipt/confirmation, etc. for this ShipmentContainer.

Money

decimal(16,5)

CustomerOrderShipmentContainer.BaseShippingFeeExpenseAmount

AS_CT_ORD_SHPMT_CNR.MO_BS_SHPPNG_FE_EXP_AMT

Base shipping fee charged by the carrier exclusive of add-on fees for extra services for this ShipmentContainer.

Money

decimal(16,5)

CustomerOrderShipmentContainer.CarrierContainerTrackingID

AS_CT_ORD_SHPMT_CNR.ID_CRR_CNR_TRCKNG

A bar code, RFID chip or some other identification used to uniquely distinguish one ShipmentContainer from all others. Used to track the shipment container

IdentityAlphaNumeric

varchar(20)

CustomerOrderShipmentContainer.Contained

AS_CT_ORD_SHPMT_CNR.ID_CT_OR_SHPMT_CNR_CNTND

Token identifier used to uniquely identify this ShippingContainer instance.

Identity

integer

CustomerOrderShipmentContainer.ContainerHeightQuantity

AS_CT_ORD_SHPMT_CNR.QL_CNR_HT_QTY

The height of a container. Used to define dimensions for load configuration.

Quantity

DECIMAL(9,3)

CustomerOrderShipmentContainer.ContainerLengthQuantity

AS_CT_ORD_SHPMT_CNR.QL_CNR_LNG_QTY

The length of a container. Used to define dimensions for load configuration.

Quantity

DECIMAL(9,3)

CustomerOrderShipmentContainer.ContainerWidthQuantity

AS_CT_ORD_SHPMT_CNR.QL_CNR_WD_QTY

The width of a container. Used to define dimensions for load configuration.

Quantity

DECIMAL(9,3)

CustomerOrderShipmentContainer.DimensionalWeightQuantity

AS_CT_ORD_SHPMT_CNR.QW_DMNSNL_WT_QTY

Dimensional weight, also known as volumetric weight, is a pricing technique for commercial freight transport (including courier and postal services), which uses an estimated weight that is calculated from the length, width and height of a package. Shipping costs have historically been calculated on the basis of gross weight in kilograms or pounds. By charging only by weight, lightweight, low density packages become unprofitable for freight carriers due to the amount of space they take up in the truck/aircraft/ship in proportion to their actual weight. The concept of dimensional weight has been adopted by the transportation industry worldwide as a uniform means of establishing a minimum charge for the cubic space a package occupies. In fact, UPS[1] and Fedex[2] have recently announced that starting 2015, shipping charges on all shipments (air and ground) will be determined by greater of the actual weight and dimensional weight of a package. Prior to this announcement, dimensional weight charges were only applicable to packages of a specific size range.

 

Dimensional weight is a calculation of a theoretical weight of a package. This theoretical weight is the weight of the package at a minimum density chosen by the freight carrier. If the package is below this minimum density, then the actual weight is irrelevant as the freight carrier will charge for the volume of the package as if it were of the chosen density (what the package would weigh at the minimum density). Furthermore, the volume used to calculate the dimensional weight may not be absolutely representative of the true volume of the package. The freight carrier will measure the longest dimension in each of the three axis (X, Y, Z) and use these measurements to determine the package volume. If the package is a right-angled rectangular box (cuboid), then this will be equal to the true volume of the package. However, if the package is of any other shape, then the calculation of volume will be more than the true volume of the package.

Dimensional weight is also known as DIM weight, volumetric weight, or cubed weight. Freight carriers utilize the greater of the actual weight or dimensional weight to calculate shipping charges. Dimensional weight is calculated as (length × width × height) / (dimensional factor). Measurements can be made all in inches or all in centimeters, but the appropriate shipping factor must also be used.

Quantity

DECIMAL(9,3)

CustomerOrderShipmentContainer.GrossWeightQuantity

AS_CT_ORD_SHPMT_CNR.QW_GW_WT_QTY

The gross weight of the ShipmentContainer including merchandise plus the weight of the container itself

Quantity

DECIMAL(9,3)

CustomerOrderShipmentContainer.Linear

AS_CT_ORD_SHPMT_CNR.CD_UOM_LNR

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.

Code

varchar(20)

CustomerOrderShipmentContainer.NetWeightQuantity

AS_CT_ORD_SHPMT_CNR.QW_NT_WT_QTY

The weight of the merchandise without the container.

Quantity

DECIMAL(9,3)

CustomerOrderShipmentContainer.PackageLevelCode

AS_CT_ORD_SHPMT_CNR.CD_PKG_LV

Designateds a llevel of packaging. Used to document containers within containers (nesting)

.

Sample GS1 values are:

 

1 Inner

1E Highest (GS1 Code)

2 Intermediate

3 Outer

4 No packaging hierarchy

5 Shipment Level

Code

varchar(20)

CustomerOrderShipmentContainer.PackageTypeCode

AS_CT_ORD_SHPMT_CNR.CD_PKG_TYP

A code used to classify packages for transportation purposes.

Code

varchar(20)

CustomerOrderShipmentContainer.PackagingShapeCode

AS_CT_ORD_SHPMT_CNR.CD_PCKGNG_SHPE

Designated code used to characterize the geometric form of a ShipmentContainer or package.

Code

varchar(20)

CustomerOrderShipmentContainer.ShipmentContainerID

AS_CT_ORD_SHPMT_CNR.ID_CT_ORD_SHPMT_CNR

Token identifier used to uniquely identify this ShippingContainer instance.

Identity

integer

CustomerOrderShipmentContainer.ShipmentContainerSequenceNumber

AS_CT_ORD_SHPMT_CNR.AI_SHPMT_CNR_SQN_NMB

Number used to list ShipmentContainer instances within a Shipment.

LineNumber

smallint

CustomerOrderShipmentContainer.ShipmentID

AS_CT_ORD_SHPMT_CNR.ID_SHP

A unique, retailer supplied identifier for a RetailTransactionShipment.

Identity

integer

CustomerOrderShipmentContainer.StandardParcelSizeID

AS_CT_ORD_SHPMT_CNR.ID_STD_PRCL_SZ

Token identifier for a CarrierStandardParcelSize entity type instance

Identity

integer

CustomerOrderShipmentContainer.Weight

AS_CT_ORD_SHPMT_CNR.CD_UOM_WT

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.

Code

varchar(20)

CustomerOrderShipmentItem.CustomerOrderGroupID

TR_ITM_RTL_SHP.ID_CTORD_GRP

A unique system assigned identifier for the group of line items from a Customer placed order, recording how the Customer wishes the StockItems that have been orderd are to be given to the Customer.

Identity

integer

CustomerOrderShipmentItem.CustomerOrderID

TR_ITM_RTL_SHP.ID_ORD

A unique system assigned identifier for the CustomerOrder.

Identity

integer

CustomerOrderShipmentItem.CustomerOrderLineItemSequenceNumber

TR_ITM_RTL_SHP.IC_OR_LTM

A unique system assigned identifier for the LineItem within the confines of the CustomerOrder.

LineNumber

smallint

CustomerOrderShipmentItem.Quantity

TR_ITM_RTL_SHP.QU_ITM_SHP

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.

Quantity

DECIMAL(9,3)

CustomerOrderShipmentItem.RetailTransactionLineItemSequenceNumber

TR_ITM_RTL_SHP.IC_LN_ITM

The sequence number of line item within the context of this RetailTransaction.

LineNumber

smallint

CustomerOrderShipmentItem.ShipmentContainerID

TR_ITM_RTL_SHP.ID_CT_ORD_SHPMT_CNR

Token identifier used to uniquely identify this ShippingContainer instance.

Identity

integer

CustomerOrderShipmentItem.ShipmentLineItemSequenceNumber

TR_ITM_RTL_SHP.IC_LTM_SHP_RTL_TRN

A unique, non-significant, automatically assigned sequential number used

to identify this item within the context of the RetailTransactionShipment.

Identity

integer

CustomerOrderShipmentItem.TransactionID

TR_ITM_RTL_SHP.ID_TRN

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members.

IdentityUUID

char(32)

CustomerOrderTenderPreAuthorization.TenderAuthorizationID

DO_CTOLTM_TND_AZN.AI_TND_AZN

A unique sequence number for this TenderAuthorization. Required because a particular TenderLineItem may have more than one TenderAuthorization attempt.

LineNumber

smallint

CustomerRebateAccount.CumulativePurchaseRebateBasisAmount

LE_CT_RBT_ACNT.MO_CUM_PCH_RBT_BSS_AMT

The cumulative amount of products and services purchased by a CustomerAccount that is participating in a designated RebateProgram. This covers membership rebate programs that pay "dividends" or issue SVC's or pay cash to customers based on some percentage of a customers total purchases (usally as a monetery value) made over a period of time (usaully on an annual basis prescribed in the RebateProgram).

Money

decimal(16,5)

CustomerRebateAccount.CustomerAccountID

LE_CT_RBT_ACNT.ID_CTAC

A unique identifier for a customer account.

Identity

integer

CustomerRebateAccount.EffectiveDate

LE_CT_RBT_ACNT.DC_EF_DT

The date and time a CustomerAccount is eligibile to participate in a RebateProgram

Datetime

datetime

CustomerRebateAccount.ExpirationDate

LE_CT_RBT_ACNT.DC_EP_DT

The date and time a CustomerAccount is no longer eligible to participate in a rebate program

Datetime

datetime

CustomerRebateAccount.RebateAccumulationEndDate

LE_CT_RBT_ACNT.DC_RBT_ACCMLTN_END_DT

The end date of a rebate accumulation period during which customer NET purchases are summarized to use as a basis for calculating a rebate.

DateCalendar

date

CustomerRebateAccount.RebateAccumulationStartDate

LE_CT_RBT_ACNT.DC_RBT_ACCMLTN_SRT_DT

The start date of a rebate accumulation period during which customer NET purchases are summarized to use as a basis for calculating a rebate.

DateCalendar

date

CustomerRebateAccountProgram.CustomerAccountID

CO_CT_RBT_ACNT_PRGM.ID_CTAC

A unique identifier for a customer account.

Identity

integer

CustomerRebateAccountProgram.CustomerRebateAccountProgramID

CO_CT_RBT_ACNT_PRGM.ID_CT_RBT_ACNT_PRGM

A token ID for a CustomerRebateAccountProgram

Identity

integer

CustomerRebateAccountProgram.EffectiveDate

CO_CT_RBT_ACNT_PRGM.DC_EF_DT

Date when a CustomerRebateAccount may actively participate in a RebateProgram.

EffectiveDate

date

CustomerRebateAccountProgram.ExpirationDate

CO_CT_RBT_ACNT_PRGM.DC_EP_DT

Date when a CustomerRebateAccount may no longer participate in a RebateProgram.

ExpirationDate

date

CustomerRebateAccountProgram.RebateProgramID

CO_CT_RBT_ACNT_PRGM.ID_RBT_PRGM

A token identifier for RebateProgram entity type instances.

Identity

integer

CustomerRebateAccountProgram.StatusCode

CO_CT_RBT_ACNT_PRGM.CD_STS

Status of the CustomerRebateAccountProgram association.

 

Valid values are:

 

A - ACTIVE

I - INACTIVE

Code2Status

char(2)

CustomerRebateClaim.ClaimFileDateTime

TR_CT_RBT_CLM.DT_CLM_FLE_DT_TM

The actual date and time a claim is filed.

 

Note that for mail in rebates where the customer is responsible for meeting eligibility criteria include ClaimLastPostalDate this attribute will be null. Only retailer controlled rows

DateTime

datetime

CustomerRebateClaim.RebateClaimAmount

TR_CT_RBT_CLM.MO_RBT_CLM_AMT

The monetary value for this RebateClaim

Money

decimal(16,5)

CustomerRebateClaim.RebateClaimantTypeCode

TR_CT_RBT_CLM.CD_RBT_CLMNT_TYP

A code that designates the category of claimant that is filing this RebateClaim. Valid values are:

 

CUSTOMER - shopper who purchased product

RETAILER - retailer gets the rebate based on satisfying contractually defined criteria

Code

varchar(20)

CustomerRebateClaim.RebateClaimID

TR_CT_RBT_CLM.ID_CT_RBT_CLM

A token ID for this RebateClaim entity type instance.

Identity

integer

CustomerRebateClaim.RebateClaimItemRetailSellingUnitQuantity

TR_CT_RBT_CLM.QU_RBT_CLM_ITM_RTL_SLLN_UN

Th actual quantity of retail selling units for an item submitted on a RebateClaim.

 

For rebates where customers are the target beneficiary this quantity will be based on what is sold and recorded in a retail transaction line item (i.e. SaleReturnLineItem).

 

For rebates where the retailer is the target beneficiary the claim quantity may be an aggregate value covering multiple retail transactions.

Quantity

DECIMAL(9,3)

CustomerRebateClaim.RebateProgramID

TR_CT_RBT_CLM.ID_RBT_PRGM

A token identifier for RebateProgram entity type instances.

Identity

integer

CustomerRebateClaim.StatusCode

TR_CT_RBT_CLM.CD_STS

Designates the CURRENT state of this RebateClaim entity type instance. Valid values based on POSLOG6 are:

 

New

ProofReceived

ProofIncomplete

VerificationComplete

RejectedInvalidProof

RejectedDueToReturn

Voided

Duplicate

CheckBeingProcessed

CheckMailed

Closed

 

 

Code

varchar(20)

CustomerRebateClaim.StatusEffectiveDateTime

TR_CT_RBT_CLM.DT_STS_EF_DT_TM

The date and time the StatusCode value was last modified to reflect the current status.

EffectiveDateTime

datetime

CustomerRentalAccount.LateReturnFeePerPeriodAmount

LE_ACNT_CT_RNT.MO_LT_RTN_FE_PR_PRD_AMT

The late fee charged per rental period when an item is returned late.

Money

decimal(16,5)

CustomerRentalAccount.MinimumLateReturnFeeAmount

LE_ACNT_CT_RNT.MO_MNM_LT_RTN_FE_AMT

A minimum flat late return fee.

Money

decimal(16,5)

CustomerRentalAccount.RentalDepositAmount

LE_ACNT_CT_RNT.MO_RNT_DS_AMT

A deposit amount paid by the customer as part of setting up a rental account. The RentalDepositAmount is typically used to offset the total rent due upon return of the rented item.

Money

decimal(16,5)

CustomerRentalAccount.RentalPeriodStartDateTime

LE_ACNT_CT_RNT.DT_RNT_PRD_SRT_DT_TM

The date and time a rental period begins. For some items (e.g. suba gear, specialty auto tools, etc.) a rental period may be hours and minutes. For other kinds of rented items the period might be days or weeks.

DateTime

datetime

CustomerRevolvingChargeAccount.AnnualInterestRatePercent

LE_ACNT_CT_CNS_CHG.PE_ANN_INTRST_RT

The annual rate used to calculate interest on the outstanding balance in this charge account.

 

Most credit cards specify a daily percentage rate which is the annual rate divided by 365 (or a value close to that).

Percent

decimal(7,4)

CustomerRevolvingChargeAccount.BillingCycleMonthDay

LE_ACNT_CT_CNS_CHG.DC_BLLNG_CYCL_MNTH_DY

The month and day of the month that a payment must be made against the principal and interest balance in the account.

DateFiscalDay

char(1)

CustomerRevolvingChargeAccount.CreditLimitAmount

LE_ACNT_CT_CNS_CHG.MO_CR_LM_AMT

The maximum balance (principal) that may be carried by a customer in this charge account.

Money

decimal(16,5)

CustomerRevolvingChargeAccount.CustomerAccountID

LE_ACNT_CT_CNS_CHG.ID_CTAC

A unique identifier for a customer account.

Identity

integer

CustomerRevolvingChargeAccount.GracePeriodDayCount

LE_ACNT_CT_CNS_CHG.DI_GRC_PRD_DY_CNT

A number of days a creditor may choose to defer penalties and penalty interest rate. The grace period extends the payment due date and enables a customer to avoid incurring penalty fees and interest.

QuantityDayCount

decimal(3,0)

CustomerRevolvingChargeAccount.MinimumInterestChargeAmount

LE_ACNT_CT_CNS_CHG.MO_MNM_INTRST_CHG_AMT

A mininmum monteary amount charged for interest. For example accrued interest of $.59 would result in a charge of $1.00. In this scenario the $1.00 is th eMinimumInterestChargedAmount

Money

decimal(16,5)

CustomerRevolvingChargeAccount.MinimumPaymentAmount

LE_ACNT_CT_CNS_CHG.MO_MNM_PYM_AMT

The minimum payment amount that must be paid on or before the billing cycle ending date in order to avoid penalty and interest.

Money

decimal(16,5)

CustomerRevolvingChargeAccount.PenaltyAnnualInterestRatePercent

LE_ACNT_CT_CNS_CHG.PE_PNTY_ANN_INTRST_RT

The annual interest percent charged for balances carred beyond the payment due date.

Percent

decimal(7,4)

CustomerRevolvingChargeAccount.PenaltyFeeAmount

LE_ACNT_CT_CNS_CHG.MO_PNTY_FE_AMT

A flat fee assessed for late or missed payments.

Money

decimal(16,5)

CustomerReward.CustomerMemberProgramAccountID

TR_CT_RWD.ID_CT_MBR_PRGM_ACNT

Token ID for a CustomerMemberProgramAccount.

Identity

integer

CustomerReward.CustomerRebateAccountProgramID

TR_CT_RWD.ID_CT_RBT_ACNT_PRGM

A token ID for a CustomerRebateAccountProgram

Identity

integer

CustomerReward.RewardID

TR_CT_RWD.ID_RWD

A token identifier for a Reward instance.

Identity

integer

CustomerRewardDerivationRuleEligibility.CustomerGroupID

CO_EL_CT_PRDV.ID_GP_ID

A unique identification number assigned to a customer group

Identity

integer

CustomerRewardDerivationRuleEligibility.RewardDerivationRuleEligibilityID

CO_EL_CT_PRDV.ID_EL_PRDV

A unique identifier for a Price Derivation Rule Eligibility.

Identity

integer

CustomerRewardLineItem.CustomerAccountValuationUnitTypeCode

TR_CT_RWD_LN_ITM.CD_CT_ACNT_VLN_UN_TYP

A code that identifies a kind of valuation unit.

 

Examples include:

MONEY

POINTS

MILES

GALLONS

VISITS

others that are relevant to a retailer

Code

varchar(20)

CustomerRewardLineItem.CustomerMemberProgramAccountID

TR_CT_RWD_LN_ITM.ID_CT_MBR_PRGM_ACNT

Token ID for a CustomerMemberProgramAccount.

Identity

integer

CustomerRewardLineItem.CustomerRewardProgramTierCode

TR_CT_RWD_LN_ITM.CD_CT_RWD_PRGM_TIER

A code that represents the relative value of a given CustomerRewardProgramTier

Code

varchar(20)

CustomerRewardLineItem.LevelNumber

TR_CT_RWD_LN_ITM.IC_LV_NMB

A whole number that establishes the relative value of a membership program level. The higer the value, the greater the level and its associated rewards and where applicable fees.

Number

integer

CustomerRewardLineItem.MembershipProgramID

TR_CT_RWD_LN_ITM.ID_CT_MBRSHP_PRGM

Token ID for a CustomerRewardProgram instance.

Identity

integer

CustomerRewardLineItem.RewardActionCode

TR_CT_RWD_LN_ITM.CD_RWD_ACTN

A code that defines how deferred rewards are to be processed in this line item. Valid values:

EARN - translate sale/return infor into reward currency

REDEEM - translate the reward currency into a discount or rebate value (percent off or monetary value) for use in the current transaction

ADJUST - add to or subtract from a redeemed currency balance held in the membership program account referenced in this entity type instance.

NOTE: Keep in mind that a Reward may be earned and redeemed in the same retail transaction. Instant rebates are one example of this. When a reward is earned AND redeemed in the same retail transaction, there will be TWO CustomerRewardLineItem (and for rebates CustomerRewardRebateLine instances) in that transaction. The first for an earned reward and the second for a redeemed reward.

Code

varchar(20)

CustomerRewardLineItem.RewardDerivationSequenceNumber

TR_CT_RWD_LN_ITM.AI_RWD_DRVN_SQN_NMB

A sequence number used to specify the order for applying derivation rules tied to a Reward.

 

RewardDerivationSequenceNumber always starts with 1 and is incremented by 1 for each appended derivation step tied to the Reward.

LineNumber

integer

CustomerRewardLineItem.RewardID

TR_CT_RWD_LN_ITM.ID_RWD

A token identifier for a Reward instance.

Identity

integer

CustomerRewardLineItem.RewardID

TR_CT_RWD_LN_ITM.ID_RWD

A token identifier for a Reward instance.

Identity

integer

CustomerRewardLineItem.RewardValueAmount

TR_CT_RWD_LN_ITM.MO_RWD_VL_AMT

The numeric value of a RewardLineItem expressed in reward currency units.

 

Reward currency unit examples include:

 

MONEY (discount amount or pct off)

POINTS

MILES

MEALS

 

Any other units a retailer chooses to reflect a stored, accrued value based on customer purchases as defeined in RewardDerivationRule.CustomerAccountValuationUnitTypeCode.

Money

decimal(16,5)

CustomerRewardRebateLineItem.CustomerRebateAccountProgramID

TR_CT_RWD_RBT_LN _ITM.ID_CT_RBT_ACNT_PRGM

A token ID for a CustomerRebateAccountProgram

Identity

integer

CustomerRewardRebateLineItem.EffectiveDate

TR_CT_RWD_RBT_LN _ITM.DT_EF

The date a RebateProgram begins.

EffectiveDate

date

CustomerRewardRebateLineItem.ExpirationDate

TR_CT_RWD_RBT_LN _ITM.DT_EP

The date a RebateProgram ends

ExpirationDate

date

CustomerRewardRebateLineItem.RebateCustomerSettlementCurrenctyTypeCode

TR_CT_RWD_RBT_LN _ITM.CD_RBT_CT_RDM_CNY_TYP

Designates the way a rebate value is transferred to a beneficiaryr. Enumerated value lists are defined by the retailer. Examples include:

 

CASH

SENDCHECK

DBCRCARD_CREDIT

DISCOUNT

PREMIUM_ITEM

LOYALTY_POINTS

STORED_VALUE

STORE_CREDIT

 

For scenarios where a rebate beneficiary is the retailer itself examples include:

BILL_BACK (in effect a receivable)

PURCHASE_DISCOUNT (take value off next purchase from the sponsor)

 

There are other more esoteric forms of payment like advertising subsidies, jointly sponsored promotional events, etc.

Code

varchar(20)

CustomerRewardRebateLineItem.RebateCustomerSettlementModeCode

TR_CT_RWD_RBT_LN _ITM.CD_RBT_CT_STLM_MOD

Defines that way customers receive rebates. Used to distinguish between mail in rebates, instant rebates and deferred rebate settlements.

 

Valid Values are:

MAILIN (deferred payout )

INSTANT (immediate payout within retail transaction)

DEFERRED_SETTLEMENT (aka "dividend")

 

Note does not establish the currency used for rebates (i.e. cash, points, premium gift items, stored value items, etc.)

Code

varchar(20)

CustomerRewardRebateLineItem.RebateID

TR_CT_RWD_RBT_LN _ITM.ID_RBT

Token ID for a CustomerRewardRebate

Identity

integer

CustomerRewardRebateLineItem.RetailTransactionLineItemSequenceNumber

TR_CT_RWD_RBT_LN _ITM.IC_LN_ITM

The sequence number of line item within the context of this RetailTransaction.

LineNumber

smallint

CustomerRewardRebateLineItem.SalesReceiptRequiredFlag

TR_CT_RWD_RBT_LN _ITM.FL_SLS_RCT_RQ

Boolean indicator that if YES means that a rebate beneficiary must subit the sales receipt on which the item being claimed for a rebate was sold.

 

If NO the rebate claimant does NOT have to submit the original sales receipt.

Flag

integer

CustomerRewardRebateLineItem.StatusCode

TR_CT_RWD_RBT_LN _ITM.CD_STS_RBT_PRGM

The current state of a RebateProgram. Sample values are:

 

ACTIVE

INACTIVE

Code2Status

char(2)

CustomerRewardRebateLineItem.TransactionID

TR_CT_RWD_RBT_LN _ITM.ID_TRN

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members.

IdentityUUID

char(32)

CustomerServiceWorkOrderAccount.CustomerAccountID

LE_CT_SV_WRK_ORD_ACNT.ID_CTAC

A unique identifier for a customer account.

Identity

integer

CustomerServiceWorkOrderAccount.ServiceProviderID

LE_CT_SV_WRK_ORD_ACNT.ID_PVR_SV

A unique system assigned identifier for the Service Provider.

Identity

integer

CustomerServiceWorkOrderAccount.WorkOrderDepositAmount

LE_CT_SV_WRK_ORD_ACNT.MO_WRK_ORD_DS_AMT

The amount of money a customer pays to secure a service. It is typically a prepayment and is subtracted from the final invoice amount for the service provided

Money

decimal(16,5)

CustomerServiceWorkOrderAccount.WorkOrderNumber

LE_CT_SV_WRK_ORD_ACNT.AI_WRK_ORD

A unique number used to identify the work order document associated with this CustomerServiceWorkOrder,.

 

IdentityAlphaNumeric

varchar(20)

CustomerStoredValueAccount.CustomerAccountID

LE_CT_STRD_VL_ACNT.ID_CTAC

A unique identifier for a customer account.

Identity

integer

CustomerStoredValueAccount.TransactionMaximumSpendLimitAmount

LE_CT_STRD_VL_ACNT.MO_TRN_MXM_SPND_LM_AMT

The maximum value a customer may use to pay for a single retail transaction. Sets an upper single retail transaction limit on the tender value for a stored valule instrument tied to this account.

 

Example: ABC Gift Card Maximum Spending Limit of $1,000 on any single transaction

 

Keep in mind that this applies to ALL stored value instruments tied to this CustomerStoredValueInstrument.

Money

decimal(16,5)

CustomerStoredValueAccount.TransactionMinimumSpendLimitAmount

LE_CT_STRD_VL_ACNT.MO_TRN_MNM_SPND_LM_AMT

The minimum value a customer may use to pay for a single retail transaction. Sets an lower single retail transaction limit on the tender value for a stored valule instrument tied to this account.

 

Example: ABC Gift Card Minimum Spending Limit of $1.00 on any single transaction

 

Keep in mind that this applies to ALL stored value instruments tied to this CustomerStoredValueInstrument.

Money

decimal(16,5)

CustomerSubscriptionProgram.MembershipProgramID

LE_CT_SBSCRPTN_PRGM.ID_CT_MBRSHP_PRGM

Token ID for a CustomerRewardProgram instance.

Identity

integer

CustomerSubscriptionProgram.SubscriptionProgramName

LE_CT_SBSCRPTN_PRGM.NM_CT_SBSCRPTN_PRGM

A short trade or advertising name assigned to a CustomerSubscriptionProgram. Examples:

 

EXECUTIVE_MEMBERSHIP

ELITE_MEMBERSHIP

 

Keep in mind these are typically applying to paid ClubMembershipPrograms. Accordingly the name is likely to reflect the nature of the program as it relates to a membership fee level.

Name

varchar(40)

CustomerTradeAccount.AnnualInterestRatePercent

LE_ACNT_CT_TRD.PE_ANN_INTRST_RT_PE

Tha annual interest rate percent charged on late invoice balances.

 

Annual rates may be expressed in monthlly or daily rates.

Percent

decimal(7,4)

CustomerTradeAccount.EarlyPaymentDiscountDayCount

LE_ACNT_CT_TRD.DI_ERLY_PYM_DY_CNT

The number of days after an invoice that grant the customer a discount for early payment of an invoice.

 

For example terms 1.5% NET 20 means that if a customer pays an invoice within 20 days it can take a 1.5% discount off of its payment.

QuantityDayCount

decimal(3,0)

CustomerTradeAccount.PaymentDueDayCount

LE_ACNT_CT_TRD.DI_PYM_DUE_DY_CNT

The number of days after an invoice date that the invoice must be paid. Invoices paid after their payment due date may (depending on the terms and conditions of the trade account and invoice) incur and interest charge.

QuantityDayCount

decimal(3,0)

Household.HouseholdTypeCode

PA_HSHLD.CD_HSHLD_TYP_CD

A retailer designated category used to group households with common properties together for reporting and analysis.

Code

varchar(20)

Household.HouseholdTypeCode

PA_HSHLD.CD_HSHLD_TYP_CD

A retailer designated category used to group households with common properties together for reporting and analysis.

Code

varchar(20)

ItemRewardDerivationRuleEligibility.ItemID

CO_EL_ITM_PRDV.ID_ITM

A unique system assigned identifier for the retailer's SKU.

IdentityUUID

char(32)

ItemRewardDerivationRuleEligibility.RewardDerivationRuleEligibilityID

CO_EL_ITM_PRDV.ID_EL_PRDV

A unique identifier for a Price Derivation Rule Eligibility.

Identity

integer

ItemSellingRule.ProportionalRefundEligibleFlag

RU_ITM_SL.FL_PRPPRTNL_RFD_EL

A boolean indicator that if TRUE means the item is subject to proportional refund based on partial consumption over a designated period of time. One example is a golf course purchase of an 18 hole round of golf where weather limits the customer's game to 9 holes. In this example a customer is eligible for a 9 hole refund (50% refund or credit) of original purchase Note that the specific way this is implemented may vary by retailer. They could issue a voucher or raincheck which is redeemable against a future round of golf.

Flag

integer

ItemSellingRule.RaincheckEligibleFlag

RU_ITM_SL.FL_RNCHK_EL

A boolean indicator that if TRUE means an item is eligible for raincheck issue if it is unavailable for sale during a promotional period. See Raincheck entity for more information.

Flag

integer

LoadingLimit.InitialLoadLimitAmount

CO_LDNG_LM.MO_INT_LD_LM_AMT

The maximum value that may be initially loaded on to a StoredValueInstrument

Money

decimal(16,5)

LoadingLimit.MaximumBalanceAmount

CO_LDNG_LM.MO_MXM_BLNC_AMT

The maximum balance amount permitted for the StoredValueInstrument.

 

For example a StoredValueCard with a $2000 balance limit and a $1500 balance could not have more than $500 added.

Money

decimal(16,5)

LoadingLimit.ReloadMaximumAmount

CO_LDNG_LM.MO_RELD_MXM_AMT

The maximum amount that may be added to a StoredValueInstrument balance. For example a stored value card may limit each reload to $1000 (or less) for each reload.

 

Note that this is subject to the MaximumBalance Amount.

Money

decimal(16,5)

LoadingLimit.StoredValueInstrumentTypeCode

CO_LDNG_LM.CD_STRD_VL_INSTRMNT_TYP

An ARTS standard code to designate the category of a StoredValueInstrument. POSLOG6 values are:

 

GiftCard

GiftCertificate

PhoneCard

SmartCard

OnlineVoucher

CarwashVoucher

Code

varchar(20)

ManufacturerRewardDerivationRuleEligibility.ManufacturerID

CO_EL_MF_PRDV.ID_MF

A unique system assigned identifier for the Manufacturer.

Identity

integer

ManufacturerRewardDerivationRuleEligibility.RewardDerivationRuleEligibilityID

CO_EL_MF_PRDV.ID_EL_PRDV

A unique identifier for a Price Derivation Rule Eligibility.

Identity

integer

MerchandiseHierarchyRewardDerivationRuleEligibility.MerchandiseHierarchyGroupID

CO_EL_MRHRC_PRDV.ID_MRHRC_GP

Unique system assigned identifier for a group or class of merchandise.

Identity

integer

MerchandiseHierarchyRewardDerivationRuleEligibility.RewardDerivationRuleEligibilityID

CO_EL_MRHRC_PRDV.ID_EL_PRDV

A unique identifier for a Price Derivation Rule Eligibility.

Identity

integer

PackageType.Description

CO_PKG_TYP.DE_PKG_TYP

Short description of a GS1PackageTypeCode.

DescriptionShort

varchar(255)

PackageType.PackageTypeCode

CO_PKG_TYP.CD_PKG_TYP

A code used to classify packages for transportation purposes.

Code

varchar(20)

PackagingShape.Description

CO_PCKGNG_SHPE.DE_PCKGNG_SHPE

Short description of a PackageShape.

DescriptionShort

varchar(255)

PackagingShape.PackagingShapeCode

CO_PCKGNG_SHPE.CD_PCKGNG_SHPE

Designated code used to characterize the geometric form of a ShipmentContainer or package.

Code

varchar(20)

PartyContactMethod.PartyContactMethodID

CO_MTH_CNCT_PTY.ID_PRTY_CNCT_MTH

A token identifier for a PartyContactMethod entity type instance.

Identity

integer

PaymentOnAccountLineItem.PaymentOnAccountTypeCode

TR_LTM_PYAN.CD_PYM_ON_ACNT_TYP

Designates the type of payment and target account it is intended to debit or credit (depending on the transaction context). Valid values are:

 

REVOLVING_CHG_PAYMENT

LAYAWAY_PAYMENT

INSTALLMENT_PAYMENT

Code

varchar(20)

PriceLineRewardDerivationRuleEligibility.MerchandiseHierarchyGroupID

CO_EL_PRC_LN_PRDV.ID_MRHRC_GP

Unique system assigned identifier for a group or class of merchandise.

Identity

integer

PriceLineRewardDerivationRuleEligibility.PriceLineID

CO_EL_PRC_LN_PRDV.ID_LN_PRC

A unique identifier for this price point.

Identity

integer

PriceLineRewardDerivationRuleEligibility.RewardDerivationRuleEligibilityID

CO_EL_PRC_LN_PRDV.ID_EL_PRDV

A unique identifier for a Price Derivation Rule Eligibility.

Identity

integer

PriceModificationLineItem.AdjustmentMethodCode

TR_LTM_MDF.CD_MTH_ADJT

A symbol code denoting what kind of adjustment is being made to the retail price of the Item.

 

e.g. Increase, Decrease.

 

'+' = Add to base retail (amount before price

modifier

'-' = Subtract from base retail

 

'=' = Replace base retail with ModifyByAmount

Code2

char(2)

PriceModificationLineItem.ModifyByAmount

TR_LTM_MDF.MO_MDFR_RT_PRC

A flat monetary value that is to be added to or subtracted from a base price. (Note typically this is a discount so subtraction is the expected action)

 

Example:

Base price $10.00

ModifyByAmountt $.50

 

Price Modification to be applied is $.50

Money

decimal(16,5)

PriceModificationLineItem.ModifyByPercent

TR_LTM_MDF.PE_MDFR_RT_PRC

The percent adjustment that was applied to the unit retail price to arrive at the modified selling price.

 

Example

 

Base price $10.00

ModifyByPercent 5% (.05)

 

Price Modification to be applied is $.50

Percent

decimal(7,4)

PriceModificationLineItem.NewPriceAmount

TR_LTM_MDF.MO_NW_PRC

The amount expressed as the new price for the item.

Money

decimal(16,5)

PriceModificationLineItem.RewardID

TR_LTM_MDF.ID_RWD

A token identifier for a Reward instance.

Identity

integer

PriceModificationType.ModifyByAmount

TR_MDF.MO_MDFR_RT_PRC

A flat monetary value that is to be added to or subtracted from a base price. (Note typically this is a discount so subtraction is the expected action)

 

Example:

Base price $10.00

ModifyByAmountt $.50

 

Price Modification to be applied is $.50

Money

decimal(16,5)

PriceModificationType.ModifyByPercent

TR_MDF.PE_MDFR_RT_PRC

The percent adjustment that was applied to the unit retail price to arrive at the modified selling price.

 

Example

 

Base price $10.00

ModifyByPercent 5% (.05)

 

Price Modification to be applied is $.50

Percent

decimal(7,4)

PriceModificationType.PriceModificationTypeName

TR_MDF.NM_MDF

The name of the standard price modification types represented in the Price Modification.

Name

varchar(40)

PromotionalOffer.CustomerRewardProgramTierCode

CO_PRM.CD_CT_RWD_PRGM_TR

A code that represents the relative value of a given CustomerRewardProgramTier

Code

varchar(20)

PromotionalOffer.LevelNumber

CO_PRM.IC_LV_NMB

A whole number that establishes the relative value of a membership program level. The higer the value, the greater the level and its associated rewards and where applicable fees.

Number

integer

PromotionalOffer.MembershipProgramID

CO_PRM.ID_CT_MBRSHP_PRGM

Token ID for a CustomerRewardProgram instance.

Identity

integer

PromotionalOfferGroup.Description

CO_TYP_PRM.DE_PRM_OFR_TYP

A human readable descripton of the Promotion Type.

DescriptionShort

varchar(255)

PromotionalOfferGroup.PromotionalOfferTypeCode

CO_TYP_PRM.CD_PRM_OFR_TYP

A classification code used to categorize promotion offer types. Examples include:

 

PRC_REC - Price reduction through a percent or flat amount discount

 

BOGO - Buy one get one (or more generally buy qty of N and get M for X$

 

MIX_MATCH - Buy X and get one of Y,Z,A for M$

 

PRC_MTCH - Price match a lower competitor price (markdown set based on delta between retailer and competitor price

 

GIVEAWAY - Item or stored value media given to customer

 

COUPON - A coupon that is treated as tender resuting in a discount. USUALLY debited as an AR when paid for by a supplier or other 3rd party

 

REBATE - A payment or credit given to a customer on a deferred basis (although some retailers offer "instant" rebates that behave more like discounts). Rebates are often sponsored by suppliers or other parties outside the retail enterprise.

 

OTHER - Anything else

 

This list is a starting point for retailers.

Code

varchar(20)

PromotionalOfferGroupOfferType.PromotionalInitiativeID

CO_PRM_TYP_PRM.ID_PRML_INITV

A token ID for a retailer's PromotionInitiative instance.

Identity

integer

PromotionalOfferGroupOfferType.PromotionalOfferID

CO_PRM_TYP_PRM.ID_PRM_OFR

The unique identifier for a promotion.

Identity

integer

PromotionalOfferGroupOfferType.PromotionalOfferTypeCode

CO_PRM_TYP_PRM.CD_PRM_OFR_TYP

A system assigned unique identifier for the PromotionType

Code

varchar(20)

RaincheckDocument.InventoryReservationID

RNCHK.ID_INV_RSRVTN

A reference to a document that sets aside a quantity of the item that is part of a raincheck. For example a customer wants to purchase 5 sale units of item A with a coupon for 20% off and can't use the coupone because the retailer is out of stock. The retailer issues a raincheck citing the items, quantity, original price and discount to the customer so they can obtain the discount. A week later, the retailer receives the items and reserves 5 sale units to honor its raincheck to the customer. When the customer comes back the stock is available and they can obtain the original discount.

Identity

integer

RaincheckDocument.RaincheckID

RNCHK.ID_RNCHK

Token ID to uniquely identify each RainCheckitem.

Identity

integer

RaincheckDocument.RaincheckIssue

RNCHK.CD_RNCHK_ISS

A unique retailer defined reason code for an action that is taken (or not taken) at a Workstation.

 

e.g. Return reason codes - Past Use By Date, Defective Merchandise, etc.

 

POSNoSale reason Codes - Customer Change Query

Code

varchar(20)

RaincheckDocument.RaincheckItemQuantity

RNCHK.QU_RNCHK_ITM

The count of item retail selling units for the item in this raincheck.

Quantity

DECIMAL(9,3)

RaincheckDocument.RaincheckItemRegularSaleslUnitPrice

RNCHK.MO_RNCHK_ITM_UN_REG_SLS_PRC

The regular (non-discounted) retail unit selling price for the Raincheck item.

Money

decimal(16,5)

RaincheckDocument.RaincheckItemUnitDiscountAmount

RNCHK.MO_RNCHK_ITM_UN_DSC

The discount amount associated with a raincheck item. For a 10% raincheck discount on a $10 item the value of the discount is $1.

Money

decimal(16,5)

RaincheckDocument.RaincheckRedeemedFlag

RNCHK.FL_RNCHK_RDMD

A boolean indicator that if set to TRUE means that the Raincheck has been redeemed.

Flag

integer

RaincheckDocument.RainCheckUnavailable

RNCHK.ID_ITM_UNAVLBL

A unique system assigned identifier for the retailer's SKU.

IdentityUUID

char(32)

RaincheckDocument.RetailTransactionDocumentID

RNCHK.ID_RTL_TRN_DCM

A token identifier for a RetailTransactionDocument instance.

Identity

integer

RaincheckDocument.SubstituteRaincheckItemAllowedFlag

RNCHK.FL_SBST_RNCHK_ALW

A boolean indicator that if YES means that the original rain check item ID may be substituted with a different item and still take the promised discount.

Flag

integer

RebateClaimDocument.RebateClaimID

DO_RBT_CLM_DCM.ID_CT_RBT_CLM

A token ID for this RebateClaim entity type instance.

Identity

integer

RebateClaimDocument.RetailTransactionDocumentID

DO_RBT_CLM_DCM.ID_RTL_TRN_DCM

A token identifier for a RetailTransactionDocument instance.

Identity

integer

RebateProcessor.PartyRoleAssignmentID

PA_RBT_PCSR.ID_PRTY_RO_ASGMT

Token identifier for a PartyRoleAssignmentInstance.

Identity

integer

RebateProcessor.RebateProcessorID

PA_RBT_PCSR.ID_PRTY_RBT_PCSR

A unique identifier for a RetailProcessor entity type instance.

Identity

integer

RebateProgram.ClaimLastPostalDate

RBT_PRGM.DC_CLM_LS_PSTL_DT

The latest postmark date that may appear on a mail in rebate and be eligible for payment. A postmark date after this date is deemed late and NOT ELIGIBLE for a rebate benefit.

DateCalendar

date

RebateProgram.EffectiveDate

RBT_PRGM.DC_EF_DT

Date when a RebateProgram is operational.

EffectiveDate

date

RebateProgram.EstimatedBreakageFactor

RBT_PRGM.PE_ESTM_BRKG_FCT

An estimated percentage of the amount of rebates earned but not paid out over the period of a rebate.

 

ABC launches a$1M rebate with a breakage estimate of .34 which is $340K.

 

When booking entries for rebate liability and rebate expense, ABC will assign 34% of a sale to the accrued rebate payable and 66% to the rebate discount. Note that breakage is a concern of the REBATE SPONSOR which may or may not be the retailer.

Percent

decimal(7,4)

RebateProgram.Expirationdate

RBT_PRGM.DC_EP_DT

Date when a RebateProgram is no longer operational

ExpirationDate

date

RebateProgram.MembershipProgramID

RBT_PRGM.ID_CT_MBRSHP_PRGM

Token ID for a CustomerRewardProgram instance.

Identity

integer

RebateProgram.Rebate

RBT_PRGM.CD_CNY_ISO_4217_RBT

Currency code designated by ISO to identify national currency

ISO_4217_CurrencyCode_char(3)

char(3)

RebateProgram.RebateBeneficiaryTypeCode

RBT_PRGM.CD_RBT_BNFCRY_TYP

Designates the party that will receive a rebate payment. Valid values for this code are:

 

RETAILER

CUSTOMER

 

Retailer means the retailer gets paid by the rebate sponsor and may or may not choose to pass it on to customers.

 

Customer means that the retailer is serving as an intermediary only -- rebate related money is passed to the customer. Retailers (unless ther are the sponsors) bill the sponosr for any money they refund to customers.

Code

varchar(20)

RebateProgram.RebateClaimProgramCode

RBT_PRGM.CD_RBT_CLM_PRGM

A code that must be supplied by a rebate claimant to indicate the rebate program a claim is submitted for. This is similar to a customer response code tied to a discount or other similar offer.

Code

varchar(20)

RebateProgram.RebateEligibilityCriteriaNarrative

RBT_PRGM.NA_RBT_EL_NRTV

A narrative description of eligibility conditions that must be satsified by a claimant to receive rebate benefits.

 

This is narrative information that supplements the SalesReceiptRequiredFlag, the UPCCutOutRequiredFlag and the ClaimLastPostalDate which are standard eligibility conditions for most retailer-based rebate programs.

DescriptionNarrative

varchar(4000)

RebateProgram.RebateProcessorID

RBT_PRGM.ID_PRTY_RBT_PCSR

A unique identifier for a RetailProcessor entity type instance.

Identity

integer

RebateProgram.RebateProgramID

RBT_PRGM.ID_RBT_PRGM

A token identifier for RebateProgram entity type instances.

Identity

integer

RebateProgram.RebateProgramPurposeCode

RBT_PRGM.CD_RBT_PRGM_PRPS

Assigns a rebate program to a certain category. The enumerated values that determine categories are assigned by the retailer. Examples include:

 

PROMOTION

CONSERVATION

HEALTYHABITS

LOYALTY

MEMBERSHIP_BENEFIT

OTHER

Code4

char(4)

RebateProgram.RebateRetailerReimbursementTypeCode

RBT_PRGM.CD_RBT_RTLR_RMBSRMNT_TYP

Designates the way a retailer is compensated for any rebate-related outlay of cash, merchandise, loyalty points, etc. they make on behalf of the rebate program.

 

 

Sample values include:

BILLBACK_REIMBURSEMENT

AP_INVOICE_CREDIT

DISCOUNT

NO_REIMBURSEMENT (applies to retailer sponsored rebates)

OTHER

Code

varchar(20)

RebateProgram.RebateSponsorID

RBT_PRGM.ID_SPNSR_RBT

Unique ID for a rebate sponsor entity type instnance

Identity

integer

RebateProgram.SponsorPromotionCode

RBT_PRGM.CD_SPNSR_PRM

A code used to report rebate claims and redemptions back to a sponsor so they can attribute rebate performance to their promotion initative.

 

This is NOT related to the retailers promotional initiatives.

Code

varchar(20)

RebateProgram.UPCCutOutRequiredFlag

RBT_PRGM.FL_UPC_CUTOUT_RQD

A boolean indicator that if YES means the rebate claimant must cut out the UPC from the original item package and submit it to validate that it is for the appropriate item. This is one of several validation reqluirements a rebate sponsor/processor may require before paying out a rebate.

Flag

integer

RebateSponsor.PartyRoleAssignmentID

PA_RBT_SPNSR.ID_PRTY_RO_ASGMT

Token identifier for a PartyRoleAssignmentInstance.

Identity

integer

RebateSponsor.RebateSponsorID

PA_RBT_SPNSR.ID_SPNSR_RBT

Unique ID for a rebate sponsor entity type instnance

Identity

integer

RentalModifier.ItemID

CO_RNT_MDFR.ID_ITM

A unique system assigned identifier for the retailer's SKU.

IdentityUUID

char(32)

RentalModifier.RentalChargePerRentalPeriod

CO_RNT_MDFR.MO_RNT_CHG_PR_RNT_PRD

The rental charge per rental period.

 

Example

 

$35 per day.

Money

decimal(16,5)

RentalModifier.RentalItemActionCode

CO_RNT_MDFR.CD_RNT_ITM_ACTN

A code that indicates whether this line item represents a customer pickup or a customer return of a rented item.

Code

varchar(20)

RentalModifier.RentalPeriodCount

CO_RNT_MDFR.QY_RNT_PRD_CNT

A count of the rental periods covered for this RentalModifier.

 

Example

 

3 days rental

QuantityDayCount

decimal(3,0)

RentalModifier.RentalPeriodEndDateTime

CO_RNT_MDFR.DT_RNT_PRD_END_DT_TM

The rental period start date and time for this rental line item.

Datetime

datetime

RentalModifier.RentalPeriodStartDateTime

CO_RNT_MDFR.DT_RNT_PRD_SRT_DT_TM

The rental period start date and time for this rental line item.

Datetime

datetime

RentalModifier.RentalPeriodTypeCode

CO_RNT_MDFR.CD_RNT_PRD_TYP

Designates the type of period used to meter a total rental charge. Values include:

 

MINUTES

HOURS

DAYS

WEEKS

MONTHS

 

Note that in a conventional retail business, it would be unusal to rent items for longer periods.

Code

varchar(20)

RentalModifier.RentalStandardContractID

CO_RNT_MDFR.ID_RNT_STD_CNTRT

Identifies an instance of a RentalStandardContract

Identity

integer

RentalModifier.RetailTransactionLineItemSequenceNumber

CO_RNT_MDFR.IC_LN_ITM

The sequence number of line item within the context of this RetailTransaction.

LineNumber

smallint

RentalModifier.SerializedUnitItemID

CO_RNT_MDFR.ID_ITM_SRZ

A unique system assigned identifier for the retailer's SKU.

IdentityUUID

char(32)

RentalModifier.SerialNumber

CO_RNT_MDFR.ID_NMB_SRZ

A unique code, which can be either alpha, numeric or alpha-numeric, to identify an individual ITEM.

Name

varchar(40)

RentalModifier.TransactionID

CO_RNT_MDFR.ID_TRN

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members.

IdentityUUID

char(32)

RentalServiceTerms.DepositAmount

AS_SV_RNT.MO_DS_RNT_SV

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 that it was when transferred to the renter.

Money

decimal(16,5)

RentalServiceTerms.DepositPercent

AS_SV_RNT.PE_DS_RNT_SV

The percentage of the value of the RENTAL OBJECT which is charged as a refundable deposit to the CUSTOMER.

 

Percent

decimal(7,4)

RentalServiceTerms.ItemID

AS_SV_RNT.ID_ITM

A unique system assigned identifier for the retailer's SKU.

IdentityUUID

char(32)

RentalServiceTerms.PenaltyAmount

AS_SV_RNT.MO_PNTY

The penalty amount which is imposed by the RETAILER if the CUSTOMER fails to meet the rental terms.

Money

decimal(16,5)

RentalServiceTerms.PenaltyAssessmentTypeCode

AS_SV_RNT.CD_PNTY_ASSSSMNT_TYP

Determines how a rental penalty is assessed. Valid values include:

 

FLAT_FEE_PCT

FLAT_FEE_AMT

PER_LATE_PERIOD_PCT

PER_LATE_PERIOD_AMT

Code

varchar(20)

RentalServiceTerms.PenaltyMethodCode

AS_SV_RNT.CD_MTH_PNTY

A code denoting how the penalty is calculated, using PenaltyAmount or PenaltyPercent.

Code2

char(2)

RentalServiceTerms.PenaltyPercent

AS_SV_RNT.PE_PNTY

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.

Percent

decimal(7,4)

RentalServiceTerms.PeriodCount

AS_SV_RNT.QU_PR_RNT

The number of contiguous rental periods the item may be rented by the customer; as well as the number of rental periods per penalty charge.

QuantityDayCount

decimal(3,0)

RentalServiceTerms.PeriodTypeCode

AS_SV_RNT.TY_PR_RNT

A code to denote the rental and overdue periods; Hour, Day, Week, etc...

Code2

char(2)

RentalServiceTerms.Rental_Cleanup_Prep_Fee_Amt

AS_SV_RNT.MO_RNT_CLNP_PRP_FE_AMT

A flat monetary amount charged to clean up, refuel, adjust, configure or otherwise prepare a RentalUnit for use by a rental customer. This would typically apply to cars, lawn and garden equipment, furniture (assembly) and other rental items that require prep work between renters.

Money

decimal(16,5)

RentalServiceTerms.RentalStandardContractID

AS_SV_RNT.ID_RNT_STD_CNTRT

Identifies an instance of a RentalStandardContract

Identity

integer

RentalStandardContract.RentalContractRevisionEffectiveDate

CO_RNT_STD_CNTRT.DC_RNT_CNTRT_RVSN_EF_DT

The date that this RentalStandardContract may be used as the basis for renting items to customers.

EffectiveDate

date

RentalStandardContract.RentalContractRevisionExpirationDate

CO_RNT_STD_CNTRT.DC_RNT_CNTRT_RVSN_EP_DT

The date that this RentalStandardContract may NO LONGER be used as the basis for renting items to customers.

ExpirationDate

date

RentalStandardContract.RentalContractRevisionNumber

CO_RNT_STD_CNTRT.AI_RNT_CNTRT_RVSN_NMB

The sequential revision number for a RentalStandardContract. This is important where different customer might have rental agreement revisions.

LineNumber

smallint

RentalStandardContract.RentalContractStandardURI

CO_RNT_STD_CNTRT.URI_RNT_CNTRT_STD

A URI that references the contract document in HTML or another readable format. For the purposes here, this is a pointer to a text object. Retailers may choose to extend this entity by adding more explicity rental tern and condition attributes.

DescriptionShort

varchar(255)

RentalStandardContract.RentalStandardContractID

CO_RNT_STD_CNTRT.ID_RNT_STD_CNTRT

Identifies an instance of a RentalStandardContract

Identity

integer

RentalStandardContract.RentalStandardContractStatusCode

CO_RNT_STD_CNTRT.CD_RNT_STD_CNTRT_STS

Indicates the current state of the RentalStandardContract.

 

Valid values are:

 

A - Active

I - Inactive

Code2

char(2)

RentalUnit.ActualRentalCount

ID_UN_RNT.QU_ACT_RNT_CNT

The actual lifetime count of the number of times this RentalUnit has been rented out.

 

This is important since some RentalUnits ( like VCR media, DVD's, garden equipment, tooling, etc.) may have finite usage count before they become unserviceable for rental purposes.

QuantityInteger

integer

RentalUnit.EstimatedLifetimeRentalCount

ID_UN_RNT.QU_ESTM_RNT_CNT

The estimated lifetime number of times this RentalUnit can be rented to customers before it has to be taken out of circulation due to wear, obsolescence, safety problems, etc.

QuantityInteger

integer

RentalUnit.InServiceDate

ID_UN_RNT.DC_IN_SV_DT

The date a RentalUnit is available to be rented to customers.

DateCalendar

date

RentalUnit.OutOfServiceDate

ID_UN_RNT.DC_OT_OF_SV_DT

The date a RentalUnit is taken out of service and may no longer be rented to customers

DateCalendar

date

RentalUnit.RentalStandardContractID

ID_UN_RNT.ID_RNT_STD_CNTRT

Identifies an instance of a RentalStandardContract

Identity

integer

RentalUnit.StatusCode

ID_UN_RNT.CD_STS

A code that designates the current state of a RentalUnit instance.

 

A = Available for rent

R = Rented (rented out unvail)

D = Damaged (damaged unavail)

L = Lost (stolen, damaged beyond repair, unavail)

 

There may be additional codes required for particular retail rental scenarios.

Code2Status

char(2)

RetailPriceModifier.ModifyByAmount

CO_MDFR_RTL_PRC.MO_MDFR_RT_PRC

A flat monetary value that is to be added to or subtracted from a base price. (Note typically this is a discount so subtraction is the expected action)

 

Example:

Base price $10.00

ModifyByAmountt $.50

 

Price Modification to be applied is $.50

Money

decimal(16,5)

RetailPriceModifier.ModifyByPercent

CO_MDFR_RTL_PRC.PE_MDFR_RT_PRC

The percent adjustment that was applied to the unit retail price to arrive at the modified selling price.

 

Example

 

Base price $10.00

ModifyByPercent 5% (.05)

 

Price Modification to be applied is $.50

Percent

decimal(7,4)

RetailPriceModifier.NewPriceAmount

CO_MDFR_RTL_PRC.MO_NW_PRC

The unit price that was the result of the price modification.

MoneyShortRetail

decimal(7,2)

RetailPriceModifier.PriceModificationBaseAmount

CO_MDFR_RTL_PRC.MO_PRC_MDFN_BS_AMT

The monetary value of the transaction (i.e. a sum of sale return line item extended actual retail amounts) plus or minus other PriceModificationLineItem values used as the basis for this price modifciation calculation.

 

NOTE: The ARTS model defines placeholders for transaction-level discounts. However, it is the retailer's responsibility to specify the business rules for calculating transaction-level price modificaction values and to assign an appropriate value to PriceModificationBaseAmount.

Money

decimal(16,5)

RetailPriceModifier.RewardDerivationSequenceNumber

CO_MDFR_RTL_PRC.AI_RWD_DRVN_SQN_NMB

A sequence number used to specify the order for applying derivation rules tied to a Reward.

 

RewardDerivationSequenceNumber always starts with 1 and is incremented by 1 for each appended derivation step tied to the Reward.

LineNumber

integer

RetailPriceModifier.RewardID

CO_MDFR_RTL_PRC.ID_RWD

A token identifier for a Reward instance.

Identity

integer

RetailPriceModifier.RoundingAmount

CO_MDFR_RTL_PRC.MO_RND

The monetary amount that the price modification was adjusted by (after calculation from the percentage).

MoneyShortRetail

decimal(7,2)

RetailTransactionDocument.EffectiveDate

DO_RTL_TRN_DCM.DC_EF_DT

Date when a document is active and may be issued or redeemed as part of one or more retail transactions.

EffectiveDate

date

RetailTransactionDocument.ExpirationDate

DO_RTL_TRN_DCM.DC_EP_DT

Date when a document is inactive and may NO LONGER be issued or redeemed as part of one or more retail transactions.

ExpirationDate

date

RetailTransactionDocument.IssueDate

DO_RTL_TRN_DCM.DC_ISS_DT

The date a RetailTransactionDocument is issued to a customer.

DateCalendar

date

RetailTransactionDocument.RedemptionDate

DO_RTL_TRN_DCM.DC_RDM_DT

The date a document is redeemed by a customer

DateCalendar

date

RetailTransactionDocument.RetailTransactionDocumentID

DO_RTL_TRN_DCM.ID_RTL_TRN_DCM

A token identifier for a RetailTransactionDocument instance.

Identity

integer

RetailTransactionDocument.RetailTransactionDocumentTypeCode

DO_RTL_TRN_DCM.CD_RTL_TRN__DCM_TYP

Designates a specific kind of retail transaction document that is issued or redeemed within the scope of a retail transaction.

 

Valid values include:

BOUNCEBACK_CPN

REBATE_CLAIM

REWARD_VCHR

Code

varchar(20)

RetailTransactionDocument.RewardID

DO_RTL_TRN_DCM.ID_RWD

A token identifier for a Reward instance.

Identity

integer

RetailTransactionDocument.StatusCode

DO_RTL_TRN_DCM.CD_STS

The current state of the RetailTransactionDocument instance. Valid values are:

 

ISSUED

REDEEMED

VOID

Code

varchar(20)

RetailTransactionDocumentImage.HorizontalImageAlignmentTypeCode

DO_RTL_TRN_DCM_IMG.CD_HRZ_IMG_ALGNMNT_TYP

A code that indicates how a receipt image is horizontally aligned when it is printed or displayed. Valid values are:

 

Left

Center

Right

Code

varchar(20)

RetailTransactionDocumentImage.Image

DO_RTL_TRN_DCM_IMG.BNRY_IMG

A binary representation of the receipt image for the transaction.

 

Blob

varbinary

RetailTransactionDocumentImage.ImageFileURI

DO_RTL_TRN_DCM_IMG.DE_URI

The Universal Resource Identifier (URI) for the image file (or object) that renders the receipt for the transaction.

Name

varchar(40)

RetailTransactionDocumentImage.ImageFormatTypeCode

DO_RTL_TRN_DCM_IMG.CD_IMG_FRMT_TYP

Designates the file format used to represent the image. Valid values include:

 

EPS

PDF

TIF

BMP

GIF

JPG

 

This enumeration is basedon POSLOG6 LogoFormatTypeCode

Code

varchar(20)

RetailTransactionDocumentImage.MapModeTypeCode

DO_RTL_TRN_DCM_IMG.CD_MP_MOD_TYP

A code that designates how the smalles unit of display for a raster image is represented. Valid values (based on POSLOG6 MapModeTypeCode) include:

 

DOTS

TWIPS

ENGLISH

METRIC

Code

varchar(20)

RetailTransactionDocumentImage.RetailTransactionDocumentID

DO_RTL_TRN_DCM_IMG.ID_RTL_TRN_DCM

A token identifier for a RetailTransactionDocument instance.

Identity

integer

RetailTransactionDocumentImage.VerticalImageAlignmentCode

DO_RTL_TRN_DCM_IMG.CD_VRTL_IMG_ALGNMNT_TYP

A code that indicates how a receipt image is vertically aligned when it is printed or displayed. Valid values are:

 

Top

Center

Bottom

Code

varchar(20)

RetailTransactionDocumentLineitem.RetailTransactionDocumentActionCode

DO_RTL_TRN _DCM_LN_ITM.CD_RTL_TRN_DCM_ACTN

A code that designates the type of document action being taken by a RetailTransactionLineItem. Valid values are:

 

ISSUE

REDEEM

VOID

 

Retailers may add other actions that are relevant to their business.

Code

varchar(20)

RetailTransactionDocumentLineitem.RetailTransactionDocumentID

DO_RTL_TRN _DCM_LN_ITM.ID_RTL_TRN_DCM

A token identifier for a RetailTransactionDocument instance.

Identity

integer

RetailTransactionDocumentLineitem.RetailTransactionLineItemSequenceNumber

DO_RTL_TRN _DCM_LN_ITM.IC_LN_ITM

The sequence number of line item within the context of this RetailTransaction.

LineNumber

smallint

RetailTransactionDocumentLineitem.TransactionID

DO_RTL_TRN _DCM_LN_ITM.ID_TRN

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members.

IdentityUUID

char(32)

RetailTransactionLineItemAssociation.DocumentIssuance

ST_ASCTN_LTM_RTL.ID_RTL_TRN_DCM

A token identifier for a RetailTransactionDocument instance.

Identity

integer

RetailTransactionLineItemAssociation.DocumentRedemption

ST_ASCTN_LTM_RTL.ID_RTL_TRN_DCM

A token identifier for a RetailTransactionDocument instance.

Identity

integer

RetailTransactionLineItemAssociation.LineItemXrefConversionDescription

ST_ASCTN_LTM_RTL.DE_LN_ITM_CVN

Short narrative specification of the procedure used to translate from line item units into to line item units. This is used to describe how sale/return retail selling unit counts or monetary values are translated into deferred reward currencies like points, miles, etc.

 

May also be used to define how other kinds of fees, penalties and other association types are calaculated.

DescriptionShort

varchar(255)

RetailTransactionLineItemGroupTotal.SubtotalAmount

TR_TOT_RTL_LTMGP.MO_TOT

The monetary value of the transaction line item subtotal group.

Money

decimal(16,5)

RetailTransactionReceiptImage.HorizontalImageAlignmentTypeCode

TR_RTL_TRN_RCT_IMG.CD_HRZ_IMG_ALGNMNT_TYP

A code that indicates how a receipt image is horizontally aligned when it is printed or displayed. Valid values are:

 

Left

Center

Right

Code

varchar(20)

RetailTransactionReceiptImage.Image

TR_RTL_TRN_RCT_IMG.BNRY_IMG

A binary representation of the receipt image for the transaction.

 

Blob

varbinary

RetailTransactionReceiptImage.ImageFileURI

TR_RTL_TRN_RCT_IMG.DE_URI

The Universal Resource Identifier (URI) for the image file (or object) that renders the receipt for the transaction.

Name

varchar(40)

RetailTransactionReceiptImage.ImageFormatTypeCode

TR_RTL_TRN_RCT_IMG.CD_IMG_FRMT_TYP

Designates the file format used to represent the image. Valid values include:

 

EPS

PDF

TIF

BMP

GIF

JPG

 

This enumeration is basedon POSLOG6 LogoFormatTypeCode

Code

varchar(20)

RetailTransactionReceiptImage.MapModeTypeCode

TR_RTL_TRN_RCT_IMG.CD_MP_MOD_TYP

A code that designates how the smalles unit of display for a raster image is represented. Valid values (based on POSLOG6 MapModeTypeCode) include:

 

DOTS

TWIPS

ENGLISH

METRIC

Code

varchar(20)

RetailTransactionReceiptImage.TransactionID

TR_RTL_TRN_RCT_IMG.ID_TRN

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members.

IdentityUUID

char(32)

RetailTransactionReceiptImage.VerticalImageAlignmentCode

TR_RTL_TRN_RCT_IMG.CD_VRTL_IMG_ALGNMNT_TYP

A code that indicates how a receipt image is vertically aligned when it is printed or displayed. Valid values are:

 

Top

Center

Bottom

Code

varchar(20)

RetailTransactionRentalModifier.CustomerAccountID

CO_RTL_TRN _RNT_MDFR.ID_CTAC

A unique identifier for a customer account.

Identity

integer

RetailTransactionRentalModifier.ItemID

CO_RTL_TRN _RNT_MDFR.ID_ITM

A unique system assigned identifier for the retailer's SKU.

IdentityUUID

char(32)

RetailTransactionRentalModifier.RentalStandardContractID

CO_RTL_TRN _RNT_MDFR.ID_RNT_STD_CNTRT

Identifies an instance of a RentalStandardContract

Identity

integer

RetailTransactionRentalModifier.TransactionID

CO_RTL_TRN _RNT_MDFR.ID_TRN

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members.

IdentityUUID

char(32)

RetailTransactionSalesReceiptImage.CreateDateTime

DO_RTL_TRN_SLS_RCT_IMG.DT_CRT_DT_TM

The time-date this RetailTransactionSalesReceipImage instance was created.

 

Note that sales receipts MAY NOT be altered after a transaction is posted. If necessary the transaction may be VOIDED and recreated.

Datetime

datetime

RetailTransactionSalesReceiptImage.SalesReceiptImageBlob

DO_RTL_TRN_SLS_RCT_IMG.BM_SLS_RCT_IMG

A binary large object used to store a sales receipt image within the database. This is provided as an option for really small receipts or retailers with low sales receipt volume. As a rule, retailers will use the URI attribute to reference the digital image file which resides outside the relational database.

Blob

varbinary

RetailTransactionSalesReceiptImage.SalesReciptImageFileURI

DO_RTL_TRN_SLS_RCT_IMG.URI_SLS_RCT_IMG_FLE

Universal Resource Identifier that points to the source where the retail sales receipt is stored.

DescriptionShort

varchar(255)

RetailTransactionSalesReceiptImage.TransactionID

DO_RTL_TRN_SLS_RCT_IMG.ID_TRN

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members.

IdentityUUID

char(32)

Reward.BuyOneGetOneTriggerFlag

TR_RWD.FL_BOGO_TRGR

Boolean indicator that if TRUE means the reward applies if the total amount of trigger items in the subtotal (line item group or transaction total level) exceed the N value in a buy N get M reward.

 

Enables a BOGO reward pattern at the transaction or line item group level.

Flag

integer

Reward.EffectiveDateTime

TR_RWD.DT_EF_DT_TM

The date and time a Reward is active and may be earned and redeemed by customers.

EffectiveDateTime

datetime

Reward.ExcludeDiscountItemsFlag

TR_RWD.FL_EXCLD_DSC_ITM

A boolean indicator that if set to TRUE means that this reward will exclude items that are already discounted.

 

Prevents taking discounts on discounts in a reward.

Flag

integer

Reward.ExcludePriceOverrideItemFlag

TR_RWD.FL_EXCLD_PRC_OVRRD_ITM

Boolean indicator that when TRUE means this reward will exclude any item with a PRICE OVERRIDE.

Flag

integer

Reward.ExpirationDateTime

TR_RWD.DT_EP_DT_TM

The date and time a Reward is no longer active and may NOT be earned and redeemed by customers.

ExpirationDateTime

datetime

Reward.PromotionalInitiativeID

TR_RWD.ID_PRML_INITV

A token ID for a retailer's PromotionInitiative instance.

Identity

integer

Reward.PromotionalOfferID

TR_RWD.ID_PRM_OFR

The unique identifier for a promotion.

Identity

integer

Reward.RewardAttributionLevelCode

TR_RWD.CD_RWD_ATTRBTN_LV

A code that assigns this reward's earning and/or redemption VALUE to:

LINE_ITEM - The reward value is applied to a single line item or line items that satisfy eligibility requirements and derivation rule thresholds and limits.

TRANSACTION - The reward value is applied to a whole transaction, usually the net sale subtotal (which will include previously applied LINE_ITEM price reductions.

ACCOUNT - The reward value is applied to an account (applies to deferrable rewards only).

 

This level code attribute is different from the RewardDerivation.RewardDerivationLevelCode The Reward.RewardAttributionLevelCode specifies the OUTPUT level that a reward value will be posted to. The RewardDerivationLevelCode specifies the level whose attributes are used as INPUT into calculating a reward value.

Code

varchar(20)

Reward.RewardDescription

TR_RWD.DE_RWD_DSCR

Short description of the reward description.

DescriptionShort

varchar(255)

Reward.RewardDispositionCode

TR_RWD.CD_RWD_DPSN

A code that determines when a reward is to be redeemed. There are two permitted values:

 

INSTANT - reward is redeemed within the scope of the transaction it is earned in

 

DEFERRED_ACCRUED - reward is redeemed at a later time in a subsequent transaction.

 

ACCRUED_TO_INSTANT - accrued rewards are converted from reward currency to money and linked to a RetailPriceModifier and/or PriceModificationLineItem which reflect consuming the reward.

 

Instant rewards apply to coupons, POS markdowns,etc. that create RetailPriceModifiers (line item discounts) and/or PriceModificationLineItem (transaction level discounts).

Code

varchar(20)

Reward.RewardGroupID

TR_RWD.ID_RWD_GP

Reward group token ID

Identity

integer

Reward.RewardID

TR_RWD.ID_RWD

A token identifier for a Reward instance.

Identity

integer

Reward.RewardIntraTransactionAppliedLimitCount

TR_RWD.QY_RWD_INTRA_TRN_APPLD_LM

A limit on the number of times a reward may be used within the scope of a transaction. Like RewardLimitAmount, this is a stop-loss rule.

 

For example:

 

Buy 2 SKU 2323 get a third for free - limit 2 REWARDS per transaction.

 

Limits the reward to a total of 6 units of SKU 2323 at 33% discount. Buying a 7th unit or more reverts back to the regular per unit retail price.

QuantityInteger

integer

Reward.RewardLimitAmount

TR_RWD.MO_RWD_LM_AMT

The maximum monetary value that is allowed for the Reward

 

This serves as a stop-loss point for retailer discounts tied to a reward in a transaction. Complex reward eligibility rules and derivation rules may result in excessive discounts and this value sets a not to exceed ceiling on the discount amount.

Money

decimal(16,5)

Reward.RewardPriorityTieBreaker

TR_RWD.AI_RWD_TI_BRKR

Value used to break a tie between two equally applicable rewards. The higher value in this attribute for two competing rewards marks reward that will be given.

LineNumber

smallint

Reward.RewardShortName

TR_RWD.NM_RWD_SHRT

A short business name used in reporting to identify this Reward.

Name

varchar(40)

Reward.RewardTaxTreatmentCode

TR_RWD.CD_RWD_TX_TRTMNT

Indicates whether the Reward is taken PRE_TAX or POST_TAX.

 

Pretax means the reward is subtracted from the tax basis of the purchase before calculating tax.

 

Post tax means the reward is calculated after tax is calculated. That means the tax basis is the pre-reward value of the reward items.

Code

varchar(20)

Reward.RewardTransactionLevelActionCode

TR_RWD.CD_RWD_TRN_LV_ACTN

Determines how a Reward is applied to a transaction, a transaction line item or a customer account. This code is related to the RewardDispositionCode.

 

VALID VALUES:

NEW_PRICE - base retail price is replaced by the RewardAmount value

PCT_OFF - base retail price is reduced by the RewardAmount value which is a PERCENT

AMT_OFF - base retail price is reduced by the RewardAmount which is a flat monetary value.

EARN_REWARD_CURRENCY - Points, miles,or another retailer designated reward currency units are added to a customer account (note only applies if the customer has an account).

REDEEM_REWARD_CURRENCY - Transforms the earned reward currency for the current transaction and, at the customers option, previously accrued reward currency balance into a discount that can be taken at a transaction or line item level

Code

varchar(20)

Reward.SubtotalMaximumAmount

TR_RWD.MO_SUBTOT_MXM_AMT

The maximum subtotal value (for line item groups or transaction totals) that once exceeded ends the reward application.

 

Example

 

Buy $100 to $500 merchandise and receive a 5% discount. The maximum value on which a discount may be given is $500. If a customer purchses $525 worth of merchandise, the discount is capped at $25 (5% of $500). The discount does NOT apply to any amount over the $500.

Money

decimal(16,5)

Reward.SubtotalMinimumAmount

TR_RWD.MO_SUBTOT_MNM_AMT

The minimum value a transaction subtotal (i.e. a line item group or transaction-level total of line items) must have in order to have a reward applied.

 

Example:

 

Buy $150 or more worth of merchandise in a transaction get a 10% discount. The $150 is the SubtotalMininumAmount. If the customer buys $149.99 worth of merchandise NO DISCOUNT reward is earned.

Money

decimal(16,5)

Reward.TimeGroupID

TR_RWD.ID_GP_TM

A unique identifier for a set of consecutive hours on a set of days of the week.

 

e.g. 10am - 2pm Mon, Wed and Fri.

Identity

integer

Reward.TransactionExclusivityFlag

TR_RWD.FL_TRN_EXCLSVTY

A boolean indicator that if set to TRUE means that this transaction-level reward may be applied one time only item within the scope of a retail transaction.

 

A transaction-level reward is indicated by assigning a value of 'TRANSACTION' to the RewardAttributionLevel attribute.

Example:

 

Buy $500 or more in a transaction and earn a bonus of 100 CUSTOMER MEMBER POINTS to your reward balance. Limit 1.

Flag

integer

Reward.TransactionLevelRewardAmount

TR_RWD.MO_TRN_LV_RWD_AMT

The monetary value or percent used in combination with the action taken on a transaction-level subtotal.

 

Money

decimal(16,5)

RewardCurrencyType.MonetaryValueAmount

CO_LYLT_CNY_TYP.MO_LYLT_CNY_VL

Monetary value for one loyalty currency type unit.

 

If points are not redeemable enter 0

MoneyShortCost

decimal(16,5)

RewardCurrencyType.QualifyingCurrencyFlag

CO_LYLT_CNY_TYP.FL_CNY_QFLYNG

THis currency is accumulated for qualifying customers to be assigned to tiers.

Flag

integer

RewardCurrencyType.RedeemableFlag

CO_LYLT_CNY_TYP.FL_RDMBL

Currency is redeemable (i.e. it has some monetary or trade value).

Flag

integer

RewardCurrencyType.RewardCurrencyDescription

CO_LYLT_CNY_TYP.DE_LYLT_CNY

Short description of a loyalty currency type

DescriptionShort

varchar(255)

RewardCurrencyType.RewardCurrencyTypeCode

CO_LYLT_CNY_TYP.CD_LYLT_CNY_TYP

Short code used to designate a currency reward type. Valid values include:

 

MONEY

MILES

POINTS

TRANSACTIONS

 

Retailers may define their own codes as long as they maintain a basis for translating them into a monetary value.

Code

varchar(20)

RewardDerivationRule.CustomerAccountValuationUnitTypeCode

RU_RWD_DRVN_RU.CD_CT_ACNT_VLN_UN_TYP

A code that identifies a kind of valuation unit.

 

Examples include:

MONEY

POINTS

MILES

GALLONS

VISITS

others that are relevant to a retailer

Code

varchar(20)

RewardDerivationRule.ItemLevelExclusivityFlag

RU_RWD_DRVN_RU.FL_ITM_LV_EXCLSVTY

When this flag is TRUE, a deal has item matching rules which once applied (i.e. matched to a sale return item) cannot be used on any subsequent sale return line item in the transaction. It is a "use it once" rule.

Example:

We have two RewardDerivation rules (with attendant eligibility rules). They each have their ItemLevelExclusivityFlag values set to TRUE. Only one of the two rules may be used in a transaction

Buy SKU 3879 and get a SKU 3879A attachment for free (limit 1 per customer)

Buy SKU 3879 or SKU 4736 and take 50% off anything in Dept 232.

In this example the firing of the first rule for SKU 3879 is exclusive and prevents the firing of the second rule.

 

 

Flag

integer

RewardDerivationRule.MaximumQuantity

RU_RWD_DRVN_RU.QU_MXM_QTY

The maximum quantity of a reward item that will result in the application of this RewardDerivationRule. A quantity higher than this value will not apply the rule.

 

Example Buy 1 to 5 SKU 2312 and get a 5% discount. If the customer purchases a 6th SKU 2312 they will pay the full retail price since it exceeds the MaximumQuantity.

Quantity

DECIMAL(9,3)

RewardDerivationRule.MinimumItemTotalAmount

RU_RWD_DRVN_RU.MO_MNM_ITM_TOT_AMT

The minimum subtotal monetary value of sale return items matching this rule to trigger the reward derivation rule.

 

Example:

 

Buy $100 or more from DEPT 242 and get a 20% discount on those items. The $100 is the MininumItemTotalAmount which is required to trigger the 20% instant reward.

Money

money

RewardDerivationRule.MinimumQuantity

RU_RWD_DRVN_RU.QU_MNM_QTY

The minimum quantity of a reward item required to trigger this RewardDerivationRule. A value of 0 puts no lower bound on the minimum value. The default value for this attribute is 1.

 

Buy 5 or more SKU 32343's and get a 6th for free. 5 is the minimum quantity of SKU 32343 units that must be purchased to trigger a 6th free item (17% discount). This only applies to INSTANT rewards not DEFERRABLE rewards.

Quantity

DECIMAL(9,3)

RewardDerivationRule.MinMaxUnitTypeCode

RU_RWD_DRVN_RU.CD_MNM_MXM_TYP

A code that determines what kind of value the MinValue and MaxValue is quantifying. Valid values are:

 

RTL_SL_UNIT - min or max retail selling units

MONETARY - min or max monetary amount

RWD_CURRENCY - min or max value refers to points, miles, meals or some other reward currency that is different from retail selling units and monetary value.

Code

varchar(20)

RewardDerivationRule.RewardArgumentQuantity

RU_RWD_DRVN_RU.QU_RWD_ARGMNT_QTY

Specifies the total number of items that a RewardActionCode applies to. This number is part of the condition required to fire a given rule.

 

Example

 

If item A can be purchased 3 units for $10, the RewardActuionArgumentValue will be $10 and the RewardArgumentQuantity is 3. In this scenario the actual retail price is 3.34 for the first item, 3.33 for the second and third item A's

 

In a scenario where Item A can be purchased as 3 units for $10 each, the RewardArgumentQuantity is 1. The total prices for three Item A's is $30.

Quantity

DECIMAL(9,3)

RewardDerivationRule.RewardDerivationActionCode

RU_RWD_DRVN_RU.CD_RWD_ACTN

RewardTransactionLevelActionCode

Determines how a Reward is applied to a transaction, a transaction line item or a customer account. This code is related to the RewardDispositionCode.

 

Within the scope of a Reward, the action code applies to the entire RetailTransaction.

 

Within the scope of a RewardDerivationRule, the action code applies to one or a designated group of RetailTransactionLineItem instances within a RetailTransaction – but not the transaction as a whole.

 

VALID VALUES:

NEW_PRICE - base retail price is replaced by the RewardAmount value

PCT_OFF - base retail price is reduced by the RewardAmount value which is a PERCENT

AMT_OFF - base retail price is reduced by the RewardAmount which is a flat monetary value.

EARN_REWARD_CURRENCY - Points, miles,or another retailer designated reward currency units are added to a customer account (note only applies if the customer has an account).

REDEEM_REWARD_CURRENCY - Transforms the earned reward currency for the current transaction and, at the customers option, previously accrued reward currency balance into a discount that can be taken at a transaction or line item level

Code

varchar(20)

RewardDerivationRule.RewardDerivationArgumentValue

RU_RWD_DRVN_RU.MO_RWD_ACTN_ARGMNT_VL

The reward value (a monetary amount or percent) applied to a base retail to arrive at the value of the reward.

Money

money

RewardDerivationRule.RewardDerivationLevelCode

RU_RWD_DRVN_RU.CD_RWD_DRVN_LV_CD

A code that determines the scope of coverage for a given reward derivation where scope designates one of three levels: LINE_ITEM, TRANSACTION or ACCOUNT. This is different from the Reward.RewardAttributionLevelCode which determines the final reward output level where it is used and consumed. The RewardDerivationLevelCode identifies the level of information used as input to the calculation of a reward value.

It is common to have different Reward.RewardAttributionLevelCode values and RewardDerivationLevelCode values. For example, a specific item SKU value may specifiy a 50 point bouns (a LINE_ITEM RewardDerivationCode) that will end up being added to a customer account balance (an ACCOUNT Reward.RewardAttributionLevelCode). Retailers routinely define derivation and eligibility rules at different levels from the reward attribution level. This is why ARTS carries two different kinds of reward level codes - one for derivation of the reward value and a separate one that tells what level that value applies to.

The enumerated values that level code attributes may assume are the same set: LINE_ITEM, TRANSACTION and ACCOUNT.

Valid values (from narrowest to widest scope):

LINE_ITEM - reward derivation value is calculated based on the properties of a single SaleReturnLineItem. This includes item ID, item merchandise hierarchy (classification), item pre-reward retail value, item pre-reward cost value, brand and other attributes of a specific RetailTransactionLineItem.

TRANSACTION - reward derivation value is calculated based on a property of the RetailTransaction. This may apply to channel (where an item is purchased), transaction subtotal (usually the total retail value of a retail transaction minus previously applied line item discounts), time of day,

ACCOUNT - reward, when calculated is added to or subtracted from a customer account depending on the RewardDispositionCode. A RewardDispositionCode of 'INSTANT' means a reward is to be earned and redeemed in the current transaction and becomes a discount. A RewardDispositionCode of 'DEFERRABLE' means the reward may be added to a customer account balance for future redemption - and that makes it a CUSTOMER_ACCOUNT reward derivation level.

Code

varchar(20)

RewardDerivationRule.RewardDerivationRuleEligibilityID

RU_RWD_DRVN_RU.ID_EL_PRDV

A unique identifier for a Reward Derivation Rule Eligibility.

Identity

integer

RewardDerivationRule.RewardDerivationSequenceNumber

RU_RWD_DRVN_RU.AI_RWD_DRVN_SQN_NMB

A sequence number used to specify the order for applying derivation rules tied to a Reward.

 

RewardDerivationSequenceNumber always starts with 1 and is incremented by 1 for each appended derivation step tied to the Reward.

LineNumber

integer

RewardDerivationRule.RewardID

RU_RWD_DRVN_RU.ID_RWD

A token identifier for a Reward instance.

Identity

integer

RewardDerivationRuleEligibilityAssociation.CombinationCode

ST_ASCTN_EL_PRDV.CD_CMBN

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

Code2

char(2)

RewardDerivationRuleEligibilityAssociation.CombinationEligibilityID

ST_ASCTN_EL_PRDV.ID_EL_CMBN

A unique identifier for the Combination Price Derivation Rule Eligibility.

Identity

integer

RewardDerivationRuleEligibilityAssociation.GroupingID

ST_ASCTN_EL_PRDV.ID_GRP

Identifies a group of conditions to be evaluated to yield a single boolean value (like using parantheses in a select statement). This allows the eligibility rules to incorporate sub-rules and handle more complex compound conditions.

 

Example

Eligibility Rule

1 - Customer is registered in Loyalty Program

2 - Customer buys Brand X

3 - Item is in cateogry A

4 - Item is in category B

5 - Combined Eligibility

1 and 2 and (3 OR 4)

The "(3 or 4)" is a group and is used to allows groups of rules to be evaluated and combined as a single boolean value with the other items in the combined rule set. This is a mechanism to handle complex, combined conditions.

LineNumber

smallint

RewardDerivationRuleEligibilityAssociation.LeftRewardEligibilityRuleID

ST_ASCTN_EL_PRDV.ID_LFT_RWD_DRVN_RU

A unique identifier for a Price Derivation Rule Eligibility that is a member of the combination.

Identity

integer

RewardDerivationRuleEligibilityAssociation.PrecedenceSequenceNumber

ST_ASCTN_EL_PRDV.AI_PRCDN_SQN_NMB

The relative order for evaluating combined eligibility rules. For example in a scenario where you have three rules:

 

1 - Customer is member of ABC Club AND

2 - Item is XYZ Brand AND

3 - Quantity Brand XYZ items > =5

 

The numbers, 1, 2 and 3 are precedence numbers and dictate the sequcen in which the orders are fired. In this instance the first test is determining of the customer is a member of ABC Club. If not the combination rule does not apply (since the rules are tied together with an AND conjunction they must all be true for the combination rule to fire).

 

LineNumber

smallint

RewardDerivationRuleEligibilityAssociation.RightRewardEligibilityRuleID

ST_ASCTN_EL_PRDV.ID_RT_RWD_DRVN_RU

A unique identifier for a Reward Derivation Rule Eligibility.

Identity

integer

RewardDerivationRuleEligibilityMaintenance.EventID

MA_RU_PRDV_EL.ID_EV

A unique, automatically assigned identifier for the Event

Identity

integer

RewardDerivationRuleEligibilityMaintenance.MaintenanceFunctionCode

MA_RU_PRDV_EL.LU_RU_PRDV_MNT

Defines the maintenance function to be performed. Valid values include creation, update or deletion of a price derivation rule eligibility

Code4

char(4)

RewardDerivationRuleEligibilityMaintenance.RewardDerivationRuleEligibilityID

MA_RU_PRDV_EL.ID_EL_PRDV

A unique identifier for a Price Derivation Rule Eligibility.

Identity

integer

RewardEligibilityPropertyType.Description

CO_RWD_EL_PRY_TYP.DE_RWD_EL_PRY_TY

Short description of a reward eligibility property type. Used for reporting and screens to provide meaningful display of a property type.

DescriptionShort

varchar(255)

RewardEligibilityPropertyType.RewardEligibilityPropertyTypeCode

CO_RWD_EL_PRY_TYP.CD_RWD_EL_PRY_TY

A short code used to identify a valid RewardEligibilityPropertyType. Valid values are:

BRAND_NAME Brand ARTS ODM V7.2

CALENDAR_ID Calendar Period part 1 ARTS ODM V7.2

CALENDAR_LEVEL_ID Calendar Period part 2 ARTS ODM V7.2

CALENDAR_PERIOD_ID Calendar Period part 3 ARTS ODM V7.2

CHANNEL_ID Channel ARTS ODM V7.2

CUSTOMER_ACCOUNT_ID Customer Account ARTS ODM V7.2

CUSTOMER_MEMBER_PROGRAM_ACCOUNT_ID Customer Membershipp Prog Acct ARTS ODM V7.2

EMPLOYEE_DISCOUNT_GROUP_ID Employee Discount Group ARTS ODM V7.2

ITEM_ID Single Item ID (SKU) ARTS ODM V7.2

MANUFACTURER_ID Manufacturer ARTS ODM V7.2

MARKET_BASKET_TRIGGER_ID (follow up on this one) ARTS ODM V7.2

MERCHANDISE_HIERARCHY_GROUP Merch Hier. Group (we're simplifying this will require tree view to create UI) ARTS ODM V7.2

PRICE_LINE_ID Price Line ARTS ODM V7.2

PRICE_OVERRIDE Flagged overriden price - no ARTS equivalent

SALE_RTN_CLASS This should be handled in MERCHANDISE HIERARCHY GROUP

SALE_RTN_DEPARTMENT This should be handled in MERCHANDISE HIERARCHY GROUP

SALE_RTN_ITEM_CLEARANCE no ARTS equivalent

SALE_RTN_ITEM_DISCOUNTED Sale Return item is already discounted

SALE_RTN_ITEM_STOCK_STATUS no ARTS equivalent

SALE_RTN_ITEM_VENDOR This should be handled by mfg / brand

SALE_RTN_QUANTITY Eligibilty trigger qty

SALE_RTN_SKU Handled by ITEM_ID

SALE_RTN_STYLE This should be handled in MERCHANDISE HIERARCHY GROUP

SALE_RTN_SUBCLASS This should be handled in MERCHANDISE HIERARCHY GROUP

SALE_RTN_SUBDEPARTMENT This should be handled in MERCHANDISE HIERARCHY GROUP

SALE_RTN_UNIT_PRICE Eligibilty trigger retail price

SEASON see Calendar

SEQ_NUMBER Comparison is between the line item number from sale return row and the value in VALUE1

TENDER_MEDIA_BRAND_ID Branded Tender Type part 2 ARTS ODM V7.2

TENDER_TYPE_CODE Branded Tender Type part 1 ARTS ODM V7.2

 

 

Code

varchar(20)

RewardEligibilityRule.CompareCode

CO_EL_PRDV.CD_CMPR

A code that indicates the kind of comparison excuted to determine if an eligibility condition applies to a specific retail transaction and/or a sale return line item's property type.

 

Valid values are:

 

EQ equals

NE not equal

GT greater than

GE greater than or equal to

LT less than

LE less than or equal to

IN value is GE and LE value1 and value 2

Code2

char(2)

RewardEligibilityRule.EligibilityPropertyValueDataTypeCode

CO_EL_PRDV.CD_EL_PRY_VL_DAT_TYP

Indicates whether the value is a string, a date, a monetary value, or a quantity.

 

Code

varchar(20)

RewardEligibilityRule.EligibilityVerbTypeCode

CO_EL_PRDV.CD_EL_VRB_TYP

A controlled vocabulary attribute used to standardize the representation of customer actions that must be taken to trigger a RewardDerivationRule.

 

Valid Values:

BUY

RENT

TRADEIN

IS_A (customer is a GOLD)

RETURN

 

Others may be added by the retailer.

Code

varchar(20)

RewardEligibilityRule.RewardDerivationRuleEligibilityID

CO_EL_PRDV.ID_EL_PRDV

A unique identifier for a Reward Derivation Rule Eligibility.

Identity

integer

RewardEligibilityRule.RewardEligibilityPropertyTypeCode

CO_EL_PRDV.CD_RWD_EL_PRY_TYP_CD

A short code used to identify a valid RewardEligibilityPropertyType. Valid values are:

BRAND_NAME Brand ARTS ODM V7.2

CALENDAR_ID Calendar Period part 1 ARTS ODM V7.2

CALENDAR_LEVEL_ID Calendar Period part 2 ARTS ODM V7.2

CALENDAR_PERIOD_ID Calendar Period part 3 ARTS ODM V7.2

CHANNEL_ID Channel ARTS ODM V7.2

CUSTOMER_ACCOUNT_ID Customer Account ARTS ODM V7.2

CUSTOMER_MEMBER_PROGRAM_ACCOUNT_ID Customer Membershipp Prog Acct ARTS ODM V7.2

EMPLOYEE_DISCOUNT_GROUP_ID Employee Discount Group ARTS ODM V7.2

ITEM_ID Single Item ID (SKU) ARTS ODM V7.2

MANUFACTURER_ID Manufacturer ARTS ODM V7.2

MARKET_BASKET_TRIGGER_ID (follow up on this one) ARTS ODM V7.2

MERCHANDISE_HIERARCHY_GROUP Merch Hier. Group (we're simplifying this will require tree view to create UI) ARTS ODM V7.2

PRICE_LINE_ID Price Line ARTS ODM V7.2

PRICE_OVERRIDE Flagged overriden price - no ARTS equivalent

SALE_RTN_CLASS This should be handled in MERCHANDISE HIERARCHY GROUP

SALE_RTN_DEPARTMENT This should be handled in MERCHANDISE HIERARCHY GROUP

SALE_RTN_ITEM_CLEARANCE no ARTS equivalent

SALE_RTN_ITEM_DISCOUNTED Sale Return item is already discounted

SALE_RTN_ITEM_STOCK_STATUS no ARTS equivalent

SALE_RTN_ITEM_VENDOR This should be handled by mfg / brand

SALE_RTN_QUANTITY Eligibilty trigger qty

SALE_RTN_SKU Handled by ITEM_ID

SALE_RTN_STYLE This should be handled in MERCHANDISE HIERARCHY GROUP

SALE_RTN_SUBCLASS This should be handled in MERCHANDISE HIERARCHY GROUP

SALE_RTN_SUBDEPARTMENT This should be handled in MERCHANDISE HIERARCHY GROUP

SALE_RTN_UNIT_PRICE Eligibilty trigger retail price

SEASON see Calendar

SEQ_NUMBER Comparison is between the line item number from sale return row and the value in VALUE1

TENDER_MEDIA_BRAND_ID Branded Tender Type part 2 ARTS ODM V7.2

TENDER_TYPE_CODE Branded Tender Type part 1 ARTS ODM V7.2

 

 

Code

varchar(20)

RewardEligibilityRule.RewardEligibilitySequenceNumber

CO_EL_PRDV.AI_RWD_EL_SQN_NMB

Specifies the relative execution order for the eligibility rule tied to a Reward.

LineNumber

smallint

RewardEligibilityRule.RewardID

CO_EL_PRDV.ID_RWD

A token identifier for a Reward instance.

Identity

integer

RewardGroup.RewardGroupDescription

CO_RWD_GP.DE_RWD_GP

Short description of the RewardGroup instance.

DescriptionShort

varchar(255)

RewardGroup.RewardGroupID

CO_RWD_GP.ID_RWD_GP

Reward group token ID

Identity

integer

RewardVoucherDocument.RetailTransactionDocumentID

DO_RWD_VCHR_DCM.ID_RTL_TRN_DCM

A token identifier for a RetailTransactionDocument instance.

Identity

integer

SaleReturnLineItem.SaleReturnItemType

TR_LTM_SLS_RTN.TY_ITM

Meta-Data denoting the kind of item being sold (or returned) in the line item

 

STOCK_ITEM

SERVICE_ITEM

RENTAL_ITEM

LINKED_ITEM

MISC_FEE

 

Stock item refers to a tangible merchandise item.

Service item refers to the execution of some process or completion of a task involving the expenditure of time for a customer

Rental Item is the temporarly loan of a tangbile item for use by a customer with the expectation that it will be returned at the end of a rental period

Linked item is a second item that is always sold along with a merchandise item. For example a car battery typically comes with a core charge item which is a fee for recycling used batteries. Bottle deposits are a similar scenario involving linked items.

 

Misc. fee is an amount charged for an activity or service that does not have a corresponding Item entity type instance. Retailers use misc. fees to capture monies charged for things they typically are not interested in tracking for analytic purposes. It is up to retailers to choose how to use Misc. Fee types versus Service Item types. ARTS provides both.

Code4

char(4)

ShipmentContainer.ContainerTypeCode

AS_CNR_SHP.CD_CNR_TYP

A category of container that defines what it is made of, its type (primarily its material handling category - e.g. 55 gallon drums, pallets, cases, etc.) and its shape.

Code

varchar(20)

ShipMethod.CarrierID

CO_SHP_MTH.ID_CRR

A unique system assigned identifier for the Carrier.

Identity

integer

ShipMethod.Description

CO_SHP_MTH.DE_SHP_MTH

Short description of a ShipMethod instance.

DescriptionShort

varchar(255)

ShipMethod.ShipMethodCode

CO_SHP_MTH.CD_SHP_MTH

A list of codes used to categorize different arrangements for the transportation of merchandise between a retailer and customer.

Code

varchar(20)

ShipMethod.ShipMethodID

CO_SHP_MTH.ID_SHP_MTH

Token identifier for a ShipMethodInstance

Identity

integer

SpendingLimit.MaximumAmountPerRollingTimePeriod

CO_SPND_LM.MO_MXM_AMT_PR_RLLNG_TM_PRD

The upper limit on the amount of money that may be spent during a rolling time period.

For example a limit of $1,000 may be impose per rolling two hour period.

Money

decimal(16,5)

SpendingLimit.RollingPeriodTimeQuantity

CO_SPND_LM.QU_RLLNG_TM_PRD

Number of RollingTimePeriodTypes for a spending limit

QuantityDayCount

decimal(3,0)

SpendingLimit.RollingTimePeriodTypeCode

CO_SPND_LM.CD_RLLNG_TM_PRD_TYP

Designates the time period used to specify a rolling time period that applies to a SVI spending limit.

Code

varchar(20)

SpendingLimit.StoredValueInstrumentTypeCode

CO_SPND_LM.CD_STRD_VL_INSTRMNT_TYP

An ARTS standard code to designate the category of a StoredValueInstrument. POSLOG6 values are:

 

GiftCard

GiftCertificate

PhoneCard

SmartCard

OnlineVoucher

CarwashVoucher

Code

varchar(20)

SpendingLimit.TransactionLimitAmount

CO_SPND_LM.MO_TRN_LM_AMT

The maximum Stored Value Amount that may be spent within a single transaction. Only applies for larger value SVI's like those used for college students and military personnel.

Money

decimal(16,5)

SpendingLimit.TransactionLimitQuantityPerPeriod

CO_SPND_LM.QU_TRN_LM_QTY_PR_PRD

The maximum allowed number of transactions allowed within a defined time period (usually a 24 hour period).

QuantityShortCount

decimal(3,0)

SpendingLimit.TransactionLimitTimePeriodQuantity

CO_SPND_LM.QU_TRN_LM_TM_PRD

The number of TransactionLimitTimePeriods that apply to a TransactionLimitQuantityPerPeriod.

Quantity

DECIMAL(9,3)

SpendingLimit.TransactionLimitTimePeriodTypeCode

CO_SPND_LM.CD_TRN_LM_TM_PRD_TYP

Designated time period type.

 

Valid values include

HOUR

DAY

WEEK

MONTH

Code

varchar(20)

StoredValueCardSupplement.CardExpirationDate

CO_STRD_VL_CRD_SPPLMNT.DC_EP_CRD

The expiration date of the Credit or Debit card, as taken from the card in MMYY format.

Code4

char(4)

StoredValueCardSupplement.CardHolderName

CO_STRD_VL_CRD_SPPLMNT.NM_CRD_HLD

The name of the cardholder, as taken from the card.

Name

varchar(40)

StoredValueCardSupplement.CardIssuerSequenceNumber

CO_STRD_VL_CRD_SPPLMNT.AI_CRD_ISS

The IssueSequnce number of the credit card being used assigned by the Credit/Debit Card issuer.

Identity

integer

StoredValueCardSupplement.CardStartDate

CO_STRD_VL_CRD_SPPLMNT.DT_CRD_SRT

The commencement date of the Credit or Debit card, as taken from the card in MMYY format.

Code4

char(4)

StoredValueCardSupplement.ServiceCode

CO_STRD_VL_CRD_SPPLMNT.CD_SV

The value of the service field from the card.

 

In XML this is referred to as a SecurityCode. The names vary from one credit debit card provider to another. Both are the same thing - a 3-4 digit code used to validate a card at the POS.

Code4

char(4)

StoredValueCardSupplement.StoredValueInstrumentID

CO_STRD_VL_CRD_SPPLMNT.ID_STRD_VL_INSTRMNT

A token ID for a StoredValueInstrument

Identity

integer

StoredValueCardSupplement.Track1CreditCardBitMap

CO_STRD_VL_CRD_SPPLMNT.DE_TRCK_1_BT_MP

Defines the bit pattern used on track 1 of the magnetic strip on the back of a StoredValueInstrument

BitMap

binary(128)

StoredValueCardSupplement.Track2CreditCardBitMap

CO_STRD_VL_CRD_SPPLMNT.DE_TRCK_2_BT_MP

Defines the bit pattern used on track 2 of the magnetic strip on the back of a credit card.

BitMap

binary(128)

StoredValueCardSupplement.Track3CreditCardBitMap

CO_STRD_VL_CRD_SPPLMNT.DE_TRCK_3_BT

Defines the bit pattern used on track 3 of the magnetic strip on the back of a credit card.

BitMap

binary(128)

StoredValueCardSupplement.Track4CreditCardBitMap

CO_STRD_VL_CRD_SPPLMNT.BM_CR_CRD_TRK_4

Defines the bit pattern used on track 4 of the magnetic strip on the back of a credit card.

BitMap

binary(128)

StoredValueControlTransaction.ActivityCode

TR_STRD_VL_CTL_TRN.CD_ACTV

Designates the type of action taken to update a StoredValueInstrument and/or StoredValueAccount

 

In this entity type the action is derived from the ControlTransaction and, based on POSLOG6, is derived from interactions between a retail point of sale system and a separate stored value management system.

.

Code

varchar(20)

StoredValueControlTransaction.CustomerAccountID

TR_STRD_VL_CTL_TRN.ID_CTAC

A unique identifier for a customer account.

Identity

integer

StoredValueControlTransaction.StoredValueInstrumentID

TR_STRD_VL_CTL_TRN.ID_STRD_VL_INSTRMNT

A token ID for a StoredValueInstrument

Identity

integer

StoredValueControlTransaction.TransactionID

TR_STRD_VL_CTL_TRN.ID_TRN

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members.

IdentityUUID

char(32)

StoredValueFundSaleLineItem.EntryMethodCode

TR_STRD_VL_FND_SL_LN _ITM.CD_ENR_MTH

The method used to enter the stored value instrument ID and account information.

 

Sample values:

 

SCAN

KEYED

 

Others that a retailer determines are required.

Code

varchar(20)

StoredValueFundSaleLineItem.RetailTransactionLineItemSequenceNumber

TR_STRD_VL_FND_SL_LN _ITM.IC_LN_ITM

The sequence number of line item within the context of this RetailTransaction.

LineNumber

smallint

StoredValueFundSaleLineItem.StoredValueInstrumentID

TR_STRD_VL_FND_SL_LN _ITM.ID_STRD_VL_INSTRMNT

A token ID for a StoredValueInstrument

Identity

integer

StoredValueFundSaleLineItem.TransactionID

TR_STRD_VL_FND_SL_LN _ITM.ID_TRN

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members.

IdentityUUID

char(32)

StoredValueInstrument.ActivationDateTime

DO_STRD_VL_INSTRMNT.DT_ACV_DT_TM

The date and time where this StoredValueInstrument is activated for use by a customer.

DateTime

datetime

StoredValueInstrument.CustomerAccountID

DO_STRD_VL_INSTRMNT.ID_CTAC

A unique identifier for a customer account.

Identity

integer

StoredValueInstrument.Description

DO_STRD_VL_INSTRMNT.DE_DSCR

Short narrative description of the StoredValueInstrument

DescriptionShort

varchar(255)

StoredValueInstrument.ExpirationDate

DO_STRD_VL_INSTRMNT.DC_EP_DT

The date when the StoredValueInstrument is nolonger active.

DateCalendar

date

StoredValueInstrument.FaceValueAmount

DO_STRD_VL_INSTRMNT.MO_FC_VL_AMT

The face value assigned to the StoredValueInstrument. For example a $25 gift card has a face value of $25. Its actual balance changes as it is used to purchase items or recharged (added to).

Money

decimal(16,5)

StoredValueInstrument.IdentificationTypeCode

DO_STRD_VL_INSTRMNT.CD_IDTN_TYP

The category of identification a customer must present to authenticate their right to purchase or redeem a StoredValueInstrument.

 

There may be age restrictions governing the sale and redemption of gift cards. A drivers license, for example, may be used to verify a customer's age.

 

NOTE: POSLOG6 has a separate element called PersonalIdentificationType that has an enumerated value list. Should we use that inplace of "IdentificationType"?

 

POSLOG6 Valid values for PERSONAL IdentificationType are:

AccountID

DUNS

GLN

StoreID

TaxID

DriversLicense

BusinessID

MilitaryID

Passport

CreditCard

NationalIdentityCard

Code

varchar(20)

StoredValueInstrument.ISOCurrencyCode

DO_STRD_VL_INSTRMNT.CD_CNY_ISO_4217

Currency code designated by ISO to identify national currency

ISO_4217_CurrencyCode_char(3)

char(3)

StoredValueInstrument.Issuing

DO_STRD_VL_INSTRMNT.ID_STR_RTL_ISSNG

A unique retailer assigned identifier for an RetailStore, DistributionCenter or AdministrationCenter

Identity

integer

StoredValueInstrument.SerialNumber

DO_STRD_VL_INSTRMNT.AI_SRL_NMB

A unique identifying BUSINESS number assigned to the stored value instrument.

Identity

integer

StoredValueInstrument.StatusCode

DO_STRD_VL_INSTRMNT.CD_STS

Code that indicates the current state of the StoredValueInstrument.

 

Valid values:

 

A = Active

I = Inactive

Code2Status

char(2)

StoredValueInstrument.StoredValueInstrumentID

DO_STRD_VL_INSTRMNT.ID_STRD_VL_INSTRMNT

A token ID for a StoredValueInstrument

Identity

integer

StoredValueInstrument.StoredValueInstrumentStateCode

DO_STRD_VL_INSTRMNT.CD_STRD_VL_INSTRMNT_ST

Indicates the current status of this StoreValueInstrument. Valid values based on POSLOG6 are:

Active

Inactive

Expired

Stolen

Damaged

Code

varchar(20)

StoredValueInstrument.StoredValueInstrumentTypeCode

DO_STRD_VL_INSTRMNT.CD_STRD_VL_INSTRMNT_TYP

An ARTS standard code to designate the category of a StoredValueInstrument. POSLOG6 values are:

 

GiftCard

GiftCertificate

PhoneCard

SmartCard

OnlineVoucher

CarwashVoucher

Code

varchar(20)

StoredValueInstrument.UnspentAmount

DO_STRD_VL_INSTRMNT.MO_UNSP_AMT

The monetary value balance remaining on the StoredValueInstrument.

Money

decimal(16,5)

StoredValueInstrument.VoucherInChangeAmount

DO_STRD_VL_INSTRMNT.MO_VCHR_IN_CHN_AMT

The monetary value of the change that has been given as a voucher.

Money

decimal(16,5)

StoredValueInstrumentActivationAuthorization.AuthorizationSequenceNumber

TR_STRD_VL_INSTRMNT_ACV_AZN.AI_AZN_SQN_NMB

Sequence number to identify the authorization attempt for a specific TenderLineItem.

LineNumber

smallint

StoredValueInstrumentActivationAuthorization.TenderAuthorizationID

TR_STRD_VL_INSTRMNT_ACV_AZN.AI_TND_AZN

A token identifier for a TenderAuthorization instance.

LineNumber

smallint

StoredValueInstrumentActivationAuthorization.TransactionID

TR_STRD_VL_INSTRMNT_ACV_AZN.ID_TRN

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members.

IdentityUUID

char(32)

StoredValueInstrumentDocument.RetailTransactionDocumentID

DO_STRD_VL_INSTRMNT_DCM.ID_RTL_TRN_DCM

A token identifier for a RetailTransactionDocument instance.

Identity

integer

StoredValueInstrumentDocument.StoredValueInstrumentID

DO_STRD_VL_INSTRMNT_DCM.ID_STRD_VL_INSTRMNT

A token ID for a StoredValueInstrument

Identity

integer

StoredValueInstrumentType.FinancialLedgerAccountID

CO_STRD_VL_INSTRMNT_TYP.ID_ACNT_LDG

The reference for the FinancialLedgeraAccount

Identity

integer

StoredValueInstrumentType.MinimumAgeYearsRequirement

CO_STRD_VL_INSTRMNT_TYP.QY_MNM_AG_YR_RQMT

The minimum age required for a customer to use a StoredValueInstrumentType to make purchase, redeem cash balances, recharge balances or any other activity.

 

This will vary depending on where the stored value instrument is involved in a transaction. Retailers need to investigate rules governing the use of SVI's where they conduct business.

QuantityInteger

integer

StoredValueInstrumentType.PersonalIDReferenceNumber

CO_STRD_VL_INSTRMNT_TYP.ID_RFC_PRSL_ID

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.

Identity

integer

StoredValueInstrumentType.PersonalIDRequiredTypeCode

CO_STRD_VL_INSTRMNT_TYP.TY_ID_PRSL_RQ

Identifies the type of personal identification required to authorize tender. Examples include driver's license, a second credit card, social security card, etc.

Code2

char(2)

StoredValueInstrumentType.PublicPrivateNetworkTypeCode

CO_STRD_VL_INSTRMNT_TYP.CD_PBLC_PRVT_NTWRK_TYP

A code that designates this StoredValueInstrumentType as an OPEN network card (it can be used at many retailers) or a CLOSED network card (it can only be used at the retailers stores.

 

Code

varchar(20)

StoredValueInstrumentType.StoredValueInstrumentMediaTypeCode

CO_STRD_VL_INSTRMNT_TYP.CD_STRD_VL_INSTRMNT_MD_TYP

A retailer defined code that designates a kind of stored value instrument media. Sample values include:

 

PAPER

MAG_STRIPE_CARD

FOB

MOBILE_APP

TOKEN

Code

varchar(20)

StoredValueInstrumentType.StoredValueInstrumentTypeCode

CO_STRD_VL_INSTRMNT_TYP.CD_STRD_VL_INSTRMNT_TYP

An ARTS standard code to designate the category of a StoredValueInstrument. POSLOG6 values are:

 

GiftCard

GiftCertificate

PhoneCard

SmartCard

OnlineVoucher

CarwashVoucher

Code

varchar(20)

StoredValueInstrumentType.StoredValueInstrumentTypeDescription

CO_STRD_VL_INSTRMNT_TYP.DE_STRD_VL_INSTRMNT_TYP

A short narrative description of the StoredValueInstrumentTypeCode used for reporting.

DescriptionShort

varchar(255)

StoredValueTransaction.ActivityCode

TR_STRD_VL_TND_CTL_TRN.CD_ACTV

Activity code defines actions that may be applied to a SVI that changes its state and the monetary balance it carries. Valid values (based on POSLOG6) include:

 

Activation enables a stored value -instrument

Associate

BalanceTransfer transfer balance from one SVI to another

Cancel Cancel a Card (

Cashout Convert balance to cash and deactivate

Deactivate Deactivate a card

Expired SVI expired - escheatment

Recharge Add monetary value to the SVI

Refund Refund value (add prior

 

Replace Replace the SVI

Stolen Flag SVI as stolen and deactivate it

Void Flag SVI as VOID and deactivate it

Code

varchar(20)

StoredValueTransaction.CustomerAccountID

TR_STRD_VL_TND_CTL_TRN.ID_CTAC

A unique identifier for a customer account.

Identity

integer

StoredValueTransaction.StoredValueInstrumentID

TR_STRD_VL_TND_CTL_TRN.ID_STRD_VL_INSTRMNT

A token ID for a StoredValueInstrument

Identity

integer

StoredValueTransaction.TransactionID

TR_STRD_VL_TND_CTL_TRN.ID_TRN

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members.

IdentityUUID

char(32)

StoredValueTenderLineItem.RetailTransactionLineItemSequenceNumber

TR_LTM_VCHR_TND.IC_LN_ITM

The sequence number of line item within the context of this RetailTransaction.

LineNumber

smallint

StoredValueTenderLineItem.StoredValueAdjudicationCode

TR_LTM_VCHR_TND.LU_ADJN_CRDB

A code indicating the result of a request to authorize the use of tender to settle a transaction.

Code6

char(6)

StoredValueTenderLineItem.StoredValueAuthorizationMethodCode

TR_LTM_VCHR_TND.LU_MTH_AZN

Identifies the method used to authorize tender. Examples include by electronic query, by sales employee visual inspection of customer card and id.

Code4

char(4)

StoredValueTenderLineItem.StoredValueEntrySourceCode

TR_LTM_VCHR_TND.LU_SCR_ENR

A code denoting who entered the StoredValueInstrument information for this VoucherTenderLineItem: Merchant or Customer.

Code2

char(2)

StoredValueTenderLineItem.StoredValueInstrumentEntryMethodCode

TR_LTM_VCHR_TND.LU_MTH_CRD_ENR

A code that indicates how the StoredValueInstrument information was entered:

 

Eg: swiped (MSR), tapped (contactless RFID card), near field (mobile) or manually keyed.

Code2AccessControl

char(2)

StoredValueTenderLineItem.StoredValueInstrumentID

TR_LTM_VCHR_TND.ID_STRD_VL_INSTRMNT

A token ID for a StoredValueInstrument

Identity

integer

StoredValueTenderLineItem.StoredValueReconciliationCode

TR_LTM_VCHR_TND.CD_RCN

A code used to indicate if thie credit/debit card instance is reconciled or not.

Identity

integer

StoredValueTenderLineItem.TransactionID

TR_LTM_VCHR_TND.ID_TRN

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members.

IdentityUUID

char(32)

StoreValueInstrumentMediaType.MediaTypeName

CO_STR_VL_INSTRMNT_MD_TYP.DE_STRD_VL_INSTRMNT_MD_TYP

A short business description of the store value media type code.

Name

varchar(40)

StoreValueInstrumentMediaType.StoredValueInstrumentMediaTypeCode

CO_STR_VL_INSTRMNT_MD_TYP.CD_STRD_VL_INSTRMNT_MD_TYP

A retailer defined code that designates a kind of stored value instrument media. Sample values include:

 

PAPER

MAG_STRIPE_CARD

FOB

MOBILE_APP

TOKEN

Code

varchar(20)

SupplierItemReceivingUnit.ContainerTypeCode

AS_UNI_SPR_ITM_RCV.CD_CNR_TYP

A category of container that defines what it is made of, its type (primarily its material handling category - e.g. 55 gallon drums, pallets, cases, etc.) and its shape.

Code

varchar(20)

SupplierItemReceivingUnitConversionRule.child

RU_CVN_SPR_ITM_UN.CD_CNR_TYP_CHLD

A category of container that defines what it is made of, its type (primarily its material handling category - e.g. 55 gallon drums, pallets, cases, etc.) and its shape.

Code

varchar(20)

SupplierItemReceivingUnitConversionRule.parent

RU_CVN_SPR_ITM_UN.CD_CNR_TYP_PRNT

A category of container that defines what it is made of, its type (primarily its material handling category - e.g. 55 gallon drums, pallets, cases, etc.) and its shape.

Code

varchar(20)

TenderAuthorization.TenderAuthorizationID

CO_AZN_TND.AI_TND_AZN

A token identifier for a TenderAuthorization instance.

LineNumber

smallint

TenderAuthorizationReversal.TenderAuthorizationID

TR_TND_AZN_RVS.AI_TND_AZN

A unique sequence number for this TenderAuthorization. Required because a particular TenderLineItem may have more than one TenderAuthorization attempt.

LineNumber

smallint

TenderLineItemAuthorization.AuthorizationSequenceNumber

CO_TND_LN_ITM_AZN.AI_AZN_SQN_NMB

Sequence number to identify the authorization attempt for a specific TenderLineItem.

LineNumber

smallint

TenderLineItemAuthorization.RetailTransactionLineItemSequenceNumber

CO_TND_LN_ITM_AZN.IC_LN_ITM

The sequence number of line item within the context of this RetailTransaction.

LineNumber

smallint

TenderLineItemAuthorization.TenderAuthorizationID

CO_TND_LN_ITM_AZN.AI_TND_AZN

A token identifier for a TenderAuthorization instance.

LineNumber

smallint

TenderLineItemAuthorization.TransactionID

CO_TND_LN_ITM_AZN.ID_TRN

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members.

IdentityUUID

char(32)

TotalPurchaseMarketBasketRewardDerivationRuleEligibility.MarketBasketTriggerID

CO_EL_MRBK_PRDV.ID_TRG_MRBK

A unique identifier for the market basket eligibility rule.

Identity

integer

TotalPurchaseMarketBasketRewardDerivationRuleEligibility.PriceChangeRuleID

CO_EL_MRBK_PRDV.ID_RU_PRC_CHN

A type of price change rule.

Identity

integer

TotalPurchaseMarketBasketRewardDerivationRuleEligibility.RewardDerivationRuleEligibilityID

CO_EL_MRBK_PRDV.ID_EL_PRDV

A unique identifier for a Price Derivation Rule Eligibility.

Identity

integer

TransportBillingMethod.Description

CO_TRNSPRT_BLLNG_MTH.DE_TRNSPRT_BLLNG_MTH

Short narrative description of a TransportBillingMethod.

DescriptionShort

varchar(255)

TransportBillingMethod.TransportBillingMethodCode

CO_TRNSPRT_BLLNG_MTH.CD_TRNSPRT_BLLNG_MTH

Retailer designated code that indicates how the transportation and handling fees for a shipment are to be billed.

 

Sample values (for domestic US shipments) include:

 

PREPAID = prepaid transportation fees

COL = collect upon delivery from receipient

BRC = Bill the receiver

B3P = Bill 3rd party

 

Others may be added as required for international shipping and other kinds of shipping arrangements.

Code

varchar(20)

TransportPaymentMethod.Description

CO_TRNSPRT_PYM_MTH.DE_TRNSPRT_PYM_MTH

Short narrative description of a TransportPaymentMethod

DescriptionShort

varchar(255)

TransportPaymentMethod.TransportationPaymentMethodCode

CO_TRNSPRT_PYM_MTH.CD_TRNSPRT_PYM_MTH

A designated code and enumerated value list that categorizes different ways of paying for transporation services related to a shipment/delivery of merchandise.

 

These typically apply to COD or scenarios where the merchandise is paid for through another means but the customer must pay transport fees on delivery.

 

GS1 examples include:

 

BANK_CHEQUE

BANK_GIRO

BANKERS_DRAFT

BOOKENTRY_CREDIT

BOOKENTRY_DEBIT

BOP

CASH

CERTIFIED_CHEQUE

CHEQUE

CREDIT_CARD

DEBIT_CARD

ELECTRONIC_CREDIT_ACH

ELECTRONIC_DEBIT_ACH

FED_WIRE_NON_REPETITIVE

FED_WIRE_REPETITIVE

INTERNATIONAL_WIRE

LETTER_OF_CREDIT

POSTGIRO

WIRE_TRANSFER_CREDIT

WIRE_TRANSFER_DEBIT

Name

varchar(40)

TransportServiceLevelType.Description

CO_TRNSPRT_PYM_SV_LV_TYP.DE_TRNSPRT_SV_LV_TYP

A short narrative description of the Transportation Service Level Type Code for reporting purposes.


char(18)

TransportServiceLevelType.TransportServiceLevelTypeCode

CO_TRNSPRT_PYM_SV_LV_TYP.CD_TRNSPRT_SV_LV_TYP

Identifies a transportation service level type used to distinguish faster from slower delivery plus additional tracking and ancillary services.

 

Sample GS1 code values:

AUTHORIZED_RETURN_SERVICE

CONSIGNEE_BILLING_SERVICE

DELIVERY_CONFIRMATION

EXPEDITED_SERVICE

EXPEDITED_SERVICE_WORLDWIDE

EXPRESS_SERVICE

EXPRESS_SERVICE_PLUS

GROUND

GROUND_CX_EXPRESS_SERVICE

MULTIWEIGHT

MUTUALLY_DEFINED

NEXT_DAY_AIR

NEXT_DAY_PM

NEXT_MORNING

PRIMARY_SERVICE_AREA_NEXT_DAY_BY_1030

PRIMARY_SERVICE_AREA_NEXT_DAY_BY_1700

RETURN_SERVICE

SAME_DAY

SATURDAY

SATURDAY_PICKUP

SECOND_DAY_AIR

SECOND_MORNING

STANDARD_GROUND_HUNDRED_WEIGHT

STANDARD_SERVICE

THREE_DAY_SERVICE

Code

varchar(20)

WorkerDiscountGroupRewardDerivationRuleEligibility.ApplyAfterAllMarkdownsFlag

CO_EL_EM_DSC_PRDV.FL_MKD_APLY_AFT

A flag to denote whether the EMPLOYEE DISCOUNT is applied after all the ITEM markdowns have been applied.

Flag

integer

WorkerDiscountGroupRewardDerivationRuleEligibility.CostPlusFlag

CO_EL_EM_DSC_PRDV.FL_CST_PLS_EM_DSC

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.

Flag

integer

WorkerDiscountGroupRewardDerivationRuleEligibility.Description

CO_EL_EM_DSC_PRDV.DE_EL_EM_PRDV_RU

Describes the derivation rule for the employee group price discount.

DescriptionShort

varchar(255)

WorkerDiscountGroupRewardDerivationRuleEligibility.EligibilityDescription

CO_EL_EM_DSC_PRDV.DE_EL_EM_DSC_GP

Describes this employee-group discount eligibility rule.

DescriptionShort

varchar(255)

WorkerDiscountGroupRewardDerivationRuleEligibility.EmployeeDiscountGroupID

CO_EL_EM_DSC_PRDV.ID_GP_EM_DSC

The identifier for a specific EMPLOYEE DISCOUNT GROUP.

Identity

integer

WorkerDiscountGroupRewardDerivationRuleEligibility.RewardDerivationRuleEligibilityID

CO_EL_EM_DSC_PRDV.ID_EL_PRDV

A unique identifier for a Price Derivation Rule Eligibility.

Identity

integer

 

The following figure presents a table of entity attribute definition changes from V7.2 to V7.3.

Figure 90 - Entity.Attribute Definition Changes V7.2 to V7.3

V73_ET_AT_NAME

V73_TBL_COL_NAME

V73_AT_DEF

V72_AT_DEF

Item.SubBrand

AS_ITM.NM_BRN_SUB_BRN

A unique name to denote a class of ITEMs as a product. The brand can include private label ITEMs.

A sequence number that identifies a subbrand within a brand.

Item.SubBrand

AS_ITM.AI_SUB_BRN

A sequence number that identifies a subbrand within a brand.

A unique name to denote a class of ITEMs as a product. The brand can include private label ITEMs.

LocationHierarchyLevel.Parent

CO_LCN_HRC_LV.IC_HRC_LV_NMB

Whole number value to indicate relative position of a level within the hierarchy. In ARTS LEVEL 0 is the root. Level 1 is the next lower level, etc. As the value increases it indicates that the levels are getting deeper towards the leaf level which has the highest value.

A token ID for a LocationHierarchy. It is to gurantee uniqueness

LocationHierarchyLevel.Parent

CO_LCN_HRC_LV.ID_LCN_HRC_LV_PRNT

A token ID for a LocationHierarchy. It is to gurantee uniqueness

Whole number value to indicate relative position of a level within the hierarchy. In ARTS LEVEL 0 is the root. Level 1 is the next lower level, etc. As the value increases it indicates that the levels are getting deeper towards the leaf level which has the highest value.

PriceModificationLineItem.PriceModificationBaseAmount

TR_LTM_MDF.MO_PRC_MDFN_BS_AMT

The monetary value of the transaction (i.e. a sum of sale return line item extended actual retail amounts) plus or minus other PriceModificationLineItem values used as the basis for this price modifciation calculation.

 

NOTE: The ARTS model defines placeholders for transaction-level discounts. However, it is the retailer's responsibility to specify the business rules for calculating transaction-level price modificaction values and to assign an appropriate value to PriceModificationBaseAmount.

The monetary value of the transaction (i.e. a sum of sale return line item extended actual retail amounts) plus or minus other PriceModificationLineItem values used as the basis for this price modifciation calculation.

 

NOTE: The ARTS model defines placeholders for transaction-level discounts. However, it is the retailer's responsibility to specify the business rules for calculating transaction-level price modificaction values.

RetailPriceModifier.ProrateFrom

CO_MDFR_RTL_PRC.ID_TRN_PRRT

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members.

The sequence number of line item within the context of this RetailTransaction.

RetailPriceModifier.ProrateFrom

CO_MDFR_RTL_PRC.IC_LN_ITM_PRRT

The sequence number of line item within the context of this RetailTransaction.

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members.

RetailTransactionLineItemType.RetailTransactionLineItemTypeCode

CO_TYP_LTM_TRN_RTL.CD_TYP_LTM_TRN_RTL

A code to denote the type of retail transaction line item, such as Sale/Return, Void, miscellaneous fee, etc.

 

Valid values include:

SALERETURN - merchandise/service sale return

CUST_REWARD - Customer reward (including optional rebate extension)

TENDER - tender line item

PRC_MOD - price modifier (discount)

GIFTCERT - gift certificate (stored value SALE)

DEPSTREM - Deposit redemption on cans, etc

MISCFEE - misc. fee line item

PAYMTONACT - Payment on account line item

records credit against customer

AR

WRTOFF - Writeoff line item to debt out

incomplete trns (drive off)

RNDG - Rounding line item

PRMLYLTPT - Promotional loyalty points

earned line item

A code to denote the type of retail transaction line item, such as Sale/Return, Void, miscellaneous fee, etc.

 

Valid values include:

SALERETURN - merchandise/service sale return

TENDER - tender line item

PRC_MOD - price modifier (discount)

GIFTCERT - gift certificate (stored value SALE)

DEPSTREM - Deposit redemption on cans, etc

MISCFEE - misc. fee line item

PAYMTONACT - Payment on account line item

records credit against customer

AR

WRTOFF - Writeoff line item to debt out

incomplete trns (drive off)

RNDG - Rounding line item

PRMLYLTPT - Promotional loyalty points

earned line item

 

The next figure presents a table of entity.attributes that have new domains assigned to them in Version 7.3.

Figure 91 - Modified Entity.Attribute Domains from V7.2 to V7.3

V73_ET_AT_NAME

V72_ET_AT_NAME

V73_TBL_COL_NAME

V73_DOMAIN_NAME

V73_AT_DATA_TYPE

V72_AT_DOMAIN_NAME

V72_AT_DATA_TYPE

BusinessUnitGroupGeographicSegmentHierarchyGroup.StatusCode

BusinessUnitGroupGeographicSegmentHierarchyGroup.StatusCode

CO_BSNGP_GEO_AR.CD_STS

Code2Status

char(2)


char(18)

CustomerAccount.GracePeriodDayCount

CustomerAccount.GracePeriodDayCount

LE_CTAC.TI_GRC_PRD_DY

QuantityDayCount

decimal(3,0)


char(18)

CustomerAffiliation.StatusCode

CustomerAffiliation.StatusCode

CO_CTAF.CD_STS

Code2Status

char(2)


char(18)

CustomerOrderLineItem.CustomerOrderLineItemTypeCode

CustomerOrderLineItem.CustomerOrderLineItemTypeCode

DO_CTOLTM.CD_CT_ORD_LN_ITM_TYP

Code

varchar(20)

Code2

char(2)

CustomerOrderProductLineItem.TotalRetailPriceAmount

CustomerOrderProductLineItem.TotalRetailPriceAmount

DO_CTOLTM_PDT.MO_PRC_TOT

Money

decimal(16,5)

MoneyShortRetail

decimal(7,2)

CustomerOrderProductPriceModifier.ReasonCode

CustomerOrderProductPriceModifier.ReasonCode

CO_MDFR_CTOLTM_PDT.CD_RSN

Code

varchar(20)

Code2

char(2)

GeophysicalLocationCoordinate.AltitudeMeters

GeophysicalLocationCoordinate.AltitudeMeters

LO_CRDN_GEO_LCN.QU_ALTTD_MTR

Quantity

integer


integer

GeophysicalLocationCoordinate.LatitudeDirectionCode

GeophysicalLocationCoordinate.LatitudeDirectionCode

LO_CRDN_GEO_LCN.CD_LTTD_DRC

Code

char(1)


char(1)

GeophysicalLocationCoordinate.LongitudeDirectionCode

GeophysicalLocationCoordinate.LongitudeDirectionCode

LO_CRDN_GEO_LCN.CD_LNGTD_DIR

Code

char(1)


char(1)

Item.SubBrand

Item.SubBrand

AS_ITM.AI_SUB_BRN

LineNumber

smallint

Name

varchar(40)

Item.SubBrand

Item.SubBrand

AS_ITM.NM_BRN_SUB_BRN

Name

varchar(40)

LineNumber

smallint

LocationHierarchyLevel.Parent

LocationHierarchyLevel.Parent

CO_LCN_HRC_LV.IC_HRC_LV_NMB

LineNumber

smallint

Identity

integer

LocationHierarchyLevel.Parent

LocationHierarchyLevel.Parent

CO_LCN_HRC_LV.ID_LCN_HRC_LV_PRNT

Identity

integer

LineNumber

smallint

METARWeatherForecast.ForecastStatusCode

METARWeatherForecast.ForecastStatusCode

CO_METAR_WTHR_FRCST.CD_FRCST_STS

Code

varchar(20)


char(18)

PriceModificationLineItem.PriceModificationBaseAmount

PriceModificationLineItem.PriceModificationBaseAmount

TR_LTM_MDF.MO_PRC_MDFN_BS_AMT

Money

decimal(16,5)

MoneyShortRetail

decimal(7,2)

PromotionalOffer.StatusCode

PromotionalOffer.StatusCode

CO_PRM.CD_STS_PRM

Code2Status

char(2)


char(18)

RegistrationEvent.RegistrationActionTypeCode

RegistrationEvent.RegistrationActionTypeCode

EV_RGSTN.CD_ACTN_TYP

Code

varchar(20)


char(18)

RetailPriceModifier.ProrateFrom

RetailPriceModifier.ProrateFrom

CO_MDFR_RTL_PRC.IC_LN_ITM_PRRT

LineNumber

smallint

IdentityUUID

char(32)

RetailPriceModifier.ProrateFrom

RetailPriceModifier.ProrateFrom

CO_MDFR_RTL_PRC.ID_TRN_PRRT

IdentityUUID

char(32)

LineNumber

smallint

RetailTransactionLineItem.RetailTransactionLineItemTypeCode

RetailTransactionLineItem.RetailTransactionLineItemTypeCode

TR_LTM_RTL_TRN.CD_TYP_LTM_TRN_RTL

Code

varchar(20)

Code2

char(2)

RetailTransactionLineItemType.RetailTransactionLineItemTypeCode

RetailTransactionLineItemType.RetailTransactionLineItemTypeCode

CO_TYP_LTM_TRN_RTL.CD_TYP_LTM_TRN_RTL

Code

varchar(20)

Code2

char(2)

SiteContactMethod.BuildingID

SiteContactMethod.BuildingID

CO_MTH_CNCT_STE.ID_BLDNG

IdentityGTIN

integer

Identity

integer