Configuration
Cash Management is configured in Customer Controlled Configuration, through the Hii Retail Config Portal or its API. Settings apply per store. A value set higher in the business unit tree, such as for the whole tenant or a group of stores, applies to every store below it that has no value of its own. Values set for a single workstation are ignored: the safe belongs to the store.
Every setting has a default in Customer Controlled Configuration. A store that never changes a setting runs with its default, shown in the tables below.
Tender limits
cmm.tender-configs.v1 holds one entry per tender, set per store. Its default is an empty list: no limits. Each entry is
the tender's id and a config object:
| Field | Meaning | When not set |
|---|---|---|
maxAllowedAmountInSafe | the most cash of this currency the safe may hold. Shown as Max amount in safe in the safe audit; above it, a bank drop is asked for. | no maximum, and no bank drop is asked for |
minAmountBankDeposit | the smallest bank drop worth sending. Hii InStore suggests at least this much. | no minimum |
maxAllowedDeviationAmount | how far Cash in safe may differ from the expected amount before the manager must explain it in a comment | no comment is asked for |
When a store has several cash tenders in the same currency, such as notes and coins set up separately, the safe audit
uses the highest maxAllowedAmountInSafe and maxAllowedDeviationAmount and the lowest minAmountBankDeposit among
them.
Safe-audit settings
| Setting | Values | Effect | Default |
|---|---|---|---|
cmm.show-total-balance-in-safe-audit.v1 | showTotalBalanceInSafeAudit: true, false | show the Total balance line in Hii InStore's safe audit | true |
cmm.show-max-allowed-amount-in-safe-audit.v1 | showMaxAllowedAmountInSafeAudit: true, false | show the Max amount in safe line | true |
cmm.do-reset-safe-audit-when-submitted.v1 | doResetSafeAuditWhenSubmitted: true, false | true: an audit covers everything since the previous audit. false: it covers the current business date. See Which period an audit covers. | false |
cmm.safe-audits-dynamic-properties.v1 | dynamicProperties: a list of fields | the tenant's own amount fields in the safe audit | no fields |
The two show settings change only what Hii InStore displays. The API returns every amount either way.
Each entry in dynamicProperties has:
| Field | Meaning |
|---|---|
id | required. Identifies the field, and becomes the event type of the transaction the field books. |
name | required. The label on the screen. |
isNegativeSignByDefault | the amount entered is taken as negative |
sortOrderKey | the field's place on the screen, lowest first |
Settings owned by other services
| Setting | Owner | What Cash Management takes from it |
|---|---|---|
che.tender | the tender configuration | each tender's currency and classCode. Only CASH and FOREIGNCURRENCY tenders reach the safe. |
rco.reason-codes.v1 | Reason Codes | the reason codes a negative bank deposit or withdrawal may carry: those whose groups include CashManagement |
| the business-day offset | Business Unit Management | the business date |
Symptom → setting to check
| Symptom | Check |
|---|---|
| The safe's balance does not move when tills are counted | the store has a safe; the cash tenders have classCode CASH or FOREIGNCURRENCY and a currency; Reconciliation is set up for the store |
| One currency is missing from the safe | that currency's tender exists in che.tender with a cash type and the currency set |
| The safe audit never asks for a bank drop | maxAllowedAmountInSafe in cmm.tender-configs.v1 for the currency's tender |
| The suggested bank drop is larger than the excess | minAmountBankDeposit: Hii InStore suggests at least that much |
| Every deviation, however small, asks for a comment | maxAllowedDeviationAmount is set to 0 |
| A day's till cash is shown twice, or a skipped day's cash is missing from Cash from till audits | cmm.do-reset-safe-audit-when-submitted.v1 |
| A negative bank deposit is refused with "reason code is invalid" | the reason code in rco.reason-codes.v1 for the store, with CashManagement in its groups |
| A bank deposit just after midnight lands on the wrong business date | the business-day offset on the business unit in Business Unit Management |