A valid request URL is required to generate request examples{
"ticketCount": 2,
"grossSalesCents": 7200,
"basketAverageCents": 3600,
"unitsSold": 4,
"vatTotalCents": 1200,
"topProducts": [
{
"skuId": "sku-espresso-1kg",
"unitsSold": 4,
"grossCents": 7200
}
]
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"statusCode": 123,
"fieldErrors": [
{
"field": "<string>",
"message": "<string>"
}
]
}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"statusCode": 123
}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"statusCode": 123
}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"statusCode": 123
}
}Summarise sales into dashboard KPIs
Rolls a period’s finalized sale tickets (ventes) up into the dashboard KPIs: ticket count, gross TTC sales (chiffre d’affaires), basket average, units sold, VAT total (TVA) and the top-selling products. Pass ?period= (e.g. today (default) / all) and an optional ?store= to narrow to one store; without a store it aggregates across every store. Money is integer cents. For the per-ticket rows use the list operation.
A valid request URL is required to generate request examples{
"ticketCount": 2,
"grossSalesCents": 7200,
"basketAverageCents": 3600,
"unitsSold": 4,
"vatTotalCents": 1200,
"topProducts": [
{
"skuId": "sku-espresso-1kg",
"unitsSold": 4,
"grossCents": 7200
}
]
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"statusCode": 123,
"fieldErrors": [
{
"field": "<string>",
"message": "<string>"
}
]
}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"statusCode": 123
}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"statusCode": 123
}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"statusCode": 123
}
}Authorizations
Authorization: Bearer <token>. Accepts EITHER a Keycloak access token (scopes-in-token) OR an opaque POS session token; both resolve to the same pos.* scope vocabulary the route guards enforce.
Query Parameters
Reporting window for the chiffre d'affaires roll-up: today (default) or all.
Narrow the KPI roll-up to one store by its canonical store id; omit for the network.
Response
The aggregated sales KPIs plus the top sellers.
The aggregated sales KPIs plus the top sellers.
-9007199254740991 <= x <= 9007199254740991-9007199254740991 <= x <= 9007199254740991-9007199254740991 <= x <= 9007199254740991-9007199254740991 <= x <= 9007199254740991-9007199254740991 <= x <= 9007199254740991Show child attributes
Show child attributes

