API ConsultarCatalogo

La API ConsultarCatalogo actúa como un diccionario centralizado y dinámico, permitiendo a los desarrolladores comprender y obtener los parámetros requeridos por el sistema para asegurar una integración coherente y robusta a través de todas las APIs del servicio de Gestión de Contribuyentes.

Al consumir esta API, los sistemas externos pueden poblar dinámicamente sus interfaces y validar los datos antes de enviarlos en las solicitudes a otras APIs, minimizando errores y garantizando la integridad de la información.Esta funcionalidad está implementada y disponible tanto en los ambientes de demo como de producción de The Factory HKA Colombia.

@IMPORTANTE: La API ConsultarCatalogo está construida en método POST. Para el consumo de este servicio se han establecido dos url especificas en ambiente DEMO y ambiente PRODUCCION las cuales las podrá encontrar a continuación:

Para mayor información pude consultas las URL en la siguiente sección:

ConsultarCatalogo

A continuación se documenta la estructura que se debe contemplar en la construcción del Request y el Response del servicio ConsultarCatalogo y de esta forma garantizar la implementación de este nuevo método:

REQUEST

Parámetros a Enviar

Tipo	Identificador	Descripción
String	Nit	Número de documento del contribuyente a consultar
String	TokenEmpresa	Suministrado por The Factory HKA Colombia según el ambiente a consultar
	TokenClave
String	Identificador	(Opcional) Nombre exacto del catálogo específico que se desea consultar. Ejemplo: "UnidadesMedida", "Paises", "TiposDocumento". Si se omite, la API podría devolver una lista general de catálogos disponibles (comportamiento a confirmar por la implementación).

RESPONSE

Parámetros a Recibir al consultar el Método ConsultarCatalogo

Tipo	Identificador	Descripción
int	Código	Indica el estado de la operación retornado por el servicio
String	Resultado	Resultado del consumo del método: “Exitoso” ó “Error”
String	Mensaje	Este mensaje está asociado al codigo, útil para identificación de errores
Array <Catalogos>	Catalogos	Histórico de las Catalogos con figuradas en los portales de HKA Factura existentes
String	Array <Errores>	Lista de errores en caso de error al consumo del servicio

Donde CatalogosAsociados contiene la siguiente información:

RESPONSE

Parámetros a Recibir Array Catalogos

Tipo	Identificador	Descripción
Array <Catalogos>	Catalogos	Nombre del Catalogo existente
String	Id	Corresponde al Identificador para la variable del catalogo
String	Codigo	Codigo correspondiente de la descripcion e la variable.
String	Nombre	Nombre de la variable perteneciente al catalogo
String	Descripcion	Descripcion de la variable del catalogo