API ConsultarCatalogoAsociado

La API ConsultarCatalogoAsociado permite obtener la lista de catálogos que ya están vinculados a un contribuyente específico. Esta operación es crucial para verificar el estado actual de las asociaciones y asegurar que el contribuyente tiene acceso a los catálogos correctos antes de realizar nuevas acciones o para propósitos de auditoría. La consulta se realiza mediante POST para permitir el envío de criterios de búsqueda complejos o sensibles en el cuerpo de la solicitud, se encuentra disponible en ambiente demo y en ambiente de producción, en el momento solo se encuentra la posibilidad de visualizar el catalogo de unidadesMedidas, proximamente se ilustraran más catalogos.

@IMPORTANTE: La API ConsultarCatalogoAsociado esta construida en Metodo 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:

ConsultarCatalogoAsociado

A continuación se documenta la estructura que se debe contemplar en la construcción del Request y el Response del servicio ConsultarCatalogoAsociado 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	Plataforma	(Opcional) Nombre de la plataforma desde la que se realiza la consulta. Si se envía, debe corresponder al valor "TFHKA".
String	Identificador	(Opcional) Nombre o identificador específico del catálogo que se desea consultar. Si se especifica, la API buscará solo ese catálogo asociado al contribuyente.

RESPONSE

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

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
String	Nit	Número de documento del contribuyente consultado
String	IdEmpresa	Identificador del contribuyente asignado por The Factory HKA Colombia (Uso Interno)
Array <CatalogosAsociados>	CatalogosAsociados	Histórico de las CatalogosAsociados configuradas en TFHKA para los diferentes Catalogos 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 CatalogosAsociados

Tipo	Identificador	Descripción
Array <Catalogos>	Catalogos	Histórico de las Catalogos configuradas en los portales de HKA Factura existentes