Referencia API
Modulos y endpoints
Hay 17 modulos y 73 endpoints disponibles como rutas visibles del frontend.
Autenticación
Gestión de sesiones, access tokens y refresh tokens para usuarios del sistema.
/auth/loginLogin
Inicia sesión de usuario y retorna un accessToken y un refreshToken.
Documentado/auth/logoutLogout
Cierra la sesión revocando el refreshToken recibido.
Documentado/auth/refreshRenovar sesión
Renueva la sesión usando el refreshToken y retorna un nuevo par de tokens.
DocumentadoAlertas
Alertas de stock bajo y eventos en tiempo real.
/alerts/summaryResumen de alertas
Obtiene un resumen agregado de alertas visibles y no vistas de la empresa.
Documentado/alerts/eventsListar eventos de alerta
Abre una conexión SSE (Server-Sent Events) para recibir alertas.
Documentado/alertsListar alertas
Obtiene el listado paginado de alertas visibles de la empresa con filtros opcionales.
Documentado/alerts/:id/vistoActualizar alerta como vista
Marca una alerta como vista.
DocumentadoSucursales
Administración de sucursales por empresa.
/branchesCrear sucursal
Crea una nueva sucursal dentro de la empresa autenticada.
Documentado/branchesListar sucursales
Obtiene el listado paginado de sucursales con filtros opcionales por nombre, identificador y estado.
Documentado/branches/:idObtener sucursal
Obtiene una sucursal por su identificador.
Documentado/branches/:idActualizar sucursal
Actualiza parcialmente los datos de una sucursal existente.
DocumentadoMarcas
Catálogo de marcas de productos.
/brandsCrear marca
Crea una nueva marca dentro de la empresa autenticada.
Documentado/brandsListar marcas
Obtiene el listado paginado de marcas con filtros opcionales por nombre y estado.
Documentado/brands/:idObtener marca
Obtiene el detalle de una marca por su identificador.
Documentado/brands/:idActualizar marca
Actualiza parcialmente los datos de una marca existente.
DocumentadoCategorías
Catálogo de categorías de productos.
/categoriesCrear categoría
Crea una nueva categoría dentro de la empresa autenticada.
Documentado/categoriesListar categorías
Obtiene el listado paginado de categorías con filtros opcionales por nombre, descripción y estado.
Documentado/categories/:idObtener categoría
Obtiene el detalle de una categoría por su identificador.
Documentado/categories/:idActualizar categoría
Actualiza parcialmente los datos de una categoría existente.
DocumentadoCajas
Gestión de cajas y estado operativo.
/checkoutsCrear caja
Crea una nueva caja dentro de una sucursal activa.
Documentado/checkoutsListar cajas
Obtiene el listado paginado de cajas con filtros por búsqueda y estado.
Documentado/checkouts/:idObtener caja
Obtiene el detalle de una caja por empresa, sucursal e identificador funcional.
Documentado/checkouts/:id/statusActualizar estado de caja
Actualiza el estado operativo de una caja.
DocumentadoClientes
Gestión de clientes.
/clientsCrear cliente
Crea un nuevo cliente para la empresa indicada en el body.
Documentado/clientsListar clientes
Obtiene el listado paginado de clientes con filtros por búsqueda y estado.
Documentado/clients/:idObtener cliente
Obtiene el detalle de un cliente por su identificador interno.
Documentado/clients/:idActualizar cliente
Actualiza la información de un cliente.
DocumentadoEmpresas
Administración de empresas registradas en el sistema.
/companiesCrear empresa
Registra una nueva empresa hija asociada a la empresa padre.
Documentado/companiesListar empresas
Obtiene el listado paginado de empresas hijas con filtros por búsqueda y estado.
Documentado/companies/:idObtener empresa
Obtiene una empresa por su identificador.
Documentado/companies/:idActualizar empresa
Actualiza los datos editables de la empresa (razón social, correo, logo).
Documentado/companies/:id/statusActualizar estado de empresa
Cambia el estado de una empresa (activo/inactivo/eliminado).
DocumentadoConfiguración
Parámetros de configuración del sistema.
/configsCrear configuración
Registra una nueva configuración clave-valor para una empresa.
Documentado/configsListar configuraciones
Obtiene todos los parámetros de configuración.
Documentado/configs/:configKeyObtener configuración por clave
Obtiene una configuración por su clave dentro de una empresa.
Documentado/configs/:configKeyActualizar configuración
Actualiza el valor de una configuración por clave y empresa.
Documentado/configs/:configKeyEliminar configuración
Elimina permanentemente una configuración por clave y empresa.
DocumentadoMedidas
Unidades de medida para productos.
/medidasCrear Medida
Registra una nueva unidad de medida.
Documentado/medidasListar Medidas
Obtiene el listado paginado de medidas con filtros por búsqueda y estado.
Documentado/medidas/:idObtener Medida
Obtiene una unidad de medida por su identificador.
Documentado/medidas/:idActualizar Medida
Actualiza parcialmente los datos de una medida.
DocumentadoMétodos de Pago
Catálogo de métodos de pago disponibles.
/payment-methodsCrear método de pago
Registra un nuevo método de pago.
Documentado/payment-methodsListar métodos de pago
Obtiene los métodos de pago disponibles.
Documentado/payment-methods/:idObtener método de pago
Obtiene un método de pago por su identificador.
Documentado/payment-methods/:idActualizar método de pago
Actualiza un método de pago existente.
DocumentadoProductos
Catálogo de productos, marcas, categorías y datos comerciales.
/productsCrear producto
Crea un nuevo producto en el catálogo.
Documentado/productsListar productos
Obtiene el listado paginado de productos.
Documentado/products/:idObtener producto
Obtiene el detalle completo de un producto por su id o código.
Documentado/products/:idActualizar producto
Actualiza la información comercial y características de un producto.
DocumentadoProformas
Creación, consulta, pago, anulación y exportación PDF de proformas.
/proformasCrear Proforma
Crea y emite una nueva proforma con estado emitida.
Documentado/proformasListar Proformas
Obtiene el listado paginado de proformas.
Documentado/proformas/:idObtener Proforma
Obtiene el detalle completo de una proforma.
Documentado/proformas/:id/pdfObtener Proforma Pdf
Genera y descarga el documento PDF de una proforma.
Documentado/proformas/:id/pagarPagar Proforma
Registra el pago de una proforma emitida, cambiando su estado a pagada y descontando el stock.
Documentado/proformas/:idReemplazar Proforma
Reemplaza completamente el contenido de una proforma emitida.
Documentado/proformas/:id/anularAnular Proforma
Cambia el estado de una proforma a anulada.
Documentado/proformas/:id/sendEnviar Proforma
Envía una proforma por email o WhatsApp al cliente.
DocumentadoProveedores
Gestión de proveedores.
/proveedoresCrear Proveedor
Registra un nuevo proveedor.
Documentado/proveedoresListar Proveedores
Obtiene el listado paginado de proveedores.
Documentado/proveedores/:idObtener Proveedor
Obtiene un proveedor por su identificador.
Documentado/proveedores/:idActualizar Proveedor
Actualiza la información de un proveedor.
DocumentadoStock
Control de inventario por producto, empresa y sucursal.
/stocksCrear Stock
Asigna o incrementa stock de un producto para una sucursal específica.
Documentado/stocksListar Stocks
Obtiene el stock detallado por producto y sucursal.
Documentado/stocks/allListar stock por empresa
Obtiene el inventario consolidado a nivel de empresa.
Documentado/stocks/:idObtener Stock
Obtiene el detalle de un registro de stock específico.
Documentado/stocks/:idActualizar Stock
Ajusta manualmente los niveles máximo o mínimo de un stock, o fuerza una corrección de cantidad.
DocumentadoUsuarios
Gestión de usuarios, credenciales, contraseñas y estado.
/usersCrear usuario
Registra un nuevo usuario en la empresa.
Documentado/usersListar usuarios
Obtiene el listado paginado de usuarios.
Documentado/users/:idObtener usuario
Obtiene un usuario por su identificador.
Documentado/users/:idActualizar usuario
Actualiza la información personal de un usuario.
Documentado/users/:id/passwordActualizar contraseña de usuario
Cambia la contraseña de un usuario.
Documentado/users/:id/statusActualizar estado de usuario
Cambia el estado de un usuario (activo/inactivo/eliminado).
DocumentadoHealth Check
Verificación de disponibilidad y estado del servicio.