Endpoints

Devuelve el catálogo de productos de una sucursal, con paginación y filtros opcionales por grupo, clasificación y visibilidad en menú.

Actualiza los datos principales de un producto existente: descripción, grupo, nombre corto, precio, impuestos, bloqueo, visibilidad en menú electrónico y si permite producto compuesto en modificador.

Es una actualización de reemplazo completo: se deben enviar todos los campos en cada solicitud (los valores omitidos no se conservan). El producto debe existir previamente — este endpoint no crea productos nuevos.

Además del cambio en sí, la operación aplica automáticamente estos efectos:

• Si el precio cambió, se registra en el historial de cambios de precio.
• Si el producto también está registrado como modificador de sí mismo, su precio se sincroniza.
• Se agrega una entrada de auditoría en la bitácora del sistema.
• Se marca el producto para sincronización con otros sistemas conectados.

No modifica grupos de modificadores, paquetes, costos, comentarios, asignaciones de estación/almacén ni configuración de monedero del producto — esa configuración, si existe, se conserva sin cambios.

Devuelve las estaciones (mesas, áreas, terminales) configuradas en una sucursal, con paginación y búsqueda opcional.

Devuelve los grupos (categorías de productos) configurados en una sucursal, con paginación y búsqueda opcional por id, descripción o clasificación.

Devuelve los turnos (cortes de caja) registrados en una sucursal, con paginación y búsqueda opcional. Admite filtros de fecha (inclusivos, formato ISO 8601) sobre la apertura (aperturaStart/aperturaEnd) y sobre el cierre (cierreStart/cierreEnd); cada límite es opcional y pueden combinarse. Nota: los turnos abiertos no tienen fecha de cierre, por lo que cualquier filtro sobre cierre los excluye.

Devuelve los registros de asistencia (entrada/salida) de los empleados de una sucursal, ordenados por empleado y hora de entrada, con paginación y búsqueda opcional por id o nombre del empleado. Cada registro incluye el nombre del empleado y su tipo (1 = mesero, 2 = usuario), resueltos contra los catálogos correspondientes del Punto de Venta.

Por defecto se consulta el día operativo actual de SoftRestaurant: de las 06:00 a las 05:59:59 del día siguiente. El inicio de esa ventana es configurable vía dayStartHour, o puede reemplazarse por un rango explícito con entradaStart y entradaEnd (formato ISO 8601, ambos límites inclusivos y opcionales por separado). La ventana efectivamente aplicada se devuelve en entradaStart/entradaEnd de la respuesta.

Los registros cuya salida aún no se ha marcado se devuelven con salida: null, abierta: true y duracionMinutos: null. Usa abiertas=true para obtener solo a quienes siguen sin marcar salida, o abiertas=false para solo los turnos ya cerrados. Usa tipo para limitar la consulta a un solo catálogo de empleados.

Devuelve las órdenes del turno actual del Punto de Venta de una sucursal, con sus productos, formas de pago e impuestos.

Usa folio para traer una orden concreta: es una coincidencia exacta, no una búsqueda parcial. Omítelo para no filtrar por folio.

El parámetro search busca coincidencias parciales en folio, número de cheque, mesa y total.

Usa facturado=true para incluir solo órdenes ya facturadas, o facturado=false para incluir solo las no facturadas; si se omite, no se filtra por estado de facturación.

Retorna solo cuentas del turno en curso, no admite filtros de fecha.

Crea una nueva cuenta y retorna el id.

Crea una nueva venta cerrada con su pago y retorna el folio generado.

Aplica un descuento a toda una cuenta abierta, expresado como porcentaje del subtotal (modo "porcentaje") o como importe fijo (modo "importe").

Cuando el modo es "importe", base indica de qué cifra se resta ese importe: "subtotal" (por omisión) lo resta del subtotal sin impuestos, y "total" lo resta del total con impuestos. Sobre una cuenta de $35.00 con IVA, un importe de $10.00 deja el total en $23.40 con base "subtotal" y en $25.00 con base "total". En modo "porcentaje" el parámetro se ignora.

El descuento reemplaza cualquier descuento general previo de la cuenta — no se acumula. Para cancelar un descuento, envíe valor 0: los totales vuelven exactamente a sus valores originales.

La cuenta debe estar abierta: no pagada, no cancelada, no en uso en una estación, y sin imprimir (una cuenta impresa solo admite descuento si fue reabierta).

Además del descuento, la operación aplica automáticamente estos efectos:

