NominexDocs
Referencia de la APICatálogos de plataforma

Listar

Descripcion general

Este endpoint devuelve el registro completo de catálogos de plataforma disponibles para tu organización. Los catálogos de plataforma son tablas de parámetros fiscales que la plataforma mantiene (UMA, tarifa ISR, cuotas IMSS, INFONAVIT, ISN por estado, etc.). No se crean ni se borran: solo se consultan (GET) y, si lo necesitas, se autoadministran con un override de la organización (PATCH). El conjunto de catálogos es fijo, por lo que la respuesta no se pagina: devuelve todas las filas de una sola vez.

Endpoint

GEThttps://app.integranom.com/api/v1/platform-catalogs

Consulta el registro de catálogos


La respuesta trae count con el número total de catálogos y results con una fila por cada catálogo. Como el conjunto es fijo, no hay paginación ni parámetros de consulta: se devuelve el registro completo.

Campos de cada fila

CampoTipoDescripcion
keystringIdentificador del catálogo. Es el valor que usas en la URL de los endpoints de detalle y edición.
namestringNombre legible del catálogo.
descriptionstringDescripción del catálogo.
shape"scalar" | "range_table" | "keyed_table"Forma del valor del catálogo. Determina la estructura del payload al leerlo o editarlo.
unitstringUnidad del valor (por ejemplo MXN).
group_keystringClave del grupo al que pertenece el catálogo.
group_labelstringEtiqueta legible del grupo.
frequency_scopedbooleantrue si el catálogo requiere una frequency al leerlo o editarlo (por ejemplo la tarifa ISR).
is_federalbooleantrue si es una tabla federal.
regulatory"legal" | "platform_default"Naturaleza regulatoria del catálogo.
source"org" | "platform""org" si tu organización lo autoadministra con un override activo; "platform" si usa el valor de la plataforma.
is_stalebooleantrue cuando tienes un override pero la plataforma publicó después una versión más reciente — tu valor autoadministrado quedó rezagado. Consulta el detalle para comparar contra platform_payload.

Errores

StatusCausa
401API key ausente o inválida.
Abrir Nominex