Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

StoreSettlement Worker - Configuration Parameters Documentation

For End Users and System Administrators

Overview

This document describes all configuration parameters for the StoreSettlement worker in POS Services. The StoreSettlement worker generates daily settlement files containing financial and operational data from the point-of-sale system. These files are used for accounting, reconciliation, and reporting purposes.

Settlement files contain various transaction codes (like IKU, IVA, B01, etc.) that represent different types of financial data. Each parameter below controls whether specific codes appear in the settlement file and how they are calculated.

...

Core Settlement Parameters

SettlementType

Purpose: Determines the level of detail in settlement reporting - whether settlements are generated per store, per operator (cashier), or per workstation (cash register).

...

  • Operator - Generates settlements grouped by cashier/operator
  • Store - Generates settlements grouped by store (consolidated)
  • Workstation - Generates settlements grouped by cash register/terminal
  • ItemGroup - Generates settlements grouped by item group (rarely usedO-file)

Default: Operator, Store, Workstation

...

Purpose: Controls how the settlement period is defined - whether it's a single business day, a date range, or a hybrid approach.

Valid Values:

  • Date - Settlement for a single business day
  • DateRange - Settlement spanning multiple days
  • Hybrid - Combination approach (consult with support before using)

Default: Date

When to Use Each:

...

Impacted Code(s): All settlement codes - shifts the time boundary for all transaction queries

...

Feature Enable/Disable Parameters

StoreSettlementEnableNonsale

...

  • Your store sells service products or fees
  • Need to track non-inventory revenue separately
  • Accounting requires non-sale items in daily reports

Impacted Code(s): INO, N00-N99, O00-O99, P00-P99

...

How It Works: When enabled, the settlement file includes separate balance sections for each supported currency (NOK, SEK, EUR, USD, etc.). Each tender transaction is reported with both the original currency amount and the converted amount in the store's base currency.

...

  • Store is located near international border
  • Store accepts multiple currencies as payment
  • Accounting needs separate currency tracking for exchange rate management

Impacted Code(s):  "SEK": SE1-SE2, "NOK": NO1-NO2,  SE1-SE2, "DKK": DA1-DA2,  "EUR": EU1-EU2,  "USD": US1-US2,  "GBP": GB1-GB2,  Z01-Z99

StoreSettlementEnableInboundOutboundChange

"CAD": CA1-CA2, "CHF": CH1-CH2, "JPY": JP1-JP2, Other: DI1 - DI2

StoreSettlementEnableInboundOutboundChange

Purpose: Tracks cash movements into Purpose: Tracks cash movements into and out of the cash drawer during the business day (separate from sales).

...

Impacted Code(s): K01-K99 with currency codes (KNONOK, KSEUSEK, etc.)

StoreSettlementEnableCashInCurrency

...

How It Works: Creates separate settlement lines for cash received in NOK, SEK, EUR, etc. This is different from EnableCurrencyBalance which tracks drawer balance - this tracks cash revenue tender transactions by currency.

When to Enable:

  • Border stores accepting multiple cash currencies
  • Need to track which currencies customers are paying with
  • Currency exchange operations within the store

Impacted Code(s):  "NOK": CNO,  "SEK": CSE,  CEU, CUS, CGB, CDK, "EUR": CEU, "DKK": CDK, "USD": CUS, "GBP": CGB, "CAD": CCA, "CHF": CCH, "JPY": CJP, Other: COT

StoreSettlementEnableDeliveredBalanceInCurrency

...

  • Using EnableCurrencyBalance
  • Starting float contains multiple currencies
  • Need detailed reconciliation of opening balances

...

Impacted Impacted Code(s):  LNO, LSE, LEU, LUS, LGB, LDK, LOT"NOK": ISN, "SEK": ISS, "EUR": ISD, "DKK": ISE, "USD": ISU, "GBP": ISG, "CAD": ISC, "CHF": ISH, "JPY": ISJ, Other: ISI


StoreSettlementEnableInboundOutboundChangeInCurrency

...

  • Using EnableInboundOutboundChange
  • Cash drops/additions happen in multiple currencies
  • Need currency-specific cash movement tracking

