Ver el código de «Api Consola IntTfhkaNomina- Indice Manual Integración Nómina Electrónica»

<includeonly>=</includeonly>== '''Api Consola IntTfhkaNomina''' ==<includeonly>=</includeonly>

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:

<center>'''Configuración Config_ne.xml'''</center>
[[Archivo:ConfiguraciónApi.png|centro|Configuración Api]]


<u>'''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:'''</u>

<center>
{| class="wikitable"
|-
! 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
|}</center>
{{clear}}

=== Funciones de la librería ===
'''<big><u>Versión</u></big>'''

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:

====<big><u>Enviar </u></big>====

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:'''''

<center>'''Enviar.bat'''</center>
[[Archivo:MetodoEnviar.png|centro|Método Enviar]]

*IntTfhkaNomina.exe Enviar NitEmisor RutaArchivoPlano
<br />
'''''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.

<center>
{| class="wikitable"
|-
! 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"''' 

|}</center>
{{clear}}

'''''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:


<center><pre>GEN|código|mensaje|resultado|consecutivoDocumento|CUNE|trackId|nit del empleador|nit empleado|idSoftware|qr|esValidoDian|xml</pre></center>

<br />

====<big><u> Descargar XML </u></big>====

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:'''''

<center>'''DescargarXML.bat'''</center>
[[Archivo:DescargarXML.png|centro|Descargar XML]]

*IntTfhkaNomina.exe DescargarXML JJSM153
<br />
'''''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.

<center>
{| class="wikitable"
|-
! Campo !! Descripción
|-
| IntTfhkaNomina.exe || Nombre del ejecutable
|-
| DescargarXML|| Corresponde al Método DescargarXML
|-
| Consecutivo||Corresponde al consecutivoDocumentoNom
|}</center>
{{clear}}

'''''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:

<center><pre>GEN|código|mensaje|resultado|CUNE|hash|consecutivoDocumento</pre></center>


====<big><u> Descargar PDF </u></big>====

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:'''''

<center>'''DescargarPDF.bat'''</center>
[[Archivo:DescargarPDF.png|centro|Descargar PDF]]

*IntTfhkaNomina.exe DescargarPDF JJSM153
<br />
'''''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.

<center>
{| class="wikitable"
|-
! Campo !! Descripción
|-
| IntTfhkaNomina.exe || Nombre del ejecutable
|-
| DescargarPDF|| Corresponde al Método DescargarPDF
|-
| Consecutivo||Corresponde al consecutivoDocumentoNom
|}</center>
{{clear}}

'''''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:

<center><pre>GEN|código|mensaje|resultado|consecutivoDocumento</pre></center>


====<big><u> Consultar Documento </u></big>====

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:'''''

<center>'''ConsultarDocumento.bat'''</center>
[[Archivo:ConsultarDocumento.png|centro|Consultar Documento]]

*IntTfhkaNomina.exe ConsultarDocumento JJSM153
<br />
'''''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.

<center>
{| class="wikitable"
|-
! Campo !! Descripción
|-
| IntTfhkaNomina.exe || Nombre del ejecutable
|-
| ConsultarDocumento|| Corresponde al Método ConsultarDocumento
|-
| Consecutivo||Corresponde al consecutivoDocumentoNom
|}</center>
{{clear}}

'''''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:

<center><pre>GEN|código|mensaje|resultado|Cune|estatusDocumento|tipoDocumento|descripcionDocumento|consecutivoDocumento|ambiente|
cadenaCune|descripcionEstatusDocumento|esValidoDIAN|trackID|fechaAceptacionDIAN</pre></center>

====<big><u> Consultar Folios </u></big>====

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:'''''

<center>'''ConsultarFolios.bat'''</center>
[[Archivo:ConsultarFolios.png|centro|Consultar Folios]]

*IntTfhkaNomina.exe ConsultarFolios
<br />
'''''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.

<center>
{| class="wikitable"
|-
! Campo !! Descripción
|-
| IntTfhkaNomina.exe || Nombre del ejecutable
|-
| ConsultarFolios|| Corresponde al Método ConsultarFolios
|}</center>
{{clear}}

'''''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:

<center><pre>GEN|código|mensaje|resultado|foliosRestantes</pre></center>