Saltar al contenido
Falmus

Consultar sucursales

POST/api/v1/sucursales/consultas

Lista sucursales registradas localmente para la empresa seleccionada. Falmus no sincroniza sucursales desde SIAT: el contribuyente las registra primero en el Padrón del SIN.

Contrato de la operación

Lista sucursales registradas localmente para la empresa seleccionada. Falmus no sincroniza sucursales desde SIAT: el contribuyente las registra primero en el Padrón del SIN.

Autorización y parámetros

Requiere únicamente X-API-Key con permiso sucursales.consultar. La clave determina la empresa; no envíes Bearer, X-Tenant-ID, NIT ni Idempotency-Key.

Cuerpo y filtros

page inicia en 0; size admite de 1 a 100. El ejemplo no filtra para incluir la Casa matriz pendiente. Los filtros permitidos son nombre, estado y codigoSiat. No hay orden configurable.

Respuestas

200 OK devuelve una página. Puede responder 400 por un cuerpo inválido, 401 por clave ausente, vencida o revocada, y 403 si la clave no tiene el permiso requerido.

Ejemplo

Solicitud de ejemplo

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

Respuesta

Ejemplo de respuesta

200 OKapplication/json
JSON
{
  "message": "sucursales obtenidas correctamente",
  "data": {
    "content": [
      {
        "id": "00000000-0000-4000-8000-000000000021",
        "codigoSiat": 1,
        "nombre": "Sucursal Sur",
        "direccion": "Av. Ejemplo 123",
        "ciudad": "Cochabamba",
        "estado": "activo",
        "esCasaMatriz": false,
        "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.