Diferencia entre revisiones de «Métodos Servicio Emisión Nómina Electrónica - Indice Manual Integración Nómina Electrónica»
(→Class.Nómina Electrónica) |
(→Método Enviar) |
||
(No se muestran 26 ediciones intermedias de 2 usuarios) | |||
Línea 12: | Línea 12: | ||
|String | |String | ||
|idSoftware | |idSoftware | ||
− | | | + | |Corresponde al NIT del Empleador emisor |
|- | |- | ||
|rowspan="2"|String | |rowspan="2"|String | ||
|tokenEmpresa | |tokenEmpresa | ||
− | |rowspan="2"|Suministrado por el proveedor tecnológico | + | |rowspan="2"|Utilice los Suministrado por el proveedor tecnológico en ambiente Demo. |
|- | |- | ||
|tokenPassword | |tokenPassword | ||
Línea 36: | Línea 36: | ||
! style="background:#f2f2f2; text-align:center;"|Descripción | ! style="background:#f2f2f2; text-align:center;"|Descripción | ||
|- | |- | ||
− | | | + | |consecutivoDocumentoNom |
|String | |String | ||
|<nowiki>AN..20</nowiki> | |<nowiki>AN..20</nowiki> | ||
Línea 44: | Línea 44: | ||
: '''PATH''': /root/NumeroSecuencialXML/(@Numero + Consecutivo) | : '''PATH''': /root/NumeroSecuencialXML/(@Numero + Consecutivo) | ||
: <span style="color:#FFFF; background:#FF0000"><b>Rechazo</b></span> No se permiten caracteres adicionales como espacios o guiones | : <span style="color:#FFFF; background:#FF0000"><b>Rechazo</b></span> No se permiten caracteres adicionales como espacios o guiones | ||
− | : <span style="color:#FFFF; background:#FF0000"><b>Rechazo</b></span> | + | : <span style="color:#FFFF; background:#FF0000"><b>Rechazo</b></span> No se permiten caracteres numéricos en el prefijo. |
− | |||
|- | |- | ||
|deducciones | |deducciones | ||
Línea 65: | Línea 64: | ||
: (ver detalle en [[#Class.Devengados|Class.Devengados]]) | : (ver detalle en [[#Class.Devengados|Class.Devengados]]) | ||
|- | |- | ||
− | | | + | |documentosReferenciadosNom |
− | |Array< | + | |Array<DocumentosReferenciadosNom> |
| - | | - | ||
|SI | |SI | ||
Línea 72: | Línea 71: | ||
: Clase destinada a la referencia de la nomina individual o nomina de ajuste a reemplazar / eliminar | : Clase destinada a la referencia de la nomina individual o nomina de ajuste a reemplazar / eliminar | ||
: '''PATH''': /root/(tipoNota) | : '''PATH''': /root/(tipoNota) | ||
− | : (ver detalle en [[#Class. | + | : (ver detalle en [[#Class.DocumentosReferenciadosNom|Class.DocumentosReferenciadosNom]]) |
|- | |- | ||
− | | | + | |extrasNom |
− | |Array< | + | |Array<ExtensibleNom> |
| - | | - | ||
|NO | |NO | ||
Línea 82: | Línea 81: | ||
: '''PATH''':/NoAplica | : '''PATH''':/NoAplica | ||
|- | |- | ||
− | | | + | |fechaEmisionNom |
|String | |String | ||
|<nowiki>AN|19</nowiki> | |<nowiki>AN|19</nowiki> | ||
Línea 105: | Línea 104: | ||
| | | | ||
: Indica si existe alguna Novedad Contractual en el Documento Soporte de Pago de Nómina Electrónica o Nota de Ajuste de Documento Soporte de Pago de Nómina Electrónica del Trabajador en dicho Mes. | : Indica si existe alguna Novedad Contractual en el Documento Soporte de Pago de Nómina Electrónica o Nota de Ajuste de Documento Soporte de Pago de Nómina Electrónica del Trabajador en dicho Mes. | ||
− | :Se debe colocar | + | :Se debe colocar true = 1, false = 0. |
: '''PATH''': /root/Novedad | : '''PATH''': /root/Novedad | ||
|- | |- | ||
Línea 123: | Línea 122: | ||
: Utilizado para Atributos del Lugar de Generación del Documento XML | : Utilizado para Atributos del Lugar de Generación del Documento XML | ||
: '''PATH''': /root/LugarGeneracionXML | : '''PATH''': /root/LugarGeneracionXML | ||
− | : ( Ver detalle en [[#Class. | + | : ( Ver detalle en [[#Class.Class.LugarGeneracionXML|Class.Class.LugarGeneracionXML]]) |
|- | |- | ||
|pagos | |pagos | ||
Línea 152: | Línea 151: | ||
: (ver detalle en [[#Class.Periodo|Class.Periodo]]) | : (ver detalle en [[#Class.Periodo|Class.Periodo]]) | ||
|- | |- | ||
− | | | + | |rangoNumeracionNom |
|String | |String | ||
|<nowiki>AN..20</nowiki> | |<nowiki>AN..20</nowiki> | ||
Línea 168: | Línea 167: | ||
: '''PATH''': /root/redondeo | : '''PATH''': /root/redondeo | ||
|- | |- | ||
− | | | + | |tipoDocumentoNom |
|String | |String | ||
|<nowiki>N|3</nowiki> | |<nowiki>N|3</nowiki> | ||
|SI | |SI | ||
| | | | ||
− | : Tipo de | + | : Tipo de XML del Documento |
: '''PATH''': /root/InformacionGeneral/@TipoXML | : '''PATH''': /root/InformacionGeneral/@TipoXML | ||
: [[Catálogos de códigos para generación de Nómina Electrónica - Indice Manual Integración Nómina Electrónica #Tabla 9|Tabla 9]] | : [[Catálogos de códigos para generación de Nómina Electrónica - Indice Manual Integración Nómina Electrónica #Tabla 9|Tabla 9]] | ||
|- | |- | ||
− | | | + | |tipoMonedaNom |
|String | |String | ||
|<nowiki>AN|3</nowiki> | |<nowiki>AN|3</nowiki> | ||
Línea 252: | Línea 251: | ||
: '''PATH''': /root.Deducciones/afc | : '''PATH''': /root.Deducciones/afc | ||
|- | |- | ||
− | | | + | |anticiposNom |
− | |Array< | + | |Array<AnticiposNom> |
| | | | ||
|NO | |NO | ||
Línea 259: | Línea 258: | ||
: Utilizado para Todos los Elementos de Anticipos de Deducciones del Documento | : Utilizado para Todos los Elementos de Anticipos de Deducciones del Documento | ||
: PATH: …/root.Deducciones/anticipos | : PATH: …/root.Deducciones/anticipos | ||
− | : (ver detalle en [[#Class. | + | : (ver detalle en [[#Class.AnticiposNom|Class.AnticiposNom]]) |
|- | |- | ||
|cooperativa | |cooperativa | ||
Línea 276: | Línea 275: | ||
: Valor que se deba pagar por las obligaciones que el empleado tenga con su empresa, como puede ser un crédito que ésta le haya otorgado, o como compensación por algún perjuicio o detrimento económico que el empleado le haya causado a la empresa. | : Valor que se deba pagar por las obligaciones que el empleado tenga con su empresa, como puede ser un crédito que ésta le haya otorgado, o como compensación por algún perjuicio o detrimento económico que el empleado le haya causado a la empresa. | ||
: '''PATH''': …/root.Deducciones/deuda | : '''PATH''': …/root.Deducciones/deuda | ||
+ | |- | ||
+ | |extrasNom | ||
+ | |Array<ExtensibleNom> | ||
+ | | - | ||
+ | |NO | ||
+ | | | ||
+ | :Habilitado como campo opcional | ||
+ | : '''PATH''': /No definido | ||
|- | |- | ||
|educación | |educación | ||
Línea 388: | Línea 395: | ||
: '''PATH''': …/root.Deducciones/sindicatos | : '''PATH''': …/root.Deducciones/sindicatos | ||
: (ver detalle en [[#Class.Sindicato|Class.Sindicato]]) | : (ver detalle en [[#Class.Sindicato|Class.Sindicato]]) | ||
+ | |- | ||
+ | |reintegro | ||
+ | |String | ||
+ | |<nowiki>N|..</nowiki> | ||
+ | |NO | ||
+ | | | ||
+ | : Valor que le regresa el trabajador a la empresa por un devengo mal realizado en otro pago de nómina | ||
+ | : '''PATH''': …/root.Deducciones/reintegro | ||
|} | |} | ||
− | =====Class. | + | =====Class.AnticiposNom===== |
{| class="mw-collapsible mw-collapsed wikitable" | {| class="mw-collapsible mw-collapsed wikitable" | ||
! style="background:#f2f2f2; text-align:center;"|Atributo | ! style="background:#f2f2f2; text-align:center;"|Atributo | ||
Línea 397: | Línea 412: | ||
! style="background:#f2f2f2; text-align:center;"|Descripción | ! style="background:#f2f2f2; text-align:center;"|Descripción | ||
|- | |- | ||
− | | | + | |montoanticipo |
|String | |String | ||
|<nowiki>N|..</nowiki> | |<nowiki>N|..</nowiki> | ||
Línea 403: | Línea 418: | ||
| | | | ||
:Anticipos de Nómina. | :Anticipos de Nómina. | ||
− | : '''PATH''': /root./@ | + | : '''PATH''': /root./@anticiposNom |
|- | |- | ||
− | | | + | |extrasNom |
− | |Array< | + | |Array<ExtensibleNom> |
| - | | - | ||
|NO | |NO | ||
Línea 413: | Línea 428: | ||
: '''PATH''': /No definido | : '''PATH''': /No definido | ||
|} | |} | ||
+ | |||
=====Class.FondoPension===== | =====Class.FondoPension===== | ||
{| class="mw-collapsible mw-collapsed wikitable" | {| class="mw-collapsible mw-collapsed wikitable" | ||
Línea 429: | Línea 445: | ||
: '''PATH''': /root./@deduccion | : '''PATH''': /root./@deduccion | ||
|- | |- | ||
− | | | + | |extrasNom |
− | |Array< | + | |Array<ExtensibleNom> |
| - | | - | ||
|NO | |NO | ||
Línea 469: | Línea 485: | ||
: '''PATH''': /root./@deduccionSub | : '''PATH''': /root./@deduccionSub | ||
|- | |- | ||
− | | | + | |extrasNom |
− | |Array< | + | |Array<ExtensibleNom> |
| - | | - | ||
|NO | |NO | ||
Línea 518: | Línea 534: | ||
: '''PATH''': /root./@deduccion | : '''PATH''': /root./@deduccion | ||
|- | |- | ||
− | | | + | |extrasNom |
− | |Array< | + | |Array<ExtensibleNom> |
| - | | - | ||
|NO | |NO | ||
Línea 535: | Línea 551: | ||
! style="background:#f2f2f2; text-align:center;"|Descripción | ! style="background:#f2f2f2; text-align:center;"|Descripción | ||
|- | |- | ||
− | | | + | |montootraDeduccion |
|String | |String | ||
|<nowiki>N|..</nowiki> | |<nowiki>N|..</nowiki> | ||
Línea 543: | Línea 559: | ||
: '''PATH''': /root./@otraDeduccion | : '''PATH''': /root./@otraDeduccion | ||
|- | |- | ||
− | | | + | |extrasNom |
− | |Array< | + | |Array<ExtensibleNom> |
| - | | - | ||
|NO | |NO | ||
Línea 568: | Línea 584: | ||
: '''PATH''': /root./@pagoTercero | : '''PATH''': /root./@pagoTercero | ||
|- | |- | ||
− | | | + | |extrasNom |
− | |Array< | + | |Array<ExtensibleNom> |
| - | | - | ||
|NO | |NO | ||
Línea 592: | Línea 608: | ||
: '''PATH''': /root./@porcentaje | : '''PATH''': /root./@porcentaje | ||
|- | |- | ||
− | | | + | |deduccion |
|String | |String | ||
|<nowiki>N|..</nowiki> | |<nowiki>N|..</nowiki> | ||
Línea 600: | Línea 616: | ||
: '''PATH''': /root./@deduccion | : '''PATH''': /root./@deduccion | ||
|- | |- | ||
− | | | + | |extrasNom |
− | |Array< | + | |Array<ExtensibleNom> |
| - | | - | ||
|NO | |NO | ||
Línea 608: | Línea 624: | ||
: '''PATH''': /No definido | : '''PATH''': /No definido | ||
|} | |} | ||
+ | |||
=====Class.Sancion===== | =====Class.Sancion===== | ||
{| class="mw-collapsible mw-collapsed wikitable" | {| class="mw-collapsible mw-collapsed wikitable" | ||
Línea 632: | Línea 649: | ||
: '''PATH''': /root./@sancionPriv | : '''PATH''': /root./@sancionPriv | ||
|- | |- | ||
− | | | + | |extrasNom |
− | |Array< | + | |Array<ExtensibleNom> |
| - | | - | ||
|NO | |NO | ||
Línea 656: | Línea 673: | ||
: '''PATH''': /root./@porcentaje | : '''PATH''': /root./@porcentaje | ||
|- | |- | ||
− | | | + | |deduccion |
|String | |String | ||
|<nowiki>N|..</nowiki> | |<nowiki>N|..</nowiki> | ||
Línea 664: | Línea 681: | ||
: '''PATH''': /root./@deduccion | : '''PATH''': /root./@deduccion | ||
|- | |- | ||
− | | | + | |extrasNom |
− | |Array< | + | |Array<ExtensibleNom> |
| - | | - | ||
|NO | |NO | ||
Línea 672: | Línea 689: | ||
: '''PATH''': /No definido | : '''PATH''': /No definido | ||
|} | |} | ||
+ | |||
====Class.Devengados==== | ====Class.Devengados==== | ||
{| class="mw-collapsible mw-collapsed wikitable" | {| class="mw-collapsible mw-collapsed wikitable" | ||
Línea 680: | Línea 698: | ||
! style="background:#f2f2f2; text-align:center;"|Descripción | ! style="background:#f2f2f2; text-align:center;"|Descripción | ||
|- | |- | ||
− | | | + | |anticiposNom |
− | |Array< | + | |Array<AnticiposNom> |
| - | | - | ||
|NO | |NO | ||
| | | | ||
:Clase relacionada a los devengos correspondientes a anticipos. | :Clase relacionada a los devengos correspondientes a anticipos. | ||
− | : '''PATH''': ../root.Devengados/ | + | : '''PATH''': ../root.Devengados/anticiposNom |
− | : (ver detalle en [[#Class. | + | : (ver detalle en [[#Class.AnticiposNom|Class.AnticiposNom]]) |
|- | |- | ||
|auxilios | |auxilios | ||
Línea 722: | Línea 740: | ||
: Utilizado para Todos los Elementos de Bonificaciones de Devengos del Documento | : Utilizado para Todos los Elementos de Bonificaciones de Devengos del Documento | ||
: '''PATH''': ../root.Devengados/bonificaciones | : '''PATH''': ../root.Devengados/bonificaciones | ||
− | : (ver detalle en [[#Class.Bonificacion|Class. | + | : (ver detalle en [[#Class.Bonificacion|Class.Bonificación]]) |
|- | |- | ||
|bonifRetiro | |bonifRetiro | ||
Línea 757: | Línea 775: | ||
: Utilizado para Todos los Elementos de Comisiones de Devengos del Documento | : Utilizado para Todos los Elementos de Comisiones de Devengos del Documento | ||
: '''PATH''': ../root.Devengados/comisiones | : '''PATH''': ../root.Devengados/comisiones | ||
− | : (ver detalle en [[#Class. | + | : (ver detalle en [[#Class.Comisión|Class.Comisión]]) |
|- | |- | ||
|compensaciones | |compensaciones | ||
Línea 766: | Línea 784: | ||
: Utilizado para Todos los Elementos de Compensaciones de Devengos del Documento | : Utilizado para Todos los Elementos de Compensaciones de Devengos del Documento | ||
: '''PATH''': ../root.Devengados/compensaciones | : '''PATH''': ../root.Devengados/compensaciones | ||
− | : (ver detalle en [[#Class. | + | : (ver detalle en [[#Class.Compensación|Class.Compensación]]) |
|- | |- | ||
− | | | + | |dotación |
|String | |String | ||
|<nowiki>N|..</nowiki> | |<nowiki>N|..</nowiki> | ||
Línea 776: | Línea 794: | ||
: '''PATH''': ../root.Devengados/dotación | : '''PATH''': ../root.Devengados/dotación | ||
|- | |- | ||
− | | | + | |extrasNom |
− | |Array< | + | |Array<ExtensibleNom> |
| - | | - | ||
|NO | |NO | ||
Línea 817: | Línea 835: | ||
:Utilizado para Todos los Elementos de Incapacidades de Devengos del Documento | :Utilizado para Todos los Elementos de Incapacidades de Devengos del Documento | ||
: '''PATH''': /root.Devengados/incapacidades | : '''PATH''': /root.Devengados/incapacidades | ||
− | : (ver detalle en [[#Class. | + | : (ver detalle en [[#Class.Incapacidad|Class.Incapacidad]]) |
|- | |- | ||
|licencias | |licencias | ||
Línea 887: | Línea 905: | ||
:Utilizado para Todos los Elementos de Vacaciones de Devengos del Documento | :Utilizado para Todos los Elementos de Vacaciones de Devengos del Documento | ||
: '''PATH''': /root.Devengados/vacaciones | : '''PATH''': /root.Devengados/vacaciones | ||
− | : (ver detalle en [[#Class. | + | : (ver detalle en [[#Class.Vacaciónes|Class.Vacaciónes]]) |
|} | |} | ||
− | =====Class. | + | =====Class.AnticiposNom===== |
{| class="mw-collapsible mw-collapsed wikitable" | {| class="mw-collapsible mw-collapsed wikitable" | ||
! style="background:#f2f2f2; text-align:center;"|Atributo | ! style="background:#f2f2f2; text-align:center;"|Atributo | ||
Línea 897: | Línea 915: | ||
! style="background:#f2f2f2; text-align:center;"|Descripción | ! style="background:#f2f2f2; text-align:center;"|Descripción | ||
|- | |- | ||
− | | | + | |montoanticipo |
|String | |String | ||
|<nowiki>N|..</nowiki> | |<nowiki>N|..</nowiki> | ||
Línea 903: | Línea 921: | ||
| | | | ||
:Anticipos de Nómina. | :Anticipos de Nómina. | ||
− | : '''PATH''': /root./@ | + | : '''PATH''': /root./@anticiposNom |
|- | |- | ||
− | | | + | |extrasNom |
− | |Array< | + | |Array<ExtensibleNom> |
| - | | - | ||
|NO | |NO | ||
Línea 913: | Línea 931: | ||
: '''PATH''': /No definido | : '''PATH''': /No definido | ||
|} | |} | ||
+ | |||
=====Class.Auxilio===== | =====Class.Auxilio===== | ||
{| class="mw-collapsible mw-collapsed wikitable" | {| class="mw-collapsible mw-collapsed wikitable" | ||
Línea 937: | Línea 956: | ||
: '''PATH''': /root./@./@auxilioS | : '''PATH''': /root./@./@auxilioS | ||
|- | |- | ||
− | | | + | |extrasNom |
− | |Array< | + | |Array<ExtensibleNom> |
| - | | - | ||
|NO | |NO | ||
Línea 961: | Línea 980: | ||
: '''PATH''': /root/@diasTrabajados | : '''PATH''': /root/@diasTrabajados | ||
|- | |- | ||
− | | | + | |extrasNom |
− | |Array< | + | |Array<ExtensibleNom> |
| - | | - | ||
|NO | |NO | ||
Línea 996: | Línea 1015: | ||
|String | |String | ||
|<nowiki>N|..</nowiki> | |<nowiki>N|..</nowiki> | ||
− | | | + | |NO |
| | | | ||
:Corresponde al valor que el empleador paga de forma periódica al trabajador como contraprestación por el trabajo realizado. | :Corresponde al valor que el empleador paga de forma periódica al trabajador como contraprestación por el trabajo realizado. | ||
: '''PATH''': /root/@bonificacionNS | : '''PATH''': /root/@bonificacionNS | ||
|- | |- | ||
− | | | + | |extrasNom |
− | |Array< | + | |Array<ExtensibleNom> |
| - | | - | ||
|NO | |NO | ||
Línea 1009: | Línea 1028: | ||
: '''PATH''': /No definido | : '''PATH''': /No definido | ||
|} | |} | ||
+ | |||
=====Class.BonoEPCTV===== | =====Class.BonoEPCTV===== | ||
{| class="mw-collapsible mw-collapsed wikitable" | {| class="mw-collapsible mw-collapsed wikitable" | ||
Línea 1033: | Línea 1053: | ||
: '''PATH''': /root/@pagoAlimentacionS | : '''PATH''': /root/@pagoAlimentacionS | ||
|- | |- | ||
− | | | + | |extrasNom |
− | |Array< | + | |Array<ExtensibleNom> |
| - | | - | ||
|NO | |NO | ||
Línea 1065: | Línea 1085: | ||
! style="background:#f2f2f2; text-align:center;"|Descripción | ! style="background:#f2f2f2; text-align:center;"|Descripción | ||
|- | |- | ||
− | | | + | |extrasNom |
− | |Array< | + | |Array<ExtensibleNom> |
| - | | - | ||
|NO | |NO | ||
Línea 1106: | Línea 1126: | ||
! style="background:#f2f2f2; text-align:center;"|Descripción | ! style="background:#f2f2f2; text-align:center;"|Descripción | ||
|- | |- | ||
− | | | + | |extrasNom |
− | |Array< | + | |Array<ExtensibleNom> |
| - | | - | ||
|NO | |NO | ||
Línea 1144: | Línea 1164: | ||
|SI | |SI | ||
| | | | ||
− | :Valor Pagado por Compensaciones | + | :Valor Pagado por Compensaciones Ordinarias. |
− | : '''PATH''': root./@ | + | : '''PATH''': root./@compensacionO |
|- | |- | ||
− | | | + | |extrasNom |
− | |Array< | + | |Array<ExtensibleNom> |
| - | | - | ||
|NO | |NO | ||
Línea 1155: | Línea 1175: | ||
: '''PATH''': /No definido | : '''PATH''': /No definido | ||
|} | |} | ||
+ | |||
=====Class.HoraExtra===== | =====Class.HoraExtra===== | ||
{| class="mw-collapsible mw-collapsed wikitable" | {| class="mw-collapsible mw-collapsed wikitable" | ||
Línea 1171: | Línea 1192: | ||
: '''PATH''': /root/HorasExtras(Tipo)/@cantidad | : '''PATH''': /root/HorasExtras(Tipo)/@cantidad | ||
|- | |- | ||
− | | | + | |extrasNom |
− | |Array< | + | |Array<ExtensibleNom> |
| - | | - | ||
|NO | |NO | ||
Línea 1185: | Línea 1206: | ||
| | | | ||
:Hora de inicio de Hora Extra Según el tipo. | :Hora de inicio de Hora Extra Según el tipo. | ||
− | : '''PATH''': /root/HorasExtras(Tipo)/@horaInicio | + | : '''PATH''': /root/HorasExtras(Tipo)/@horaInicio. En formato YYYY-MM-DDTHH:MM:SS |
|- | |- | ||
|horaFin | |horaFin | ||
Línea 1193: | Línea 1214: | ||
| | | | ||
:Hora de fin de Hora Extra según el tipo. | :Hora de fin de Hora Extra según el tipo. | ||
− | : '''PATH''': /root/HorasExtras(Tipo)/@horaFin | + | : '''PATH''': /root/HorasExtras(Tipo)/@horaFin. En formato YYYY-MM-DDTHH:MM:SS |
|- | |- | ||
|pago | |pago | ||
Línea 1237: | Línea 1258: | ||
: '''PATH''': /root/@cantidad | : '''PATH''': /root/@cantidad | ||
|- | |- | ||
− | | | + | |extrasNom |
− | |Array< | + | |Array<ExtensibleNom> |
| - | | - | ||
|NO | |NO | ||
Línea 1277: | Línea 1298: | ||
: '''PATH''': /root/Incapacidad/@cantidad | : '''PATH''': /root/Incapacidad/@cantidad | ||
|- | |- | ||
− | | | + | |extrasNom |
− | |Array< | + | |Array<ExtensibleNom> |
| - | | - | ||
|NO | |NO | ||
Línea 1327: | Línea 1348: | ||
! style="background:#f2f2f2; text-align:center;"|Descripción | ! style="background:#f2f2f2; text-align:center;"|Descripción | ||
|- | |- | ||
− | | | + | |extrasNom |
− | |Array< | + | |Array<ExtensibleNom> |
| - | | - | ||
|NO | |NO | ||
Línea 1377: | Línea 1398: | ||
: '''PATH''': /root/@cantidad | : '''PATH''': /root/@cantidad | ||
|- | |- | ||
− | | | + | |extrasNom |
− | |Array< | + | |Array<ExtensibleNom> |
| - | | - | ||
|NO | |NO | ||
Línea 1406: | Línea 1427: | ||
|SI | |SI | ||
| | | | ||
− | : | + | :Valor pagado al trabajador del descanso remunerado que la ley confiere por el nacimiento de un hijo, y que es reconocido y pagado por la EPS a la que está afiliado el padre o la madre, o en su defecto por el empleador |
− | |||
: '''PATH''': /root/@pago | : '''PATH''': /root/@pago | ||
|} | |} | ||
Línea 1426: | Línea 1446: | ||
: '''PATH''': /root/Licencias/licenciaNR/cantidad | : '''PATH''': /root/Licencias/licenciaNR/cantidad | ||
|- | |- | ||
− | | | + | |extrasNom |
− | |Array< | + | |Array<ExtensibleNom> |
| - | | - | ||
|NO | |NO | ||
Línea 1449: | Línea 1469: | ||
:Fecha donde termina la Licencia. | :Fecha donde termina la Licencia. | ||
: '''PATH''': /root/Licencias/licenciaNR/fechaFin | : '''PATH''': /root/Licencias/licenciaNR/fechaFin | ||
− | | | + | |} |
− | + | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
======Class.LicenciaR====== | ======Class.LicenciaR====== | ||
{| class="mw-collapsible mw-collapsed wikitable" | {| class="mw-collapsible mw-collapsed wikitable" | ||
Línea 1475: | Línea 1487: | ||
: '''PATH''': /root/Licencias/licenciaR/cantidad | : '''PATH''': /root/Licencias/licenciaR/cantidad | ||
|- | |- | ||
− | | | + | |extrasNom |
− | |Array< | + | |Array<ExtensibleNom> |
| - | | - | ||
|NO | |NO | ||
Línea 1504: | Línea 1516: | ||
|SI | |SI | ||
| | | | ||
− | : | + | :Valor pagado al trabajador corresponde a tiempo no laborado, que por ley o por acuerdo con el empleador se le concede |
− | |||
: '''PATH''': /root/Licencias/licenciaR/pago | : '''PATH''': /root/Licencias/licenciaR/pago | ||
|} | |} | ||
Línea 1539: | Línea 1550: | ||
| | | | ||
:Nombre del Concepto que corresponde a los demás pagos fijos o variables realizados al trabajador que remuneren en dinero o en especie como contraprestación directa del servicio. | :Nombre del Concepto que corresponde a los demás pagos fijos o variables realizados al trabajador que remuneren en dinero o en especie como contraprestación directa del servicio. | ||
+ | :'''@IMPORTANTE''': Este campo solo admite 100 caracteres según el anexo técnico. | ||
: '''PATH''': /root/@descripcionConcepto | : '''PATH''': /root/@descripcionConcepto | ||
|- | |- | ||
− | | | + | |extrasNom |
− | |Array< | + | |Array<ExtensibleNom> |
| - | | - | ||
|NO | |NO | ||
Línea 1549: | Línea 1561: | ||
: '''PATH''': /No definido | : '''PATH''': /No definido | ||
|} | |} | ||
+ | |||
=====Class.PagoTercero===== | =====Class.PagoTercero===== | ||
{| class="mw-collapsible mw-collapsed wikitable" | {| class="mw-collapsible mw-collapsed wikitable" | ||
Línea 1565: | Línea 1578: | ||
: '''PATH''': /root/@pagoTercero | : '''PATH''': /root/@pagoTercero | ||
|- | |- | ||
− | | | + | |extrasNom |
− | |Array< | + | |Array<ExtensibleNom> |
| - | | - | ||
|NO | |NO | ||
Línea 1589: | Línea 1602: | ||
: '''PATH''': /root/@cantidad | : '''PATH''': /root/@cantidad | ||
|- | |- | ||
− | | | + | |extrasNom |
− | |Array< | + | |Array<ExtensibleNom> |
| - | | - | ||
|NO | |NO | ||
Línea 1629: | Línea 1642: | ||
: '''PATH''': /root/@auxilioTransporte | : '''PATH''': /root/@auxilioTransporte | ||
|- | |- | ||
− | | | + | |extrasNom |
− | |Array< | + | |Array<ExtensibleNom> |
| - | | - | ||
|NO | |NO | ||
Línea 1637: | Línea 1650: | ||
: '''PATH''': /No definido | : '''PATH''': /No definido | ||
|- | |- | ||
− | | | + | |ViaticoManuAlojS |
|String | |String | ||
|<nowiki>N|..</nowiki> | |<nowiki>N|..</nowiki> | ||
Línea 1653: | Línea 1666: | ||
: '''PATH''': /root/@viaticoManuAlojNS | : '''PATH''': /root/@viaticoManuAlojNS | ||
|} | |} | ||
+ | |||
=====Class.Vacaciónes===== | =====Class.Vacaciónes===== | ||
{| class="mw-collapsible mw-collapsed wikitable" | {| class="mw-collapsible mw-collapsed wikitable" | ||
Línea 1661: | Línea 1675: | ||
! style="background:#f2f2f2; text-align:center;"|Descripción | ! style="background:#f2f2f2; text-align:center;"|Descripción | ||
|- | |- | ||
− | | | + | |extrasNom |
− | |Array< | + | |Array<ExtensibleNom> |
| - | | - | ||
|NO | |NO | ||
Línea 1704: | Línea 1718: | ||
: '''PATH''': /root/@cantidad | : '''PATH''': /root/@cantidad | ||
|- | |- | ||
− | | | + | |extrasNom |
− | |Array< | + | |Array<ExtensibleNom> |
| - | | - | ||
|NO | |NO | ||
Línea 1755: | Línea 1769: | ||
: '''PATH''': /root/@cantidad | : '''PATH''': /root/@cantidad | ||
|- | |- | ||
− | | | + | |extrasNom |
− | |Array< | + | |Array<ExtensibleNom> |
| - | | - | ||
|NO | |NO | ||
Línea 1790: | Línea 1804: | ||
|} | |} | ||
− | ====Class. | + | ====Class.DocumentosReferenciadosNom==== |
{| class="mw-collapsible mw-collapsed wikitable" | {| class="mw-collapsible mw-collapsed wikitable" | ||
! style="background:#f2f2f2; text-align:center;"|Atributo | ! style="background:#f2f2f2; text-align:center;"|Atributo | ||
Línea 1804: | Línea 1818: | ||
| | | | ||
: Debe corresponder al CUNE del Documento Soporte de Pago de Nómina Electrónica o Nota de Ajuste de Documento Soporte de Pago de Nómina Electrónica a Reemplazar | : Debe corresponder al CUNE del Documento Soporte de Pago de Nómina Electrónica o Nota de Ajuste de Documento Soporte de Pago de Nómina Electrónica a Reemplazar | ||
− | : '''PATH''': /root. | + | : '''PATH''': /root.documentosReferenciadosNom/@CUNEPred |
: [[Catálogos de códigos para generación de Nómina Electrónica - Indice Manual Integración Nómina Electrónica #Tabla 17|Tabla 17]] | : [[Catálogos de códigos para generación de Nómina Electrónica - Indice Manual Integración Nómina Electrónica #Tabla 17|Tabla 17]] | ||
|- | |- | ||
− | | | + | |extrasNom |
− | |Array< | + | |Array<ExtensibleNom> |
| - | | - | ||
|NO | |NO | ||
Línea 1821: | Línea 1835: | ||
| | | | ||
: Debe corresponder a la Fecha de Emisión del Documento Soporte de Pago de Nómina Electrónica o Nota de Ajuste de Documento Soporte de Pago de Nómina Electrónica a Reemplazar | : Debe corresponder a la Fecha de Emisión del Documento Soporte de Pago de Nómina Electrónica o Nota de Ajuste de Documento Soporte de Pago de Nómina Electrónica a Reemplazar | ||
− | : '''PATH''': /root. | + | : '''PATH''': /root.documentosReferenciadosNom/fechaGenPred |
|- | |- | ||
|numeroPred | |numeroPred | ||
Línea 1829: | Línea 1843: | ||
| | | | ||
: Debe corresponder al Numero de Documento Soporte de Pago de Nómina Electrónica o Nota de Ajuste de Documento Soporte de Pago de Nómina Electrónica a Reemplazar | : Debe corresponder al Numero de Documento Soporte de Pago de Nómina Electrónica o Nota de Ajuste de Documento Soporte de Pago de Nómina Electrónica a Reemplazar | ||
− | : '''PATH''': …/root. | + | : '''PATH''': …/root.documentosReferenciadosNom/numeroPred |
|} | |} | ||
Línea 1848: | Línea 1862: | ||
: '''PATH''': .. /root.notas/descripción | : '''PATH''': .. /root.notas/descripción | ||
|- | |- | ||
− | | | + | |extrasNom |
− | |Array< | + | |Array<ExtensibleNom> |
| - | | - | ||
|NO | |NO | ||
Línea 1874: | Línea 1888: | ||
|- | |- | ||
− | | | + | |extrasNom |
− | |Array< | + | |Array<ExtensibleNom> |
| - | | - | ||
|NO | |NO | ||
Línea 1916: | Línea 1930: | ||
! style="background:#f2f2f2; text-align:center;"|Descripción | ! style="background:#f2f2f2; text-align:center;"|Descripción | ||
|- | |- | ||
− | | | + | |extrasNom |
− | |Array< | + | |Array<ExtensibleNom> |
| - | | - | ||
|NO | |NO | ||
Línea 1964: | Línea 1978: | ||
|NC | |NC | ||
| | | | ||
− | : | + | : Se debe colocar el nombre de la entidad bancaria donde el trabajador tiene su cuenta para pago de nómina. Si el Método de Pago se realiza de forma Bancaria, este campo es obligatorio. |
: '''PATH''': .. /root.Pago/@Banco | : '''PATH''': .. /root.Pago/@Banco | ||
|- | |- | ||
Línea 1972: | Línea 1986: | ||
|NC | |NC | ||
| | | | ||
− | : | + | : Se debe colocar el tipo de cuenta que el trabajador tiene para pago de nómina. Si el Método de Pago se realiza de forma Bancaria, este campo es obligatorio. |
: '''PATH''': .. /root.Pago/@tipoCuenta | : '''PATH''': .. /root.Pago/@tipoCuenta | ||
|- | |- | ||
Línea 1980: | Línea 1994: | ||
|NC | |NC | ||
| | | | ||
− | : | + | : Se debe colocar el número de la cuenta que el trabajador tiene para pago de nómina. Si el Método de Pago se realiza de forma Bancaria, este campo es obligatorio. |
: '''PATH''': .. /root.Pago/@numeroCuenta | : '''PATH''': .. /root.Pago/@numeroCuenta | ||
|} | |} | ||
Línea 1991: | Línea 2005: | ||
! style="background:#f2f2f2; text-align:center;"|Descripción | ! style="background:#f2f2f2; text-align:center;"|Descripción | ||
|- | |- | ||
− | | | + | |extrasNom |
− | |Array< | + | |Array<ExtensibleNom> |
| - | | - | ||
|NO | |NO | ||
Línea 2016: | Línea 2030: | ||
! style="background:#f2f2f2; text-align:center;"|Descripción | ! style="background:#f2f2f2; text-align:center;"|Descripción | ||
|- | |- | ||
− | | | + | |extrasNom |
− | |Array< | + | |Array<ExtensibleNom> |
| - | | - | ||
|NO | |NO | ||
Línea 2099: | Línea 2113: | ||
: '''PATH''': /No.Aplica | : '''PATH''': /No.Aplica | ||
|- | |- | ||
− | | | + | |extrasNom |
− | |Array< | + | |Array<ExtensibleNom> |
| - | | - | ||
|NO | |NO | ||
Línea 2134: | Línea 2148: | ||
|String | |String | ||
|<nowiki>AN|2</nowiki> | |<nowiki>AN|2</nowiki> | ||
− | | | + | |SI |
| | | | ||
:Código del país actual donde se encontraba ubicado el trabajador o aprendiz en el mes reportado. | :Código del país actual donde se encontraba ubicado el trabajador o aprendiz en el mes reportado. | ||
Línea 2177: | Línea 2191: | ||
|SI | |SI | ||
| | | | ||
− | :Si el trabajador tiene un salario integral, el cual es el tipo de remuneración que incluye todos los conceptos que puedan constituir salario en un solo monto o pago (prestaciones sociales y recargos nocturno, dominical y festivo, y el trabajo extra) y que sea superior a 10 SMLMV mas un 30% correspondiente a factor prestacional. | + | :Si el trabajador tiene un salario integral, el cual es el tipo de remuneración que incluye todos los conceptos que puedan constituir salario en un solo monto o pago (prestaciones sociales y recargos nocturno, dominical y festivo, y el trabajo extra) y que sea superior a 10 SMLMV mas un 30% correspondiente a factor prestacional. '''True = 1 False = 0''' |
: '''PATH''': /root.Trabajador/@salarioIntegral | : '''PATH''': /root.Trabajador/@salarioIntegral | ||
|- | |- | ||
Línea 2183: | Línea 2197: | ||
|String | |String | ||
|<nowiki>AN|...60</nowiki> | |<nowiki>AN|...60</nowiki> | ||
− | | | + | |SI |
| | | | ||
:Segundo Apellido del trabajador o aprendiz. | :Segundo Apellido del trabajador o aprendiz. | ||
Línea 2232: | Línea 2246: | ||
|} | |} | ||
− | ====Class. | + | ====Class.ExtrasNom==== |
{| class="mw-collapsible mw-collapsed wikitable" | {| class="mw-collapsible mw-collapsed wikitable" | ||
! style="background:#f2f2f2; text-align:center;"|Atributo | ! style="background:#f2f2f2; text-align:center;"|Atributo | ||
Línea 2302: | Línea 2316: | ||
|Número de seguimiento, es un UUID, para consultar posteriormente el proceso asíncrono | |Número de seguimiento, es un UUID, para consultar posteriormente el proceso asíncrono | ||
|- | |- | ||
− | |Array | + | |Array<String> |
− | | | + | |reglasNotificacionesTFHKA |
|Reglas de validación en caso de notificación TFHKA | |Reglas de validación en caso de notificación TFHKA | ||
|- | |- | ||
− | |Array | + | |Array<String> |
− | | | + | |reglasNotificacionesDIAN |
|Reglas de validación en caso de notificación DIAN | |Reglas de validación en caso de notificación DIAN | ||
|- | |- | ||
− | |Array | + | |Array<String> |
− | | | + | |reglasRechazoTFHKA |
|Reglas de validación en caso de rechazo TFHKA | |Reglas de validación en caso de rechazo TFHKA | ||
|- | |- | ||
− | |Array | + | |Array<String> |
− | | | + | |reglasRechazoDIAN |
− | | | + | |Reglas de validación en caso de rechazo DIAN |
+ | |} | ||
+ | |||
+ | ===Método ConsultarDocumento=== | ||
+ | |||
+ | Permite consultar el estado de un documento Soporte de Pago de Nómina Electrónica y Nómina de Ajuste, ante la DIAN, el tipo de entrega y si la misma fue exitosa,además otros parámetros de interés que puedes ser útil en los procesos de control del software de Nómina (ERP) o para el modelo de negocio del empleador emisor. | ||
+ | |||
+ | ; REQUEST: Parámetros a Enviar | ||
+ | {| class="mw-collapsible mw-collapsed wikitable" | ||
+ | ! style="background:#f2f2f2; text-align:center;"|Tipo | ||
+ | ! style="background:#f2f2f2; text-align:center;"|Identificador | ||
+ | ! style="background:#f2f2f2; text-align:center;"|Descripción | ||
+ | |- valign="center" | ||
+ | |- | ||
+ | |rowspan="3"|String | ||
+ | |tokenEmpresa | ||
+ | |rowspan="2"|Suministrado por The Factory HKA Colombia | ||
|- | |- | ||
− | | | + | |tokenPassword |
− | |||
− | |||
|- | |- | ||
− | | | + | |consecutivoDocumentoNom |
− | | | + | |Prefijo y Consecutivo del Documento electrónico concatenado sin separadores. Ejemplo “PRUE980338212 |
− | | | + | |} |
+ | |||
+ | ; RESPONSE: Parámetros a Recibir | ||
+ | {| class="mw-collapsible mw-collapsed wikitable" | ||
+ | ! style="background:#f2f2f2; text-align:center;"|Tipo | ||
+ | ! style="background:#f2f2f2; text-align:center;"|Identificador | ||
+ | ! style="background:#f2f2f2; text-align:center;"|Descripción | ||
+ | |- valign="center" | ||
|- | |- | ||
|String | |String | ||
− | | | + | |ambiente |
− | | | + | |Tipo de ambiente de generación del documento: |
+ | :: “ambienteDePruebas” | ||
+ | :: “ambienteDeProducción” | ||
|- | |- | ||
|String | |String | ||
− | | | + | |cadenaCodigoQR |
|Concatenación cadena del código QR (elemento de control) | |Concatenación cadena del código QR (elemento de control) | ||
|- | |- | ||
− | | | + | |String |
− | | | + | |cadenaCune |
− | |“true” Si es válido | + | |Concatenación cadena del código CUNE previo al cálculo por el algoritmo correspondiente del servicio |
+ | |- | ||
+ | |Int | ||
+ | |código | ||
+ | |Indica el estado de la operación retornado por el servicio | ||
+ | |- | ||
+ | |String | ||
+ | |cune | ||
+ | |“Código Único de Nómina Electrónica” correspondiente al documento consultado, calculado por el algoritmo correspondiente del servicio. | ||
+ | |- | ||
+ | |String | ||
+ | |descripcionDocumento | ||
+ | |Identificador del tipo de documento de referencia, | ||
+ | : Ejemplo: “Nómina Individual o Nómina Ajuste” | ||
+ | |- | ||
+ | |String | ||
+ | |descripcionEstatusDocumento | ||
+ | |Descripción correspondiente al estatusDocumento ante la DIAN: “La Nomina Individual, ha sido autorizada” | ||
+ | |- | ||
+ | |String | ||
+ | |estatusDocumento | ||
+ | |Código obtenido en la respuesta correspondiente al estado del documento ante la DIAN ("200","109") | ||
+ | |- | ||
+ | |String | ||
+ | |esValidoDIAN | ||
+ | | | ||
+ | : “true” Si es válido | ||
+ | : “false” Si no es válido | ||
+ | |- | ||
+ | |String | ||
+ | |fechaAceptacionDIAN | ||
+ | |Día y Hora en la que la DIAN aceptó el documento electrónico, en formato AAAA-MM-DD HH:MM:SS | ||
+ | |- | ||
+ | |String | ||
+ | |fechaDocumento | ||
+ | |Fecha en la que se generó el documento, en formato: AAAA-MM-DD | ||
+ | |- | ||
+ | |String | ||
+ | |mensaje | ||
+ | |Este mensaje está asociado al código, útil para identificación de errores | ||
+ | |- | ||
+ | |String | ||
+ | |mensajeDocumento | ||
+ | |Entrega una descripción del error de cada una de las validaciones iniciales. Si no hay errores no entrega descripción | ||
+ | |- | ||
+ | |String | ||
+ | |reglasValidacionDIAN | ||
+ | |Mensajes de validación por parte de la DIAN | ||
+ | |- | ||
+ | |String | ||
+ | |resultado | ||
+ | |Resultado del consumo del método: | ||
+ | : “Procesado” ó “Error” | ||
+ | |- | ||
+ | |String | ||
+ | |trackID | ||
+ | |Este elemento corresponde al TrackId del documento procesado | ||
+ | |- | ||
+ | |String | ||
+ | |tipoDocumento | ||
+ | |Identificador del tipo de documento de referencia | ||
+ | : Ver [[Catálogos de códigos para generación de Nómina Electrónica - Indice Manual Integración Nómina Electrónica #Tabla 9|Tabla 9]] | ||
+ | |} | ||
+ | |||
+ | ===Método ConsultarFolios=== | ||
+ | |||
+ | Permite consultar la cantidad de folios para procesar el Soporte de Pago de Nómina Electrónica y Nómina de Ajuste. | ||
+ | |||
+ | ; REQUEST: Parámetros a Enviar | ||
+ | {| class="mw-collapsible mw-collapsed wikitable" | ||
+ | ! style="background:#f2f2f2; text-align:center;"|Tipo | ||
+ | ! style="background:#f2f2f2; text-align:center;"|Identificador | ||
+ | ! style="background:#f2f2f2; text-align:center;"|Descripción | ||
+ | |- valign="center" | ||
+ | |- | ||
+ | |rowspan="3"|String | ||
+ | |tokenEmpresa | ||
+ | |rowspan="2"|Suministrado por The Factory HKA Colombia | ||
+ | |- | ||
+ | |tokenPassword | ||
+ | |} | ||
+ | |||
+ | ; RESPONSE: Parámetros a Recibir | ||
+ | {| class="mw-collapsible mw-collapsed wikitable" | ||
+ | ! style="background:#f2f2f2; text-align:center;"|Tipo | ||
+ | ! style="background:#f2f2f2; text-align:center;"|Identificador | ||
+ | ! style="background:#f2f2f2; text-align:center;"|Descripción | ||
+ | |- valign="center" | ||
+ | |- | ||
+ | |Int | ||
+ | |código | ||
+ | |Indica el estado de la operación retornado por el servicio | ||
+ | |- | ||
+ | |String | ||
+ | |mensaje | ||
+ | |Este mensaje está asociado al código, útil para identificación de errores | ||
+ | |- | ||
+ | |String | ||
+ | |resultado | ||
+ | |Resultado del consumo del método: | ||
+ | : “Procesado” ó “Error” | ||
+ | |- | ||
+ | |Int | ||
+ | |foliosRestantes | ||
+ | |Cantidad de folios disponibles | ||
|} | |} | ||
+ | |||
+ | ===Método EnviarCorreo=== | ||
+ | |||
+ | Permite reenviar a una direccion de correo electrónico el Soporte de Pago de Nómina Electrónica y Nómina de Ajuste. | ||
+ | |||
+ | ; REQUEST: Parámetros a Enviar | ||
+ | {| class="mw-collapsible mw-collapsed wikitable" | ||
+ | ! style="background:#f2f2f2; text-align:center;"|Tipo | ||
+ | ! style="background:#f2f2f2; text-align:center;"|Identificador | ||
+ | ! style="background:#f2f2f2; text-align:center;"|Descripción | ||
+ | |- valign="center" | ||
+ | |- | ||
+ | |rowspan="4"|String | ||
+ | |tokenEmpresa | ||
+ | |rowspan="2"|Suministrado por The Factory HKA Colombia | ||
+ | |- | ||
+ | |tokenPassword | ||
+ | |- | ||
+ | |email | ||
+ | |Direccion de correo electrónico del empleado | ||
+ | |- | ||
+ | |consecutivoDocumentoNom | ||
+ | |Prefijo y Consecutivo del Documento electrónico concatenado sin separadores. Ejemplo “PRUE980338212 | ||
+ | |} | ||
+ | |||
+ | ; RESPONSE: Parámetros a Recibir | ||
+ | {| class="mw-collapsible mw-collapsed wikitable" | ||
+ | ! style="background:#f2f2f2; text-align:center;"|Tipo | ||
+ | ! style="background:#f2f2f2; text-align:center;"|Identificador | ||
+ | ! style="background:#f2f2f2; text-align:center;"|Descripción | ||
+ | |- valign="center" | ||
+ | |- | ||
+ | |Int | ||
+ | |código | ||
+ | |Indica el estado de la operación retornado por el servicio | ||
+ | |- | ||
+ | |String | ||
+ | |mensaje | ||
+ | |Este mensaje está asociado al código, útil para identificación de errores | ||
+ | |- | ||
+ | |String | ||
+ | |resultado | ||
+ | |Resultado del consumo del método: | ||
+ | : “Procesado” ó “Error” | ||
+ | |} | ||
+ | |||
+ | ===Método DescargarXML=== | ||
+ | |||
+ | Permite descargar documento Soporte de Pago de Nómina Electrónica, Nota de Ajuste de Documento Soporte de Pago de Nómina Electrónica en formato XML. | ||
+ | |||
+ | ; REQUEST: Parámetros a Enviar | ||
+ | {| class="mw-collapsible mw-collapsed wikitable" | ||
+ | ! style="background:#f2f2f2; text-align:center;"|Tipo | ||
+ | ! style="background:#f2f2f2; text-align:center;"|Identificador | ||
+ | ! style="background:#f2f2f2; text-align:center;"|Descripción | ||
+ | |- valign="center" | ||
+ | |- | ||
+ | |rowspan="3"|String | ||
+ | |tokenEmpresa | ||
+ | |rowspan="2"|Suministrado por The Factory HKA Colombia | ||
+ | |- | ||
+ | |tokenPassword | ||
+ | |- | ||
+ | |consecutivoDocumentoNom | ||
+ | |Prefijo y Consecutivo del Documento electrónico concatenado sin separadores. Ejemplo “PRUE980338212 | ||
+ | |} | ||
+ | |||
+ | ; RESPONSE: Parámetros a Recibir | ||
+ | {| class="mw-collapsible mw-collapsed wikitable" | ||
+ | ! style="background:#f2f2f2; text-align:center;"|Tipo | ||
+ | ! style="background:#f2f2f2; text-align:center;"|Identificador | ||
+ | ! style="background:#f2f2f2; text-align:center;"|Descripción | ||
+ | |- valign="center" | ||
+ | |- | ||
+ | |Int | ||
+ | |código | ||
+ | |Indica el estado de la operación retornado por el servicio | ||
+ | |- | ||
+ | |String | ||
+ | |cune | ||
+ | |“Código Único de Nómina Electrónica” correspondiente al documento consultado, calculado por el algoritmo correspondiente del servicio. | ||
+ | |- | ||
+ | |String | ||
+ | |documento | ||
+ | |Documento XML codificado en Base64 | ||
+ | |- | ||
+ | |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 | ||
+ | |nombre | ||
+ | |Prefijo y consecutivo del Documento Electrónico concatenado sin separadores. Ejemplo “PRUE980338212” | ||
+ | |- | ||
+ | |String | ||
+ | |resultado | ||
+ | |Resultado del consumo del método: | ||
+ | : “Procesado” ó “Error” | ||
+ | |} | ||
+ | |||
+ | ===Método DescargarPDF=== | ||
+ | |||
+ | Permite descargar la representación gráfica de un documento Soporte de Pago de Nómina Electrónica y Nómina de Ajuste. | ||
+ | |||
+ | ; REQUEST: Parámetros a Enviar | ||
+ | {| class="mw-collapsible mw-collapsed wikitable" | ||
+ | ! style="background:#f2f2f2; text-align:center;"|Tipo | ||
+ | ! style="background:#f2f2f2; text-align:center;"|Identificador | ||
+ | ! style="background:#f2f2f2; text-align:center;"|Descripción | ||
+ | |- valign="center" | ||
+ | |- | ||
+ | |rowspan="3"|String | ||
+ | |tokenEmpresa | ||
+ | |rowspan="2"|Suministrado por The Factory HKA Colombia | ||
+ | |- | ||
+ | |tokenPassword | ||
+ | |- | ||
+ | |consecutivoDocumentoNom | ||
+ | |Prefijo y Consecutivo del Documento electrónico concatenado sin separadores. Ejemplo “PRUE980338212 | ||
+ | |} | ||
+ | |||
+ | ; RESPONSE: Parámetros a Recibir | ||
+ | {| class="mw-collapsible mw-collapsed wikitable" | ||
+ | ! style="background:#f2f2f2; text-align:center;"|Tipo | ||
+ | ! style="background:#f2f2f2; text-align:center;"|Identificador | ||
+ | ! style="background:#f2f2f2; text-align:center;"|Descripción | ||
+ | |- valign="center" | ||
+ | |- | ||
+ | |Int | ||
+ | |código | ||
+ | |Indica el estado de la operación retornado por el servicio | ||
+ | |- | ||
+ | |String | ||
+ | |cune | ||
+ | |“Código Único de Nómina Electrónica” correspondiente al documento consultado, calculado por el algoritmo correspondiente del servicio. | ||
+ | |- | ||
+ | |String | ||
+ | |documento | ||
+ | |Documento PDF codificado en Base64 | ||
+ | |- | ||
+ | |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 | ||
+ | |nombre | ||
+ | |Prefijo y consecutivo del Documento Electrónico concatenado sin separadores. Ejemplo “PRUE980338212” | ||
+ | |- | ||
+ | |String | ||
+ | |resultado | ||
+ | |Resultado del consumo del método: | ||
+ | : “Procesado” ó “Error” | ||
+ | |} | ||
+ | |||
{{clear}} | {{clear}} |
Revisión actual del 03:16 16 jun 2023
Sumario
- 1 Método Enviar
- 1.1 Class.Nómina Electrónica
- 1.2 Class.Deducciones
- 1.3 Class.Devengados
- 1.3.1 Class.AnticiposNom
- 1.3.2 Class.Auxilio
- 1.3.3 Class.Basico
- 1.3.4 Class.Bonificación
- 1.3.5 Class.BonoEPCTV
- 1.3.6 Class.Cesantia
- 1.3.7 Class.Comisión
- 1.3.8 Class.Compensación
- 1.3.9 Class.HoraExtra
- 1.3.10 Class.HuelgaLegal
- 1.3.11 Class.Incapacidad
- 1.3.12 Class.Licencia
- 1.3.13 Class.OtroConcepto
- 1.3.14 Class.PagoTercero
- 1.3.15 Class.Prima
- 1.3.16 Class.Transporte
- 1.3.17 Class.Vacaciónes
- 1.4 Class.DocumentosReferenciadosNom
- 1.5 Class.Nota
- 1.6 Class.LugarGeneracionXML
- 1.7 Class.Pago
- 1.8 Class.Periodo
- 1.9 Class.Trabajador
- 1.10 Class.ExtrasNom
- 2 Método ConsultarDocumento
- 3 Método ConsultarFolios
- 4 Método EnviarCorreo
- 5 Método DescargarXML
- 6 Método DescargarPDF
Método Enviar
La función encargada de construir y enviar los documentos de soporte de pago de Nómina Electrónica a la DIAN.
- REQUEST
- Parámetros a Enviar
Tipo | Identificador | Descripción |
---|---|---|
String | idSoftware | Corresponde al NIT del Empleador emisor |
String | tokenEmpresa | Utilice los Suministrado por el proveedor tecnológico en ambiente Demo. |
tokenPassword | ||
String | nitEmpleador | Debe corresponder al NIT del Empleador que realiza el DE |
Objeto | Nomina | Ver el detalle del Objeto Nomina más abajo |
Class.Nómina Electrónica
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
consecutivoDocumentoNom | String | AN..20 | Si |
|
deducciones | Class | - | SI |
|
devengados | Class | SI |
| |
documentosReferenciadosNom | Array<DocumentosReferenciadosNom> | - | SI |
|
extrasNom | Array<ExtensibleNom> | - | NO |
|
fechaEmisionNom | String | AN|19 | SI |
|
notas | Array<Nota> | - | NO |
|
novedad | String | N|1 | SI |
|
novedadCUNE | String | N|96 | C/C |
|
lugarGeneracionXML | Class | - | SI |
|
pagos | Array<Pago> | - | SI |
|
periodoNomina | String | N|1 | SI |
|
periodos | Array<Periodo> | AN|19 | SI |
|
rangoNumeracionNom | String | AN..20 | SI |
|
redondeo | String | N|.. | NO |
|
tipoDocumentoNom | String | N|3 | SI |
|
tipoMonedaNom | String | AN|3 | SI |
|
tipoNota | String | N|1 | SI |
|
totalComprobante | String | N|.. | SI |
|
totalDeducciones | String | N|.. | SI |
|
totalDevengados | String | N|.. | SI |
|
trm | String | N|.. | NO |
|
trabajador | Class | - | SI |
|
Class.Deducciones
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
afc | String | N|.. | NO |
|
anticiposNom | Array<AnticiposNom> | NO |
| |
cooperativa | String | N|.. | NO |
|
deuda | String | N|.. | NO |
|
extrasNom | Array<ExtensibleNom> | - | NO |
|
educación | String | N|.. | NO |
|
embargoFiscal | String | N|.. | NO |
|
fondosPensiones | Array<FondoPension> | - | SI |
|
fondosSP | Array<FondosSP> | - | NO |
|
libranzas | Array<Libranza> | N|.. | NO |
|
otrasDeducciones | Array<OtrasDeducciones> | - | NO |
|
pagosTerceros | Array<PagoTerceros> | - | NO |
|
pensionVoluntaria | String | N|.. | NO |
|
planComplementarios | String | N|.. | NO |
|
retencionFuente | String | N|.. | NO |
|
salud | Array<Salud> | - | SI |
|
sanciones | Array<Sanción> | - | NO |
|
sindicatos | Array<Sindicato> | - | NO |
|
reintegro | String | N|.. | NO |
|
Class.AnticiposNom
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
montoanticipo | String | N|.. | NO |
|
extrasNom | Array<ExtensibleNom> | - | NO |
|
Class.FondoPension
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
deducción | String | N|.. | SI |
|
extrasNom | Array<ExtensibleNom> | - | NO |
|
porcentaje | String | N|4-6 | SI |
|
Class.FondoSP
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
deduccionSP | String | N|.. | NO |
|
deduccionSub | String | N|.. | NO |
|
extrasNom | Array<ExtensibleNom> | - | NO |
|
porcentaje | String | N|4-6 | NO |
|
porcentajeSub | String | N|4-6 | NO |
|
Class.Libranza
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
descripción | String | AN|.. | SI |
|
deduccion | String | N|.. | SI |
|
extrasNom | Array<ExtensibleNom> | - | NO |
|
Class.OtraDeduccion
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
montootraDeduccion | String | N|.. | NO |
|
extrasNom | Array<ExtensibleNom> | - | NO |
|
Class.PagoTercero
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
pagoTercero | String | N|... | NO |
|
extrasNom | Array<ExtensibleNom> | - | NO |
|
Class.Salud
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
porcentaje | String | N|.. | SI |
|
deduccion | String | N|.. | SI |
|
extrasNom | Array<ExtensibleNom> | - | NO |
|
Class.Sancion
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
sancionPublic | String | N|.. | SI |
|
sancionPriv | String | N|.. | SI |
|
extrasNom | Array<ExtensibleNom> | - | NO |
|
Class.Sindicato
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
porcentaje | String | N|.. | SI |
|
deduccion | String | N|.. | SI |
|
extrasNom | Array<ExtensibleNom> | - | NO |
|
Class.Devengados
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
anticiposNom | Array<AnticiposNom> | - | NO |
|
auxilios | Array<Auxilios> | - | NO |
|
apoyoSost | String | N|.. | NO |
|
basico | Array<Basico> | - | SI |
|
bonificaciones | Array<Bonificaciones> | - | NO |
|
bonifRetiro | String | N|.. | NO |
|
bonoEPCTVs | Array<BonoEPCTVs> | - | NO |
|
cesantías | Array<Cesantía> | - | NO |
|
comisiones | Array<Comisión> | - | NO |
|
compensaciones | Array<Compensación> | - | NO |
|
dotación | String | N|.. | NO |
|
extrasNom | Array<ExtensibleNom> | - | NO |
|
horasExtras | Array<HoraExtra> | - | NO |
|
huelgasLegales | Array<HuelgaLegal> | - | NO |
|
indemnización | String | N|.. | NO |
|
incapacidades | Array<Incapacidad> | - | NO |
|
licencias | Class | - | NO |
|
otrosConceptos | Array<OtroConcepto> | - | NO |
|
pagosTerceros | Array<PagoTercero> | - | NO |
|
primas | Array<Prima> | - | NO |
|
reintegro | String | N|.. | NO |
|
teletrabajo | String | N|.. | NO |
|
transporte | Array<Transporte> | - | NO |
|
vacaciones | Class | - | NO |
|
Class.AnticiposNom
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
montoanticipo | String | N|.. | NO |
|
extrasNom | Array<ExtensibleNom> | - | NO |
|
Class.Auxilio
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
auxilioNS | String | N|.. | NO |
|
auxilioS | String | N|.. | NO |
|
extrasNom | Array<ExtensibleNom> | - | NO |
|
Class.Basico
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
diasTrabajados | String | N|1-2 | SI |
|
extrasNom | Array<ExtensibleNom> | - | NO |
|
sueldoTrabajado | String | N|.. | SI |
|
Class.Bonificación
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
bonificacionNS | String | N|.. | NO |
|
bonificacionS | String | N|.. | NO |
|
extrasNom | Array<ExtensibleNom> | - | NO |
|
Class.BonoEPCTV
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
pagoAlimentacionNS | String | N|.. | NO |
|
pagoAlimentacionS | String | N|.. | NO |
|
extrasNom | Array<ExtensibleNom> | - | NO |
|
pagoNS | String | N|.. | NO |
|
pagoS | String | N|.. | NO |
|
Class.Cesantia
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
extrasNom | Array<ExtensibleNom> | - | NO |
|
pago | String | N|.. | SI |
|
pagoIntereses | String | N|.. | SI |
|
porcentaje | String | N|.. | SI |
|
Class.Comisión
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
extrasNom | Array<ExtensibleNom> | - | NO |
|
montocomision | String | N|.. | NO |
|
Class.Compensación
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
compensacionE | String | N|.. | SI |
|
compensacionO | String | N|.. | SI |
|
extrasNom | Array<ExtensibleNom> | - | NO |
|
Class.HoraExtra
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
cantidad | String | N|.. | SI |
|
extrasNom | Array<ExtensibleNom> | - | NO |
|
horaInicio | String | AN|19 | NO |
|
horaFin | String | AN|19 | NO |
|
pago | String | N|.. | SI |
|
porcentaje | String | N|4-6 | SI |
|
tipoHorasExtra | String | N|1 | C/C |
|
Class.HuelgaLegal
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
cantidad | String | N|.. | SI |
|
extrasNom | Array<ExtensibleNom> | - | NO |
|
fechaInicio | String | AN|10 | NO |
|
fechaFin | String | AN|10 | NO |
|
Class.Incapacidad
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
cantidad | String | N|.. | SI |
|
extrasNom | Array<ExtensibleNom> | - | NO |
|
fechaInicio | String | AN|10 | NO |
|
fechaFin | String | AN|10 | NO |
|
pago | String | N|.. | SI |
|
tipo | String | N|1 | SI |
|
Class.Licencia
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
extrasNom | Array<ExtensibleNom> | - | NO |
|
licenciaMP | Array<LicenciaMP> | - | SI |
|
licenciaNR | Array<LicenciaNR> | - | SI |
|
licenciaR | Array<LicenciaR> | - | SI |
|
Class.LicenciaMP
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
cantidad | String | N|.. | SI |
|
extrasNom | Array<ExtensibleNom> | - | NO |
|
fechaInicio | String | AN|10 | NO |
|
fechaFin | String | AN|10 | NO |
|
pago | String | N|.. | SI |
|
Class.LicenciaNR
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
cantidad | String | N|.. | SI |
|
extrasNom | Array<ExtensibleNom> | - | NO |
|
fechaInicio | String | AN|10 | NO |
|
fechaFin | String | AN|10 | NO |
|
Class.LicenciaR
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
cantidad | String | N|.. | SI |
|
extrasNom | Array<ExtensibleNom> | - | NO |
|
fechaInicio | String | AN|10 | NO |
|
fechaFin | String | AN|10 | NO |
|
pago | String | N|.. | SI |
|
Class.OtroConcepto
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
conceptoNS | String | N|.. | NO |
|
conceptoS | String | N|.. | NO |
|
descripcionConcepto | String | AN|.. | SI |
|
extrasNom | Array<ExtensibleNom> | - | NO |
|
Class.PagoTercero
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
montopagoTercero | String | N|.. | NO |
|
extrasNom | Array<ExtensibleNom> | - | NO |
|
Class.Prima
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
cantidad | String | N|.. | SI |
|
extrasNom | Array<ExtensibleNom> | - | NO |
|
pago | String | N|.. | SI |
|
pagoNS | String | N|.. | NO |
|
Class.Transporte
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
auxilioTransporte | String | N|.. | NO |
|
extrasNom | Array<ExtensibleNom> | - | NO |
|
ViaticoManuAlojS | String | N|.. | NO |
|
viaticoManuAlojNS | String | N|.. | NO |
|
Class.Vacaciónes
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
extrasNom | Array<ExtensibleNom> | - | NO |
|
vacaciónesComunes | Array<VacaciónesComunes> | - | NO |
|
vacaciónesCompensadas | Array<VacaciónesCompensadas> | - | NO |
|
Class.VacaciónesComunes
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
cantidad | String | N|.. | SI |
- Número de días que el trabajador estuvo activo durante el mes sin disfrutar sus vacaciones. (Vacaciones NO disfrutadas).
|
extrasNom | Array<ExtensibleNom> | - | NO |
|
fechaInicio | String | AN|10 | NO |
|
fechaFin | String | AN|10 | NO |
|
pago | String | N|.. | SI |
determinado tiempo. (Vacaciones disfrutadas) Corresponde al valor pagado al trabajador, por el descanso remunerado que no disfrutó y que tiene derecho por haber trabajado un determinado tiempo. (Vacaciones NO disfrutadas).
|
Class.VacaciónesCompensadas
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
cantidad | String | N|.. | SI |
- Número de días que el trabajador estuvo activo durante el mes sin disfrutar sus vacaciones. (Vacaciones NO disfrutadas).
|
extrasNom | Array<ExtensibleNom> | - | NO |
|
fechaInicio | String | AN|10 | NO |
|
fechaFin | String | AN|10 | NO |
|
pago | String | N|.. | SI |
determinado tiempo. (Vacaciones disfrutadas) Corresponde al valor pagado al trabajador, por el descanso remunerado que no disfrutó y que tiene derecho por haber trabajado un determinado tiempo. (Vacaciones NO disfrutadas).
|
Class.DocumentosReferenciadosNom
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
cunePred | String | AN..20 | SI |
|
extrasNom | Array<ExtensibleNom> | - | NO |
|
fechaGenPred | String | AN|10 | SI |
|
numeroPred | String | AN..20 | SI |
|
Class.Nota
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
descripción | String | - | NO |
|
extrasNom | Array<ExtensibleNom> | - | NO |
|
Class.LugarGeneracionXML
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
departamentoEstado | String | N|2 | SI |
|
extrasNom | Array<ExtensibleNom> | - | NO |
|
idioma | String | N|2 | SI |
|
municipioCiudad | String | N|5 | SI |
|
pais | String | AN|2 | SI |
|
Class.Pago
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
extrasNom | Array<ExtensibleNom> | - | NO |
|
fechasPagos | Array<FechasPago> | - | SI |
|
fechapagonomina | String | AN|10 | SI |
|
metodoDePago | String | N|1 | SI |
|
medioPago | String | AN|3 | SI |
|
nombreBanco | String | AN|..50 | NC |
|
tipoCuenta | String | AN|..50 | NC |
|
numeroCuenta | String | AN|..50 | NC |
|
Class.FechasPagos
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
extrasNom | Array<ExtensibleNom> | - | NO |
|
fechapagonomina | String | AN|10 | SI |
|
Class.Periodo
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
extrasNom | Array<ExtensibleNom> | - | NO |
|
fechaIngreso | String | AN|10 | SI |
|
fechaLiquidacionInicio | String | AN|10 | SI |
|
fechaLiquidacionFin | String | AN|10 | SI |
|
fechaRetiro | String | AN|10 | NO |
|
tiempoLaborado | String | 5 caracteres enteros n decimales (días) | NO |
|
Class.Trabajador
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
altoRiesgoPension | String | N|1 | SI |
|
codigoTrabajador | String | N|2 | SI |
|
String | - | SI |
| |
extrasNom | Array<ExtensibleNom> | - | NO |
|
lugarTrabajoDepartamentoEstado | String | N|2 | SI |
|
lugarTrabajoDireccion | String | AN|...100 | SI |
|
lugarTrabajoMunicipioCiudad | String | N|5 | SI |
|
lugarTrabajoPais | String | AN|2 | SI |
|
numeroDocumento | String | AN|...60 | SI |
|
primerApellido | String | AN|...60 | SI |
|
primerNombre | String | AN|...60 | SI |
|
otrosNombres | String | AN|...60 | NO |
|
salarioIntegral | String | N|1 | SI |
|
segundoApellido | String | AN|...60 | SI |
|
subTipoTrabajador | String | N|2 | SI |
|
sueldo | String | N|.. | SI |
|
tipoContrato | String | N|1 | SI |
|
tipoIdentificacion | String | N|2 | SI |
|
tipoTrabajador | String | N|2 | SI |
|
Class.ExtrasNom
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
controlInterno1 | String | AN|.. | C/C |
|
controlInterno2 | String | AN|.. | C/C |
|
nombre | String | AN|.. | SI |
|
valor | String | AN|.. | SI |
|
- RESPONSE
- Parámetros a Recibir
Tipo | Identificación | Descripción |
---|---|---|
int | código | Indica el Estado de la operación retornado por el servicio, (Por definir catálogo) |
String | mensaje | Este mensaje está asociado al código de respuesta, útil para identificación de errores |
String | resultado | Resultado del consumo del método:" Procesado” ó “Error”. |
String | consecutivoDocumento | Prefijo y Consecutivo del Documento concatenado sin separadores. Para el ejemplo anterior corresponde a: “PRUE980338337” |
String | cune | Código Único de Nómina Electrónica” correspondiente al documento consultado. |
String | trackId | Número de seguimiento, es un UUID, para consultar posteriormente el proceso asíncrono |
Array<String> | reglasNotificacionesTFHKA | Reglas de validación en caso de notificación TFHKA |
Array<String> | reglasNotificacionesDIAN | Reglas de validación en caso de notificación DIAN |
Array<String> | reglasRechazoTFHKA | Reglas de validación en caso de rechazo TFHKA |
Array<String> | reglasRechazoDIAN | Reglas de validación en caso de rechazo DIAN |
Método ConsultarDocumento
Permite consultar el estado de un documento Soporte de Pago de Nómina Electrónica y Nómina de Ajuste, ante la DIAN, el tipo de entrega y si la misma fue exitosa,además otros parámetros de interés que puedes ser útil en los procesos de control del software de Nómina (ERP) o para el modelo de negocio del empleador emisor.
- REQUEST
- Parámetros a Enviar
Tipo | Identificador | Descripción |
---|---|---|
String | tokenEmpresa | Suministrado por The Factory HKA Colombia |
tokenPassword | ||
consecutivoDocumentoNom | Prefijo y Consecutivo del Documento electrónico concatenado sin separadores. Ejemplo “PRUE980338212 |
- RESPONSE
- Parámetros a Recibir
Tipo | Identificador | Descripción |
---|---|---|
String | ambiente | Tipo de ambiente de generación del documento:
|
String | cadenaCodigoQR | Concatenación cadena del código QR (elemento de control) |
String | cadenaCune | Concatenación cadena del código CUNE previo al cálculo por el algoritmo correspondiente del servicio |
Int | código | Indica el estado de la operación retornado por el servicio |
String | cune | “Código Único de Nómina Electrónica” correspondiente al documento consultado, calculado por el algoritmo correspondiente del servicio. |
String | descripcionDocumento | Identificador del tipo de documento de referencia,
|
String | descripcionEstatusDocumento | Descripción correspondiente al estatusDocumento ante la DIAN: “La Nomina Individual, ha sido autorizada” |
String | estatusDocumento | Código obtenido en la respuesta correspondiente al estado del documento ante la DIAN ("200","109") |
String | esValidoDIAN |
|
String | fechaAceptacionDIAN | Día y Hora en la que la DIAN aceptó el documento electrónico, en formato AAAA-MM-DD HH:MM:SS |
String | fechaDocumento | Fecha en la que se generó el documento, en formato: AAAA-MM-DD |
String | mensaje | Este mensaje está asociado al código, útil para identificación de errores |
String | mensajeDocumento | Entrega una descripción del error de cada una de las validaciones iniciales. Si no hay errores no entrega descripción |
String | reglasValidacionDIAN | Mensajes de validación por parte de la DIAN |
String | resultado | Resultado del consumo del método:
|
String | trackID | Este elemento corresponde al TrackId del documento procesado |
String | tipoDocumento | Identificador del tipo de documento de referencia
|
Método ConsultarFolios
Permite consultar la cantidad de folios para procesar el Soporte de Pago de Nómina Electrónica y Nómina de Ajuste.
- REQUEST
- Parámetros a Enviar
Tipo | Identificador | Descripción |
---|---|---|
String | tokenEmpresa | Suministrado por The Factory HKA Colombia |
tokenPassword |
- RESPONSE
- Parámetros a Recibir
Tipo | Identificador | Descripción |
---|---|---|
Int | código | Indica el estado de la operación retornado por el servicio |
String | mensaje | Este mensaje está asociado al código, útil para identificación de errores |
String | resultado | Resultado del consumo del método:
|
Int | foliosRestantes | Cantidad de folios disponibles |
Método EnviarCorreo
Permite reenviar a una direccion de correo electrónico el Soporte de Pago de Nómina Electrónica y Nómina de Ajuste.
- REQUEST
- Parámetros a Enviar
Tipo | Identificador | Descripción |
---|---|---|
String | tokenEmpresa | Suministrado por The Factory HKA Colombia |
tokenPassword | ||
Direccion de correo electrónico del empleado | ||
consecutivoDocumentoNom | Prefijo y Consecutivo del Documento electrónico concatenado sin separadores. Ejemplo “PRUE980338212 |
- RESPONSE
- Parámetros a Recibir
Tipo | Identificador | Descripción |
---|---|---|
Int | código | Indica el estado de la operación retornado por el servicio |
String | mensaje | Este mensaje está asociado al código, útil para identificación de errores |
String | resultado | Resultado del consumo del método:
|
Método DescargarXML
Permite descargar documento Soporte de Pago de Nómina Electrónica, Nota de Ajuste de Documento Soporte de Pago de Nómina Electrónica en formato XML.
- REQUEST
- Parámetros a Enviar
Tipo | Identificador | Descripción |
---|---|---|
String | tokenEmpresa | Suministrado por The Factory HKA Colombia |
tokenPassword | ||
consecutivoDocumentoNom | Prefijo y Consecutivo del Documento electrónico concatenado sin separadores. Ejemplo “PRUE980338212 |
- RESPONSE
- Parámetros a Recibir
Tipo | Identificador | Descripción |
---|---|---|
Int | código | Indica el estado de la operación retornado por el servicio |
String | cune | “Código Único de Nómina Electrónica” correspondiente al documento consultado, calculado por el algoritmo correspondiente del servicio. |
String | documento | Documento XML codificado en Base64 |
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 | nombre | Prefijo y consecutivo del Documento Electrónico concatenado sin separadores. Ejemplo “PRUE980338212” |
String | resultado | Resultado del consumo del método:
|
Método DescargarPDF
Permite descargar la representación gráfica de un documento Soporte de Pago de Nómina Electrónica y Nómina de Ajuste.
- REQUEST
- Parámetros a Enviar
Tipo | Identificador | Descripción |
---|---|---|
String | tokenEmpresa | Suministrado por The Factory HKA Colombia |
tokenPassword | ||
consecutivoDocumentoNom | Prefijo y Consecutivo del Documento electrónico concatenado sin separadores. Ejemplo “PRUE980338212 |
- RESPONSE
- Parámetros a Recibir
Tipo | Identificador | Descripción |
---|---|---|
Int | código | Indica el estado de la operación retornado por el servicio |
String | cune | “Código Único de Nómina Electrónica” correspondiente al documento consultado, calculado por el algoritmo correspondiente del servicio. |
String | documento | Documento PDF codificado en Base64 |
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 | nombre | Prefijo y consecutivo del Documento Electrónico concatenado sin separadores. Ejemplo “PRUE980338212” |
String | resultado | Resultado del consumo del método:
|