> ## Documentation Index > Fetch the complete documentation index at: https://docs-pos.solya.app/llms.txt > Use this file to discover all available pages before exploring further. # Summarise sales into dashboard KPIs > Rolls a period's finalized sale tickets up into the dashboard KPIs: ticket count, gross TTC sales, basket average, units sold, VAT total 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. ## OpenAPI ````yaml /openapi.json get /v1/sales/summary openapi: 3.0.3 info: title: Solya POS API version: 1.0.0 description: >- The Solya POS backend HTTP surface. Every documented operation is agent-ready: it carries an `operationId`, an agent-facing `description`, the `pos.*` scopes it enforces (`x-required-permissions`) and an `x-agent-tier`. Success responses return the payload as raw JSON; failures return the `ErrorResponse` envelope (`{ error: { code, message, statusCode } }`). servers: - url: / description: The backend, relative to its deployed origin. security: [] paths: /v1/sales/summary: get: tags: - Finance summary: Summarise sales into dashboard KPIs description: >- Rolls a period's finalized sale tickets up into the dashboard KPIs: ticket count, gross TTC sales, basket average, units sold, VAT total 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. operationId: salesSummary parameters: - schema: type: string in: query name: period required: false - schema: type: string in: query name: store required: false responses: '200': description: The aggregated sales KPIs plus the top sellers. content: application/json: schema: type: object properties: ticketCount: type: integer minimum: -9007199254740991 maximum: 9007199254740991 grossSalesCents: type: integer minimum: -9007199254740991 maximum: 9007199254740991 basketAverageCents: type: integer minimum: -9007199254740991 maximum: 9007199254740991 unitsSold: type: integer minimum: -9007199254740991 maximum: 9007199254740991 vatTotalCents: type: integer minimum: -9007199254740991 maximum: 9007199254740991 topProducts: type: array items: type: object properties: skuId: type: string unitsSold: type: integer minimum: -9007199254740991 maximum: 9007199254740991 grossCents: type: integer minimum: -9007199254740991 maximum: 9007199254740991 required: - skuId - unitsSold - grossCents additionalProperties: false required: - ticketCount - grossSalesCents - basketAverageCents - unitsSold - vatTotalCents - topProducts additionalProperties: false description: The aggregated sales KPIs plus the top sellers. example: ticketCount: 2 grossSalesCents: 7200 basketAverageCents: 3600 unitsSold: 4 vatTotalCents: 1200 topProducts: - skuId: sku-espresso-1kg unitsSold: 4 grossCents: 7200 '400': description: >- The request failed schema validation; `error.fieldErrors` lists the fields. content: application/json: schema: $ref: '#/components/schemas/ValidationErrorResponse' '401': description: No valid credential was presented — send a bearer token. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: The actor is authenticated but lacks the required `pos.*` scope. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '500': description: An unexpected server error — safe to retry idempotent requests. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - bearerAuth: [] components: schemas: ValidationErrorResponse: type: object required: - error additionalProperties: false description: >- A `VALIDATION_FAILED` envelope carrying the offending fields in `fieldErrors`. properties: error: type: object required: - code - message - statusCode additionalProperties: false properties: code: type: string enum: - VALIDATION_FAILED message: type: string statusCode: type: integer fieldErrors: type: array description: >- One entry per rejected field: the field path and why it was rejected. items: type: object required: - field - message additionalProperties: false properties: field: type: string description: Dot-path of the offending field. message: type: string description: Why the field was rejected. ErrorResponse: type: object required: - error additionalProperties: false description: The uniform failure envelope every non-2xx response returns. properties: error: type: object required: - code - message - statusCode additionalProperties: false properties: code: type: string enum: - VALIDATION_FAILED - UNAUTHORIZED - FORBIDDEN - NOT_FOUND - CONFLICT - BUSINESS_RULE_VIOLATION - INTERNAL_ERROR description: >- Machine-readable kernel `ResultCode` — branch on this, not on `message`. message: type: string description: >- Human-readable explanation. Safe to surface; never leaks server internals. statusCode: type: integer description: >- The HTTP status, mirrored into the body so a client need not read headers. securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT description: >- `Authorization: Bearer `. 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. ````