Saltar al contenido
Falmus

Consultar catálogo

POST/api/v1/catalogos-siat/consultas

Consulta el contrato de esta operación.

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

Contrato de la operación

Consultar catálogo SIAT

Devuelve códigos oficiales ya sincronizados para la empresa, ambiente, sucursal y punto de venta asociados a X-API-Key.

Autorización

Requiere X-API-Key con permiso catalogos.consultar. No requiere Bearer, X-Tenant-ID, NIT, ambiente, Token Delegado ni Idempotency-Key.

Cuerpo

  • filters.catalogo: opcional. Usa todos (o omítelo) para recorrer todos los catálogos en una sola paginación. Para un catálogo específico: actividades, actividades_documento_sector, leyendas_factura, mensajes_servicios, productos_servicios, eventos_significativos, motivos_anulacion, paises_origen, tipos_documento_identidad, tipos_documento_sector, tipos_emision, tipos_habitacion, metodos_pago, monedas, tipos_punto_venta, tipos_factura, unidades_medida.
  • sortBy: opcional. Admite catalogo, codigo, descripcion o codigoActividad; el valor por defecto es catalogo.
  • sortDir: opcional. Admite asc o desc; el valor por defecto es asc.
  • page: opcional, inicia en 0.
  • size: opcional, entre 1 y 100; el valor inicial es 50.
  • filters.codigo, filters.descripcion, filters.codigoActividad: filtros opcionales. No existen otros filtros ni ordenamiento configurable.

Respuestas

  • 200 OK: resultados paginados, ordenados por catálogo, código y actividad. Cuando se usa todos, cada fila incluye su campo catalogo.
  • 400 Bad Request: cuerpo o catálogo inválido.
  • 401 Unauthorized: clave ausente, inválida, vencida o revocada.
  • 404 Not Found: catálogo aún no sincronizado.
  • 429 Too Many Requests: máximo 120...

Ejemplo

Solicitud de ejemplo

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

Respuesta

Ejemplo de respuesta

200 OKapplication/json
JSON
{
  "message": "catálogo obtenido",
  "data": {
    "content": [
      {
        "codigo": "6201000",
        "descripcion": "Desarrollo de sistemas informáticos",
        "catalogo": "actividades"
      }
    ],
    "page": 0,
    "size": 50,
    "totalElements": 1,
    "totalPages": 1,
    "syncedAt": "2026-08-22T10:00:00Z"
  }
}

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