Web soap reporting service methods
The SOAP Web Reports Service exposes methods through which the billing software can manage the generation of reports of issued documents, thus eliminating the need for the biller to enter The Factory HKA - Dfactura portal for this purpose. The methods available in this Web Services are detailed below:
“DescargarReporte” Method
It allows downloading a report of the electronic documents issued and stored in the TFHKA platform according to the filters indicated in the ProgramarReporte method, that is, it is an asynchronous process.
- REQUEST
- Parameters to Send
| Type
|
Identifier
|
Description
|
| String
|
tokenEmpresa
|
Supplied by The Factory HKA Colombia
|
| tokenPassword
|
| IdReporte
|
Identifier obtained when scheduling the report
|
- REQUEST
- Parameters to Receive
| Type
|
Identifier
|
Description
|
| int
|
código
|
Indicates the Status of the operation returned by the service: (To define catalog)
|
| String
|
formato
|
Report format, formats: (pdf, doc, docx, xls, xlsx)
|
| String
|
hash
|
Error detection code
|
| String
|
mensaje
|
This message is associated with the code, useful for identifying errors
|
| String
|
reporte
|
Requested report encoded in Base64
|
| String
|
resultado
|
Method consumption result: “Processed” or “Error”
|
“ProgramarReporte” Method
Method used to program the report filters of the electronic documents issued that you want to obtain or download through the DescargarReporte method.
- REQUEST
- Parameters to Send
| Type
|
Identifierr
|
Description
|
| String
|
tokenEmpresa
|
Supplied by The Factory HKA Colombia
|
| tokenPassword
|
| Reporte
|
reporte
|
Object with the data and filters of the report to be programmed
|
Where Class.Reporte contains the following information:
| Type
|
Identifier
|
Description
|
| String
|
email
|
Email to which the scheduled report will be sent
|
| Filtros
|
filtros
|
Fields to be displayed in the report
|
| String
|
formato
|
Attachment extension, allowed formats: (pdf, doc, docx, xls, xlsx)
|
Where Class.Filtros contains the following information:
| Type
|
Identifier
|
Description
|
| String
|
CodigoProducto
|
Product code
|
| String
|
Condicion
|
Transaction condition (acuseEstatus)
|
| int
|
Estatus
|
Document Status (entregaCodigo)
|
| String
|
FechaHasta
|
Report end date
|
| String
|
FechaInicio
|
Initial date of the report
|
| String
|
NumeroIdentificacionAdquiriente
|
Acquirer Identification Number
|
| Array <ExtrasFiltros>
|
OtrosFiltros
|
Information on other filters of interest
|
| String
|
TipoDocumento
|
Electronic document type. WatchTabla 1
|
| String
|
TipoIdentificacionAdquiriente
|
Type of acquirer identification See Tabla 3
|
Where Class.ExtrasFiltros contains the following information:
| Type
|
Identifier
|
Description
|
| String
|
codigoInterno1
|
Hashtag
|
| String
|
codigoInterno2
|
Additional Description
|
| String
|
nombre
|
Field code
|
| String
|
valor
|
Additional Information
|
- REQUEST
- Parameters to Receive
| Type
|
Identifier
|
Description
|
| int
|
código
|
Indicates the status of the operation returned by the service (to define catalog)
|
| String
|
idReporte
|
This message is associated with the code, useful for identifying errors
|
| String
|
mensaje
|
This error identification message
|
| String
|
resultado
|
Method consumption result: “Processed” or “Error”
|
“SolicitudReporteSincrono” Method
Method used to request a report immediately (synchronously) of the electronic documents issued.
- REQUEST
- Parameters to Send
| Type
|
Identifier
|
Description
|
| String
|
tokenEmpresa
|
Supplied by The Factory HKA Colombia
|
| tokenPassword
|
| Filtros
|
filtros
|
Fields to be displayed in the report
|
Donde Class.Filtros contiene la siguiente información:
| Type
|
Identifier
|
Description
|
| String
|
CodigoProducto
|
Product code
|
| String
|
Condicion
|
Transaction condition (acuseEstatus)
|
| String
|
Estatus
|
Document Status (entregaCodigo)
|
| String
|
FechaHasta
|
Report end date
|
| String
|
FechaInicio
|
Initial date of the report
|
| String
|
NumeroIdentificacionAdquiriente
|
Acquirer Identification Number
|
| Array <ExtrasFiltros>
|
OtrosFiltros
|
Information on other filters of interest
|
| String
|
TipoDocumento
|
Electronic document type. Watch Tabla 1
|
| String
|
TipoIdentificacionAdquiriente
|
Type of acquirer identification. Watch Tabla 3
|
Where Class.ExtrasFiltros contains the following information:
| Type
|
Identifier
|
Description
|
| String
|
codigoInterno1
|
Hashtag
|
| String
|
codigoInterno2
|
Additional Description
|
| String
|
nombre
|
field code
|
| String
|
valor
|
Additional Information
|
- REQUEST
- Parameters to Receive
| Type
|
Identifier
|
Description
|
| String
|
ResultadosReporte
|
Arrangement with the report data (In definition)
|
| int
|
código
|
Indicates the status of the operation returned by the service (to define catalog)
|
| String
|
hash
|
Error detection code
|
| String
|
mensaje
|
This message is associated with the code, useful for identifying errors
|
| String
|
pagina
|
Report page number
|
| String
|
resultado
|
Method consumption result: “Processed” or “Error”
|
| int
|
total
|
Total Report Pages
|
