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).

...

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

...

Feature Enable/Disable Parameters

StoreSettlementEnableNonsale

...

Impacted Code(s): IV1-IV9 (with reason code breakdown)

...

Item Transaction Parameters

StoreSettlementEnabledItemTransactionTypes

...

Impacted Code(s): IV1 (Breakage), IV2 (InternalUse), IV3 (DockingArea), IV4 (StockAdjustment), IV5 (Inventory), IV6 (InternalTransfer), IV7 (Return), IV8 (Complaint), IV9 (Shrinkage)

...

VAT and Tax Parameters

StoreSettlementVatCodes

Purpose: Maps internal settlement codes to VAT/tax rates used in your country.

...

Impacted Code(s): IW1-IW5

...

Reason and Action Code Parameters

StoreSettlementBreakageReasonAndActionCodes

...

Impacted Code(s): I01-I99, U01-U99

...

Payment and Card Parameters

StoreSettlementCreditPaymentIssuerIds

...

Impacted Code(s): C01-C99

...

Coupon and Value Code Parameters

StoreSettlementCouponTypes

...

Impacted Code(s): Value code balance calculations

...

Deposit and Refund Parameters

StoreSettlementDepositRefundOutItemGroups

...

Impacted Code(s): IUP, IIP, IA1-IA5, IB1-IB5

...

Prize Payout Parameters

StoreSettlementPrizePayoutItemGroups

...

Impacted Code(s): IP1-IP5, IPR

...

Cash Drawer and Control Parameters

StoreSettlementCashDrawerTenderControlTypes

...

Impacted Code(s): IDR, IKI, IIN, IUT, INS, IBL, IQP, IEP

...

Price Channel Parameters

StoreSettlementGroceriesOnlinePriceChannel

...

Impacted Code(s): IC1-IC5

...

Operator and Cashier Parameters

StoreSettlementUnknownCashierNumber

...

Impacted Code(s): All operator-level codes when operator is missing

...

Complete Settlement Code Reference

Code RangeDescription
K01-K99Payment by credit/debit card type
B01-B99Balance per tender type (counted/registered)
S01-S99Sales per tender type (cash, card, check, etc.)
IM1-IM4Sales grouped by VAT rate (main VAT reporting)
IA1-IA5Deposit refunds IN by VAT rate
IB1-IB5Deposit fees OUT by VAT rate
IZ1-IZ5Delayed payment by VAT rate
IP1-IP5Prize payout by VAT rate
IC1-IC5Groceries online by VAT rate
IW1-IW5Webshop sales by VAT rate
IV1-IV9Item transactions (breakage, inventory, etc.)
IDR, IKI, IIN, IUTCash management (drop, paid in/out)
INONonSale total
N00-N99NonSale turnover by type
IKUNumber of customers
IVANumber of items sold
IREReturns
IRM, IRK, IRPDiscounts by type
IGK, IG1Gift cards (own/foreign)
Q01-Q99Coupon types
R01-R99Alternative payment types
S01-S99SoftPay card types
C01-C99CoopPay card types
NO1-NO2, SE1-SE2, etc.Currency breakdown codes
CNO, CSE, CEU, COTCash by currency
IVI, IVUInbound/outbound change fund
INGGrand total (EOBD)
IRC, IRSFallback codes

...

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
StoreSettlementHasItemTransactionReasonCodesfalseIV1-IV9 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
StoreSettlementCouponTypesEmptyQ01-Q99
StoreSettlementPaymentCardTypesEmptyR01-R99
StoreSettlementPaymentCardsSEmptyS01-S99
StoreSettlementPaymentCardsCEmptyC01-C99
StoreSettlementPrizePayoutItemGroupsEmptyIP codes
StoreSettlementDepositRefundOutItemGroupsEmptyIUP, IIP, IA/IB codes
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

<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" />

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" />

...

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

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

...

Version History

Document Version: 1.0 (Confluence-Optimized)
Last Updated: 2025
Applicable to: POS Services StoreSettlement Worker
Configuration Files: App.config, POSServices.Workers.exe.config

...