Platform Overview

Architecture

┌─────────────────────┐         ┌──────────────────────────────┐
│  External System    │  JSON   │  Your Ekomium Instance       │
│  (your integration) │ ─RPC──▶ │  your-company.ekomium.com    │
└─────────────────────┘         │                              │
                                │  ┌──────────┐  ┌──────────┐  │
                                │  │ POS      │  │ Inventory│  │
                                │  │ Sales    │  │ Catalog  │  │
                                │  └──────────┘  └──────────┘  │
                                │  … other ERP modules …       │
                                │         PostgreSQL DB         │
                                └──────────────────────────────┘

Ekomium hosts client instances on a managed cloud infrastructure (Kubernetes, PostgreSQL, Redis, secure ingress). Modules are activated and tailored per client: retail, hospitality, services, and other sectors.

Relevant Ekomium models (POS API)

This API documentation covers POS-related resources. Other ERP modules (accounting, HR, etc.) use the same JSON-RPC foundation but are outside the current scope.

Ekomium API resource	Platform model	Description
Sales / Tickets	pos.order	Completed POS orders
Order lines	pos.order.line	Products sold per order
Payments	pos.payment	Payment method & amount
Refunds	pos.order (is_refund=True)	Refund tickets
Cancellations	pos.order (state=cancel)	Cancelled orders
Session closures	pos.session (state=closed)	Cash register closing
Catalog	product.template	Products available in POS
POS Config	pos.config	Register / terminal identifier

Your instance

When Ekomium provisions your environment, you receive:

• A unique instance URL (subdomain on *.ekomium.com or custom domain)
• A database name and integration user credentials
• The modules enabled for your contract (POS, stock, accounting, etc.)

Contact your Ekomium account manager to obtain credentials and confirm which endpoints are available on your instance.