> ## Documentation Index
> Fetch the complete documentation index at: https://muveya.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Listar saldos de inventario

> Lista los saldos de existencias por caja en toda la clínica dental, con paginación keyset por id de caja y filtros opcionales por catalogItemId o warehouseId. Requiere inventory:read.



## OpenAPI

````yaml /openapi.es.json get /v1/inventory/balances
openapi: 3.1.0
info:
  description: >-
    La API pública para desarrolladores de Muveya: recursos /v1 de solo lectura,
    limitados a un tenant y autenticados con una clave de API opaca. Un
    presupuesto de solicitudes por clave.
  title: API para desarrolladores de Muveya
  version: 0.1.0
servers:
  - description: Producción
    url: https://api.muveya.com
security: []
tags:
  - name: Clave de API
  - name: Clínicas
  - name: Bodegas
  - name: Catálogo
  - name: Inventario
  - name: Pedidos
  - name: Entregas
  - name: Analítica
paths:
  /v1/inventory/balances:
    get:
      tags:
        - Inventario
      summary: Listar saldos de inventario
      description: >-
        Lista los saldos de existencias por caja en toda la clínica dental, con
        paginación keyset por id de caja y filtros opcionales por catalogItemId
        o warehouseId. Requiere inventory:read.
      operationId: listInventoryBalances
      parameters:
        - name: limit
          in: query
          required: false
          description: Tamaño de página, de 1 a 200 (por defecto 50).
          schema:
            type: integer
            minimum: 1
            maximum: 200
        - name: cursor
          in: query
          required: false
          description: Cursor keyset opaco tomado del nextCursor de una página anterior.
          schema:
            type: string
        - name: catalogItemId
          in: query
          required: false
          description: Filtra los saldos a un insumo del catálogo.
          schema:
            type: string
        - name: warehouseId
          in: query
          required: false
          description: Filtra los saldos a una bodega.
          schema:
            type: string
      responses:
        '200':
          description: La página de recursos solicitada.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: false
                required:
                  - data
                  - hasMore
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/InventoryBalance'
                  hasMore:
                    type: boolean
                  nextCursor:
                    type: string
                    description: >-
                      Cursor keyset opaco para la página siguiente; solo aparece
                      cuando hasMore es true.
          headers:
            X-RateLimit-Limit:
              description: El presupuesto de solicitudes por clave en la ventana actual.
              schema:
                type: integer
                minimum: 1
            X-RateLimit-Remaining:
              description: Solicitudes restantes en la ventana actual (0 cuando se agotan).
              schema:
                type: integer
                minimum: 0
            X-RateLimit-Reset:
              description: Segundos hasta que se reinicie la ventana actual.
              schema:
                type: integer
                minimum: 1
            RateLimit:
              description: >-
                Estado del presupuesto de solicitudes según el borrador de la
                IETF, por ejemplo "limit=120, remaining=119, reset=60".
              schema:
                type: string
            RateLimit-Policy:
              description: >-
                Política según el borrador de la IETF, por ejemplo "120;w=60"
                (límite;segundos de la ventana).
              schema:
                type: string
        '400':
          description: Los parámetros de paginación o de filtro no son válidos.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
          headers:
            X-RateLimit-Limit:
              description: El presupuesto de solicitudes por clave en la ventana actual.
              schema:
                type: integer
                minimum: 1
            X-RateLimit-Remaining:
              description: Solicitudes restantes en la ventana actual (0 cuando se agotan).
              schema:
                type: integer
                minimum: 0
            X-RateLimit-Reset:
              description: Segundos hasta que se reinicie la ventana actual.
              schema:
                type: integer
                minimum: 1
            RateLimit:
              description: >-
                Estado del presupuesto de solicitudes según el borrador de la
                IETF, por ejemplo "limit=120, remaining=119, reset=60".
              schema:
                type: string
            RateLimit-Policy:
              description: >-
                Política según el borrador de la IETF, por ejemplo "120;w=60"
                (límite;segundos de la ventana).
              schema:
                type: string
        '401':
          description: >-
            La clave de API falta, no es válida, fue revocada, expiró o está
            vinculada a una clínica dental suspendida.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: La clave de API no tiene el scope que requiere esta ruta.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '429':
          description: >-
            La clave de API superó su límite de solicitudes en la ventana
            actual.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
          headers:
            Retry-After:
              description: Segundos (valor positivo) hasta que se permita otra solicitud.
              schema:
                type: integer
                minimum: 1
            X-RateLimit-Limit:
              description: El presupuesto de solicitudes por clave en la ventana actual.
              schema:
                type: integer
                minimum: 1
            X-RateLimit-Remaining:
              description: Solicitudes restantes en la ventana actual (0 cuando se agotan).
              schema:
                type: integer
                minimum: 0
            X-RateLimit-Reset:
              description: Segundos hasta que se reinicie la ventana actual.
              schema:
                type: integer
                minimum: 1
            RateLimit:
              description: >-
                Estado del presupuesto de solicitudes según el borrador de la
                IETF, por ejemplo "limit=120, remaining=119, reset=60".
              schema:
                type: string
            RateLimit-Policy:
              description: >-
                Política según el borrador de la IETF, por ejemplo "120;w=60"
                (límite;segundos de la ventana).
              schema:
                type: string
      security:
        - apiKeyBearer: []
components:
  schemas:
    InventoryBalance:
      type: object
      additionalProperties: false
      required:
        - boxId
        - catalogItemId
        - warehouseId
        - onHand
        - reserved
        - available
      properties:
        boxId:
          type: string
        catalogItemId:
          type: string
        warehouseId:
          type: string
        onHand:
          type: integer
        reserved:
          type: integer
        available:
          type: integer
          description: 'Derivado: onHand - reserved.'
    ProblemDetails:
      type: object
      additionalProperties: false
      required:
        - type
        - title
        - status
        - detail
        - instance
        - code
        - requestId
      properties:
        type:
          type: string
          format: uri
        title:
          type: string
        status:
          type: integer
          minimum: 400
          maximum: 599
        detail:
          type: string
        instance:
          type: string
        code:
          type: string
        requestId:
          type: string
  securitySchemes:
    apiKeyBearer:
      type: http
      scheme: bearer
      bearerFormat: opaque
      description: >-
        Clave de API opaca mvy_test_ enviada como token Bearer. El servidor
        deriva de ella exactamente una clínica dental; la ruta nunca lleva un
        selector de clínica dental.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.