Diferencia entre revisiones de «API ConsultarCatalogo»

De tfhkacolwiki
Ir a la navegación Ir a la búsqueda
(Página creada con «La API '''ConsultarCatalogo''' es un desarrollo elaborado por el equipo de The Factory HKA el cual brinda la posibilidad al contribuyente de consultar todos los catálogos…»)
 
 
(No se muestran 8 ediciones intermedias del mismo usuario)
Línea 4: Línea 4:
 
<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> 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>
 +
  
 
'''Para mayor información pude consultas las URL en la siguiente sección:'''
 
'''Para mayor información pude consultas las URL en la siguiente sección:'''
 
  '''[[Tips_Urls_de_Emisión #ConsultarCatalogo|ConsultarCatalogo]]'''
 
  '''[[Tips_Urls_de_Emisión #ConsultarCatalogo|ConsultarCatalogo]]'''
  
−
A continuación se documenta la estructura que se debe contemplar en la construcción del Request y el Response del servicio '''ConsultarProductos''' 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 '''ConsultarCatalogo''' 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 25: Línea 28:
 
|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
 
|String
−
|Plataforma
+
|Identificador
−
|Nombre de la plataforma corresponde a TFHKA
+
|Parametro Opcional corresponde al nombre del Catalogo a consultar Ejemplo: UnidadesMedida.
 
|}
 
|}
 
<br>
 
<br>
 +
<br>
 +
 +
<center>'''Ejemplo  Request ConsultarCatalogo'''</center>
 +
[[Archivo:RequestConsultarCatalogo.png|800px|sinmarco|centro|Request ConsultarCatalogo]]
 +
<br />
 +
 +
; RESPONSE: Parámetros a Recibir al consultar el Método ConsultarCatalogo
 +
{| 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
 +
|-
 +
|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
 +
|}
 +
{{clear}}
 +
 +
 +
Donde CatalogosAsociados contiene la siguiente información:
 +
 +
; RESPONSE: Parámetros a Recibir Array Catalogos
 +
{| 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
 +
|-
 +
|String
 +
|Id
 +
|Corresponde a la secuencial del Objeto
 +
|-
 +
|String
 +
|Codigo
 +
|Codigo correspondiente a la descripcion del catalogo.
 +
|-
 +
|String
 +
|Nombre
 +
|Nombre del catalogo
 +
|-
 +
|String
 +
|Descripcion
 +
|Descripcion del catalogo
 +
|}
 +
{{clear}}
 +
<br>
 +
<br>
 +
 +
<center>'''Ejemplo  Response ConsultarCatalogo'''</center>
 +
[[Archivo:ResponseConsultarCatalogo .png|800px|sinmarco|centro|Response ConsultarCatalogo]]
 +
<br />
 +
<br />

Revisión actual del 16:22 8 oct 2024

La API ConsultarCatalogo es un desarrollo elaborado por el equipo de The Factory HKA el cual brinda la posibilidad al contribuyente de consultar todos los catálogos creados 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.

@IMPORTANTE: 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 Parametro Opcional corresponde al nombre del Catalogo a consultar Ejemplo: UnidadesMedida.



Ejemplo Request ConsultarCatalogo
Request ConsultarCatalogo


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 Histórico de las Catalogos configuradas en los portales de HKA Factura existentes
String Id Corresponde a la secuencial del Objeto
String Codigo Codigo correspondiente a la descripcion del catalogo.
String Nombre Nombre del catalogo
String Descripcion Descripcion del catalogo



Ejemplo Response ConsultarCatalogo
Response ConsultarCatalogo



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