Diferencia entre revisiones de «API DescargarReporte»
Ir a la navegación
Ir a la búsqueda
Sin resumen de edición |
Sin resumen de edición |
||
| (No se muestran 4 ediciones intermedias del mismo usuario) | |||
| Línea 22: | Línea 22: | ||
|rowspan="2"|String | |rowspan="2"|String | ||
|TokenEmpresa | |TokenEmpresa | ||
|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 | ||
|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 | |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. | ||
|- | |- | ||
|String | |String | ||
|IdReporte | |IdReporte | ||
|Codigo con el | |Codigo con el que se identifica el reporte a descargar. | ||
|- | |||
|String | |||
|FormatoRequerido | |||
|Permite elegir el tipo de formato en el que desea descargar el reporte: | |||
: 1 Formato CSV | |||
: 2 Formato JSON | |||
|} | |} | ||
<br> | |||
; RESPONSE: Parámetros a Recibir al consumir la Api DescargarReporte | |||
{| 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 | |||
|El Reporte ha sido descargado satisfactoriamente | |||
|- | |||
|String | |||
|Resultado | |||
|Resultado del consumo del método: | |||
: “Procesado” ó “Error” | |||
|- | |||
|String | |||
|IdReporte | |||
|Codigo identificador del Reporte agendado descargado. | |||
|- | |||
|String | |||
|AgendadoEstadoLegal | |||
|Codigo indica si el reporte agendado se descargo con estadoLegal | |||
|- | |||
|String | |||
|GeneradoEstadoLegal | |||
|Codigo indica si el reporte generado se descargo con estadoLegal | |||
|- | |||
|String | |||
|ReporteCodificado | |||
|Reporte codificado Base 64 este se encuentra dentro de un .zip. | |||
|- | |||
|String | |||
|NombreArchivo | |||
|Nombre del reporte descargado, este es generado automaticamente por el servicio. | |||
|- | |||
|String | |||
|Errores | |||
|Indica la descripcion de los posibles errores al momento de descargar el reporte agendado. | |||
|} | |||
{{clear}} | |||
<br> | |||
<br /> | |||
<br /> | |||
<br> | |||
<br> | <br> | ||
Revisión actual - 18:08 25 nov 2024
La API DescargarReporte es un desarrollo elaborado por el equipo de The Factory HKA el cual brinda la posibilidad al contribuyente de poder descargar los diferentes 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 DescargarReporte.
@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:
DescargarReporteProgramado
A continuación se documenta la estructura que se debe contemplar en la construcción del Request y el Response del servicio DescargarReporte 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. |
| String | IdReporte | Codigo con el que se identifica el reporte a descargar. |
| String | FormatoRequerido | Permite elegir el tipo de formato en el que desea descargar el reporte:
|
- RESPONSE
- Parámetros a Recibir al consumir la Api DescargarReporte
| Tipo | Identificador | Descripción |
|---|---|---|
| int | Código | Indica el estado de la operación retornado por el servicio |
| String | Mensaje | El Reporte ha sido descargado satisfactoriamente |
| String | Resultado | Resultado del consumo del método:
|
| String | IdReporte | Codigo identificador del Reporte agendado descargado. |
| String | AgendadoEstadoLegal | Codigo indica si el reporte agendado se descargo con estadoLegal |
| String | GeneradoEstadoLegal | Codigo indica si el reporte generado se descargo con estadoLegal |
| String | ReporteCodificado | Reporte codificado Base 64 este se encuentra dentro de un .zip. |
| String | NombreArchivo | Nombre del reporte descargado, este es generado automaticamente por el servicio. |
| String | Errores | Indica la descripcion de los posibles errores al momento de descargar el reporte agendado. |