• Recalcula todos los totales de la cuenta (subtotal, impuestos, total, alimentos/bebidas/otros).
• Reparte el descuento entre alimentos, bebidas y otros en proporción a su peso en el subtotal.
• Marca la cuenta para sincronización de descuentos con SoftRestaurant.
• Un descuento del 100% se registra como CORTESÍA: totalDescuentos conserva sólo los descuentos por producto y el importe general pasa a totalCortesias. Los descuentos por producto ya aplicados a las líneas se conservan y se descuentan antes de este: el porcentaje general opera sobre el subtotal ya neteado.

Aplica un descuento a una o más líneas de una cuenta abierta. Acepta los mismos parámetros y sigue las mismas reglas que el descuento general, pero referidos a cada línea en lugar de a toda la cuenta: modo ("porcentaje" o "importe") y, cuando el modo es "importe", base ("subtotal" o "total").

En modo "importe" el valor es POR UNIDAD. Una línea de 3 piezas a $100 con importe $50 sobre "total" descuenta $150 en total, porque cada pieza baja $50; el punto de venta lo guarda como un 50% en esa línea. Con base "subtotal" el importe se resta del precio unitario sin impuestos.

Cada línea se resuelve por separado: una misma petición puede combinar líneas con modo "porcentaje" y líneas con modo "importe", y usar bases distintas entre ellas.

Cada línea se identifica por su movimiento y su idProducto. El valor enviado reemplaza el descuento previo de esa línea — no se acumula. Para cancelar el descuento de una línea, envíe valor 0.

El descuento se guarda en la línea como porcentaje: el detalle de la cuenta no tiene columnas para el importe ni para la base, así que un importe se convierte a su porcentaje equivalente y sólo ese porcentaje queda almacenado.

Un descuento del 100% en una línea se registra como CORTESÍA, no como descuento — igual que un descuento general del 100%. Aplica también si el importe enviado iguala el precio unitario.

La operación es atómica: si alguna línea del cuerpo no existe en la cuenta, no se aplica ningún descuento y se devuelve un error. Las líneas no mencionadas conservan su descuento actual.

La cuenta debe estar abierta: no pagada, no cancelada, no en uso en una estación, y sin imprimir (una cuenta impresa solo admite descuento si fue reabierta).

Al terminar se recalculan todos los totales de la cuenta y se agrega una entrada de auditoría en la bitácora del sistema. Si la cuenta también tiene un descuento general, este se recalcula sobre el nuevo subtotal.

Agrega una o más líneas a una cuenta que ya está abierta. La operación sólo toca la cuenta temporal — no genera una venta ni reimprime nada.

El campo movimiento de cada producto sólo define el orden dentro de esta petición y a qué producto base pertenece cada modificador: debe empezar en 1 y ser consecutivo. El movimiento real dentro de la cuenta lo asigna el punto de venta continuando desde la última línea existente, y se devuelve en movimientos — son esos valores los que se usan después para descontar o cancelar cada línea.

Recuerde que impuesto1, impuesto2 e impuesto3 son TASAS en porcentaje (16.00 = 16%), no importes.

La cuenta debe estar abierta: no pagada, no cancelada, no en uso en una estación, y sin imprimir (una cuenta impresa solo admite cambios si fue reabierta).

Al terminar se recalculan todos los totales de la cuenta. Si la cuenta ya tenía un descuento general, este se conserva y se vuelve a aplicar sobre el nuevo subtotal; los descuentos por producto de las líneas existentes tampoco se pierden.

Cancela una o más líneas de una cuenta abierta. Cada línea se identifica por su movimiento y su idProducto; la línea se retira de la cuenta y la cancelación queda registrada para el personal de cocina y para el reporte de cancelaciones de la sucursal.

Cancelar un producto base arrastra sus modificadores: se cancelan junto con él y aparecen en movimientos, por lo que itemsCancelados puede ser mayor que el número de líneas enviadas. Cancelar un modificador por separado sí es posible y no afecta al producto base.

La operación es atómica: si alguna línea del cuerpo no existe en la cuenta, no se cancela nada y se devuelve un error.

razon es el motivo de la cancelación en texto libre. Si la sucursal exige motivo (forzarmotivocancela), es obligatorio y no puede ir vacío. El punto de venta ofrece un catálogo de motivos sugeridos (SERVICIO LENTO, ERROR DE CAPTURA, MAL SABOR, CAMBIO DE OPINIÓN CLIENTE), pero son sólo texto y no llevan clave: envíe la descripción tal cual, o cualquier otro texto (máximo 200 caracteres).

