API DescargarReporte

De tfhkacolwiki
Ir a la navegación Ir a la búsqueda

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
TokenPassword
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 PROXIMAMENTE
String IdReporte Codigo con el quese identifica el reporte a descargar PROXIMAMENTE



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:
“Procesado” ó “Error”
String IdReporte Codigo identificador del Reporte agendado
String AgendadoEstadoLegal Codigo indica si el reporte agendado viene con estado Legal
String GeneradoEstadoLegal Codigo indica si el reporte agendado viene con estado Legal
String ReporteCodificado Reporte codificado Base 64
String NombreArchivo Reporte codificado Base 64