> ## 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. # Windowed sales analytics report > Rolls the per-ticket sales read model up into a windowed analytics report for the `Rapports / Analytics` screen: the headline KPIs for the `[from, to]` UTC-day window (`YYYY-MM-DD`), a period-over-period comparison against the immediately-preceding equal-length window (absolute Δ + %, `percent` null when the previous window is empty), and breakdowns by store, by day and by product category. Both `from` and `to` are REQUIRED — a missing or inverted window 400s. Pass an optional `?store=` to narrow. Money is integer cents. ## OpenAPI ````yaml /openapi.json get /v1/reports/sales 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/reports/sales: get: tags: - Finance summary: Windowed sales analytics report description: >- Rolls the per-ticket sales read model up into a windowed analytics report for the `Rapports / Analytics` screen: the headline KPIs for the `[from, to]` UTC-day window (`YYYY-MM-DD`), a period-over-period comparison against the immediately-preceding equal-length window (absolute Δ + %, `percent` null when the previous window is empty), and breakdowns by store, by day and by product category. Both `from` and `to` are REQUIRED — a missing or inverted window 400s. Pass an optional `?store=` to narrow. Money is integer cents. operationId: salesReport parameters: - schema: type: string in: query name: from required: false - schema: type: string in: query name: to required: false - schema: type: string in: query name: store required: false responses: '200': description: >- The windowed report: window, comparison and the store/day/category breakdowns. content: application/json: schema: type: object properties: window: type: object properties: from: type: string to: type: string required: - from - to additionalProperties: false previousWindow: type: object properties: from: type: string to: type: string required: - from - to additionalProperties: false comparison: type: object properties: current: 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 required: - ticketCount - grossSalesCents - basketAverageCents - unitsSold - vatTotalCents additionalProperties: false previous: 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 required: - ticketCount - grossSalesCents - basketAverageCents - unitsSold - vatTotalCents additionalProperties: false grossSalesCents: type: object properties: absolute: type: number percent: nullable: true type: number required: - absolute - percent additionalProperties: false ticketCount: type: object properties: absolute: type: number percent: nullable: true type: number required: - absolute - percent additionalProperties: false unitsSold: type: object properties: absolute: type: number percent: nullable: true type: number required: - absolute - percent additionalProperties: false basketAverageCents: type: object properties: absolute: type: number percent: nullable: true type: number required: - absolute - percent additionalProperties: false required: - current - previous - grossSalesCents - ticketCount - unitsSold - basketAverageCents additionalProperties: false byStore: type: array items: type: object properties: key: type: string metrics: 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 required: - ticketCount - grossSalesCents - basketAverageCents - unitsSold - vatTotalCents additionalProperties: false required: - key - metrics additionalProperties: false byDay: type: array items: type: object properties: key: type: string metrics: 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 required: - ticketCount - grossSalesCents - basketAverageCents - unitsSold - vatTotalCents additionalProperties: false required: - key - metrics additionalProperties: false byCategory: nullable: true type: array items: type: object properties: category: type: string grossCents: type: integer minimum: -9007199254740991 maximum: 9007199254740991 unitsSold: type: integer minimum: -9007199254740991 maximum: 9007199254740991 ticketCount: type: integer minimum: -9007199254740991 maximum: 9007199254740991 required: - category - grossCents - unitsSold - ticketCount additionalProperties: false required: - window - previousWindow - comparison - byStore - byDay - byCategory additionalProperties: false description: >- The windowed report: window, comparison and the store/day/category breakdowns. example: window: from: '2026-07-16' to: '2026-07-16' previousWindow: from: '2026-07-15' to: '2026-07-15' comparison: current: ticketCount: 2 grossSalesCents: 7200 basketAverageCents: 3600 unitsSold: 4 vatTotalCents: 1200 previous: ticketCount: 0 grossSalesCents: 0 basketAverageCents: 0 unitsSold: 0 vatTotalCents: 0 grossSalesCents: absolute: 7200 percent: null ticketCount: absolute: 2 percent: null unitsSold: absolute: 4 percent: null basketAverageCents: absolute: 3600 percent: null byStore: - key: store-report metrics: ticketCount: 2 grossSalesCents: 7200 basketAverageCents: 3600 unitsSold: 4 vatTotalCents: 1200 byDay: - key: '2026-07-16' metrics: ticketCount: 2 grossSalesCents: 7200 basketAverageCents: 3600 unitsSold: 4 vatTotalCents: 1200 byCategory: - category: coffee grossCents: 7200 unitsSold: 4 ticketCount: 2 '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. ````