Diferencia entre revisiones de «API ListarReporte»

De tfhkacolwiki
Ir a la navegación Ir a la búsqueda
(Página creada con «La API '''ListarReporte''' es un desarrollo elaborado por el equipo de The Factory HKA el cual brinda la posibilidad al contribuyente de poder listar los Reportes Programad…»)
 
 
(No se muestran 6 ediciones intermedias del mismo usuario)
Línea 6: Línea 6:
 
<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 #ListarReporte|ListarReporte]]'''
+
  '''[[Tips_Urls_de_Emisión #ListarReporteProgramado|ListarReporteProgramado]]'''
 
A continuación se documenta la estructura que se debe contemplar en la construcción del Request y el Response del servicio <u>ListarReporte</u> 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 <u>ListarReporte</u> y de esta forma garantizar la implementación de este nuevo método:
  
Línea 24: Línea 24:
 
|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
 
|ClaveSecreta
 
|ClaveSecreta
−
|Definida por el contribuyente emisor desde el usuario root a través del portal HKA Factura Electrónica en ambiente demo y en ambiente de producción <u>'''PROXIMAMENTE'''</u>
+
|Definida por el contribuyente emisor desde el usuario root a través del portal HKA Factura Electrónica en ambiente demo y en ambiente de producción.
 
|}
 
|}
 
<br>
 
<br>
 +
<br>
 +
 +
<center>'''Ejemplo  Request ListarReporte'''</center>
 +
[[Archivo:RequestListarReporte.png|800px|sinmarco|centro|Request Listar Reporte]]
 +
<br />
 +
<br />
 +
 +
; RESPONSE: Parámetros a Recibir al consumir la Api ListarReporte
 +
{| 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
 +
|Mensaje
 +
|Se retorna el listado de los Reportes
 +
|-
 +
|String
 +
|Resultado
 +
|Resultado del consumo del método:
 +
: “Procesado” ó “Error”
 +
|-
 +
|Array<Informacion>
 +
|Informacion
 +
|Contiene los parametros donde se describe la informacion de los reportes agendados
 +
|}
 +
{{clear}}
 +
 +
Donde Class.Informacion contiene la siguiente información:
 +
 +
; RESPONSE: Parámetros a Recibir Array Informacion
 +
{| 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
 +
|IdReporte
 +
|Codigo identificador del Reporte agendado.
 +
|-
 +
|String
 +
|Nombre
 +
|Nombre del reporte solicitado sus opciones son:
 +
:1= Reporte General En Línea Facturación
 +
:2= Reporte General Programado Facturación
 +
|-
 +
|String
 +
|FechaSolicitud
 +
|Indica la fecha en la que fue agendado la solicitud del reporte.
 +
|-
 +
|String
 +
|FechaEjecucion
 +
|Indica la fecha en la que se ejecuta o se expide el reporte agendado.
 +
|-
 +
|String
 +
|CodigoEstatus
 +
|Codigo del  estatus para identificar la generacion del reporte:
 +
:0= No Generado
 +
:201= Generado
 +
|-
 +
|String
 +
|DescripcionEstatus
 +
|Describe el proceso del estatus del reporte agendado.
 +
:Agendado
 +
:Vacio
 +
|-
 +
|String
 +
|AgendadoEstadoLegal
 +
|Indica si el reporte agendado se solicito con EstadoLegal.
 +
|-
 +
|String
 +
|GeneradoEstadoLegal
 +
|Indica si el reporte agendado se genero con EstadoLegal.
 +
|-
 +
|String
 +
|NombreArchivo
 +
|Indica si el reporte se genero con un nombre establecido.
 +
|-
 +
|String
 +
|NombreUsuario
 +
|Indica el nombre del usuario que agendo el reporte.
 +
|-
 +
|String
 +
|CorreoUsuario
 +
|Indica el correo del usuario que agendo el reporte.
 +
|}
 +
{{clear}}
 +
<br>
 +
<br>
 +
 +
RequestListarReporte
 +
 +
<center>'''Ejemplo  Response ListarReporte'''</center>
 +
[[Archivo:ListarReporteProgramado.png|800px|sinmarco|centro|Listar Reporte Programado]]
 +
<br />
 +
<br />

Revisión actual del 03:42 13 jul 2024

La API ListarReporte es un desarrollo elaborado por el equipo de The Factory HKA el cual brinda la posibilidad al contribuyente de poder listar los Reportes Programado o agendados previamente se puede utilizar en el ambiente demo y en ambiente de producción o al realizar el consumo del servicio a través de la Api ListarReporte.

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

ListarReporteProgramado

A continuación se documenta la estructura que se debe contemplar en la construcción del Request y el Response del servicio ListarReporte 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 emisor.
String TokenEmpresa Suministrado por The Factory HKA Colombia según el ambiente a consultar
TokenClave
String ClaveSecreta Definida por el contribuyente emisor desde el usuario root a través del portal HKA Factura Electrónica en ambiente demo y en ambiente de producción.



Ejemplo Request ListarReporte
Request Listar Reporte



RESPONSE
Parámetros a Recibir al consumir la Api ListarReporte
Tipo Identificador Descripción
int Código Indica el estado de la operación retornado por el servicio
String Mensaje Se retorna el listado de los Reportes
String Resultado Resultado del consumo del método:
“Procesado” ó “Error”
Array<Informacion> Informacion Contiene los parametros donde se describe la informacion de los reportes agendados

Donde Class.Informacion contiene la siguiente información:

RESPONSE
Parámetros a Recibir Array Informacion
Tipo Identificador Descripción
String IdReporte Codigo identificador del Reporte agendado.
String Nombre Nombre del reporte solicitado sus opciones son:
1= Reporte General En Línea Facturación
2= Reporte General Programado Facturación
String FechaSolicitud Indica la fecha en la que fue agendado la solicitud del reporte.
String FechaEjecucion Indica la fecha en la que se ejecuta o se expide el reporte agendado.
String CodigoEstatus Codigo del estatus para identificar la generacion del reporte:
0= No Generado
201= Generado
String DescripcionEstatus Describe el proceso del estatus del reporte agendado.
Agendado
Vacio
String AgendadoEstadoLegal Indica si el reporte agendado se solicito con EstadoLegal.
String GeneradoEstadoLegal Indica si el reporte agendado se genero con EstadoLegal.
String NombreArchivo Indica si el reporte se genero con un nombre establecido.
String NombreUsuario Indica el nombre del usuario que agendo el reporte.
String CorreoUsuario Indica el correo del usuario que agendo el reporte.



RequestListarReporte

Ejemplo Response ListarReporte
Listar Reporte Programado



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