...

Impacted Code(s):
Inbound:  "NOK": IVN, "SEK": IVS, "DKK": IVD, "EUR": IVE, "USD": IVC, "GBP": IVG, "CAD": IVK, "CHF": IVM, "JPY": IVR, Other: IVU
Outbound: "NOK": IVO, "SEK": IVT, "DKK": IVF, "EUR": IVH, "USD": IVB, "GBP": IVJ, "CAD": IVL, "CHF": IVP, "JPY": IVW, Other: IVY

StoreSettlementEnableFallbacks

Purpose: Enables reporting on fallback solution for payment card

Impacted Code(s): IVI, IVU with currency codes

StoreSettlementEnableFallbacks

Purpose: Enables fallback values when primary data sources are missing or incomplete.

Valid Values: true, false

Default: false

How It Works: If certain data isn't available (e.g., reason codes missing, item groups undefined), the system uses predefined fallback values instead of failing or skipping the transaction.

When to Enable:

  • Data quality issues in source system
  • Migration period with incomplete data
  • Want settlement to always succeed even with missing data

Impacted Code(s): IRC, IRS and various codes when fallback logic applies

StoreSettlementEnableGrandTotal

Purpose: Adds a grand total line at the end of settlement file summarizing all transactions.

Valid Values: true, false

Default: false

How It Works: Calculates and outputs a summary line (ING) showing total revenue across all transaction types, providing a single reconciliation point.

When to Enable:

  • Accounting system requires grand total for validation
  • Quick check of total revenue without analyzing individual lines
  • External system imports settlement and needs total amount field

Impacted Code(s): ING

StoreSettlementEnableLottery

Purpose: Enables lottery transaction processing and reporting in settlement files.

Valid Values: true, false

Default: false

How It Works: When enabled, lottery ticket sales, prize payouts, and related transactions are included in the settlement with appropriate categorization. Lottery sales are tracked separately from regular merchandise due to different commission structures and accounting treatment. Reports data on specific PaymentCard types

When to Enable:

  • Store sells lottery tickets (e.g., national lottery, scratch cards)
  • Need to track lottery revenue separate from merchandise
  • Accounting requires lottery commission calculations
  • External lottery system requires reconciliation data

Important Notes:

  • There exists system for fallback on payment cards

Impacted Code(s): "CoopPay": IRC, "SoftPay":IRS 

StoreSettlementEnableGrandTotal

Purpose: Adds statistics on workstation business day grand total 

Valid Values: true, false

Default: false

How It Works: Works only on workstation level and shows closing value on given day

When to Enable:

  • System is working with shift mode and needs to report on closing of business day
  • Lottery sales typically don't count toward store revenue (commission only)
  • Prize payouts reduce cash but aren't store expenses
  • May require coordination with StoreSettlementPrizePayoutItemGroups

Impacted Code(s): IL1-IL9 (Lottery sales), IP1-IP9 (Prize payouts)

...

ING

StoreSettlementEnableLottery

Purpose: Enables kickback/commission calculation and reporting in settlement files.reporting on different lottery types sales

Valid Values: true, false

Default: false

How It Works: Kickbacks are financial returns or commissions that the retailer receives from suppliers based on sales volume, promotion participation, or contractual agreements. When enabled, the settlement calculates and reports these amounts based on configured rulesWhen enabled, lottery ticket sales are included in the settlement with appropriate categorization. Lottery sales are tracked separately from regular merchandise due to different commission structures and accounting treatment.

When to Enable:

  • Store
  • has supplier rebate agreements tied to sales volume
  • Participation in vendor promotional programs with commission payments
  • Accounting requires accrual of expected supplier rebates
  • Need to track promotional incentives separately

Common Kickback Scenarios:

  • Volume-based: 2% rebate on sales exceeding monthly threshold
  • Promotional: Additional commission during campaign periods
  • Category-based: Different rebate rates for different product types
  • Placement fees: Compensation for shelf space or end-cap displays

Important Notes:

