Diferencia entre revisiones de «API ConsultarFolios»

De tfhkacolwiki
Ir a la navegación Ir a la búsqueda
(Página creada con «La API '''ConsultarFolios''' es un desarrollo elaborado por el equipo de The Factory HKA el cual brinda la posibilidad al contribuyente de consultar los folios, comprados,…»)
 
 
(No se muestra una edición intermedia del mismo usuario)
Línea 29: Línea 29:
 
|TokenClave
 
|TokenClave
 
|}
 
|}
−
<br>
 
 
<br>
 
<br>
  
−
<center>'''Ejemplo  Request ConsultarFolios'''</center>
 
−
[[Archivo:RequestConsultarFolios.png|800px|sinmarco|centro|Request ConsultarFolios]]
 
−
<br />
 
  
 
; RESPONSE: Parámetros a Recibir al consultar el Método ConsultarFolios
 
; RESPONSE: Parámetros a Recibir al consultar el Método ConsultarFolios
Línea 54: Línea 50:
 
|String
 
|String
 
|Mensaje
 
|Mensaje
−
|Este mensaje está asociado al codigo, útil para identificación de errores
+
|Resumen de folios insertado exitosamente en la Redis Caché
 
|-
 
|-
 
|String
 
|String
Línea 64: Línea 60:
 
|Identificador del contribuyente asignado por The Factory HKA Colombia (Uso Interno)
 
|Identificador del contribuyente asignado por The Factory HKA Colombia (Uso Interno)
 
|-
 
|-
−
|Array <CatalogosAsociados>
+
|String
−
|CatalogosAsociados
+
|Errores
−
|Histórico de las CatalogosAsociados configuradas en TFHKA para los diferentes Catalogos Existentes
+
|Identificador hace referencia a los errores que se puedan presentar
 
|-
 
|-
−
|String
+
|Folios<Folios>
−
|Array <Errores>
+
|Folios
−
|Lista de errores en caso de error al consumo del servicio
+
|Contiene al informacion referente a los proceso de carga de folios del contribuyente.
 
|}  
 
|}  
 
{{clear}}
 
{{clear}}
  
  
−
Donde CatalogosAsociados contiene la siguiente información:
+
Donde Folios contiene la siguiente información:
  
−
; RESPONSE: Parámetros a Recibir Array CatalogosAsociados
+
; RESPONSE: Parámetros a Recibir Array Folios
 
{| class="mw-collapsible wikitable"  
 
{| class="mw-collapsible wikitable"  
 
! style="background:#f2f2f2; text-align:center;"|Tipo
 
! style="background:#f2f2f2; text-align:center;"|Tipo
Línea 84: Línea 80:
 
|- valign="center"
 
|- valign="center"
 
|-
 
|-
−
|Array <Catalogos>
+
|String
−
|Catalogos
+
|Comprados
−
|Histórico de las Catalogos configuradas en los portales de HKA Factura existentes
+
|Informa el valor de folios adquiridos por el contribuyente
 
|-
 
|-
 +
|String
 +
|Consumidos
 +
|Informa el valor de folios utilizados por el cliente
 +
|-
 +
|String
 +
|ConsumidosValidacionPosterior
 +
|Informaba el valor de folios utilizados en para validacion posterior
 +
|-
 +
|String
 +
|Restantes
 +
|Informa el valor de folios dospinibles para emision de documentos
 +
|-
 +
|String
 +
|Fuente
 +
|Informa Basede Datos
 
|}  
 
|}  
 
{{clear}}
 
{{clear}}
 
<br>
 
<br>
−
<br>
 
  
−
<center>'''Ejemplo  Response ConsultarCatalogoAsociado'''</center>
+
 
−
[[Archivo:ResponseConsultarCatociado.png|800px|sinmarco|centro|Response Consultar CatalogoAsociado]]
 
 
<br />
 
<br />
 
<br />
 
<br />

Revisión actual del 17:58 25 nov 2024

La API ConsultarFolios es un desarrollo elaborado por el equipo de The Factory HKA el cual brinda la posibilidad al contribuyente de consultar los folios, comprados, consumidos y restantes adquiridos con el servicio de The Factory HKA para el ambiente demo y en ambiente de producción.

@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: 

ConsultarFolios

A continuación se documenta la estructura que se debe contemplar en la construcción del Request y el Response del servicio ConsultarFolios 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



RESPONSE
Parámetros a Recibir al consultar el Método ConsultarFolios
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 Resumen de folios insertado exitosamente en la Redis Caché
String Nit Número de documento del contribuyente consultado
String IdEmpresa Identificador del contribuyente asignado por The Factory HKA Colombia (Uso Interno)
String Errores Identificador hace referencia a los errores que se puedan presentar
Folios<Folios> Folios Contiene al informacion referente a los proceso de carga de folios del contribuyente.


Donde Folios contiene la siguiente información:

RESPONSE
Parámetros a Recibir Array Folios
Tipo Identificador Descripción
String Comprados Informa el valor de folios adquiridos por el contribuyente
String Consumidos Informa el valor de folios utilizados por el cliente
String ConsumidosValidacionPosterior Informaba el valor de folios utilizados en para validacion posterior
String Restantes Informa el valor de folios dospinibles para emision de documentos
String Fuente Informa Basede Datos





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