Diferencia entre revisiones de «Manual de usuario API IntTfhkaNomina»
| Línea 21: | Línea 21: | ||
<center>'''Configuración Config_ne.xml'''</center> | <center>'''Configuración Config_ne.xml'''</center> | ||
| − | [[Archivo:ConfiguraciónApi.png|centro|Configuración Api]] | + | [[Archivo:ConfiguraciónApi.png|800px|centro|Configuración Api]] |
| Línea 62: | Línea 62: | ||
*IntTfhkaNomina.exe Enviar NitEmisor RutaArchivoPlano | *IntTfhkaNomina.exe Enviar NitEmisor RutaArchivoPlano | ||
<center>'''Enviar.bat'''</center> | <center>'''Enviar.bat'''</center> | ||
| − | [[Archivo:MetodoEnviar.png|centro|Método Enviar]] | + | [[Archivo:MetodoEnviar.png|800px|centro|Método Enviar]] |
<br> | <br> | ||
| Línea 117: | Línea 117: | ||
*IntTfhkaNomina.exe DescargarXML JJSM153 | *IntTfhkaNomina.exe DescargarXML JJSM153 | ||
<center>'''DescargarXML.bat'''</center> | <center>'''DescargarXML.bat'''</center> | ||
| − | [[Archivo:DescargarXML.png|centro|Descargar XML]] | + | [[Archivo:DescargarXML.png|800px|centro|Descargar XML]] |
<br> | <br> | ||
| Línea 163: | Línea 163: | ||
*IntTfhkaNomina.exe DescargarPDF JJSM153 | *IntTfhkaNomina.exe DescargarPDF JJSM153 | ||
<center>'''DescargarPDF.bat'''</center> | <center>'''DescargarPDF.bat'''</center> | ||
| − | [[Archivo:DescargarPDF.png|centro|Descargar PDF]] | + | [[Archivo:DescargarPDF.png|800px|centro|Descargar PDF]] |
<br> | <br> | ||
| Línea 208: | Línea 208: | ||
*IntTfhkaNomina.exe ConsultarDocumento JJSM153 | *IntTfhkaNomina.exe ConsultarDocumento JJSM153 | ||
<center>'''ConsultarDocumento.bat'''</center> | <center>'''ConsultarDocumento.bat'''</center> | ||
| − | [[Archivo:ConsultarDocumento.png|centro|Consultar Documento]] | + | [[Archivo:ConsultarDocumento.png|800px|centro|Consultar Documento]] |
<br> | <br> | ||
| Línea 263: | Línea 263: | ||
*IntTfhkaNomina.exe ConsultarFolios | *IntTfhkaNomina.exe ConsultarFolios | ||
<center>'''ConsultarFolios.bat'''</center> | <center>'''ConsultarFolios.bat'''</center> | ||
| − | [[Archivo:ConsultarFolios.png|centro|Consultar Folios]] | + | [[Archivo:ConsultarFolios.png|800px|centro|Consultar Folios]] |
<br> | <br> | ||
| Línea 305: | Línea 305: | ||
*IntTfhkaNomina.exe EnviarCorreo JJSM153 email@thefactoryhka.com | *IntTfhkaNomina.exe EnviarCorreo JJSM153 email@thefactoryhka.com | ||
<center>'''EnviarCorreo.bat'''</center> | <center>'''EnviarCorreo.bat'''</center> | ||
| − | [[Archivo:EnviarCorreo.png|centro|Envia rCorreo]] | + | [[Archivo:EnviarCorreo.png|800px|centro|Envia rCorreo]] |
<br> | <br> | ||
| Línea 350: | Línea 350: | ||
*IntTfhkaNomina.exe EnviarLote 900390126 Ejemplos/Ejemplo Lote.csv | *IntTfhkaNomina.exe EnviarLote 900390126 Ejemplos/Ejemplo Lote.csv | ||
<center>'''EnviarLote.bat'''</center> | <center>'''EnviarLote.bat'''</center> | ||
| − | [[Archivo:EnviarLote.png|centro|Enviar Lote]] | + | [[Archivo:EnviarLote.png|800px|centro|Enviar Lote]] |
<br> | <br> | ||
Revisión del 20:50 28 ene 2022
Sumario
Api Consola IntTfhkaNomina
En este apartado se brindaran todas las características que The Factory HKA Colombia a implementado para la integración de Nómina Electrónica a través de la creación de una Api consola la cual podrá ser utilizada por lenguajes de programación con limitaciones para consumir de manera directa servicios web tipo Rest y Soap, este desarrollo es multiplataforma y recibe archivos planos con una estructura definida por nosotros, el consumo del api es muy sencillo y solo deben centrarse en generar el origen de datos en el formato txt.
Objetivo
El presente manual tiene como propósito dar a conocer los detalles de la interfaz de aplicación IntTfhkaNomina para la integración directa y la descripción de las funciones para la generación de Nómina Electrónicao y Nómina de Ajuste ofrecida por The Factory HKA Colombia SAS.
Alcance
El presente documento abarca desde la configuración del API hasta las funciones utilizables para el consumo del Api Consola a traves de archivos planos. La librería IntTfhkaNomina es multiplataforma, es decir, compatible con sistemas operativos Windows, Linux y Mac. Esta librería permite consumir el servicio de integración de The Factory HKA Colombia SAS en sistemas administrativos (ERP) que nativamente tienen limitantes para el consumo de servicios web referenciando o importando el WSDL.
Definiciones y Términos
EXE: En el ámbito de la informática .exe (de la abreviación del inglés executable, que se traduce en ejecutable) es una extensión que se refiere a un archivo ejecutable de código reubicable, es decir, sus direcciones de memoria son relativas. Los sistemas operativos que utilizan de forma nativa este formato son DOS, Microsoft Windows, OS/2 y ReactOS.
Configuración
En el archivo descargado, se encontrará con las tres herramientas básicas para realizar la integración del software administrativo con nuestra plataforma de nómina electrónica: librería de integración indirecta (IntTfhkaNomina), el presente manual y un archivo de texto (config_ne.xml) que contendrá los datos de acceso a la plataforma de facturación electrónica de The Factory HKA. La estructura del archivo config_ne.xml debe ser la siguiente:
Para la adecuada configuración los parámetros que se deben tener en cuenta son los registrados en la tabla que se ilustra a continuación:
| Campo | Descripción |
|---|---|
| Url | Direccion del servicio Rest implementado por The Factory http://demonominaelectronica.thefactoryhka.com.co |
| timeOut | Tiempo de espera de la respuesta del servicio |
| idSoftware | Este campo podrá colocar un dato temporal o vacío |
| token | Puede utilizar los mismos tokens de emisión |
| nit | Debe corresponder al nit del empleador |
| resultado | Nombre que asigna al archivo resultado |
Funciones de la librería
Versión
Para saber la versión del API IntTfhkaNomina , puede ejecutar el siguiente comando desde la consola del sistema:
- IntTfhkaNomina.exe version (Windows)
- ./IntTfhkaNominaversion (Linux)
En el presenta manual se describen las funcionalidades disponibles del API IntTfhkaNomina que pone a disposición del desarrollador la función del Método Enviar del Servicio Web de Integración de The Factory HKA Colombia SAS, dicha funcione se listan a continuación:
Enviar
Función utilizada para la creación del documento Soporte de Pago de Nómina Electrónica y Nómina de Ajuste). La respuesta del servicio se almacena en Resultado.txt.
Comando:
- IntTfhkaNomina.exe Enviar NitEmisor RutaArchivoPlano
Parámetros:
A continuación se relacionan los parámetros requeridos para la configuración del Método Enviar el cual se realizara a través del archivo Enviar.bat que se encuentra en la carpeta Api_Consola - IntTfhkaNomina.
| Campo | Descripción |
|---|---|
| IntTfhkaNomina.exe | Nombre del ejecutable |
| Enviar | Corresponde al Método Enviar |
| Nit | Corresponde a numero de nit del empleador |
| Ruta | Corresponde a la ruta del archivo plano que desea enviar. "EjemplosTXT/TXT_Request_NominaIndividual - Campos Completos.txt" |
Retorno:
Mensaje en ventana del sistema al enviar Documento Soporte de Pago de Nómina Electrónica y Nómina de Ajuste:
- código
- mensaje
- resultado
- consecutivoDocumento
- CUNE
- trackId
- nit del Empleador
- nit Empleado
- idSoftware
- qr
- xml
Resultado.txt:
Campos separados por el carácter pipe “|”. El campo GEN es el identificador cuyo significado es PARAMETROS GENERALES DE LA RESPUESTA al que el servicio consumido fue el de Envió de Documento Soporte de Pago de Nómina Electrónica y Nómina de Ajuste, los demás campos son propios de la respuesta de servicio:
GEN|código|mensaje|resultado|consecutivoDocumento|CUNE|trackId|nit del empleador|nit empleado|idSoftware|qr|esValidoDian|xml
Descargar XML
Permite descargar documento Soporte de Pago de Nómina Electrónica y Nómina de Ajuste 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:
- IntTfhkaNomina.exe DescargarXML JJSM153
Parámetros:
A continuación se relacionan los parámetros requeridos para la configuración del Método Descargar XML el cual se realizara a través del archivo DescargarXML.bat que se encuentra en la carpeta Api_Consola - IntTfhkaNomina.
| Campo | Descripción |
|---|---|
| IntTfhkaNomina.exe | Nombre del ejecutable |
| DescargarXML | Corresponde al Método DescargarXML |
| Consecutivo | Corresponde al consecutivoDocumentoNom |
Retorno:
Mensaje en ventana del sistema al DescargarXML del Documento Soporte de Pago de Nómina Electrónica y Nómina de Ajuste:
- código
- mensaje
- resultado
- CUNE
- hash
- consecutivoDocumento
Resultado.txt:
Campos separados por el carácter pipe “|”. El campo GEN es el identificador cuyo significado es PARAMETROS GENERALES DE LA RESPUESTA al que el servicio consumido fue el de Descargar XML de Documento Soporte de Pago de Nómina Electrónica y Nómina de Ajuste, los demás campos son propios de la respuesta de servicio:
GEN|código|mensaje|resultado|CUNE|hash|consecutivoDocumento
Descargar PDF
Permite descargar la representación gráfica de un documento Soporte de Pago de Nómina Electrónica y Nómina de Ajuste. 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:
- IntTfhkaNomina.exe DescargarPDF JJSM153
Parámetros:
A continuación se relacionan los parámetros requeridos para la configuración del Método Descargar PDF el cual se realizara a través del archivo DescargarPDF.bat que se encuentra en la carpeta Api_Consola - IntTfhkaNomina.
| Campo | Descripción |
|---|---|
| IntTfhkaNomina.exe | Nombre del ejecutable |
| DescargarPDF | Corresponde al Método DescargarPDF |
| Consecutivo | Corresponde al consecutivoDocumentoNom |
Retorno
Mensaje en ventana del sistema al DescargarPDF del Documento Soporte de Pago de Nómina Electrónica y Nómina de Ajuste:
- código
- mensaje
- resultado
- CUNE
- consecutivoDocumento
Resultado.txt:
Campos separados por el carácter pipe “|”. El campo GEN es el identificador cuyo significado es PARAMETROS GENERALES DE LA RESPUESTA al que el servicio consumido fue el de Descargar PDF de Documento Soporte de Pago de Nómina Electrónica y Nómina de Ajuste los demás campos son propios de la respuesta de servicio:
GEN|código|mensaje|resultado|consecutivoDocumento
Consultar Documento
Permite consultar el estado de un documento Soporte de Pago de Nómina Electrónica, Nómina de Ajuste. Los valores de la consulta son almacenados en el archivo Resultado.txt
Comando:
- IntTfhkaNomina.exe ConsultarDocumento JJSM153
Parámetros:
A continuación se relacionan los parámetros requeridos para la configuración del Método ConsultarDocumento el cual se realizara a través del archivo ConsultarDocumento.bat que se encuentra en la carpeta Api_Consola - IntTfhkaNomina.
| Campo | Descripción |
|---|---|
| IntTfhkaNomina.exe | Nombre del ejecutable |
| ConsultarDocumento | Corresponde al Método ConsultarDocumento |
| Consecutivo | Corresponde al consecutivoDocumentoNom |
Retorno:
Mensaje en ventana del sistema al ConsultarDocumento del Documento Soporte de Pago de Nómina Electrónica y Nómina de Ajuste:
- código
- mensaje
- resultado
- CUNE
- estatusDocumento
- tipoDocumento
- descripcionDocumento
- consecutivoDocumento
- ambiente
- cadenaCune
- descripcionEstatusDocumento
- esValidoDIAN
- trackID
- fechaAceptacionDIAN
Resultado.txt:
Campos separados por el carácter pipe “|”. El campo GEN es el identificador cuyo significado es PARAMETROS GENERALES DE LA RESPUESTA al que el servicio consumido fue el de Consultar Documento de Documento Soporte de Pago de Nómina Electrónica y Nómina de Ajuste los demás campos son propios de la respuesta de servicio:
GEN|código|mensaje|resultado|Cune|estatusDocumento|tipoDocumento|descripcionDocumento|consecutivoDocumento|ambiente| cadenaCune|descripcionEstatusDocumento|esValidoDIAN|trackID|fechaAceptacionDIAN
Consultar Folios
Permite consultar la cantidad de folios para procesar el el Soporte de Pago de Nómina Electrónica y Nómina de Ajuste. Los valores de la consulta son almacenados en el archivo Resultado.txt.
Comando:
- IntTfhkaNomina.exe ConsultarFolios
Parámetros:
A continuación se relacionan los parámetros requeridos para la configuración del Método ConsultarFolios el cual se realizara a través del archivo ConsultarFolios.bat que se encuentra en la carpeta Api_Consola - IntTfhkaNomina.
| Campo | Descripción |
|---|---|
| IntTfhkaNomina.exe | Nombre del ejecutable |
| ConsultarFolios | Corresponde al Método ConsultarFolios |
Retorno:
Mensaje en ventana del sistema al ConsultarFolios del Documento Soporte de Pago de Nómina Electrónica, Nota de Ajuste de Documento Soporte de Pago de Nómina Electrónica:
- código
- mensaje
- resultado
- foliosRestantes
Resultado.txt:
Campos separados por el carácter pipe “|”. El campo GEN es el identificador cuyo significado es PARAMETROS GENERALES DE LA RESPUESTA al que el servicio consumido fue el de Consultar Folios de Documento Soporte de Nómina Electrónica,Nota de Ajuste de Documento Soporte de Pago de Nómina Electrónica los demás campos son propios de la respuesta de servicio:
GEN|código|mensaje|resultado|foliosRestantes
Enviar Correo
Permite reenviar el correo que se emite cuando se genera un documento Soporte de Pago de Nómina Electrónica y Nómina de Ajuste si se indica un correo, entonces reenvía el XML y la Representación Gráfica a dicha dirección. Los valores de la consulta son almacenados en el archivo Resultado.txt.
Comando:
- IntTfhkaNomina.exe EnviarCorreo JJSM153 email@thefactoryhka.com
Parámetros:
A continuación se relacionan los parámetros requeridos para la configuración del Método EnviarCorreo el cual se realizara a través del archivo EnviarCorreo.bat que se encuentra en la carpeta Api_Consola - IntTfhkaNomina.
| Campo | Descripción |
|---|---|
| IntTfhkaNomina.exe | Nombre del ejecutable |
| EnviarCorreo | Corresponde al Método ConsultarFolios |
| Consecutivo | Corresponde al consecutivo de la nómina generada |
| Correo | Corresponde al correo electrónico a donde se desea enviar la nómina |
Retorno:
Mensaje en ventana del sistema al EnvarCorreo del Documento Soporte de Pago de Nómina Electrónica, Nota de Ajuste de Documento Soporte de Pago de Nómina Electrónica:
- código
- mensaje
- resultado
Resultado.txt:
Campos separados por el carácter pipe “|”. El campo GEN es el identificador cuyo significado es PARAMETROS GENERALES DE LA RESPUESTA al que el servicio consumido fue el de Enviar Correo de Documento Soporte de Nómina Electrónica,Nota de Ajuste de Documento Soporte de Pago de Nómina Electrónica los demás campos son propios de la respuesta de servicio:
GEN|código|mensaje|resultado
Enviar Lote
Función utilizada para la creación del documento Soporte de Pago de Nómina Electrónica y Nómina de Ajuste cuyo envió se permite realizar de forma masiva a través de un archivo csv o txt donde se almacenan varias lineas de nómina las cuales se envian de forma sincrona. La respuesta del servicio se almacena en Resultado.txt.
Comando:
- IntTfhkaNomina.exe EnviarLote 900390126 Ejemplos/Ejemplo Lote.csv
@IMPORTANTE: Para el consumo del método EnviarLote se en el archivo plano o csv se debe documentar un secuencial creado con las siguientes características:
- Tipo Servicio: PORTAL
- Modalidad Servicio: AUTOMATICO.
Si no ha creado los secuenciales tipo Portal diríjase a la sección:
Parámetros:
A continuación se relacionan los parámetros requeridos para la configuración del Método EnviarLote el cual se realizara a través del archivo EnviarLote.bat que se encuentra en la carpeta Api_Consola - IntTfhkaNomina.
| Campo | Descripción |
|---|---|
| IntTfhkaNomina.exe | Nombre del ejecutable |
| EnviarLote | Corresponde al Método Enviar Lote |
| Nit | Corresponde al Nit del Emisor del documento |
| Ruta | Corresponde a la ruta del archivo plano txt o archivo csv que desea enviar. Ejemplos/Ejemplo Lote.csv |
Retorno:
Al consumir el método EnviarLote para envió del Documento Soporte de Pago de Nómina Electrónica, Nota de Ajuste de Documento Soporte de Pago de Nómina Electrónica, estos parámetros se retornan en el archivo ResponseLote que se almacena en la carpeta lote generada en la carpeta de la Api_Consola - IntTfhkaNomina :
- código
- mensaje
- resultado
- consecutivoDocumento
- CUNE
- trackId
- reglasNotificacionesTFHKA
- reglasNotificacionesDIAN
- reglasRechazoTFHKA
- reglasRechazoDIAN
- nit del Empleador
- nit Empleado
- idSoftware
- qr
- xml
Resultado.txt:
Campos separados por el carácter pipe “|”. El campo GEN es el identificador cuyo significado es PARAMETROS GENERALES DE LA RESPUESTA al que el servicio consumido fue el de Enviar Lote de Documento Soporte de Nómina Electrónica,Nota de Ajuste de Documento Soporte de Pago de Nómina Electrónica los demás campos son propios de la respuesta de servicio:
GEN|código|mensaje|resultado|consecutivoDocumento|CUNE|trackId|reglasNotificacionesTFHKA| reglasNotificacionesDIAN|reglasRechazoTFHKA|reglaRechazoDIAN| nit del empleador|nit empleado|idSoftware|qr|esValidoDian|xml
