Métodos servicio reportes web soap
El Servicio Reportes Web SOAP, expone métodos a través de los cuales el software de facturación puede administrar la generación de reportes de los documentos emitidos, eliminando así la necesidad al facturador de ingresar al portal The Factory HKA - Dfactura para este fin. A continuación se detallan los métodos disponibles en este Web Services:
Método “DescargarReporte”
Permite descargar un reporte de los documentos electrónicos emitidos y almacenados en la plataforma TFHKA de acuerdo a los filtros indicados en el método ProgramarReporte, es decir, es un proceso asíncrono.
- REQUEST
- Parámetros a Enviar
| Tipo
|
Identificador
|
Descripción
|
| String
|
tokenEmpresa
|
Suministrado por The Factory HKA Colombia
|
| tokenPassword
|
| IdReporte
|
Identificador que se obtiene al programar el reporte
|
- REQUEST
- Parámetros a Recibir
| Tipo
|
Identificador
|
Descripción
|
| int
|
código
|
Indica el Estado de la operación retornado por el servicio: (Por definir catálogo)
|
| String
|
formato
|
Formato del reporte, formatos: (pdf, doc, docx, xls, xlsx)
|
| String
|
hash
|
Código de detección de errores
|
| String
|
mensaje
|
Este mensaje está asociado al código, útil para identificación de errores
|
| String
|
reporte
|
Reporte solicitado codificado en Base64
|
| String
|
resultado
|
Resultado del consumo del método: “Procesado” ó “Error”
|
Método “ProgramarReporte”
Método utilizado para programar los filtros del reporte de los documentos electrónicos emitidos que se desea obtener o descargar a través del método DescargarReporte.
- REQUEST
- Parámetros a Enviar
| Tipo
|
Identificador
|
Descripción
|
| String
|
tokenEmpresa
|
Suministrado por The Factory HKA Colombia
|
| tokenPassword
|
| Reporte
|
reporte
|
Objeto con los datos y filtros del reporte que se desea programar
|
Donde Class.Reporte contiene la siguiente información:
| Tipo
|
Identificador
|
Descripción
|
| String
|
email
|
Correo al cual se enviará el reporte programado
|
| Filtros
|
filtros
|
Campos que se deben visualizar en el reporte
|
| String
|
formato
|
Extensión del archivo adjunto, formatos permitidos: (pdf, doc, docx, xls, xlsx)
|
Donde Class.Filtros contiene la siguiente información:
| Tipo
|
Identificador
|
Descripción
|
| String
|
CodigoProducto
|
Código del producto
|
| String
|
Condicion
|
Condición de la transacción (acuseEstatus)
|
| int
|
Estatus
|
Estatus del documento (entregaCodigo)
|
| String
|
FechaHasta
|
Fecha final del reporte
|
| String
|
FechaInicio
|
Fecha inicial del reporte
|
| String
|
NumeroIdentificacionAdquiriente
|
Número de identificación del adquiriente
|
| Array <ExtrasFiltros>
|
OtrosFiltros
|
Información de otros filtros de interés
|
| String
|
TipoDocumento
|
Tipo documento electrónico. Ver Tabla 1
|
| String
|
TipoIdentificacionAdquiriente
|
Tipo de identificación del adquiriente Ver Tabla 3
|
Donde Class.ExtrasFiltros contiene la siguiente información:
| Tipo
|
Identificador
|
Descripción
|
| String
|
codigoInterno1
|
Etiqueta
|
| String
|
codigoInterno2
|
Descripción Adicional
|
| String
|
nombre
|
Código del campo
|
| String
|
valor
|
Información adicional
|
- REQUEST
- Parámetros a Recibir
| Tipo
|
Identificador
|
Descripción
|
| int
|
código
|
Indica el Estado de la operación retornado por el servicio (Por definir catálogo)
|
| String
|
idReporte
|
Este mensaje está asociado al código, útil para identificación de errores
|
| String
|
mensaje
|
Este mensaje de identificación de errores
|
| String
|
resultado
|
Resultado del consumo del método: “Procesado” ó “Error”
|
Método “SolicitudReporteSincrono”
Método utilizado para solicitar un reporte de manera inmediata (síncrona) de los documentos electrónicos emitidos.
- REQUEST
- Parámetros a Enviar
| Tipo
|
Identificador
|
Descripción
|
| String
|
tokenEmpresa
|
Suministrado por The Factory HKA Colombia
|
| tokenPassword
|
| Filtros
|
filtros
|
Campos que se deben visualizar en el reporte
|
Donde Class.Filtros contiene la siguiente información:
| Tipo
|
Identificador
|
Descripción
|
| String
|
CodigoProducto
|
Código del producto
|
| String
|
Condicion
|
Condición de la transacción (acuseEstatus)
|
| String
|
Estatus
|
Estatus del documento (entregaCodigo)
|
| String
|
FechaHasta
|
Fecha final del reporte
|
| String
|
FechaInicio
|
Fecha inicial del reporte
|
| String
|
NumeroIdentificacionAdquiriente
|
Número de identificación del adquiriente
|
| Array <ExtrasFiltros>
|
OtrosFiltros
|
Información de otros filtros de interés
|
| String
|
TipoDocumento
|
Tipo documento electrónico. Ver Tabla 1
|
| String
|
TipoIdentificacionAdquiriente
|
Tipo de identificación del adquiriente Ver Tabla 3
|
Donde Class.ExtrasFiltros contiene la siguiente información:
| Tipo
|
Identificador
|
Descripción
|
| String
|
codigoInterno1
|
Etiqueta
|
| String
|
codigoInterno2
|
Descripción Adicional
|
| String
|
nombre
|
Código del campo
|
| String
|
valor
|
Información adicional
|
- REQUEST
- Parámetros a Recibir
| Tipo
|
Identificador
|
Descripción
|
| String
|
ResultadosReporte
|
Arreglo con los datos del reporte (En definición)
|
| int
|
código
|
Indica el Estado de la operación retornado por el servicio (Por definir catálogo)
|
| String
|
hash
|
Código de detección de errores
|
| String
|
mensaje
|
Este mensaje está asociado al código, útil para identificación de errores
|
| String
|
pagina
|
Número de página del reporte
|
| String
|
resultado
|
Resultado del consumo del método: “Procesado” ó “Error”
|
| int
|
total
|
Total páginas del reporte
|
