Skip to main content

42 docs tagged with "integration"

View all tags

B2B Customer Registry

The B2B Customer Registry (CRS) holds your business customers, the trusted agents who buy on their behalf and their projects, per tenant and optionally per business unit group.

Business Partner

The register of the suppliers and manufacturers a tenant trades with: one record per party, a set of roles, pushed from the ERP and published as events.

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.

Connecting your system

The endpoint your system must expose for Order Response to read, how Hii Retail authenticates to it, and what it must return.

Currency

Currency holds the list of the world's currencies with their coins and notes, records which currencies each store takes, and tells the other Hii Retail services when that changes.

Currency API

For ERP integrations and Hii Retail clients: switching a currency on or off for the whole company or one store, reading which currencies a store takes, and reading the currency list and its coins and notes.

Data sources

Every way a delivery reaches Goods Received, and the Hii Retail services it depends on to resolve items, stores and reason codes

Data sources

Everything Stock Count reads — stock levels from STP, items and saved searches from PnP, stores from Business Unit Management, settings from CCC — and the API it is driven through.

Data sources

Where Stock Transaction Processing gets its data — PosLog sales from the POS, events from other Hii Retail services, item master data from PnP, and the Input API

Events

The business-partner-changed and warehouse-supply-terms-changed events: payloads, attributes, and how to deduplicate, order and apply them.

Events

The stock correction event, its payload and attributes, what a consumer must handle, and how Stock Transaction Processing applies it.

Events

The two events Stock Count publishes — stock count completed and stock count changed — their payloads and attributes, and what a consumer must handle.

Events

The two events Store Transfer publishes, their payloads, and what a consumer needs to handle.

Exchange Rates

Exchange Rates keeps the exchange rates every store uses, from the customer's ERP, from the European Central Bank every night or set by hand, and tells the other Hii Retail services when a store's rates change.

Exchange Rates API

For ERP integrations and Hii Retail clients: setting and deleting a rate for the whole company or one store, reading the rates and markups each store uses, and what an ERP moving from Currency & Exchange Rates changes.

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

External ingest

Push customers, trusted agents and projects from your own back office into the B2B Customer Registry (CRS), keyed by your own ids.

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.

GS1 field reference

The Hii Retail profile of the GS1 despatch advice — which elements are required, which are ignored, and how each maps to a delivery

GS1 import

How an external ERP, OMS or WMS sends a delivery note into Hii Retail as a GS1 despatch advice, and what the import accepts

GS1 XML example

A complete, known-good GS1 despatch advice document for Goods Received, with each section explained

How it works

The path a correction takes from the shop floor to the system that owns the stock figure, and what Stock Corrections deliberately does not do.

Messages to other services

The Pub/Sub messages Currency sends when a store's currencies change and when a currency's coins and notes are needed, how to receive them correctly, and how to get the current state sent again.

Messages to other services

The Pub/Sub message Exchange Rates sends when a store's rates change, how to read a rate in it, how to receive it correctly, and how to get the current state sent again.

Messages to other services

The Pub/Sub message Tax Rules sends when a country's rules change: when it is sent, what it holds, its attributes, and how to receive it correctly.

Proxy configuration

Tell the B2B Customer Registry where your own system is and how to sign in to it, so it can validate credit limits and create customers there.

Proxy configuration

One place to tell the Hii Retail logistics services where your own system is, and how to sign in to it, when they should answer from it instead of from Hii Retail's data.

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.

Stock Corrections

Recording deliberate stock adjustments — damage, theft, expiry, write-offs — and publishing them as events for whichever system owns the stock figure.

Stock Count

Counting the stock in a store with the Hii Retail Inventory app, and publishing the counted quantities so the stock figure is corrected.

Stock ownership

Which stock setups Stock Count supports — STP as master, an external system synchronizing into STP, or a lookup proxy — and what an external system must do when it owns the quantity.

Synchronizing stock

Running Stock Transaction Processing alongside an external system that owns the stock — full master, synchronized, or a combination

Tax Rules

Tax Rules keeps the tax regions, taxable groups and tax rates of every country Hii Retail supports, one list for every company, maintained by Extenda, and tells the other Hii Retail services when a country's rates change.

Tax Rules API

Reading tax regions and tax rates with the Tax Rules API: the two endpoints, the current rate or the whole list, the fields in a response, and the traps around dates, missing lists and tenant aliases.

Tenant system endpoints

The two endpoints your own system implements so the B2B Customer Registry can validate credit limits and create customers in it.

The API

Every Stock Count endpoint, grouped by what it is for — planning counts, counting, submitting, reading counts and reports, and recurring definitions — and how to call it safely.

What Cash Management receives

Everything Cash Management reads from other Hii Retail services: Reconciliation's cash movements, the tender list, your settings and reason codes, the business-day offset, and what must be in place before a store starts trading.

What Reconciliation receives

Everything Reconciliation reads: the tills' transactions, your settings, the tender list, denominations and business units, and what must be in place before a store starts trading.