Aller au contenu principal

Sales & Tickets

Retrieve POS sales tickets with date/time, total amount, and payment methods.

Endpoint

GET /api/v1/sales

Ekomium model: pos.order · Method: search_read

Fields returned

FieldTypeDescription
idintegerOrder ID
namestringTicket reference (e.g. POS/00001)
date_orderdatetimeSale date & time
amount_totalfloatTotal incl. tax (local currency)
amount_paidfloatAmount paid
amount_taxfloatTax amount
statestringdraft, paid, done, cancel, invoiced
config_id[id, name]POS register
session_id[id, name]POS session
payment_ids[ids]Linked payment records

Example request

import requests

url = "https://your-company.ekomium.com/jsonrpc"
payload = {
"jsonrpc": "2.0",
"method": "call",
"params": {
"service": "object",
"method": "execute_kw",
"args": [
"your_database", UID, PASSWORD,
"pos.order", "search_read",
[[["date_order", ">=", "2026-09-01 00:00:00"]]],
{
"fields": [
"id", "name", "date_order", "amount_total",
"amount_paid", "state", "config_id", "payment_ids"
],
"limit": 50,
"order": "date_order desc"
}
]
},
"id": 1
}
response = requests.post(url, json=payload)
orders = response.json()["result"]

Example response

[
{
"id": 1,
"name": "POS/00001",
"date_order": "2026-09-12 14:30:00",
"amount_total": 16.0,
"amount_paid": 16.0,
"amount_tax": 0.0,
"state": "done",
"config_id": [1, "Main Register"],
"session_id": [1, "POS/00001"],
"payment_ids": [1]
}
]

Resolve payment methods

Fetch payment details from payment_ids:

"pos.payment", "read", [payment_ids], {"fields": ["amount", "payment_method_id", "payment_date"]}
FieldDescription
payment_method_id[id, "Espèces"] or [id, "Carte bancaire"]
amountPayment amount
payment_datePayment timestamp

Filters

FilterDomain
By date range[["date_order", ">=", from], ["date_order", "<=", to]]
By POS config[["config_id", "=", CONFIG_ID]]
By session[["session_id", "=", SESSION_ID]]

Test in API Playground →