Saltar al contenido
Falmus

Consultar puntos de venta

POST/api/v1/sucursales/:branchId/puntos-venta/consultas

Lista puntos de venta locales de una sucursal del tenant seleccionado. Nunca incluye CUIS, CUFD, Token Delegado, certificados ni contraseñas.

Contrato de la operación

Lista puntos de venta locales de una sucursal del tenant seleccionado. Nunca incluye CUIS, CUFD, Token Delegado, certificados ni contraseñas.

Autorización y filtros

Requiere únicamente X-API-Key con permiso sucursales.consultar. branchId es el UUID de la sucursal y debe pertenecer a la empresa determinada por la clave. Los filtros admitidos son nombre, estado y codigoPuntoVenta; page inicia en 0 y size es de 1 a 100. El orden admite codigoPuntoVenta, nombre, estado, tipoSiat y creadoEn, con dirección asc o desc.

Respuestas

200 OK devuelve resultados paginados. 400 indica un UUID inválido, 401 una clave inválida, 403 permiso insuficiente y 404 que la sucursal no pertenece a la empresa seleccionada.

Ejemplo

Solicitud de ejemplo

Clave ficticia; no se ejecuta desde esta página
JSON · cuerpo de solicitud
{
  "page": 0,
  "size": 20,
  "sortBy": "codigoPuntoVenta",
  "filters": {
    "estado": "activo"
  }
}

Respuesta

Ejemplo de respuesta

200 OKapplication/json
JSON
{
  "message": "puntos de venta obtenidos correctamente",
  "data": {
    "content": [
      {
        "id": "00000000-0000-4000-8000-000000000022",
        "codigoPuntoVenta": 1,
        "nombre": "Caja rápida",
        "tipoSiat": 5,
        "estado": "activo",
        "creadoEn": "2026-08-20T09:00:00-04:00",
        "actualizadoEn": "2026-08-30T16:10:00-04:00"
      }
    ],
    "page": 0,
    "size": 20,
    "totalElements": 1,
    "totalPages": 1
  }
}

Datos ficticios; los identificadores y valores cambian en cada respuesta.