...

  • sells lottery tickets (e.g., national lottery, scratch cards)
  • Need to track lottery revenue separate from merchandise
  • Accounting requires lottery commission calculations
  • External lottery system requires reconciliation data

Important Notes:

  • Lottery sales typically don't count toward store revenue (commission only)
  • Prize payouts reduce cash but aren't store expenses

Impacted Code(s): IFX, IFX000, IFX001-IFX999

StoreSettlementEnableKickBack

Purpose: Enables kickback value reporting in settlement files.

Valid Values: true, false

Default: false

How It Works: 

...

Impacted Code(s): IKB, KB1-KB9IFR

StoreSettlementHasItemTransactionReasonCodes

Purpose: Indicates whether non-sale item transactions (breakage, internal use, etc.) require and use reason codessplit reporting per reason code used.

Valid Values: true, false

...

How It Works: When enabled, the settlement process expects reason codes on item transactions like breakage or internal use, and includes those reason codes in reporting. This provides audit trail for why items were removed from inventoryreports item transactions split by transaction type and the reason code as well as sum per transaction type.

When to Enable:

  • Store policy requires documented reasons for inventory adjustments
  • Need detailed shrinkage analysis by reason
  • Audit requirements for non-sale inventory movements

...

StoreSettlementHasDiscountReasonCodes

Purpose: Indicates whether discount transactions require reason codes for audit and reporting purposes.whether to use old or new split of Discounts codes rules

Valid Values: true, false

Default: false

How It Works: When enabled, the settlement process expects reason codes for discount transactions and includes them in validation and reporting. This is particularly important for manual discounts where managers must document why a discount was given.

When to Enable:

...

: 

When to Enable:

...

Common Discount Reasons:

...

...

Important Notes:

  • If enabled, transactions lacking reason codes may be rejected or flagged
  • Reason code master data must be maintained in system
  • Different discount types (line, group, customer) may use different reason codes

Impacted Code(s): IRM, IRK, IRP, IRG, IGR with reason code details, D01-D25

...

VAT and Tax Configuration Parameters

StoreSettlementVatCodes

Purpose: Defines which VAT rates are used in settlement reporting and maps them to settlement file codes.

...

Impacted Code(s): IF1-IF5 (Foreign member rebates)

...

Item Group and Product Code Configuration

StoreSettlementEnabledItemTransactionTypes

...

Impacted Code(s): IDT, DT1-DT9 (Dated item sales)

...

Payment and Tender Configuration

StoreSettlementUnknownCashierNumber

...

Impacted Code(s): IC1-IC5 (online grocery codes)

...

Settlement Code Reference Table

Code RangeDescriptionControlling Parameters
B01-B99Cash balance by tender typeNone (always generated)
K01-K99Payment card transactions by card typeStoreSettlementPaymentCardTypes, EnablePaymentCardInCurrency
S01-S99Store-branded payment cardsStoreSettlementPaymentCardsS
C01-C99Customer/partner payment cardsStoreSettlementPaymentCardsC
Q01-Q99Coupon transactions by typeStoreSettlementCouponTypes
R01-R99General payment card reportingStoreSettlementPaymentCardTypes
IKUCustomer countNone
IVAItem quantity soldNone
IM1-IM9Sales by VAT rateStoreSettlementVatCodes
IZ1-IZ5Delayed payment (credit) sales by VATStoreSettlementDelayedPaymentVatRates
IC1-IC5Online grocery by VATStoreSettlementGroceriesOnlineVatRates
IW1-IW5Web shop by VATStoreSettlementWebShopVatRates
IA1-IA5, IB1-IB5Deposit refund in/out by VATStoreSettlementDepositRefundVatRates
IP1-IP5Prize payouts by VATStoreSettlementPrizePayoutVatRates
IR1-IR5Own member rebates by VATStoreSettlementRebateOwnMemberVatRates
IF1-IF5Foreign member rebates by VATStoreSettlementRebateForeignMemberVatRates
INONon-sale itemsStoreSettlementEnableNonsale
IVI, IVUInbound/outbound changeStoreSettlementEnableInboundOutboundChange
IV1-IV9Item transactions (breakage, inventory, etc.)StoreSettlementEnabledItemTransactionTypes
IDR, IKI, IIN, IUTTender control transactionsStoreSettlementCashDrawerTenderControlTypes
IRM, IRK, IRP, IRG, IGRDiscount typesStoreSettlementHasDiscountReasonCodes
INGGrand totalStoreSettlementEnableGrandTotal
IGK, IG1Gift card sales (own/foreign)StoreSettlementGiftCardTypesCodes
IL1-IL9Lottery salesStoreSettlementEnableLottery
IKB, KB1-KB9Kickback/commissionStoreSettlementEnableKickBack
IDT, DT1-DT9Dated item salesStoreSettlementReasonDateItemSales
IUP, IIPDeposit refund out/inStoreSettlementDepositRefundOutItemGroups, StoreSettlementAutomaticDepositRefundEans
CNO, CSE, CEU, etc.Cash by currencyStoreSettlementEnableCashInCurrency
NO1-NO2, SE1-SE2, etc.Currency balanceStoreSettlementEnableCurrencyBalance
LNO
ISN,
LSE
 ISS,
