README

Exports

Cash Management publishes transactions as events to PubSub. Other Hii Retail services, or external system using External Events, can subscribe to these messages.

Transactions

A cash management transaction, is a transaction that affects the safe. When a cash management transaction is created, this is immediately published.

Example

{
    "tenantId": "tenantId",
    "businessUnitId": "businessUnitId",
    "eventId": "e70c9b8c-070b-44f0-b268-3108f6a33805",
    "eventType": "Reconciliation",
    "eventDateTime": "2022-10-28T07:32:29.939Z",
    "correlationId": "237410af-5b85-426a-a813-1459f4abdca3",
    "exportDateTime": "2022-10-28T07:32:33.001689667Z",
    "createdBy": "e504ad5b-6686-4c67-9f9c-9efa70117b3d",
    "workstationId": "327318a7-9905-4c25-9ae9-4f862a2e79f5",
    "operatorId": "68f19997-d1c4-47bc-8539-066918f6a1cf",
    "transactions": [
        {
            "transactionId": "be7659ea-75d4-42f4-a120-74a51f072b94",
            "currencyId": "USD",
            "amount": 100.0,
            "repositoryToBalance": 100.0,
            "repositoryIdTo": "e6d2560c-8919-44bb-ab27-ac984364124e"
        },
        {
            "transactionId": "664cf380-f76e-43dd-866d-fa3064868ff0",
            "currencyId": "EUR",
            "amount": 200.0,
            "repositoryFromBalance": -200.0,
            "repositoryIdFrom": "e6d2560c-8919-44bb-ab27-ac984364124e"
        }
    ]
}

Subscriptions

Tech	Subscription
Pub/Sub	cmm.public.event.transactions.v2
External Events	cmm.transactions.v2

Format

The JSON format for cash management transactions.

Event types

The event types indicates the type of transaction. The following event types are currently supported:

Event type	Description
BankWithdrawal	Bank withdrawal, i.e. transfer cash from bank to safe.
BankDeposit	Bank deposit, i.e. transfer cash from safe to bank.
InitialBalance	Initial balance/float, i.e. starting balance/float for a cash drawer/workstation.
Reconciliation	The counted cash when doing a reconciliation.
ReconciliationRecount	The adjusted cash when doing a reconciliation recount.
Transfer	A transfer, e.g. transfer from safe to cash drawer or a transfer from cash drawer to safe.
Correction	A correction of the safe balance. This is either done when doing a safe count, or when doing a safe audit, and if the counted amount deviates from the system safe balance.

Safe Audit

A safe audit, i.e. cash totals for the business unit like total amount from till audits, total amount in safe, deviations, bank deposit etc.

Format

The JSON format for safe audits.