Use cases

The aim of the ERP-API is to be useful for implementing use cases related to ERP, specfically in the "Retail" vertical.

Initially, the API will only support a small set of use cases:

  • Import and update of sales item master data
  • Notification about and fetching of invoice information

Import and update of sales item master data

A main use case for the ERP-API is the import and update of sales item master data. The use case assumes that the external system (e.g., SAP, Dynamics) has ownership of the data and that the enfore platform is subordinate to the external system.

Therefore, when an update request conflicts with a change made on the enfore platform's side, the enfore-side change will be overruled by the external change.

Notification about and fetching of invoice information

Another core use case is based on the usage of the enforePOS devices as a cash registers. Sales performed via the enforePOS devices result in invoice data being generated in the enfore platform (cf. MetaCompany "Ledger" module). The invoice data generated in the enfore platform must then be copied into the external ERP system.

For that, the ERP-API will provide the functionality to subscribe to an "invoice data available" event as well as a way to fetch the new invoice data.

Sequence diagram: Notification and fetch

Notification about and fetching of credit memo information

Another core use case is based on the usage of the enforePOS devices as a cash registers. Voids or sales returns performed via the enforePOS devices result in credit memo data being generated in the enfore platform (cf. MetaCompany "Ledger" module). The credit memo data generated in the enfore platform must then be copied into the external ERP system.

For that, the ERP-API will provide the functionality to subscribe to an "credit memo data available" event as well as a way to fetch the new credit memo data.