> ## 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. # Report the period close > Returns the period-close aggregate — the overall cash-variance summary plus a per-store breakdown — over the same register-session projection. Optionally narrow by `from` / `to` (`YYYY-MM-DD`, inclusive; `from <= to`) and `store`. A malformed or inverted period returns 400. ## OpenAPI ````yaml /openapi.json get /v1/finance/period-close 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/finance/period-close: get: tags: - Finance summary: Report the period close description: >- Returns the period-close aggregate — the overall cash-variance summary plus a per-store breakdown — over the same register-session projection. Optionally narrow by `from` / `to` (`YYYY-MM-DD`, inclusive; `from <= to`) and `store`. A malformed or inverted period returns 400. operationId: periodCloseReport 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 overall summary and the per-store slices. content: application/json: schema: type: object properties: from: nullable: true type: string to: nullable: true type: string store: nullable: true type: string overall: type: object properties: sessionCount: type: integer minimum: -9007199254740991 maximum: 9007199254740991 countedCount: type: integer minimum: -9007199254740991 maximum: 9007199254740991 uncountedCount: type: integer minimum: -9007199254740991 maximum: 9007199254740991 balancedCount: type: integer minimum: -9007199254740991 maximum: 9007199254740991 shortageCount: type: integer minimum: -9007199254740991 maximum: 9007199254740991 overageCount: type: integer minimum: -9007199254740991 maximum: 9007199254740991 openingFloatCents: type: integer minimum: -9007199254740991 maximum: 9007199254740991 expectedCashCents: type: integer minimum: -9007199254740991 maximum: 9007199254740991 countedCashCents: type: integer minimum: -9007199254740991 maximum: 9007199254740991 netVarianceCents: type: integer minimum: -9007199254740991 maximum: 9007199254740991 shortageCents: type: integer minimum: -9007199254740991 maximum: 9007199254740991 overageCents: type: integer minimum: -9007199254740991 maximum: 9007199254740991 required: - sessionCount - countedCount - uncountedCount - balancedCount - shortageCount - overageCount - openingFloatCents - expectedCashCents - countedCashCents - netVarianceCents - shortageCents - overageCents additionalProperties: false byStore: type: array items: type: object properties: store: type: string summary: type: object properties: sessionCount: type: integer minimum: -9007199254740991 maximum: 9007199254740991 countedCount: type: integer minimum: -9007199254740991 maximum: 9007199254740991 uncountedCount: type: integer minimum: -9007199254740991 maximum: 9007199254740991 balancedCount: type: integer minimum: -9007199254740991 maximum: 9007199254740991 shortageCount: type: integer minimum: -9007199254740991 maximum: 9007199254740991 overageCount: type: integer minimum: -9007199254740991 maximum: 9007199254740991 openingFloatCents: type: integer minimum: -9007199254740991 maximum: 9007199254740991 expectedCashCents: type: integer minimum: -9007199254740991 maximum: 9007199254740991 countedCashCents: type: integer minimum: -9007199254740991 maximum: 9007199254740991 netVarianceCents: type: integer minimum: -9007199254740991 maximum: 9007199254740991 shortageCents: type: integer minimum: -9007199254740991 maximum: 9007199254740991 overageCents: type: integer minimum: -9007199254740991 maximum: 9007199254740991 required: - sessionCount - countedCount - uncountedCount - balancedCount - shortageCount - overageCount - openingFloatCents - expectedCashCents - countedCashCents - netVarianceCents - shortageCents - overageCents additionalProperties: false required: - store - summary additionalProperties: false required: - from - to - store - overall - byStore additionalProperties: false description: The overall summary and the per-store slices. example: from: null to: null store: null overall: sessionCount: 1 countedCount: 1 uncountedCount: 0 balancedCount: 0 shortageCount: 1 overageCount: 0 openingFloatCents: 20000 expectedCashCents: 157000 countedCashCents: 156500 netVarianceCents: -500 shortageCents: 500 overageCents: 0 byStore: - store: store-bastille summary: sessionCount: 1 countedCount: 1 uncountedCount: 0 balancedCount: 0 shortageCount: 1 overageCount: 0 openingFloatCents: 20000 expectedCashCents: 157000 countedCashCents: 156500 netVarianceCents: -500 shortageCents: 500 overageCents: 0 '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. ````