API ConsultarFolios - Historial de revisiones

Dmrodriguez2 en 13:47 27 jun 2025

2025-06-27T13:47:02Z

← Revisión anterior		Revisión del 13:47 27 jun 2025
Línea 2:		Línea 2:
	<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 ConsultarFolios 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:
	<br>		<br>

Dmrodriguez2 en 17:58 25 nov 2024

2024-11-25T17:58:11Z

← Revisión anterior		Revisión del 17:58 25 nov 2024
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 106:		Línea 102:
	{{clear}}		{{clear}}
	<br>		<br>
	~~<br>~~

	~~<center>'''Ejemplo Response Folios'''</center>~~
	~~[[Archivo:ResponseConsultarFolios.png\|800px\|sinmarco\|centro\|Response Consultar Folios]]~~
	<br />		<br />
	<br />		<br />

Dmrodriguez2 en 15:59 8 oct 2024

2024-10-08T15:59:26Z

← Revisión anterior		Revisión del 15:59 8 oct 2024
Línea 54:		Línea 54:
	\|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 64:
	\|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 84:
	\|- 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}}
Línea 93:		Línea 108:
	<br>		<br>

	<center>'''Ejemplo Response ~~ConsultarCatalogoAsociado~~'''</center>		<center>'''Ejemplo Response Folios'''</center>
	[[Archivo:~~ResponseConsultarCatociado~~.png\|800px\|sinmarco\|centro\|Response Consultar ~~CatalogoAsociado~~]]		[[Archivo:ResponseConsultarFolios.png\|800px\|sinmarco\|centro\|Response Consultar Folios]]
	<br />		<br />
	<br />		<br />

Dmrodriguez2: 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,…»

2024-10-04T16:45:38Z

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,…»

Página nueva

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:'''
'''[[Tips_Urls_de_Emisión #ConsultarFolios |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
{| 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"
|-
|String
|Nit
|Número de documento del contribuyente a consultar
|-
|rowspan="2"|String
|TokenEmpresa
|rowspan="2"|Suministrado por The Factory HKA Colombia según el ambiente a consultar
|-
|TokenClave
|}
 
 

<center>'''Ejemplo Request ConsultarFolios'''</center>
[[Archivo:RequestConsultarFolios.png|800px|sinmarco|centro|Request ConsultarFolios]]
 

; RESPONSE: Parámetros a Recibir al consultar el Método ConsultarFolios
{| 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}}
 
 

<center>'''Ejemplo Response ConsultarCatalogoAsociado'''</center>
[[Archivo:ResponseConsultarCatociado.png|800px|sinmarco|centro|Response Consultar CatalogoAsociado]]