Diferencia entre revisiones de «API ConsultarCatalogoAsociado»

De tfhkacolwiki
Ir a la navegación Ir a la búsqueda
← Edición anterior
Sin resumen de edición
Sin resumen de edición
 
(No se muestran 16 ediciones intermedias del mismo usuario)
Línea 1: Línea 1:
La API '''ConsultarCatalogoAsociado''' es un desarrollo elaborado por el equipo de The Factory HKA el cual brinda la posibilidad al contribuyente de consultar todos los catálogos Asociados en el portal de factura electrónica en ambiente demo y en ambiente de producción, entre los catálogos se encuentran Clientes, Unidades de Medida Establecimiento entre otros.
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.
<br>
<br>
<br>
<br>
<font color="red">'''@IMPORTANTE:'''</font> 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:
<font color="red">'''@IMPORTANTE:'''</font> 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:
<br>
<br>


Línea 9: Línea 9:
  '''[[Tips_Urls_de_Emisión #ConsultarCatalogoAsociado |ConsultarCatalogoAsociado]]'''
  '''[[Tips_Urls_de_Emisión #ConsultarCatalogoAsociado |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:


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
; REQUEST: Parámetros a Enviar
Línea 27: Línea 27:
|rowspan="2"|Suministrado por The Factory HKA Colombia según el ambiente a consultar
|rowspan="2"|Suministrado por The Factory HKA Colombia según el ambiente a consultar
|-
|-
|TokenPassword
|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
|String
|Identificador
|Identificador
|Este parámetro es Opcional puede reportar el nombre o ID del catalogoAsociado
|(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.
|}
|}
<br>
<br>
; RESPONSE: Parámetros a Recibir al consultar el Método ConsultarCatalogoAsociado
{| class="mw-collapsible wikitable"
! style="background:#f2f2f2; text-align:center;"|Tipo
! style="background:#f2f2f2; text-align:center;"|Identificador
! style="background:#f2f2f2; text-align:center;"|Descripción
|- valign="center"
|-
|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
|}
{{clear}}
Donde CatalogosAsociados contiene la siguiente información:
; RESPONSE: Parámetros a Recibir Array CatalogosAsociados
{| class="mw-collapsible wikitable"
! style="background:#f2f2f2; text-align:center;"|Tipo
! style="background:#f2f2f2; text-align:center;"|Identificador
! style="background:#f2f2f2; text-align:center;"|Descripción
|- valign="center"
|-
|Array <Catalogos>
|Catalogos
|Histórico de las Catalogos configuradas en los portales de HKA Factura existentes
|-
|}
{{clear}}
<br>
<br>
<br />
<br />

Revisión actual - 15:00 9 sep 2025

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





Obtenido de «http://felcowiki.thefactoryhka.com.co/index.php?title=API_ConsultarCatalogoAsociado&oldid=8683»