Consultar cuadres de caja

get

https://api.pirpos.com/cashbox

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

pagination

boolean

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

limit

integer

1 to 999

Defaults to 1000

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.

page

integer

≥ 0

Defaults to 0

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

status

string

enum

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

Allowed:

cashBoxId

string

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

cashierId

string

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

dateInit

date-time

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

dateEnd

date-time

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

Responses

200Lista de cuadres de caja obtenida exitosamente

401Token de autorización inválido o faltante

403Sin permisos para listar cuadres de caja

500Error interno del servidor