> ## 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.

# Close (lock) a fiscal period

> LOCKS a fiscal period, sealing its cash truth so it can no longer be re-opened or re-stated (201). Address the period by an opaque `periodKey` (e.g. `2026-07`, or `2026-07:store-paris` for a per-store close); pass `store` and the inclusive `from` / `to` day window (`YYYY-MM-DD`, `from <= to`) to record the locked span, or omit `store` for a network-wide close. The sealing actor and instant are stamped server-side — a body actor is ignored. IRREVERSIBLE: this is the back-office period-end lock, distinct from the live period-close READ aggregate (`GET /v1/finance/period-close`) and from the NF525 closure chain (`/v1/fiscal/closures`). Idempotent-by-conflict: re-closing an already-locked key 409s (never a silent overwrite). Failure conditions: 400 on a malformed body or an inverted window; 409 when the `periodKey` is already locked.



## OpenAPI

````yaml /openapi.json post /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:
    post:
      tags:
        - Finance
      summary: Close (lock) a fiscal period
      description: >-
        LOCKS a fiscal period, sealing its cash truth so it can no longer be
        re-opened or re-stated (201). Address the period by an opaque
        `periodKey` (e.g. `2026-07`, or `2026-07:store-paris` for a per-store
        close); pass `store` and the inclusive `from` / `to` day window
        (`YYYY-MM-DD`, `from <= to`) to record the locked span, or omit `store`
        for a network-wide close. The sealing actor and instant are stamped
        server-side — a body actor is ignored. IRREVERSIBLE: this is the
        back-office period-end lock, distinct from the live period-close READ
        aggregate (`GET /v1/finance/period-close`) and from the NF525 closure
        chain (`/v1/fiscal/closures`). Idempotent-by-conflict: re-closing an
        already-locked key 409s (never a silent overwrite). Failure conditions:
        400 on a malformed body or an inverted window; 409 when the `periodKey`
        is already locked.
      operationId: closeFinancialPeriod
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                periodKey:
                  type: string
                  minLength: 1
                store:
                  type: string
                  minLength: 1
                from:
                  type: string
                  format: date
                  pattern: >-
                    ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
                to:
                  type: string
                  format: date
                  pattern: >-
                    ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
              required:
                - periodKey
              example:
                periodKey: 2026-07:store-paris
                store: store-paris
                from: '2026-07-01'
                to: '2026-07-31'
      responses:
        '201':
          description: >-
            The locked period record: the key, the store/window, and the sealing
            stamp.
          content:
            application/json:
              schema:
                type: object
                properties:
                  periodKey:
                    type: string
                    minLength: 1
                  store:
                    nullable: true
                    type: string
                    minLength: 1
                  from:
                    nullable: true
                    type: string
                  to:
                    nullable: true
                    type: string
                  closedAt:
                    type: string
                    minLength: 1
                  closedBy:
                    type: string
                    minLength: 1
                required:
                  - periodKey
                  - store
                  - from
                  - to
                  - closedAt
                  - closedBy
                additionalProperties: false
                description: >-
                  The locked period record: the key, the store/window, and the
                  sealing stamp.
                example:
                  periodKey: 2026-07:store-paris
                  store: store-paris
                  from: '2026-07-01'
                  to: '2026-07-31'
                  closedAt: '2026-08-01T02:00:00.000Z'
                  closedBy: manager-1
        '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'
        '409':
          description: >-
            The request conflicts with current state (duplicate id or stale
            version).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: The request is well-formed but violates a domain rule.
          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 <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.

````