Skip to main content

17 docs tagged with "external-events"

View all tags

Cash balance format

The format of cash-balance: one message per tenant and business date, with the cash expected to remain in the drawers and cash changers of each store, per currency.

Cash Management

Cash Management keeps the balance of each store's safe per currency, books every cash movement in and out of it, checks the safe in a daily safe audit, and publishes every movement so that an ERP or accounting system can follow the store's cash.

External Events

The event Goods Received publishes when a delivery is approved, and how to consume it correctly

External Events

Subscribing to Hii Retail stock events as an external system — stock level updates, processed transactions, delivery semantics and the published schemas

General Ledger

General Ledger turns every sale, return and payment in your stores into accounting entries, adds them up per store and business day, and sends the result to your accounting system.

General ledger format

The JSON schema of a General Ledger journal event (gle.public.event.general-ledger.v1).

Receiving the events

The Cash Management events you can subscribe to through External Events, what each one means, and the rules for consuming them: duplicates, order, direction, levels and changes, and the business date.

Receiving the events

The Reconciliation events you can subscribe to through External Events, what each one means, and the rules for consuming them: duplicates, order, levels and deltas.

Receiving the journals

Subscribing to General Ledger journals through External Events or Pub/Sub, and the rules an accounting integration must follow: post every journal, skip duplicates by journal ID, and never replace a day with its latest journal.

Reconciliation

Reconciliation keeps a running total of the cash every till drawer should hold, checks the count that store staff make against the deviation you allow, and closes each store's day with a summary that your own systems can receive.

Reconciliation change shift format

The format of reconciliation-change-shift: a completed till audit's counts in time order, one per shift, with the deviation per tender at the count (deviationAmount) and within the shift (deviationAmountInShift).

Reconciliation end of day format

The format of reconciliation-end-of-day: one store and business date, with the day's totals per tender and item and the change since the previous summary of the same day in the fields ending in Delta.

Reconciliation recount format

The format of reconciliation-recount: a recount of a completed till audit, with each tender's and item's correction against the previous count.

Safe audit format

The format of safe-audits: one message per submitted safe audit, with the counted and calculated amounts per currency.

Transactions format

The format of transactions: one message per movement into or out of a store's safe, with one line per currency and the safe's balance after it.