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

# List deposits (acomptes)

> Returns one page of the special-order down-payments (acomptes), optionally narrowed by `store` and/or `status` (open | settled). Use `page`/`pageSize` (max 100) to walk the result; `total`/`pageCount` tell you when to stop.



## OpenAPI

````yaml /openapi.json get /v1/deposits
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/deposits:
    get:
      tags:
        - Checkout
      summary: List deposits (acomptes)
      description: >-
        Returns one page of the special-order down-payments (acomptes),
        optionally narrowed by `store` and/or `status` (open | settled). Use
        `page`/`pageSize` (max 100) to walk the result; `total`/`pageCount` tell
        you when to stop.
      operationId: listDeposits
      parameters:
        - schema:
            type: string
          in: query
          name: store
          required: false
          description: Narrow to one store's deposits (acomptes) by store id.
        - schema:
            type: string
            enum:
              - open
              - settled
          in: query
          name: status
          required: false
          description: 'Filter by lifecycle status: open | settled.'
        - schema:
            type: integer
            minimum: 0
            exclusiveMinimum: true
            maximum: 9007199254740991
          in: query
          name: page
          required: false
          description: 1-based page number (default 1).
        - schema:
            type: integer
            minimum: 0
            exclusiveMinimum: true
            maximum: 100
          in: query
          name: pageSize
          required: false
          description: Rows per page, max 100 (default 20).
      responses:
        '200':
          description: A page of deposits with the pagination totals.
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        orderId:
                          type: string
                        customerId:
                          type: string
                        storeId:
                          type: string
                        currency:
                          type: string
                        orderTotalCents:
                          type: integer
                          minimum: 0
                          exclusiveMinimum: true
                          maximum: 9007199254740991
                        payments:
                          type: array
                          items:
                            type: object
                            properties:
                              amountCents:
                                type: integer
                                minimum: 0
                                exclusiveMinimum: true
                                maximum: 9007199254740991
                              at:
                                type: string
                            required:
                              - amountCents
                              - at
                            additionalProperties: false
                        status:
                          type: string
                          enum:
                            - open
                            - settled
                        actorId:
                          type: string
                        createdAt:
                          type: string
                      required:
                        - id
                        - orderId
                        - customerId
                        - storeId
                        - currency
                        - orderTotalCents
                        - payments
                        - status
                        - actorId
                        - createdAt
                      additionalProperties: false
                  total:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                  page:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                  pageSize:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                  pageCount:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                required:
                  - items
                  - total
                  - page
                  - pageSize
                  - pageCount
                additionalProperties: false
                description: A page of deposits with the pagination totals.
                example:
                  items:
                    - id: dep-ok
                      orderId: order-1
                      customerId: cust-1
                      storeId: shop-1
                      currency: EUR
                      orderTotalCents: 100000
                      payments:
                        - amountCents: 30000
                          at: '2026-07-28T09:00:00.000Z'
                      status: open
                      actorId: user-cashier-1
                      createdAt: '2026-07-28T09:00:00.000Z'
                  total: 1
                  page: 1
                  pageSize: 20
                  pageCount: 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'
        '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.

````