Lo que queda guardado no es exactamente lo enviado: el punto de venta añade la mesa al final, con el formato ERROR DE CAPTURA Mesa: CL-GE9-1, porque su registro de cancelaciones no tiene columna de mesa. Esta API reproduce el mismo formato. En una venta sin mesa se guarda sólo el motivo.

La cuenta debe estar abierta: no pagada, no cancelada, no en uso en una estación, y sin imprimir (una cuenta impresa solo admite cambios si fue reabierta).

Además de retirar las líneas, la operación:

• Renumera las líneas restantes de forma consecutiva desde 1, igual que hace SoftRestaurant. Los movimientos devueltos son los que tenían ANTES de la renumeración.
• Marca los productos correspondientes como cancelados en producción para que cocina lo vea.
• Recalcula todos los totales de la cuenta, conservando el descuento general y los descuentos por producto de las líneas que sobreviven.
• Agrega una entrada de auditoría en la bitácora del sistema.

Cancelar todas las líneas deja la cuenta ABIERTA y vacía con totales en cero; no cancela la cuenta.

Devuelve el catálogo de tipos de descuento visibles de la sucursal. La clave idTipoDescuento de cada elemento es la que se envía al aplicar un descuento.

Cuando maximoActivado es true, el campo descuento funciona como tope: un descuento mayor a ese porcentaje será rechazado por el punto de venta.

Cierra un turno abierto: consolida las cuentas pagadas/canceladas en las tablas permanentes, libera mesas y marca el turno como cerrado. Requiere el idTurno exacto para evitar cerrar el turno equivocado cuando hay varios abiertos.

Abre un nuevo turno para la estación y empresa indicadas. Devuelve el idTurno asignado junto con los datos de apertura (fondo, cajero, mesero, fondo en dólares). Falla con un error si ya existe un turno abierto para esa estación/empresa; ciérralo primero con turnos_cierre.

Devuelve el listado de meseros configurados en una sucursal.

Devuelve las empresas registradas en el Punto de Venta de una sucursal.

Devuelve todas las cuentas activas (sin cancelar) del turno operativo actual (6:00 AM – 5:59:59 AM del día siguiente).

Devuelve las líneas de productos temporales de una sucursal, con paginación y filtros opcionales por folio de orden o búsqueda por producto.

Devuelve las órdenes cerradas/históricas del Punto de Venta de una sucursal, con filtro opcional por folio, número de cheque o total. Usa facturado=true para incluir solo órdenes ya facturadas, o facturado=false para incluir solo las no facturadas; si se omite, no se filtra por estado de facturación. Admite filtros de fecha (inclusivos, formato ISO 8601): fechaStart/fechaEnd sobre la fecha de apertura de la orden y cierreStart/cierreEnd sobre su fecha de cierre. Además, turnoAperturaStart/turnoAperturaEnd filtran por turno: devuelven las órdenes de TODOS los turnos abiertos dentro de ese rango de fechas, sin necesidad de enviar la lista de ids. Para filtrar por una lista explícita de ids de turno (potencialmente grande), usa POST /ordenes/buscar/{licenseKey}.

Devuelve las órdenes cerradas/históricas cuyos ids de turno estén en la lista idTurnos enviada en el cuerpo (hasta 10,000 ids), con los mismos filtros opcionales de GET /ordenes/{licenseKey} (search, facturado, fechaStart/fechaEnd, cierreStart/cierreEnd) y paginación. Usa este endpoint cuando necesites filtrar por una lista explícita de turnos demasiado grande para la URL de un GET (~500 ids); si los turnos que te interesan corresponden a un rango de fechas, es más simple usar GET /ordenes/{licenseKey} con turnoAperturaStart/turnoAperturaEnd.

Devuelve las líneas de productos de órdenes cerradas/históricas de una sucursal, con paginación y filtros opcionales por folio de orden o búsqueda por producto.

Devuelve todas las órdenes del día operativo actual (abiertas y cerradas), juntando las órdenes según los turnos que iniciaron y cerraron dentro de la ventana. Por defecto la ventana es 06:00–05:59:59 del día siguiente; el inicio es configurable vía dayStartHour. Usa facturado=true para incluir solo órdenes ya facturadas, o facturado=false para incluir solo las no facturadas; si se omite, no se filtra por estado de facturación.

Retorna todas las formas de pago disponibles en una sucursal específica.

Descarga el contenido XML (CFDI) de la factura asociada a un número de cheque, dentro de una empresa del Punto de Venta.