Diferencia entre revisiones de «API ListarReporte»
| (No se muestran 3 ediciones intermedias del mismo usuario) | |||
| 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 | ||
|- | |- | ||
| − | | | + | |TokenClave |
|- | |- | ||
|String | |String | ||
| Línea 32: | Línea 32: | ||
<br> | <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 | ; RESPONSE: Parámetros a Recibir al consumir la Api ListarReporte | ||
{| class="mw-collapsible wikitable" | {| class="mw-collapsible wikitable" | ||
| Línea 51: | Línea 57: | ||
|Resultado del consumo del método: | |Resultado del consumo del método: | ||
: “Procesado” ó “Error” | : “Procesado” ó “Error” | ||
| − | |||
| − | |||
| − | |||
| − | |||
|- | |- | ||
|Array<Informacion> | |Array<Informacion> | ||
|Informacion | |Informacion | ||
| − | | | + | |Contiene los parametros donde se describe la informacion de los reportes agendados |
|} | |} | ||
{{clear}} | {{clear}} | ||
| Línea 122: | Línea 124: | ||
|} | |} | ||
{{clear}} | {{clear}} | ||
| + | <br> | ||
| + | <br> | ||
| − | + | RequestListarReporte | |
<center>'''Ejemplo Response ListarReporte'''</center> | <center>'''Ejemplo Response ListarReporte'''</center> | ||
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. |
- 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:
|
| 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:
|
| 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:
|
| String | DescripcionEstatus | Describe el proceso del estatus del reporte agendado.
|
| 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
