Consultar estado de catálogos

GET/api/v1/catalogos-siat/estado

Un catálogo vacío indica que Falmus todavía debe sincronizar los datos de esa empresa antes de consultarlos mediante la API.

Header requerido X-API-KeyVer operaciones de Catálogos SIAT

Contrato de la operación

Consultar estado de catálogos SIAT

Informa qué catálogos están disponibles en almacenamiento local para el contexto que resuelve X-API-Key.

Autorización

Requiere X-API-Key con permiso catalogos.consultar. No recibe parámetros de ruta, query ni cuerpo. No requiere Bearer, X-Tenant-ID, NIT, ambiente ni Idempotency-Key.

Respuestas

200 OK: disponibilidad, cantidad total y última sincronización.
401 Unauthorized: clave ausente, inválida, vencida o revocada.
429 Too Many Requests: máximo 120 solicitudes por minuto por clave.

Un catálogo vacío indica que Falmus todavía debe sincronizar los datos de esa empresa antes de consultarlos mediante la API.

Ejemplo

Solicitud de ejemplo

Clave ficticia; no se ejecuta desde esta página

cURL · GET

export FALMUS_API_URL='https://staging-api.falmus.com/api/v1'
export FALMUS_API_KEY='flm_test_REEMPLAZA_CON_TU_CLAVE'

curl --request GET \
  --url "$FALMUS_API_URL/catalogos-siat/estado" \
  --header "X-API-Key: $FALMUS_API_KEY"

Este ejemplo no incluye un cuerpo. Revisa el contrato para conocer los parámetros de ruta y consulta.

Respuesta

Ejemplo de respuesta

200 OKapplication/json

JSON

{
  "message": "Operación realizada correctamente",
  "data": {
    "syncedAt": "2026-08-22T10:00:00Z",
    "totalRecords": 588,
    "catalogs": [
      "actividades",
      "metodos_pago",
      "productos_servicios"
    ]
  }
}

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

Volver a Catálogos SIAT