Documentos de Académico
Documentos de Profesional
Documentos de Cultura
API IntTfhkaFel21
(Integración Directa)
Junio, 2020
Versión 1.6
El presente manual tiene como propósito dar a conocer los detalles de la interfaz de
aplicación IntTfhkaFel21 para la integración directa y la descripción de las funciones
para la generación de facturación electrónica ofrecida por The Factory HKA Colombia
SAS.
2. ALCANCE
El presente documento abarca desde la configuración del API hasta las funciones
utilizables para el consumo del Servicio Web de Integración. La librería IntTfhkaFel21
es multiplataforma, es decir, compatible con sistemas operativos Windows y Linux.
3. DEFINICIONES Y TÉRMINOS
Servicio Web de Integración: Servicio Web de The Factory HKA Colombia SAS
puesto en disposición a propietarios de software administrativos o de gestión para la
generación de factura electrónica.
4. CONFIGURACIÓN
5. FUNCIONES DE LA LIBRERÍA
version
Para saber la versión del API IntfhkaFel21, puede ejecutar el siguiente comando
desde la consola del sistema:
FoliosRestantes
Permite consultar la cantidad de folios. Los valores de la consulta son almacenados
en el archivo Resultado.txt.
Comando:
IntTfhkaFel21.exe FoliosRestantes (Windows)
./IntTfhkaFel21 FoliosRestantes (Linux)
Ejemplo:
01|200|9929|Se retorna folios restantes.|Procesado
EstadoDocumento
Permite consultar el estado de un documento. Los valores de la consulta son
almacenados en el archivo Resultado.txt.
Comando:
IntTfhkaFel21.exe EstadoDocumento PRUE100 (Windows)
./IntTfhkaFel21 EstadoDocumento PRUE100 (Linux)
Parámetros: String numeroDocumento: Numero del documento a consultar
Retorno: Mensaje en ventana del sistema
aceptacionFisica
acuseComentario
acuseEstatus
acuseResponsable
acuseRespuesta
ambiente
cadenaCufe
código
NOTA: Se genera una línea con identificador 01B por cada email informado en el
identificador 01A al momento de la emisión del documento.
DescargarXml
Permite descargar un documento en formato XML. Los valores de la consulta son
almacenados en el archivo Resultado.txt y el archivo XML es creado en la carpeta
donde se ejecuta la librería.
Comando:
IntTfhkaFel21.exe DescargarXML PRUE100 (Windows)
./IntTfhkaFel21 DescargarXML PRUE100 (Linux)
Parámetros: String numeroDocumento: Numero del documento a consultar
Retorno: Mensaje en ventana del sistema
Código
Cufe
Mensaje.
Resultado
Resultado.txt: Campos separados por el carácter porcentaje “%”. El campo Id
hace referencia a que el servicio consumido fue el de Emisión (01), los demás
campos son propios de la respuesta de servicio.
Id|Código|CUFE|Mensaje|Resultado
DescargarPDF
Permite descargar la representación gráfica de un documento. Los valores de la
consulta son almacenados en el archivo Resultado.txt y el archivo PDF es creado en
la carpeta donde se ejecuta la librería.
Comando:
IntTfhkaFel21.exe DescargarPDF PRUE100 (Windows)
./IntTfhkaFel21 DescargarPDF PRUE100 (Linux)
Parámetros: String numeroDocumento: Numero del documento a consultar
Retorno: Mensaje en ventana del sistema
Código
Cufe
Mensaje.
Resultado
Resultado.txt: Campos separados por el carácter pipe “|”. El campo Id hace
referencia a que el servicio consumido fue el de Emisión (01), los demás campos
son propios de la respuesta de servicio.
Id|Código|CUFE|Mensaje|Resultado
Ejemplo:
01|200|2257bd44493a74d0a13da41700b3f95c77a83fe4|Se retorna el archivo
solicitado.|Procesado
Ejemplo:
01|200|Se ha enviado el email de manera correcta.|Procesado
-Con error:
01|109|||2019-09-15 01:59:04|El documento no superó las validaciones.||False||||
01A|El campo obligaciones debe tener un valor del catálogo.
Envío de Adjuntos
Para esta funcionalidad, se envía el archivo adjunto en un archivo .txt distinto a donde
se carga la información del documento electrónico, se debe seguir la siguiente
estructura en la emisión del documento, teniendo en cuenta que el documento
emitido queda pendiente por adjuntos al enviar el Parámetro Adjuntos en “1” u
“11” Ver tabla 1.
Número de la Factura
Número de
2 SI AN|..20 Electrónica a la cual se asocian
Documento
los archivos adjuntos.
Indicar si el documento es
6 Tipo SI N|1 Representación gráfica:
2- Anexo
01|Pedro|2||Perez|12345678|13|email@thefactoryhka.com|04245555555|SI|0010|The
Factory HKA Colombia|Pedro Perez||8|||||
01A|0|email1@thefactoryhka.com,email2@thefactoryhka.com|2019-08-07
00:00:00||12345789|5555555||||
01B|01||||
01C|||||||BOGOTÁ, D.C.|11||Bogotá||Calle 1|||es|11001||||CO|||||110211||||
01D|||||||BOGOTÁ, D.C.|11||Bogotá||Calle 1|||es|11001||||CO|||||110211||||
01E|00001|CONSORCIO ALIANZA SAN CRISTOBAL 4|901041710|5|123456|BC|31
01F|O-15|04||||
02|01|CONSECUTIVO|PEFIJO-DESDE|2019-09-12
00:00:00||COP|||1003.00|1193.57|2||||0.00|05||1003.00|1193.57||1
02G|1003.00|01||19.00|WSD||190.57|||||
02H|01|190.57||||
02I|TEXTO INFO ADICIONAL 1
02I|TEXTO INFO ADICIONAL 2
02J|||||10|1||0001||||||
03|P000001|Impresora
HKA80|1.00|WSD|1003.00|1003.00|90.00||1|1.00|WSD|||||999||||PHKA80||||||||0||
||1|||||||||||||||||||||||||||||||||||||||||1003.00|01||19.00|WSD||190.57||||
||||||||||||||||||||||||||01|190.57|||||||||||||||||||||||||||
04|||100200|1|123456|1
05|PARAMETROADJUNTO
Resultado.txt: Campos separados por el carácter pipe “|” y cada respuesta por
archivo adjunto separados por un salto de línea. El campo Id hace referencia a que
el servicio consumido fue el de Emisión (01), los demás campos son propios de la
respuesta de servicio, por ejemplo:
01|200|VALF162|a1a3283d31e284c3d77326a5efa2e2a05a45f2c034c2d66649371bda
7239d73703e42e8b1c9420bae6e1dae90cf88ab5|2019-09-17 12:42:52| Documento
pendiente por Adjuntos.
|Procesado|True|593b52129119d248c3b1466f5db7f8168b13c279|fv0020519221016
1900000162.xml|CUFE-SHA384
05|VALF1|0|pdf|Adjunto1|2|email1@thefactoryhka.com,
email2@thefactoryhka.com|Adjunto1.pdf
05|VALF1|1|pdf|Adjunto2|2|email1@thefactoryhka.com,
email2@thefactoryhka.com|Adjunto2.pdf
Resultado.txt: Campos separados por el carácter pipe “|” y cada respuesta por
archivo adjunto separados por un salto de línea. El campo Id hace referencia a que
el servicio consumido fue el de Adjuntos (02), los demás campos son propios de la
respuesta de servicio, por ejemplo:
Comando:
IntTfhkaFel21.exe GenerarContenedor PRUE100 (Windows)
./IntTfhkaFel21 GenerarContenedor PRUE100 (Linux)
Parámetros: String numeroDocumento: Numero del documento al cual se le
generará el contenedor.
Retorno: Mensaje en ventana del sistema
código
fecha
mensaje
resultado
Resultado.txt: Campos separados por el carácter pipe “|”. El campo Id hace
referencia a que el servicio consumido fue el de Emisión (01), los demás campos son
propios de la respuesta de servicio.
Id|código|fechaDocumento|mensaje|resultado
Ejemplo:
01|200|2020-01-22 10:04:36-05:00|Documento Generado con éxito|Procesado
Nota: Las funciones descritas anteriormente fueron puestas a prueba bajo los
siguientes Sistemas Operativos:
Windows 7 - 64bits
Windows 10 - 64bits
Windows XP - 32bits
Linux CentOS 6.9 (Final) - 32bits
Linux CentOS 7.5.1804 (Core) - 64bits
Linux Kali 2016.1 – 32bits
Ubuntu 18.04 LTS – 64bits
Método EstadoDocumento
Códigos Genéricos Resultado Código de Mensaje
Respuesta
Respuesta Satisfactoria Procesado 200 Se retornan datos de la factura
Token Invalido Error 101 El Token del Emisor es inválido.
Número de documento inválido, no
Error en Validaciones Error 102
existe.
Ha ocurrido un error en la ejecución del
Error de Ejecución Error 103
servicio, por favor intente más tarde.
Error al Extraer Datos Error 105 Error al extraer los datos del documento.
Método DescargaPDF
Códigos Genéricos Resultado Código de Mensaje
Respuesta
Respuesta
Procesado 200 Se retorna el archivo solicitado
Satisfactoria
Token Invalido Error 101 El Token del Emisor es inválido.
Error en Validaciones Error 102 Número de documento inválido, no existe.
Ha ocurrido un error en la ejecución del
Error de Ejecución Error 103
servicio, por favor intente más tarde.
Error, no se pudo obtener el archivo
Error al Extraer Datos Error 105
solicitado.
Método DescargaXML
Códigos Genéricos Resultado Código de Mensaje
Respuesta
Respuesta
Procesado 200 Se retorna el archivo solicitado
Satisfactoria
Token Invalido Error 101 El Token del Emisor es inválido.
Error en Validaciones Error 102 Número de documento inválido, no existe.
Ha ocurrido un error en la ejecución del
Error de Ejecución Error 103
servicio, por favor intente más tarde.
Error, no se pudo obtener el archivo
Error al Extraer Datos Error 105
solicitado.
Método FoliosRestantes
Códigos Genéricos Resultado Código de Mensaje
Respuesta
Respuesta
Procesado 200 Se retorna folios restantes.
Satisfactoria
Token Invalido Error 101 El Token del Emisor es inválido.
Error en Validaciones Error 102 Número de documento inválido, no existe.
Ha ocurrido un error en la ejecución del
Error de Ejecución Error 103
servicio, por favor intente más tarde.
Método CargarAdjuntos
Códigos Genéricos Resultado Código de Mensaje
Respuesta
Archivo {nombreDelArchivo}{extension}
Envío satifactorio Procesado 200
almacenado exitosamente
Se señaló previamente que para el
documento {consecutivo} emitido por
Error en carga de {NIT Emisor} ya se habían completado los
Error 107
archivo adjuntos esperados
(Quiere decir que ya la propiedad enviar
fuen setada en “1” anteriormente)
[Sección del Error]El campo {nombre del
campo} debe tener un valor del catálogo.
[Sección del Error]El campo {nombre del
Error en Validaciones Error 109 campo} es requerido.
[Sección del Error]El campo {nombre del
campo} debe ser un {tipo de datos} de
{tamaño} {numérico/alfanumérico}.