Diferencia entre revisiones de «Métodos Servicio Emisión Nómina Electrónica - Indice Manual Integración Nómina Electrónica»
Ir a la navegación
Ir a la búsqueda
Línea 84: | Línea 84: | ||
|SI | |SI | ||
| | | | ||
− | : Debe ir la fecha de | + | : Debe ir la fecha de emisión del documento. Considerando zona horaria de Colombia (-5), en formato AAAA-MM-DD HH:MM:SS |
: '''PATH''': /root/InformacionGeneral/@(FechaGen + HoraGen) | : '''PATH''': /root/InformacionGeneral/@(FechaGen + HoraGen) | ||
|- | |- | ||
Línea 118: | Línea 118: | ||
|SI | |SI | ||
| | | | ||
− | : Utilizado para Atributos del Lugar de | + | : Utilizado para Atributos del Lugar de Generación del Documento XML |
: '''PATH''': /root/LugarGeneracionXML | : '''PATH''': /root/LugarGeneracionXML | ||
: ( Ver detalle en [[#Class.LugarGeneracionXM|Class.LugarGeneracionXM]]) | : ( Ver detalle en [[#Class.LugarGeneracionXM|Class.LugarGeneracionXM]]) | ||
Línea 251: | Línea 251: | ||
|NO | |NO | ||
| | | | ||
− | : Corresponde a (Ahorro Fomento a la | + | : Corresponde a (Ahorro Fomento a la construcción) |
: '''PATH''': /root.Deducciones/afc | : '''PATH''': /root.Deducciones/afc | ||
|- | |- | ||
Línea 285: | Línea 285: | ||
| | | | ||
: Valor Pagado correspondiente a Conceptos Educativos por parte del trabajador | : Valor Pagado correspondiente a Conceptos Educativos por parte del trabajador | ||
− | : '''PATH''': …/root.Deducciones/ | + | : '''PATH''': …/root.Deducciones/educación |
|- | |- | ||
|embargoFiscal | |embargoFiscal | ||
Línea 300: | Línea 300: | ||
|SI | |SI | ||
| | | | ||
− | : Utilizado para Atributos de Fondos de | + | : Utilizado para Atributos de Fondos de Pensión del Documento |
: '''PATH''': …/root.Deducciones/FondoPension | : '''PATH''': …/root.Deducciones/FondoPension | ||
: (ver detalle en [[#Class.FondoPension|Class.FondoPension]]) | : (ver detalle en [[#Class.FondoPension|Class.FondoPension]]) | ||
Línea 345: | Línea 345: | ||
|NO | |NO | ||
| | | | ||
− | : Valor correspondiente al ahorro que hace el trabajador para complementar su | + | : Valor correspondiente al ahorro que hace el trabajador para complementar su pensión obligatoria o cumplir metas especificas. |
: '''PATH''': …/root.Deducciones/pensionVoluntaria | : '''PATH''': …/root.Deducciones/pensionVoluntaria | ||
|- | |- | ||
Línea 374: | Línea 374: | ||
|- | |- | ||
|sanciones | |sanciones | ||
− | |Array< | + | |Array<Sanción> |
| - | | - | ||
|NO | |NO | ||
Línea 460: | Línea 460: | ||
: (ver detalle en [[#Class.BonoEPCTV|Class.BonoEPCTV]]) | : (ver detalle en [[#Class.BonoEPCTV|Class.BonoEPCTV]]) | ||
|- | |- | ||
− | | | + | |cesantías |
− | |Array< | + | |Array<Cesantía> |
| - | | - | ||
|NO | |NO | ||
| | | | ||
− | : Utilizado para Atributos de | + | : Utilizado para Atributos de Cesantías de Devengos del Documento |
: '''PATH''': ../root.Devengados/cesantias | : '''PATH''': ../root.Devengados/cesantias | ||
: (ver detalle en [[#Class.Cesantia|Class.Cesantia]]) | : (ver detalle en [[#Class.Cesantia|Class.Cesantia]]) | ||
|- | |- | ||
|comisiones | |comisiones | ||
− | |Array< | + | |Array<Comisión> |
| - | | - | ||
|NO | |NO | ||
Línea 479: | Línea 479: | ||
|- | |- | ||
|compensaciones | |compensaciones | ||
− | |Array< | + | |Array<Compensación> |
| - | | - | ||
|NO | |NO | ||
Línea 493: | Línea 493: | ||
| | | | ||
: De conformidad con lo previsto en el artículo 230 del Código Sustantivo del Trabajo, o la norma que lo modifique, adicione o sustituya, corresponde al valor que el empleador dispone para suministrar la dotación de sus trabajadores. | : De conformidad con lo previsto en el artículo 230 del Código Sustantivo del Trabajo, o la norma que lo modifique, adicione o sustituya, corresponde al valor que el empleador dispone para suministrar la dotación de sus trabajadores. | ||
− | : '''PATH''': ../root.Devengados/ | + | : '''PATH''': ../root.Devengados/dotación |
|- | |- | ||
|extras | |extras | ||
Línea 521: | Línea 521: | ||
: (ver detalle en [[#Class.HuelgaLegal|Class.HuelgasLegal]]) | : (ver detalle en [[#Class.HuelgaLegal|Class.HuelgasLegal]]) | ||
|- | |- | ||
− | | | + | |indemnización |
|String | |String | ||
|<nowiki>N|..</nowiki> | |<nowiki>N|..</nowiki> | ||
|NO | |NO | ||
| | | | ||
− | :Valor de | + | :Valor de Indemnización establecido por ley |
− | : '''PATH''': /root.Devengados/ | + | : '''PATH''': /root.Devengados/indemnización |
|- | |- | ||
|incapacidades | |incapacidades | ||
Línea 657: | Línea 657: | ||
! style="background:#f2f2f2; text-align:center;"|Descripción | ! style="background:#f2f2f2; text-align:center;"|Descripción | ||
|- | |- | ||
− | | | + | |descripción |
|String | |String | ||
| - | | - | ||
Línea 663: | Línea 663: | ||
| | | | ||
: Campo de libre uso para Observaciones en el documento | : Campo de libre uso para Observaciones en el documento | ||
− | : '''PATH''': .. /root.notas/ | + | : '''PATH''': .. /root.notas/descripción |
|- | |- | ||
|extras | |extras | ||
Línea 855: | Línea 855: | ||
|tiempoLaborado | |tiempoLaborado | ||
|String | |String | ||
− | |5 caracteres enteros n decimales ( | + | |5 caracteres enteros n decimales (días) |
|NO | |NO | ||
| | | | ||
Línea 1123: | Línea 1123: | ||
|- | |- | ||
|int | |int | ||
− | | | + | |código |
|Indica el Estado de la operación retornado por el servicio, (Por definir catálogo) | |Indica el Estado de la operación retornado por el servicio, (Por definir catálogo) | ||
|- | |- | ||
|String | |String | ||
− | | | + | |mensaje |
− | | | + | |Este mensaje está asociado al código de respuesta, útil para identificación de errores |
|- | |- | ||
|String | |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 | |String | ||
− | | | + | |cune |
− | | | + | |Código Único de Nómina Electrónica” correspondiente al documento consultado. |
|- | |- | ||
|String | |String | ||
− | | | + | |trackId |
− | | | + | |Número de seguimiento, es un UUID, para consultar posteriormente el proceso asíncrono |
|- | |- | ||
− | | | + | |Array |
− | | | + | |notificacionesTFHKA |
− | | | + | |Reglas de validación en caso de notificación TFHKA |
|- | |- | ||
− | | | + | |Array |
− | | | + | |notificacionesDIAN |
− | | | + | |Reglas de validación en caso de notificación DIAN |
|- | |- | ||
|Array | |Array | ||
− | | | + | |rechazoTFHKA |
− | | | + | |Reglas de validación en caso de rechazo TFHKA |
|- | |- | ||
− | | | + | |Array |
− | | | + | |rechazoDIAN |
|Nombre definido por la DIAN | |Nombre definido por la DIAN | ||
|- | |- | ||
|String | |String | ||
− | | | + | |nitEmpleador |
− | | | + | |Indica el nit del empleador |
|- | |- | ||
− | | | + | |String |
− | | | + | |nitEmpleado |
− | | | + | |Indica el nit del empleado |
− | |||
− | |||
− | |||
− | |||
|- | |- | ||
|String | |String | ||
− | | | + | |idSoftware |
− | | | + | |Identificador de Casa de Software |
|- | |- | ||
|String | |String | ||
− | | | + | |qr |
− | | | + | |Concatenación cadena del código QR (elemento de control) |
|- | |- | ||
− | | | + | |Bolean |
− | | | + | |esvalidoDIAN |
− | | | + | |“true” Si es válido |
|} | |} | ||
− | Una vez realizado el envío exitoso de la | + | Una vez realizado el envío exitoso de la Nómina electrónica (código ‘200’ o ‘201’ en la respuesta), se procede a enviar los archivos adjuntos (a través del método '''CargarAdjuntos''') consumiendo el Servicio Adjuntos Web SOAP, en el escenario de que el parámetro '''adjuntos''' se haya asignado en “1” u “11”, en caso contrario el Servicio Adjuntos Web SOAP retornará un error indicando que el documento NO admite adjuntos. |
{{clear}} | {{clear}} |
Revisión del 17:01 26 mar 2021
Sumario
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 | Identificador Software: Identificador del software habilitado para la emisión de nóminas |
String | tokenEmpresa | Suministrado por el proveedor tecnológico |
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 |
---|---|---|---|---|
consecutivoDocumento | String | AN..20 | Si |
|
deducciones | Class | - | SI |
|
devengados | Class | SI |
| |
documentosReferenciados | Array<DocumentoReferenciado> | - | SI |
|
extras | Array<Extras> | - | NO |
|
fechaEmision | 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 |
|
rangoNumeracion | String | AN..20 | SI |
|
redondeo | String | N|.. | NO |
|
tipoDocumento | String | N|3 | SI |
|
tipoMoneda | 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 |
|
anticipos | Array<Anticipo> | NO |
| |
cooperativa | String | N|.. | NO |
|
deuda | String | N|.. | 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 |
|
Class.Devengados
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
anticipos | Array<Anticipo> | - | 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 |
|
dotacion | String | N|.. | NO |
|
extras | Array<Extra> | - | 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.DocumentoReferenciado
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
cunePred | String | AN..20 | SI |
|
extras | Array<Extra> | - | NO |
|
fechaGenPred | String | AN|10 | SI |
|
numeroPred | String | AN..20 | SI |
|
Class.Nota
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
descripción | String | - | NO |
|
extras | Array<Extra> | - | NO |
|
Class.LugarGeneracionXML
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
departamentoEstado | String | N|2 | SI |
|
extras | Array<Extra> | - | 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 |
---|---|---|---|---|
extras | Array<Extra> | - | NO |
|
fechasPagos | Array<FechasPago> | - | SI |
|
extras | Array<Extra> | - | NO |
|
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.Periodo
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
extras | Array<Extra> | - | 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 |
| ||||||
extras | Array<Extra> | - | NO |
| |||||
lugarTrabajoDepartamentoEstado | String | N|2 | SI |
| |||||
lugarTrabajoDireccion | String | AN|...100 | SI |
| |||||
lugarTrabajoMunicipioCiudad | String | N|5 | SI |
| |||||
codigoTrabajador | String | N|2 | SI |
| |||||
lugarTrabajoPais | String | AN|2 | SI |
| |||||
numeroDocumento | String | AN|...60 | NO |
| |||||
primerApellido | String | AN|...60 | SI |
| |||||
primerNombre | String | AN|...60 | SI |
| |||||
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.Anticipo
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
anticipo | String | N|.. | NO |
|
extras | Array<Extra> | - | NO |
|
Class.FondoPension
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
deducción | String | N|.. | SI |
|
extras | Array<Extra> | - | NO |
|
porcentaje | String | N|4-6 | SI |
|
Class.FondoSP
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
deduccionSP | String | N|.. | SI |
|
deduccionSub | String | N|.. | NO |
|
extras | Array<Extra> | - | NO |
|
porcentaje | String | N|4-6 | NO |
|
- 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 | notificacionesTFHKA | Reglas de validación en caso de notificación TFHKA |
Array | notificacionesDIAN | Reglas de validación en caso de notificación DIAN |
Array | rechazoTFHKA | Reglas de validación en caso de rechazo TFHKA |
Array | rechazoDIAN | Nombre definido por la DIAN |
String | nitEmpleador | Indica el nit del empleador |
String | nitEmpleado | Indica el nit del empleado |
String | idSoftware | Identificador de Casa de Software |
String | qr | Concatenación cadena del código QR (elemento de control) |
Bolean | esvalidoDIAN | “true” Si es válido |
Una vez realizado el envío exitoso de la Nómina electrónica (código ‘200’ o ‘201’ en la respuesta), se procede a enviar los archivos adjuntos (a través del método CargarAdjuntos) consumiendo el Servicio Adjuntos Web SOAP, en el escenario de que el parámetro adjuntos se haya asignado en “1” u “11”, en caso contrario el Servicio Adjuntos Web SOAP retornará un error indicando que el documento NO admite adjuntos.