LOloggro
Cuadre de Caja

Consultar cuadres de caja

Consulta la lista de cuadres de caja del negocio actual, con soporte de filtros y paginación.

Autenticación requerida: Este endpoint requiere autenticación Bearer Token. Usar el campo tokenCurrent obtenido del servicio de login (/login) en el header: Authorization: Bearer {tokenCurrent}

Permiso requerido: CB_GET_ALL - "Listar todos"

Reglas de negocio según el plan:

  • Negocios no premium: solo se retorna el último cuadre de caja (limit forzado a 1, count = 1).
  • Cuentas en periodo de prueba (trial): solo se muestran cuadres de las últimas 24 horas.
  • Negocios premium: acceso completo a todos los cuadres con filtros y paginación.

Los resultados se ordenan por fecha de apertura descendente (-dateStart, los más recientes primero).

Ejemplos de Uso

1. Listar cuadres con paginación

GET /cashbox?pagination=true&limit=20&page=0
Authorization: Bearer tu_token_aqui

Retorna un objeto { data, count } con los primeros 20 cuadres.

2. Listar solo cuadres abiertos

GET /cashbox?status=open
Authorization: Bearer tu_token_aqui

3. Cuadres de un cajero en un rango de fechas

GET /cashbox?cashierId=507f1f77bcf86cd799439014&dateInit=2025-08-01T00:00:00.000Z&dateEnd=2025-08-31T23:59:59.999Z
Authorization: Bearer tu_token_aqui
get/cashbox

Request

  • Base URL
    https://api.pirpos.com
  • URL
    https://api.pirpos.com/cashbox
  • Auth
    HTTP bearer

Query parameters

paginationboolean

Si es true, retorna un objeto con data y count. Si es false (u omitido), retorna un arreglo directo de cuadres.

limitinteger

Número máximo de cuadres a retornar. Por defecto 1000; valores >= 1000 se ajustan a 1000. En negocios no premium se fuerza a 1.

pageinteger

Número de página para la paginación (inicia en 0). El salto se calcula como page * limit.

status'open' | 'closed'

Filtra por estado del cuadre. open = cajas abiertas (isClosed=false), closed = cajas cerradas (isClosed=true).

cashBoxIdstring

Filtra por el ID de la caja registradora (CashBoxRegister) asociada.

cashierIdstring

Filtra por el ID del cajero responsable (owner) del cuadre.

dateInitstring date-time

Fecha inicial para filtrar por fecha de creación (createdOn >= dateInit).

dateEndstring date-time

Fecha final para filtrar por fecha de creación (createdOn <= dateEnd).

Response

Lista de cuadres de caja obtenida exitosamente

OR

Example response

[
  {
    "_id": "507f1f77bcf86cd799439011",
    "business": "507f1f77bcf86cd799439012",
    "user": "507f1f77bcf86cd799439013",
    "owner": "507f1f77bcf86cd799439014",
    "dateStart": "2025-08-05T08:00:00.000Z",
    "dateEnd": "2025-08-05T20:00:00.000Z",
    "paymentMethods": [
      {
        "paymentMethod": "507f1f77bcf86cd799439015",
        "totalInit": 100000,
        "totalNow": 350000,
        "totalCashier": 350000
      }
    ],
    "expense": 25000,
    "canceledInvoices": [
      "507f1f77bcf86cd799439016"
    ],
    "dailyReport": "507f1f77bcf86cd799439017",
    "idMachine": "POS-01",
    "nextTurn": 1,
    "seq": 42,
    "_idCashBoxRegister": "507f1f77bcf86cd799439018",
    "cashiers": [
      {
        "_idUser": "507f1f77bcf86cd799439014",
        "name": "Carlos Pérez",
        "dateAssignment": "2025-08-05T08:00:00.000Z"
      }
    ],
    "scaleConfig": {
      "unit": "507f1f77bcf86cd799439030"
    },
    "modifiedOn": "2025-08-05T12:30:00.000Z",
    "createdOn": "2025-08-05T08:00:00.000Z"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.