LEU
ISD, etc.Delivered balance by currencyStoreSettlementEnableDeliveredBalanceInCurrency
IRC, IRSFallback valuesStoreSettlementEnableFallbacks

...

Parameter Summary Table

ParameterDefaultKey Codes Affected
SettlementTypeOperator, Store, WorkstationAll codes
StoreSettlementOutputDirectoryc:\temp\File system
StoreSettlementPeriodTypeDateAll codes
StoreSettlementTimeOffset0:00All codes
StoreSettlementEnableNonsalefalseINO, N00-N99, O00-O99, P00-P99
StoreSettlementEnableCurrencyBalancefalseNO1-NO2, SE1-SE2, DA1-DA2, etc.
StoreSettlementEnableInboundOutboundChangefalseIVI, IVU
StoreSettlementEnablePaymentCardInCurrencyfalseK codes with currency
StoreSettlementEnableCashInCurrencyfalseCNO, CSE, CEU, COT
StoreSettlementEnableFallbacksfalseIRC, IRS
StoreSettlementEnableGrandTotalfalseING
StoreSettlementEnableLotteryfalseIL1-IL9, IP1-IP9
StoreSettlementEnableKickBackfalseIKB, KB1-KB9
StoreSettlementHasItemTransactionReasonCodesfalseIV1-IV9 with reasons
StoreSettlementHasDiscountReasonCodesfalseIRM, IRK, IRP, IRG, IGR with reasons
StoreSettlementEnabledItemTransactionTypesEmptyIV1-IV9
StoreSettlementVatCodesIM1=25;IM2=0;IM3=14;IM4=99IM1-IM4
StoreSettlementDelayedPaymentVatRatesEmptyIZ1-IZ5
StoreSettlementDepositRefundVatRatesEmptyIA1-IA5, IB1-IB5
StoreSettlementPrizePayoutVatRatesEmptyIP1-IP5
StoreSettlementGroceriesOnlineVatRatesEmptyIC1-IC5
StoreSettlementWebShopVatRatesEmptyIW1-IW5
StoreSettlementRebateOwnMemberVatRatesEmptyIR1-IR5
StoreSettlementRebateForeignMemberVatRatesEmptyIF1-IF5
StoreSettlementCouponTypesEmptyQ01-Q99
StoreSettlementPaymentCardTypesEmptyR01-R99
StoreSettlementPaymentCardsSEmptyS01-S99
StoreSettlementPaymentCardsCEmptyC01-C99
StoreSettlementPrizePayoutItemGroupsEmptyIP codes
StoreSettlementDepositRefundOutItemGroupsEmptyIUP, IIP, IA/IB codes
StoreSettlementAutomaticDepositRefundEansEmptyIUP, IIP, IA/IB codes
StoreSettlementGiftCardTypesCodesEmptyIGK, IG1
StoreSettlementReasonDateItemSalesEmptyIDT, DT1-DT9
StoreSettlementCashDrawerTenderControlTypesEmptyIDR, IKI, IIN, IUT, etc.
StoreSettlementGroceriesOnlinePriceChannelEmptyIC codes
StoreSettlementUnknownCashierNumber9999Operator-level codes

