Ekomium Company API
:::info Documentation v1.0.0 Last updated September 12, 2026. See About this documentation for version history and scope. :::
Welcome to the Ekomium Company API documentation. This API enables third-party systems to integrate with Ekomium ERP instances hosted and managed by Ekomium.
What is Ekomium?
Ekomium is a company that helps businesses automate, optimize, and digitize their operations. Ekomium delivers this through a modular ERP platform: a suite of interconnected applications (Point of Sale, inventory, accounting, CRM, and more) that Ekomium configures and customizes to each client's industry and needs.
Each client receives a dedicated hosted instance (e.g. https://your-company.ekomium.com) with its own database, users, and activated modules. Ekomium manages hosting, updates, and security so your team can focus on integration and business logic.
The Ekomium Company API documented here exposes Point of Sale (POS) data through a standardized REST-like interface, implemented on top of Ekomium's native JSON-RPC protocol. Additional module APIs may be documented separately as they become available.
Use cases
Integrate your external system to:
- Sync sales & tickets: date/time, amount, payment method
- Read order lines: product, quantity, price, discount
- Track refunds, cancellations & cash closures
- Import the product catalog
- Identify POS registers by configuration ID
Quick start
- Read Platform Overview to understand the architecture
- Set up Authentication
- Explore the API Reference
- Test live in the API Playground
Base URL
Your Ekomium team provides the base URL for your instance when onboarding.
| Item | Value |
|---|---|
| Instance URL | https://your-company.ekomium.com |
| JSON-RPC endpoint | POST /jsonrpc |
| Database name | Provided by Ekomium (e.g. production) |
Protocol
All data endpoints use Ekomium JSON-RPC 2.0. The API maps logical REST paths to platform model operations for clarity. See API Overview for the full mapping.