POS / Cash Register Identifier

Retrieve point of sale configurations. Each config represents a physical register or terminal.

Endpoint

GET /api/v1/pos/configs

Ekomium model: pos.config · Method: search_read

Fields returned

Field	Type	Description
id	integer	POS Config ID, use as register identifier
name	string	Register name (e.g. Main Register)
current_session_id	[id, name]	Active session (if open)
current_session_state	string	opened, opening_control, closed
last_session_closing_date	date	Last closure date
last_session_closing_cash	float	Cash balance at last closure
payment_method_ids	[ids]	Configured payment methods

Example request

"pos.config", "search_read",
[[]],
{
    "fields": [
        "id", "name", "current_session_id", "current_session_state",
        "last_session_closing_date", "last_session_closing_cash",
        "payment_method_ids"
    ]
}

Example response

[
  {
    "id": 1,
    "name": "Main Register",
    "current_session_id": [2, "POS/00002"],
    "current_session_state": "opened",
    "last_session_closing_date": "2026-09-11",
    "last_session_closing_cash": 850.0,
    "payment_method_ids": [1, 2]
  }
]

Using config_id in other endpoints

Filter sales and sessions by register:

GET /api/v1/sales?config_id=1
GET /api/v1/sessions/closures?config_id=1

In Ekomium domain syntax:

[["config_id", "=", 1]]

Payment methods

Resolve payment method names:

"pos.payment.method", "read", [1, 2], {"fields": ["name", "is_cash_count"]}

Returns: Espèces (cash), Carte bancaire (card).

Test in API Playground →