...

Configuration Examples by Business Type

Standard Retail Store

<add key="SettlementType" value="Store, Workstation" />
<add key="StoreSettlementOutputDirectory" value="c:\LPOS\Settlements\" />
<add key="StoreSettlementPeriodType" value="Date" />
<add key="StoreSettlementVatCodes" value="IM1=25;IM2=15;IM3=0" />
<add key="StoreSettlementEnabledItemTransactionTypes" value="Breakage,Inventory" />

Multi-Currency Border Store

<add key="SettlementType" value="Store, Operator" />
<add key="StoreSettlementEnableCurrencyBalance" value="true" />
<add key="StoreSettlementEnablePaymentCardInCurrency" value="true" />
<add key="StoreSettlementEnableCashInCurrency" value="true" />
<add key="StoreSettlementEnableDeliveredBalanceInCurrency" value="true" />

Grocery Store with Online Orders and Deposit System

<add key="StoreSettlementGroceriesOnlinePriceChannel" value="ShopAndGoCheckTerminal" />
<add key="StoreSettlementGroceriesOnlineVatRates" value="IC1=25.00;IC2=15.00;IC3=0.00" />
<add key="StoreSettlementDepositRefundOutItemGroups" value="1,8" />
<add key="StoreSettlementDepositRefundVatRates" value="1=25.0;2=0.0" />
<add key="StoreSettlementAutomaticDepositRefundEans" value="7035620001017,7035620001024" />
<add key="StoreSettlementReasonDateItemSales" value="BESTBEFORE,EXPIRY" />

24-Hour Fuel Station

<add key="StoreSettlementTimeOffset" value="6:00" />
<add key="StoreSettlementDelayedPaymentReasonAndActionCodes" value="(16,11)" />
<add key="StoreSettlementDelayedPaymentVatRates" value="IZ1=25.0;IZ2=15.0" />
<add key="StoreSettlementCashDrawerTenderControlTypes" value="Drop,PayedIn,PayedOut,Float" />

Co-op Store with Member Programs and Lottery

<add key="StoreSettlementRebateOwnMemberVatRates" value="25,15,0" />
<add key="StoreSettlementRebateForeignMemberVatRates" value="25,15" />
<add key="StoreSettlementEnableLottery" value="true" />
<add key="StoreSettlementPrizePayoutVatRates" value="IP1=0.0" />
<add key="StoreSettlementPrizePayoutItemGroups" value="50,51,52" />

Retail Chain with Supplier Kickbacks and Gift Cards

<add key="StoreSettlementEnableKickBack" value="true" />
<add key="StoreSettlementGiftCardTypesCodes" value="GIFT01,EGIFT01,FOREIGN01" />
<add key="StoreSettlementHasDiscountReasonCodes" value="true" />

...

Validation Checklist

Before Deploying Configuration Changes:

Configuration File Syntax:

  • ☑ All parameters use correct XML syntax
  • ☑ Quotation marks properly paired
  • ☑ Semicolons and commas in right places

Parameter Values:

  • ☑ VAT rates match legal requirements
  • ☑ Reason/action code pairs exist in database
  • ☑ Item group numbers are valid
  • ☑ Price channel keys match system values
  • ☑ EAN codes for deposit refunds are correct
  • ☑ Gift card type codes match system configuration

Directory and Permissions:

  • ☑ Output directory exists
  • ☑ Service account has write permission
  • ☑ Sufficient disk space available

Testing:

  • ☑ Test in development environment first
  • ☑ Compare output with manual calculations
  • ☑ Verify all expected codes appear
  • ☑ Check totals match POS reports
  • ☑ Test new parameters (lottery, kickback, gift cards, dated items, member rebates)

...

Version History

Document Version: 2.0 (Updated with 8 New Parameters)
Last Updated: November 2025
Applicable to: POS Services StoreSettlement Worker
Configuration Files: App.config, POSServices.Workers.exe.config

...