Diferencia entre revisiones de «Métodos Servicio Emisión Nómina Electrónica - Indice Manual Integración Nómina Electrónica»

De tfhkacolwiki
Ir a la navegación Ir a la búsqueda
(→‎Método Enviar)
Línea 1: Línea 1:
−
<includeonly>=</includeonly>==Método Servicio Nómina Electrónica Web Soap==<includeonly>=</includeonly>
+
===Método Enviar===
−
Los parámetros a incorporar en los métodos de este Web Service deberán cumplir con el formato y las directivas que correspondan según las siguientes reglas:
+
La función encargada de construir y enviar los documentos de soporte de pago de Nómina Electrónica a la DIAN.
−
 
 
−
{| class="mw-collapsible mw-collapsed wikitable" style="margin: auto;"
 
−
|-
 
−
! style="background:#e9e9e9; text-align:center;"|Formato
 
−
! style="background:#e9e9e9; text-align:center;"|Descripción
 
−
|- valign="center"
 
−
| A || Carácter alfabético
 
−
|-
 
−
| N || Carácter numérico
 
−
|-
 
−
| AN || Carácter alfanumérico
 
−
|-
 
−
| <nowiki> A|3 </nowiki> || 3 caracteres alfabéticos (longitud fija)
 
−
|-
 
−
| <nowiki> N|3 </nowiki> || 3 caracteres numéricos (longitud fija)
 
−
|-
 
−
| <nowiki> AN|3 </nowiki> || 3 caracteres alfanuméricos (longitud fija)
 
−
|-
 
−
| <nowiki> A|..3 </nowiki> || Hasta 3 caracteres alfabéticos (longitud variable)
 
−
|-
 
−
| <nowiki> N|..3 </nowiki> || Hasta 3 caracteres numéricos (longitud variable)
 
−
|-
 
−
| <nowiki> AN|..3 </nowiki> || Hasta 3 caracteres alfanuméricos (longitud variable)
 
−
|-
 
−
| <nowiki> N|2..6 </nowiki> || Entre 2 y 6 caracteres numéricos (longitud variable)
 
−
|-
 
−
| INT32 || Entero. (Valor Máximo: 2,147,483,647)
 
−
|}
 
−
{{clear}}
 
 
<br>
 
<br>
−
{| class="mw-collapsible mw-collapsed wikitable" style="margin: auto;"
 
−
|-
 
−
! style="background:#e9e9e9; text-align:center;"|Obligatorio
 
−
! style="background:#e9e9e9; text-align:center;"|Descripción
 
−
|- valign="center"
 
−
| SI || Si es obligatorio para la DIAN
 
−
|-
 
−
| NO || No es obligatorio para la DIAN
 
−
|-
 
−
| C/C || Es requerido cuando corresponda (o bajo cierta condición por el modelo de negocio del cliente)
 
−
|}
 
−
{{clear}}
 
−
 
−
===Método Enviar===
 
−
La función encargada de construir y enviar los documentos electrónicos al proveedor tecnológico.
 
 
; REQUEST: Parámetros a Enviar
 
; REQUEST: Parámetros a Enviar
 
{| class="mw-collapsible mw-collapsed wikitable" style="margin: auto;"
 
{| class="mw-collapsible mw-collapsed wikitable" style="margin: auto;"
Línea 54: Línea 10:
 
|- valign="center"
 
|- valign="center"
 
|-
 
|-
 +
|String
 
|idSoftware
 
|idSoftware
−
|iD
 
 
|Identificador Software: Identificador del software habilitado para la emisión de nóminas
 
|Identificador Software: Identificador del software habilitado para la emisión de nóminas
 
|-
 
|-
Línea 64: Línea 20:
 
|tokenPassword
 
|tokenPassword
 
|-
 
|-
 +
|String
 
|nitEmpleador
 
|nitEmpleador
−
|Nit
 
 
|Debe corresponder al NIT del Empleador que realiza el DE
 
|Debe corresponder al NIT del Empleador que realiza el DE
 
|-
 
|-
−
|ObjetoNomina
 
 
|Objeto
 
|Objeto
 +
|Nomina
 
|Ver el detalle del Objeto Nomina más abajo
 
|Ver el detalle del Objeto Nomina más abajo
 
|}
 
|}
Línea 91: Línea 47:
 
|Class
 
|Class
 
| -
 
| -
−
|NO
+
|SI
 
|
 
|
 
: Clase relacionada al las deducciones reportadas en el documento
 
: Clase relacionada al las deducciones reportadas en el documento
Línea 107: Línea 63:
 
|-
 
|-
 
|documentosReferenciados
 
|documentosReferenciados
−
|Array
+
|Array<DocumentoReferenciado>
 
| -
 
| -
 
|SI
 
|SI
Línea 116: Línea 72:
 
|-
 
|-
 
|extras
 
|extras
−
|String
+
|Array<Extras>
 
| -
 
| -
 
|NO
 
|NO
Línea 124: Línea 80:
 
|-
 
|-
 
|fechaEmision
 
|fechaEmision
−
|String<CondicionPago>
+
|String
 
|<nowiki>AN|19</nowiki>
 
|<nowiki>AN|19</nowiki>
 
|SI
 
|SI
 
|
 
|
−
: Debe ir la fecha de emision del documento. Considerando zona horaria de Colombia (-5), en formato AAAA-MM-DD
+
: Debe ir la fecha de emision del documento. Considerando zona horaria de Colombia (-5), en formato AAAA-MM-DD-
 
: '''PATH''': /root/InformacionGeneral/@(FechaGen + HoraGen)
 
: '''PATH''': /root/InformacionGeneral/@(FechaGen + HoraGen)
 
|-
 
|-
 
|notas
 
|notas
−
|Array
+
|Array<Nota>
 
| -
 
| -
 
|NO
 
|NO
 
|
 
|
 
: Información adicional Texto libre, relativo al documento.
 
: Información adicional Texto libre, relativo al documento.
−
: '''PATH''': /root/Notas.
+
: '''PATH''': /root/Nota.
 
: ( Ver detalle en [[#Class.Notas|Class.Notas]])
 
: ( Ver detalle en [[#Class.Notas|Class.Notas]])
 
|-
 
|-
Línea 167: Línea 123:
 
|-
 
|-
 
|pagos
 
|pagos
−
|Array <Extras>
+
|Array<Pago>
 
| -
 
| -
 
|SI
 
|SI
Línea 173: Línea 129:
 
: Pagos por el reconocimiento del logro o cumplimiento por parte del trabajador en el desarrollo de sus labores, de condiciones definidas expresamente entre las partes.
 
: Pagos por el reconocimiento del logro o cumplimiento por parte del trabajador en el desarrollo de sus labores, de condiciones definidas expresamente entre las partes.
 
: '''PATH''': /root/Pago
 
: '''PATH''': /root/Pago
−
: (ver detalle en [[#Class.pagos|Class.pagos]])
+
: (ver detalle en [[#Class.Pago|Class.Pago]])
 
|-
 
|-
 
|periodoNomina
 
|periodoNomina
Línea 184: Línea 140:
 
|-
 
|-
 
|periodos
 
|periodos
−
|Array
+
|Array<Periodo>
 
|<nowiki>AN|19</nowiki>
 
|<nowiki>AN|19</nowiki>
 
|SI
 
|SI
Línea 190: Línea 146:
 
: Corresponde al periodo de generación del documento (periodo laborable del trabajador)
 
: Corresponde al periodo de generación del documento (periodo laborable del trabajador)
 
: '''PATH''': /root/periodo
 
: '''PATH''': /root/periodo
 +
: (ver detalle en [[#Class.Periodo|Class.Periodo]])
 
|-
 
|-
 
|rangoNumeracion
 
|rangoNumeracion
Línea 295: Línea 252:
 
|
 
|
 
: Corresponde a (Ahorro Fomento a la construccion)
 
: Corresponde a (Ahorro Fomento a la construccion)
−
: '''PATH''': /Class.Deducciones/afc  
+
: '''PATH''': /root.Deducciones/afc  
 
|-  
 
|-  
 
|anticipos
 
|anticipos
−
|Array<String>
+
|Array<Anticipo>
 
|  
 
|  
 
|NO
 
|NO
 
|
 
|
 
: Utilizado para Todos los Elementos de Anticipos de Deducciones del Documento
 
: Utilizado para Todos los Elementos de Anticipos de Deducciones del Documento
−
: PATH: …/Class.Deducciones/anticipos
+
: PATH: …/root.Deducciones/anticipos
 
: (ver detalle en [[#Class.Anticipos|Class.Anticipos]])
 
: (ver detalle en [[#Class.Anticipos|Class.Anticipos]])
 
|-
 
|-
Línea 312: Línea 269:
 
|
 
|
 
: Las cuotas o aportes que los empleados hagan a las cooperativas legalmente constituidas
 
: Las cuotas o aportes que los empleados hagan a las cooperativas legalmente constituidas
−
: '''PATH''': …/Class.Deducciones/cooperativa
+
: '''PATH''': …/root.Deducciones/cooperativa
 
|-
 
|-
 
|deuda
 
|deuda
Línea 320: Línea 277:
 
|
 
|
 
: 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''': …/Class.Deducciones/deuda
+
: '''PATH''': …/root.Deducciones/deuda
 
|-
 
|-
 
|educación
 
|educación
Línea 328: Línea 285:
 
|
 
|
 
: Valor Pagado correspondiente a Conceptos Educativos por parte del trabajador
 
: Valor Pagado correspondiente a Conceptos Educativos por parte del trabajador
−
: '''PATH''': …/Class.Deducciones/educacion
+
: '''PATH''': …/root.Deducciones/educacion
 
|-
 
|-
 
|embargoFiscal
 
|embargoFiscal
Línea 336: Línea 293:
 
|
 
|
 
: Valor Pagado correspondiente a Embargos Fiscales por parte del trabajador
 
: Valor Pagado correspondiente a Embargos Fiscales por parte del trabajador
−
: '''PATH''': …/Class.Deducciones/embargoFiscal
+
: '''PATH''': …/root.Deducciones/embargoFiscal
 
|-
 
|-
 
|fondosPensiones
 
|fondosPensiones
−
|Array<String>
+
|Array<FondoPension>
 
| -
 
| -
 
|SI
 
|SI
 
|
 
|
 
: Utilizado para Atributos de Fondos de Pension del Documento
 
: Utilizado para Atributos de Fondos de Pension del Documento
−
: '''PATH''': …/Class.Deducciones/FondoPension
+
: '''PATH''': …/root.Deducciones/FondoPension
−
: (ver detalle en [[#Class.FondosPensiones|Class.FondosPensiones]])
+
: (ver detalle en [[#Class.FondosPension|Class.FondosPension]])
 
|-
 
|-
 
|fondosSP
 
|fondosSP
−
|Array<String>
+
|Array<FondosSP>
 
| -
 
| -
 
|NO
 
|NO
 
|
 
|
 
: Utilizado para Atributos de Fondo de Seguridad Pensional del Documento
 
: Utilizado para Atributos de Fondo de Seguridad Pensional del Documento
−
: '''PATH''': …/Class.Deducciones/FondoSP
+
: '''PATH''': …/root.Deducciones/FondoSP
−
: (ver detalle en [[#Class.FondosSP|Class.FondosSP]])
+
: (ver detalle en [[#Class.FondoSP|Class.FondoSP]])
 
|-
 
|-
 
|libranzas
 
|libranzas
−
|Array<String>
+
|Array<Libranza>
 
|<nowiki>N|..</nowiki>
 
|<nowiki>N|..</nowiki>
 
|NO
 
|NO
 
|
 
|
 
: Utilizado para Todos los Elementos de Libranzas de Deducciones del Documento
 
: Utilizado para Todos los Elementos de Libranzas de Deducciones del Documento
−
: '''PATH''': …/Class.Deducciones/libranzas
+
: '''PATH''': …/root.Deducciones/libranzas
−
: (ver detalle en [[#Class.Libranzas|Class.Libranzas]])
+
: (ver detalle en [[#Class.Libranza|Class.Libranza]])
 
|-
 
|-
 
|otrasDeducciones
 
|otrasDeducciones
−
|Array<String>
+
|Array<OtrasDeducciones>
 
| -
 
| -
 
|NO
 
|NO
 
|
 
|
 
:Utilizado para Todos los Elementos de Otras Deducciones del Documento
 
:Utilizado para Todos los Elementos de Otras Deducciones del Documento
−
: '''PATH''': …/Class.Deducciones/otrasDeducciones
+
: '''PATH''': …/root.Deducciones/otrasDeducciones
−
: (ver detalle en [[#Class.OtrasDeducciones|Class.OtrasDeducciones]])
+
: (ver detalle en [[#Class.OtraDeduccion|Class.OtraDeduccion]])
 
|-
 
|-
 
|pagosTerceros
 
|pagosTerceros
−
|Array<String>
+
|Array<PagoTerceros>
 
| -
 
| -
 
|NO
 
|NO
 
|
 
|
 
: Utilizado para Todos los Elementos de Pagos a Tercero de Devengos del Documento
 
: Utilizado para Todos los Elementos de Pagos a Tercero de Devengos del Documento
−
: '''PATH''': …/Class.Deducciones/pagosTerceros
+
: '''PATH''': …/root.Deducciones/pagosTerceros
−
: (ver detalle en [[#Class.PagosTerceros|Class.PagosTerceros]])
+
: (ver detalle en [[#Class.PagoTercero|Class.PagoTercero]])
 
|-
 
|-
 
|pensionVoluntaria
 
|pensionVoluntaria
Línea 389: Línea 346:
 
|
 
|
 
: Valor correspondiente al ahorro que hace el trabajador para complementar su pension obligatoria o cumplir metas especificas.
 
: Valor correspondiente al ahorro que hace el trabajador para complementar su pension obligatoria o cumplir metas especificas.
−
: '''PATH''': …/Class.Deducciones/pensionVoluntaria
+
: '''PATH''': …/root.Deducciones/pensionVoluntaria
 
|-
 
|-
 
|planComplementarios
 
|planComplementarios
Línea 397: Línea 354:
 
|
 
|
 
: Valor de planes complementarios de salud al que el trabajador se encuentran afiliado, siempre que medie autorización del empleado.
 
: Valor de planes complementarios de salud al que el trabajador se encuentran afiliado, siempre que medie autorización del empleado.
−
: '''PATH''': …/Class.Deducciones/planComplementarios
+
: '''PATH''': …/root.Deducciones/planComplementarios
 
|-
 
|-
 
|retencionFuente
 
|retencionFuente
Línea 405: Línea 362:
 
|
 
|
 
: Si hubiere lugar, la empresa deberá calcular y retener al empleado el valor correspondiente a retención en la fuente por ingresos laborales. Este valor será declarado y consignado en la respectiva declaración mensual de retención en la fuente.
 
: Si hubiere lugar, la empresa deberá calcular y retener al empleado el valor correspondiente a retención en la fuente por ingresos laborales. Este valor será declarado y consignado en la respectiva declaración mensual de retención en la fuente.
−
: '''PATH''': …/Class.Deducciones/retencionFuente
+
: '''PATH''': …/root.Deducciones/retencionFuente
 
|-
 
|-
 
|salud
 
|salud
−
|Array<String>
+
|Array<Salud>
 
| -
 
| -
 
|SI
 
|SI
 
|
 
|
 
: Utilizado para Atributos de Salud del Documento.
 
: Utilizado para Atributos de Salud del Documento.
−
: '''PATH''': …/Class.Deducciones/Salud
+
: '''PATH''': …/root.Deducciones/Salud
 
: (ver detalle en [[#Class.Salud|Class.Salud]])
 
: (ver detalle en [[#Class.Salud|Class.Salud]])
 
|-
 
|-
 
|sanciones
 
|sanciones
−
|Array<String>
+
|Array<Sancion>
 
| -
 
| -
 
|NO
 
|NO
 
|
 
|
 
: Utilizado para Todos los Elementos de Sanciones de Deducciones del Documento
 
: Utilizado para Todos los Elementos de Sanciones de Deducciones del Documento
−
: '''PATH''': …/Class.Deducciones/sanciones
+
: '''PATH''': …/root.Deducciones/sanciones
−
: (ver detalle en [[#Class.Sanciones|Class.Sanciones]])
+
: (ver detalle en [[#Class.Sancion|Class.Sancion]])
 
|-
 
|-
 
|sindicatos
 
|sindicatos
−
|Array<String>
+
|Array<Sindicato>
 
| -
 
| -
 
|NO
 
|NO
 
|
 
|
 
: Utilizado para Todos los Elementos de Sindicatos de Deducciones del Documento.
 
: Utilizado para Todos los Elementos de Sindicatos de Deducciones del Documento.
−
: '''PATH''': …/Class.Deducciones/sindicatos
+
: '''PATH''': …/root.Deducciones/sindicatos
−
: (ver detalle en [[#Class.Sindicatos|Class.Sindicatos]])
+
: (ver detalle en [[#Class.Sindicato|Class.Sindicato]])
 
|}
 
|}
 
====Class.Devengados====
 
====Class.Devengados====
Línea 443: Línea 400:
 
|-
 
|-
 
|anticipos
 
|anticipos
−
|Array<String>
+
|Array<Anticipo>
 
| -
 
| -
 
|NO
 
|NO
 
|
 
|
 
:Clase relacionada a los devengos correspondientes a anticipos.
 
:Clase relacionada a los devengos correspondientes a anticipos.
−
: '''PATH''': ../Class.Devengados/anticipos
+
: '''PATH''': ../root.Devengados/anticipos
 +
: (ver detalle en [[#Class.Anticipo|Class.Anticipo]])
 
|-
 
|-
 
|auxilios
 
|auxilios
−
|Array<String>
+
|Array<Auxilios>
 
| -
 
| -
 
|NO
 
|NO
 
|
 
|
 
: Utilizado para Todos los Elementos de Auxilios de Devengos del Documento
 
: Utilizado para Todos los Elementos de Auxilios de Devengos del Documento
−
: '''PATH''': ../Class.Devengados/auxilios
+
: '''PATH''': ../root.Devengados/auxilios
 +
: (ver detalle en [[#Class.Auxilio|Class.Auxilio]])
 
|-
 
|-
 
|apoyoSost
 
|apoyoSost
Línea 464: Línea 423:
 
|
 
|
 
: Corresponde al valor no salarial que el patrocinador paga de forma mensual como ayuda o apoyo economía al aprendiz o practicante universitario durante su etapa lectiva y fase practica.
 
: Corresponde al valor no salarial que el patrocinador paga de forma mensual como ayuda o apoyo economía al aprendiz o practicante universitario durante su etapa lectiva y fase practica.
−
: '''PATH''': /Class.Devengados/apoyoSost
+
: '''PATH''': /root.Devengados/apoyoSost
 
|-
 
|-
 
|basico
 
|basico
−
|Array<String>
+
|Array<Basico>
 
| -
 
| -
 
|SI
 
|SI
 
|
 
|
−
: Utilizado para Atributos Basicos de Devengos del Documento
+
: Utilizado para Atributos Básicos de Devengos del Documento
−
: '''PATH''': ../Class.Basico
+
: '''PATH''': ../root.Basico
 
: (ver detalle en [[#Class.Basico|Class.Basico]])
 
: (ver detalle en [[#Class.Basico|Class.Basico]])
 
|-
 
|-
 
|bonificaciones
 
|bonificaciones
−
|Array<String>
+
|Array<Bonificaciones>
 
| -
 
| -
 
|NO
 
|NO
 
|
 
|
 
: Utilizado para Todos los Elementos de Bonificaciones de Devengos del Documento
 
: Utilizado para Todos los Elementos de Bonificaciones de Devengos del Documento
−
: '''PATH''': ../Class.Devengados/bonificaciones
+
: '''PATH''': ../root.Devengados/bonificaciones
−
: (ver detalle en [[#Class.Bonificaciones|Class.Bonificaciones]])
+
: (ver detalle en [[#Class.Bonificacion|Class.Bonificacion]])
 
|-
 
|-
 
|bonifRetiro
 
|bonifRetiro
Línea 490: Línea 449:
 
|
 
|
 
: Valor establecido por mutuo acuerdo por retiro del Trabajador.
 
: Valor establecido por mutuo acuerdo por retiro del Trabajador.
−
: '''PATH''': ../Class.Devengados/bonifRetiro
+
: '''PATH''': ../root.Devengados/bonifRetiro
 
|-
 
|-
 
|bonoEPCTVs
 
|bonoEPCTVs
−
|Array<String>
+
|Array<BonoEPCTVs>
 
| -
 
| -
 
|NO
 
|NO
 
|
 
|
−
: Utilizado para Todos los Elementos de Bonos Electronicos o de Papel de Servicio, Cheques, Tarjetas, Vales, etc de Devengos del Documento
+
: Utilizado para Todos los Elementos de Bonos Electrónicos o de Papel de Servicio, Cheques, Tarjetas, Vales, etc de Devengos del Documento
−
: '''PATH''': ../Class.Devengados/bonoEPCTVs
+
: '''PATH''': ../root.Devengados/bonoEPCTVs
−
: (ver detalle en [[#Class.bonoEPCTVs|Class.bonoEPCTVs]])
+
: (ver detalle en [[#Class.BonoEPCTV|Class.BonoEPCTV]])
 
|-
 
|-
 
|cesantias
 
|cesantias
−
|Array<String>
+
|Array<Cesantia>
 
| -
 
| -
 
|NO
 
|NO
 
|
 
|
 
: Utilizado para Atributos de Cesantias de Devengos del Documento
 
: Utilizado para Atributos de Cesantias de Devengos del Documento
−
: '''PATH''': ../Class.Devengados/cesantias
+
: '''PATH''': ../root.Devengados/cesantias
−
: (ver detalle en [[#Class.Cesantias|Class.Cesantias]])
+
: (ver detalle en [[#Class.Cesantia|Class.Cesantia]])
 
|-
 
|-
 
|comisiones
 
|comisiones
−
|Array<String>
+
|Array<Comision>
 
| -
 
| -
 
|NO
 
|NO
 
|
 
|
 
: Utilizado para Todos los Elementos de Comisiones de Devengos del Documento
 
: Utilizado para Todos los Elementos de Comisiones de Devengos del Documento
−
: '''PATH''': ../Class.Devengados/comisiones
+
: '''PATH''': ../root.Devengados/comisiones
 +
: (ver detalle en [[#Class.Comision|Class.Comision]])
 
|-
 
|-
 
|compensaciones
 
|compensaciones
−
|Array<String>
+
|Array<Compensacion>
 
| -
 
| -
 
|NO
 
|NO
 
|
 
|
 
: Utilizado para Todos los Elementos de Compensaciones de Devengos del Documento
 
: Utilizado para Todos los Elementos de Compensaciones de Devengos del Documento
−
: '''PATH''': ../Class.Devengados/compensaciones
+
: '''PATH''': ../root.Devengados/compensaciones
 +
: (ver detalle en [[#Class.Compensacion|Class.compensacion]])
 
|-
 
|-
 
|dotacion
 
|dotacion
Línea 532: 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''': ../Class.Devengados/dotacion
+
: '''PATH''': ../root.Devengados/dotacion
 
|-
 
|-
 
|extras
 
|extras
−
|String
+
|Array<Extra>
 
| -
 
| -
 
|NO
 
|NO
Línea 543: Línea 504:
 
|-
 
|-
 
|horasExtras
 
|horasExtras
−
|Array<String>
+
|Array<HoraExtra>
 
| -
 
| -
 
|NO
 
|NO
 
|
 
|
 
:Utilizado para Todos los Elementos de Horas Extras Diarias de Devengos del Documento
 
:Utilizado para Todos los Elementos de Horas Extras Diarias de Devengos del Documento
−
: '''PATH''': /Class.Devengado/horasExtras
+
: '''PATH''': /root.Devengado/horasExtras
 +
: (ver detalle en [[#Class.HoraExtra|Class.HoraExtra]])
 
|-
 
|-
 
|huelgasLegales
 
|huelgasLegales
−
|Array<String>
+
|Array<HuelgaLegal>
 
| -
 
| -
 
|NO
 
|NO
 
|
 
|
 
:Utilizado para Todos los Elementos de Huelgas Legales de Devengos del Documento
 
:Utilizado para Todos los Elementos de Huelgas Legales de Devengos del Documento
−
: '''PATH''': /Class.Devengados/huelgasLegales
+
: '''PATH''': /root.Devengados/huelgasLegales
−
: (ver detalle en [[#Class.HuelgasLegales|Class.HuelgasLegales]])
+
: (ver detalle en [[#Class.HuelgaLegal|Class.HuelgasLegal]])
 
|-
 
|-
 
|indemnizacion
 
|indemnizacion
Línea 565: Línea 527:
 
|
 
|
 
:Valor de Indemnizacion establecido por ley
 
:Valor de Indemnizacion establecido por ley
−
: '''PATH''': /Class.Devengados/indemnizacion
+
: '''PATH''': /root.Devengados/indemnizacion
 
|-
 
|-
 
|incapacidades
 
|incapacidades
−
|Array<String>
+
|Array<Incapacidad>
 
| -
 
| -
 
|NO
 
|NO
 
|
 
|
 
:Utilizado para Todos los Elementos de Incapacidades de Devengos del Documento
 
:Utilizado para Todos los Elementos de Incapacidades de Devengos del Documento
−
: '''PATH''': /Class.Devengados/incapacidades
+
: '''PATH''': /root.Devengados/incapacidades
−
: (ver detalle en [[#Class.incapacidades|Class.incapacidades]])
+
: (ver detalle en [[#Class.incapacidad|Class.incapacidad]])
 
|-
 
|-
 
|licencias
 
|licencias
Línea 582: Línea 544:
 
|
 
|
 
:Utilizado para Todos los Elementos de Licencias de Devengos del Documento
 
:Utilizado para Todos los Elementos de Licencias de Devengos del Documento
−
: '''PATH''': /Class.Devengados/licencias
+
: '''PATH''': /root.Devengados/licencias
−
: (ver detalle en [[#Class.Licencias|Class.Licencias]])
+
: (ver detalle en [[#Class.Licencia|Class.Licencia]])
 
|-
 
|-
 
|otrosConceptos
 
|otrosConceptos
−
|Array<String>
+
|Array<OtroConcepto>
 
| -
 
| -
 
|NO
 
|NO
 
|
 
|
 
:Utilizado para Todos los Elementos de Otros Conceptos de Devengos del Documento
 
:Utilizado para Todos los Elementos de Otros Conceptos de Devengos del Documento
−
: '''PATH''': /Class.Devengados/otrosConceptos
+
: '''PATH''': /root.Devengados/otrosConceptos
−
: (ver detalle en [[#Class.otrosConceptos|Class.otrosConceptos]])
+
: (ver detalle en [[#Class.OtroConcepto|Class.OtroConcepto]])
 
|-
 
|-
 
|pagosTerceros
 
|pagosTerceros
−
|Array<String>
+
|Array<PagoTercero>
 
| -
 
| -
 
|NO
 
|NO
 
|
 
|
 
:Utilizado para Todos los Elementos de Pagos a Tercero de Devengos del Documento
 
:Utilizado para Todos los Elementos de Pagos a Tercero de Devengos del Documento
−
: '''PATH''': /Class.Devengados/pagosTerceros
+
: '''PATH''': /root.Devengados/pagosTerceros
−
: (ver detalle en [[#Class.otrosConceptos|Class.otrosConceptos]])
+
: (ver detalle en [[#Class.PagoTercero|Class.PagoTercero]])
 
|-
 
|-
 
|primas
 
|primas
−
|Array<String>
+
|Array<Prima>
 
| -
 
| -
 
|NO
 
|NO
 
|
 
|
 
:Utilizado para Atributos de Primas de Devengos del Documento
 
:Utilizado para Atributos de Primas de Devengos del Documento
−
: '''PATH''': /Class.Devengados/primas
+
: '''PATH''': /root.Devengados/primas
−
: (ver detalle en [[#Class.Primas|Class.Primas]])
+
: (ver detalle en [[#Class.Prima|Class.Prima]])
 
|-
 
|-
 
|reintegro
 
|reintegro
Línea 618: Línea 580:
 
|
 
|
 
:Valor que le regresa la empresa al trabajador por una deducción mal realizada en otro pago de nomina
 
:Valor que le regresa la empresa al trabajador por una deducción mal realizada en otro pago de nomina
−
: '''PATH''': /Class.Devengados/reintegro
+
: '''PATH''': /root.Devengados/reintegro
 
|-
 
|-
 
|teletrabajo
 
|teletrabajo
Línea 629: Línea 591:
 
|-
 
|-
 
|transporte
 
|transporte
−
|Array<String>
+
|Array<Transporte>
 
| -
 
| -
 
|NO
 
|NO
 
|
 
|
 
:Utilizado para Atributos de Transporte de Devengos del Documento
 
:Utilizado para Atributos de Transporte de Devengos del Documento
−
: '''PATH''': /Class.Transporte
+
: '''PATH''': /root.Transporte
 
: (ver detalle en [[#Class.Transporte|Class.Transporte]])
 
: (ver detalle en [[#Class.Transporte|Class.Transporte]])
−
 
 
|-
 
|-
 
|vacaciones
 
|vacaciones
Línea 644: Línea 605:
 
|
 
|
 
:Utilizado para Todos los Elementos de Vacaciones de Devengos del Documento
 
:Utilizado para Todos los Elementos de Vacaciones de Devengos del Documento
−
: '''PATH''': /Class.Devengados/vacaciones
+
: '''PATH''': /root.Devengados/vacaciones
−
: (ver detalle en [[#Class.Vacaciones|Class.Vacaciones]])
+
: (ver detalle en [[#Class.Vacacion|Class.Vacacion]])
 
|}
 
|}
  
Línea 658: Línea 619:
 
|cunePred
 
|cunePred
 
|String
 
|String
−
| -
+
|<nowiki>AN..20</nowiki>
−
|C/C
+
|SI
 
|
 
|
 
: 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''': /Class.documentosReferenciados/@CUNEPred
+
: '''PATH''': /root.documentosReferenciadoS/@CUNEPred
 
|-
 
|-
 
|extras
 
|extras
−
|String
+
|Array<Extra>
 
| -
 
| -
 
|NO
 
|NO
Línea 674: Línea 635:
 
|fechaGenPred
 
|fechaGenPred
 
|String  
 
|String  
−
| -
+
|<nowiki>AN|10</nowiki>
 
|SI
 
|SI
 
|
 
|
−
: Debe corresponder a la Fecha de Emision 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''': /Class.documentosReferenciados/fechaGenPred
+
: '''PATH''': /root.documentosReferenciados/fechaGenPred
 
|-
 
|-
 
|numeroPred
 
|numeroPred
 
|String
 
|String
−
| -
+
|<nowiki>AN..20</nowiki>
 
|SI
 
|SI
 
|
 
|
 
: 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''': …/Class.documentosReferenciados/numeroPred
+
: '''PATH''': …/root.documentosReferenciados/numeroPred
 
|}
 
|}
 
====Class.Notas====
 
====Class.Notas====
Línea 702: Línea 663:
 
|
 
|
 
: Campo de libre uso para Observaciones en el documento
 
: Campo de libre uso para Observaciones en el documento
−
: '''PATH''': .. /class.notas/descripcion
+
: '''PATH''': .. /root.notas/descripcion
 
|-
 
|-
 
|extras
 
|extras
−
|String
+
|Array<Extra>
 
| -
 
| -
 
|NO
 
|NO
Línea 722: Línea 683:
 
|departamentoEstado
 
|departamentoEstado
 
|String
 
|String
−
| -
+
|<nowiki>N|2</nowiki>
 
|SI
 
|SI
 
|
 
|
 
: Código del departamento donde se genera el documento
 
: Código del departamento donde se genera el documento
−
: '''PATH''': ../Class.LugarGeneracionXML/departamentoEstado
+
: '''PATH''': ../root.LugarGeneracionXML/departamentoEstado
 
: [[Tablas de códigos de propiedades para emisión de documentos - Indice Manual Integración Nómina Electrónica#Tabla 4|Tabla 4]]
 
: [[Tablas de códigos de propiedades para emisión de documentos - Indice Manual Integración Nómina Electrónica#Tabla 4|Tabla 4]]
 
|-
 
|-
 
|extras
 
|extras
−
|String
+
|Array<Extra>
 
| -
 
| -
 
|NO
 
|NO
Línea 739: Línea 700:
 
|idioma
 
|idioma
 
|String
 
|String
−
| -
+
|<nowiki>N|2</nowiki>
 
|SI
 
|SI
 
|
 
|
 
: Codigo del país donde se genera el documento
 
: Codigo del país donde se genera el documento
−
: '''PATH''': ../Class.LugarGeneracionXML/idioma
+
: '''PATH''': ../root.LugarGeneracionXML/idioma
 
: [[Tablas de códigos de propiedades para emisión de documentos - Indice Manual Integración Nómina Electrónica#Tabla 5|Tabla 5]]
 
: [[Tablas de códigos de propiedades para emisión de documentos - Indice Manual Integración Nómina Electrónica#Tabla 5|Tabla 5]]
 
|-
 
|-
 
|municipioCiudad
 
|municipioCiudad
 
|String
 
|String
−
| -
+
|<nowiki>N|5</nowiki>
 
|SI
 
|SI
 
|
 
|
 
: Código del municipio o ciudad donde se genera el documento
 
: Código del municipio o ciudad donde se genera el documento
−
: '''PATH''': ../Class.LugarGeneracionXML/municipioCiudad
+
: '''PATH''': ../root.LugarGeneracionXML/municipioCiudad
 
: [[Tablas de códigos de propiedades para emisión de documentos - Indice Manual Integración Nómina Electrónica#Tabla 6|Tabla 6]]
 
: [[Tablas de códigos de propiedades para emisión de documentos - Indice Manual Integración Nómina Electrónica#Tabla 6|Tabla 6]]
 
|-
 
|-
 
|pais
 
|pais
 
|String
 
|String
−
| -
+
|<nowiki>AN|2</nowiki>
 
|SI
 
|SI
 
|
 
|
−
: '''PATH''': ../Class.LugarGeneracionXML/municipioCiudad
+
: '''PATH''': ../root.LugarGeneracionXML/municipioCiudad
 
: [[Tablas de códigos de propiedades para emisión de documentos - Indice Manual Integración Nómina Electrónica#Tabla 7|Tabla 7]]  
 
: [[Tablas de códigos de propiedades para emisión de documentos - Indice Manual Integración Nómina Electrónica#Tabla 7|Tabla 7]]  
 
|}
 
|}
−
====Class.Pagos====
+
====Class.Pago====
 
{| 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 772: Línea 733:
 
|-
 
|-
 
|extras
 
|extras
−
|String
+
|Array<Extra>
 
| -
 
| -
 
|NO
 
|NO
Línea 780: Línea 741:
 
|-
 
|-
 
|fechasPagos
 
|fechasPagos
−
|Array<FechasPagos>
+
|Array<FechasPago>
 
| -
 
| -
 
|SI
 
|SI
Línea 788: Línea 749:
 
|-
 
|-
 
|extras
 
|extras
−
|String
+
|Array<Extra>
 
| -
 
| -
 
|NO
 
|NO
Línea 801: Línea 762:
 
|  
 
|  
 
: Fecha de Pago de la Nómina
 
: Fecha de Pago de la Nómina
−
: '''PATH''': .. /Class.Fechaspagos/@FechaPago
+
: '''PATH''': .. /root.Fechaspagos/@FechaPago
 
|-
 
|-
 
|metodoDePago
 
|metodoDePago
Línea 809: Línea 770:
 
|
 
|
 
: Metodos de Pago del Documento
 
: Metodos de Pago del Documento
−
: '''PATH''': ../Class.Pago/@Forma
+
: '''PATH''': ../root.Pago/@Forma
 
: [[Tablas de códigos de propiedades para emisión de documentos - Indice Manual Integración Nómina Electrónica#Tabla 8|Tabla 8]]  
 
: [[Tablas de códigos de propiedades para emisión de documentos - Indice Manual Integración Nómina Electrónica#Tabla 8|Tabla 8]]  
 
|-
 
|-
Línea 818: Línea 779:
 
|
 
|
 
: Métodos de Pago del Documento
 
: Métodos de Pago del Documento
−
: '''PATH''': .. /Class.Pago/@Metodo
+
: '''PATH''': .. /root.Pago/@Metodo
 
|-
 
|-
 
|nombreBanco
 
|nombreBanco
Línea 826: Línea 787:
 
|
 
|
 
: Nombre de Entidad Bancaria del Empleado donde se realiza la consignación
 
: Nombre de Entidad Bancaria del Empleado donde se realiza la consignación
−
: '''PATH''': .. /Class.Pago/@Banco
+
: '''PATH''': .. /root.Pago/@Banco
 
|-
 
|-
 
|tipoCuenta
 
|tipoCuenta
Línea 834: Línea 795:
 
|
 
|
 
: Tipo de Cuenta Bancaria del Empleado donde se realiza la consignación
 
: Tipo de Cuenta Bancaria del Empleado donde se realiza la consignación
−
: '''PATH''': .. /Class.Pago/@tipoCuenta
+
: '''PATH''': .. /root.Pago/@tipoCuenta
 
|-
 
|-
 
|numeroCuenta
 
|numeroCuenta
Línea 842: Línea 803:
 
|
 
|
 
: Numero de Cuenta Bancaria del Empleado donde se realiza la consignación
 
: Numero de Cuenta Bancaria del Empleado donde se realiza la consignación
−
: '''PATH''': .. /Class.Pago/@numeroCuenta
+
: '''PATH''': .. /root.Pago/@numeroCuenta
 
|}
 
|}
−
====Class.Periodos====
+
====Class.Periodo====
 
{| 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 853: Línea 814:
 
|-
 
|-
 
|extras
 
|extras
−
|String
+
|Array<Extra>
 
| -
 
| -
 
|NO
 
|NO
Línea 866: Línea 827:
 
|
 
|
 
:Se debe indicar la Fecha de Ingreso del trabajador a la empresa, en formato AAAA-MM-DD
 
:Se debe indicar la Fecha de Ingreso del trabajador a la empresa, en formato AAAA-MM-DD
−
: '''PATH''': /Class.Periodo/@fechaIngreso
+
: '''PATH''': /root.Periodo/@fechaIngreso
 
|-
 
|-
 
|fechaLiquidacionInicio
 
|fechaLiquidacionInicio
Línea 874: Línea 835:
 
|
 
|
 
:Se debe indicar la Fecha de Inicio del Periodo de Liquidación del documento, en formato AAAA-MM-DD
 
:Se debe indicar la Fecha de Inicio del Periodo de Liquidación del documento, en formato AAAA-MM-DD
−
: '''PATH''': /Class.Periodo/@fechaLiquidacionInicio
+
: '''PATH''': /root.Periodo/@fechaLiquidacionInicio
 
|-
 
|-
 
|fechaLiquidacionFin
 
|fechaLiquidacionFin
Línea 882: Línea 843:
 
|
 
|
 
:Se debe indicar la Fecha de Fin del Periodo de Liquidación del documento, en formato AAAA-MM-DD
 
:Se debe indicar la Fecha de Fin del Periodo de Liquidación del documento, en formato AAAA-MM-DD
−
: '''PATH''': /Class.Periodo/@fechaLiquidacionFin
+
: '''PATH''': /root.Periodo/@fechaLiquidacionFin
 
|-
 
|-
 
|fechaRetiro
 
|fechaRetiro
Línea 890: Línea 851:
 
|
 
|
 
:Se debe indicar la Fecha de Retiro del trabajador a la empresa, en formato AAAA-MM-DD
 
:Se debe indicar la Fecha de Retiro del trabajador a la empresa, en formato AAAA-MM-DD
−
: '''PATH''': /Class.Periodo/@fechaRetiro
+
: '''PATH''': /root.Periodo/@fechaRetiro
 
|-
 
|-
 
|tiempoLaborado
 
|tiempoLaborado
Línea 898: Línea 859:
 
|
 
|
 
:Cantidad de Tiempo que lleva laborando el Trabajador en la empresa
 
:Cantidad de Tiempo que lleva laborando el Trabajador en la empresa
−
: '''PATH''': /Class.Periodo/@tiempoLaborado
+
: '''PATH''': /root.Periodo/@tiempoLaborado
 
|}
 
|}
 +
====Class.Trabajador====
 +
{| class="mw-collapsible mw-collapsed wikitable"
 +
! style="background:#f2f2f2; text-align:center;"|Atributo
 +
! style="background:#f2f2f2; text-align:center;"|Tipo Dato
 +
! style="background:#f2f2f2; text-align:center;"|Formato
 +
! style="background:#f2f2f2; text-align:center;"|Requerido
 +
! style="background:#f2f2f2; text-align:center;"|Descripción
 +
|-
 +
|altoRiesgoPension
 +
|String
 +
|<nowiki>N|1</nowiki>
 +
|SI
 +
|
 +
:Si el trabajador desarrollo durante el presente periodo alguna de las actividades descritas en el Decreto 2090 de 2003, o la norma que lo modifique, adicione o sustituya.
 +
: '''PATH''': /root.Trabajador/@altoRiesgoPension
 +
|-
 +
|codigoTrabajador
 +
|String
 +
|<nowiki>N|2</nowiki>
 +
|SI
 +
|
 +
:Código del tipo de trabajador del Ministerio de salud. Aportes a Seguridad Social de Activos.
 +
: '''PATH''': /root.Trabajador/@tipoTrabajador
 +
|-
 +
|email
 +
|String
 +
| -
 +
|SI
 +
|
 +
:Email del trabajador para entregarle el Desprendible de Nómina.
 +
: '''PATH''': /No.Aplica
 +
|-
 +
|extras
 +
|Array<Extra>
 +
| -
 +
|NO
 +
|
 +
:Habilitado como campo opcional
 +
: '''PATH''': /No definido
 +
|-
 +
|lugarTrabajoDepartamentoEstado
 +
|String
 +
|<nowiki>N|2</nowiki>
 +
|SI
 +
|
 +
:Código del departamento actual donde se encontraba ubicado el trabajador o aprendiz en el mes reportado.
 +
: '''PATH''': /root.Trabajador/@lugarTrabajoDepartamentoEstado
 +
|-
 +
|lugarTrabajoDireccion
 +
|String
 +
|<nowiki>AN|...100</nowiki>
 +
|SI
 +
|
 +
:Debe corresponder a la dirección del lugar físico donde vive el empleado.
 +
: '''PATH''': /root.Trabajador/@lugarTrabajoDireccion
 +
|-
 +
|lugarTrabajoMunicipioCiudad
 +
|String
 +
|<nowiki>N|5</nowiki>
 +
|SI
 +
|
 +
:Código del municipio o ciudad actual donde se encontraba ubicado el trabajador o aprendiz en el mes reportado.
 +
: '''PATH''': /root.Trabajador/@lugarTrabajoMunicipioCiudad
 +
|-
 +
|codigoTrabajador
 +
|String
 +
|<nowiki>N|2</nowiki>
 +
|SI
 +
|
 +
:Código del tipo de trabajador del Ministerio de salud. Aportes a Seguridad Social de Activos.
 +
: '''PATH''': /root.Trabajador/@tipoTrabajador
 +
|-
 +
|lugarTrabajoPais
 +
|String
 +
|<nowiki>AN|2</nowiki>
 +
|SI
 +
|
 +
:Código del país actual donde se encontraba ubicado el trabajador o aprendiz en el mes reportado.
 +
: '''PATH''': /root.Trabajador/@lugarTrabajoPais
 +
|-
 +
|numeroDocumento
 +
|String
 +
|<nowiki>AN|...60</nowiki>
 +
|NO
 +
|
 +
:Otros Nombres del trabajador o aprendiz.
 +
: '''PATH''': /root.Trabajador/@otrosNombres
 +
|-
 +
|primerApellido
 +
|String
 +
|<nowiki>AN|...60</nowiki>
 +
|SI
 +
|
 +
:Primer Apellido del trabajador o aprendiz.
 +
: '''PATH''': /root4.Trabajador/@primerApellido
 +
|-
 +
|primerNombre
 +
|String
 +
|<nowiki>AN|...60</nowiki>
 +
|SI
 +
|
 +
:Primer Nombre del trabajador o aprendiz.
 +
: '''PATH''': /root.Trabajador/@primerNombre
 +
|-
 +
|salarioIntegral
 +
|String
 +
|<nowiki>N|1</nowiki>
 +
|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..
 +
: '''PATH''': /root.Trabajador/@salarioIntegral
 +
|-
 +
|numeroDocumento
 +
|String
 +
|<nowiki>AN|...12</nowiki>
 +
|SI
 +
|
 +
:Numero de identificación que actualmente el trabajador o aprendiz.
 +
: '''PATH''': /root.Trabajador/@numeroDocumento
 +
|numeroDocumento
 +
|String
 +
|<nowiki>AN|...12</nowiki>
 +
|SI
 +
|
 +
:Numero de identificación que actualmente el trabajador o aprendiz.
 +
: '''PATH''': /root.Trabajador/@numeroDocumento
 +
|numeroDocumento
 +
|String
 +
|<nowiki>AN|...12</nowiki>
 +
|SI
 +
|
 +
:Numero de identificación que actualmente el trabajador o aprendiz.
 +
: '''PATH''': /root.Trabajador/@numeroDocumento
 +
|numeroDocumento
 +
|String
 +
|<nowiki>AN|...12</nowiki>
 +
|SI
 +
|
 +
:Numero de identificación que actualmente el trabajador o aprendiz.
 +
: '''PATH''': /root.Trabajador/@numeroDocumento
 
; RESPONSE: Parámetros a Recibir
 
; RESPONSE: Parámetros a Recibir
 
{| class="mw-collapsible mw-collapsed wikitable"  
 
{| class="mw-collapsible mw-collapsed wikitable"  
Línea 971: Línea 1072:
 
|}
 
|}
 
Una vez realizado el envío exitoso de la factura 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.
 
Una vez realizado el envío exitoso de la factura 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}}
 
−
 
−
===Método EstadoDocumento===
 
−
Permite consultar el estado del documento indicado ante el Adquiriente, ante la DIAN, el tipo de entrega y si la misma fue exitosa, la lista de eventos (ApplicationResponse) asociados y otros parámetros de interés que puedes ser útil en los procesos de control del software de facturación (ERP) o para el modelo de negocio del cliente 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
 
−
|-
 
−
|Documento
 
−
|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"
 
−
|-
 
−
|Bool
 
−
|aceptacionFisica
 
−
|Indica si el documento posee aceptación física (entregado físicamente): “true” o “false”
 
−
|-
 
−
|String
 
−
|acuseComentario
 
−
|Comentario informado por el adquiriente al realizar el acuse
 
−
|-
 
−
|String
 
−
|acuseEstatus
 
−
|0: Acuse no realizado  ;  1: Acuse realizado
 
−
|-
 
−
|String
 
−
|acuseResponsable
 
−
|Email del responsable de realizar el acuse
 
−
|-
 
−
|String
 
−
|acuseRespuesta
 
−
|0: Respuesta no enviada  ;  1:  Respuesta enviada
 
−
|-
 
−
|String
 
−
|ambiente
 
−
|Tipo de ambiente de generación del documento:
 
−
:: “1: ambienteDeProducción”
 
−
:: “2: ambienteDePruebas”
 
−
|-
 
−
|String
 
−
|cadenaCodigoQR
 
−
|Concatenación cadena del código QR (elemento de control)
 
−
|-
 
−
|String
 
−
|cadenaCufe
 
−
|Concatenación cadena del código CUFE previo al cálculo por el algoritmo correspondiente del servicio
 
−
|-
 
−
|int
 
−
|Codigo
 
−
|Indica el estado de la operación retornado por el servicio
 
−
|-
 
−
|String
 
−
|consecutivo
 
−
|Consecutivo del Documento TFHKA/DIAN
 
−
|-
 
−
|String
 
−
|cufe
 
−
|“Código Único de Factura Electrónica” correspondiente al documento consultado, calculado por el algoritmo correspondiente del servicio
 
−
|-
 
−
|String
 
−
|descripcionDocumento
 
−
|Identificador del tipo de documento de referencia,
 
−
: Ejemplo: “Factura de Venta Nacional”
 
−
|-
 
−
|String
 
−
|descripcionEstatusDocumento
 
−
|Descripción correspondiente al estatusDocumento ante la DIAN: “Procesado Correctamente”
 
−
|-
 
−
|String
 
−
|entregaMetodoDIAN
 
−
|Indica el método de Entrega a la DIAN
 
−
: (Síncrono ó Asyncrono), (Individual ó Lote)
 
−
|-
 
−
|Bool
 
−
|esValidoDIAN
 
−
|
 
−
: “true” Si es válido
 
−
: “false” Si no es válido
 
−
|-
 
−
|String
 
−
|estatusDocumento
 
−
|Código obtenido en la respuesta correspondiente al estado del documento ante la DIAN (Por definir catálogo)
 
−
|-
 
−
|Array <Evento>
 
−
|eventos
 
−
|Lista de eventos del Documento Electrónico
 
−
|-
 
−
|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
 
−
|-
 
−
|Array <HistorialDeEntregas>
 
−
|historialDeEntregas
 
−
|Histórico de las entregas del documento
 
−
|-
 
−
|String
 
−
|mensaje
 
−
|Este mensaje está asociado al codigo, ú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
 
−
|-
 
−
|Bool
 
−
|poseeAdjuntos
 
−
|Indica si el documento posee adjuntos:
 
−
: “true” o “false”
 
−
|-
 
−
|Bool
 
−
|poseeRepresentacionGrafica
 
−
|Indica si el documento posee representación gráfica:
 
−
: “true” o “false”
 
−
|-
 
−
|Array <String>
 
−
|reglasValidacionDIAN
 
−
|Mensajes de validación por parte de la DIAN
 
−
|-
 
−
|String
 
−
|resultado
 
−
|Resultado del consumo del método:
 
−
: “Procesado” ó “Error”
 
−
|-
 
−
|String
 
−
|tipoCufe
 
−
|Algoritmo utilizado para calcular CUFE:
 
−
: SHA-256, SHA-384, SHA-512
 
−
|-
 
−
|String
 
−
|tipoDocumento
 
−
|Identificador del tipo de documento de referencia
 
−
: Ver  [[Tablas de códigos de propiedades para emisión de documentos - Indice Manual Integración Directa#Tabla 1|Tabla 1]]
 
−
|-
 
−
|String
 
−
|trackID
 
−
|Este elemento corresponde al TrackId del documento procesado
 
−
|}
 
−
Donde Class.Evento contiene la siguiente información:
 
−
{| 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
 
−
|ambienteDIAN
 
−
|Ambiente de generación en la DIAN:
 
−
: “1:ambienteDeProducción”
 
−
: “2:ambienteDePruebas”
 
−
|-
 
−
|String
 
−
|codigo
 
−
|Código el documento del Application Response (evento)
 
−
|-
 
−
|String
 
−
|comentario
 
−
|Comentario del evento
 
−
|-
 
−
|String
 
−
|cufe
 
−
|CUFE del documento electronico
 
−
|-
 
−
|String
 
−
|descripcionEvento
 
−
|Descripción de uso/origen del evento
 
−
|-
 
−
|String
 
−
|emisorNumeroDocumento
 
−
|Número de Identificación del Emisor
 
−
|-
 
−
|String
 
−
|emisorNumeroDocumentoDV
 
−
|Dígito Verificador del Número de Documento del Emisor
 
−
|-
 
−
|String
 
−
|emisorRazonSocial
 
−
|Razón Social del Emisor
 
−
|-
 
−
|String
 
−
|emisorTipoIdentificacion
 
−
|Tipo de Identificación del Emisor
 
−
|-
 
−
|Array <ExtrasEvento>
 
−
|extras
 
−
|Información extra correspondiente al evento
 
−
|-
 
−
|String
 
−
|fechaEmision
 
−
|Fecha de Emisión del Application Response (evento)
 
−
|-
 
−
|String
 
−
|fechaRecepcion
 
−
|Fecha de Recepción del Application Response (evento)
 
−
|-
 
−
|String
 
−
|hash
 
−
|Hash del documento Application Response
 
−
|-
 
−
|String
 
−
|idPerfilDIAN
 
−
|Perfil de la DIAN
 
−
|-
 
−
|String
 
−
|mensaje
 
−
|Mensaje de descripción del ApplicationResponse
 
−
|-
 
−
|String
 
−
|nombreArchivoXML
 
−
|Nombre del archivo XML
 
−
|-
 
−
|String
 
−
|nota
 
−
|Contenido del campo Note del Application Response
 
−
|-
 
−
|String
 
−
|numeroDelEvento
 
−
|Consecutivo del Application Response
 
−
|-
 
−
|String
 
−
|receptorNumeroDocumento
 
−
|Número de Identificación del Receptor
 
−
|-
 
−
|String
 
−
|receptorNumeroDocumentoDV
 
−
|Dígito Verificador del Número de Documento del Receptor
 
−
|-
 
−
|String
 
−
|receptorRazonSocial
 
−
|Razón Social del Receptor
 
−
|-
 
−
|String
 
−
|receptorTipoIdentificacion
 
−
|Tipo de Identificación del Receptor
 
−
|-
 
−
|String
 
−
|resultado
 
−
|Resultado del consumo del método:
 
−
: “Procesado” ó “Error”
 
−
|-
 
−
|String
 
−
|tipoCufe
 
−
|Algoritmo utilizado para calcular CUDE del evento:
 
−
: SHA-256, SHA-384, SHA-512
 
−
|-
 
−
|String
 
−
|tipoEvento
 
−
|Identificador del tipo de Evento:
 
−
: (Interno/ApplicationResponse)
 
−
|-
 
−
|String
 
−
|versionUBL
 
−
|Versión UBL del XML
 
−
|}
 
−
Y Class.ExtrasEvento contiene la siguiente información:
 
−
{| 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
 
−
|codigoInterno1
 
−
|Etiqueta
 
−
|-
 
−
|String
 
−
|codigoInterno2
 
−
|Descripción Adicional
 
−
|-
 
−
|String
 
−
|nombre
 
−
|Código del campo
 
−
|-
 
−
|String
 
−
|valor
 
−
|Información Adicional
 
−
|}
 
−
Class.HistorialDeEntregas corresponderá a:
 
−
{| 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
 
−
|LeidoEmailIPAddress
 
−
|Dirección IP del computador en el cual se realizó el acuse del correo de notificación
 
−
|-
 
−
|String
 
−
|LeidoEstatus
 
−
|Estatus del acuse del correo de notificación
 
−
|-
 
−
|String
 
−
|LeidoFecha
 
−
|Fecha del acuse del correo de notificación
 
−
|-
 
−
|String
 
−
|canalDeEntrega
 
−
|Canal de entrega del documento electrónico
 
−
|-
 
−
|Array <String>
 
−
|email
 
−
|Email del receptor del documento electrónico
 
−
|-
 
−
|String
 
−
|entregaEstatus
 
−
|Estatus de la entrega:
 
−
: ‘0’: Correo no enviado
 
−
: ‘200’: Correo enviado
 
−
|-
 
−
|String
 
−
|entregaEstatusDescripcion
 
−
|Descripción del Estatus de la entrega
 
−
|-
 
−
|String
 
−
|entregaFecha
 
−
|Fecha de la Entrega del documento
 
−
|-
 
−
|String
 
−
|fechaProgramada
 
−
|Fecha de la Entrega
 
−
|-
 
−
|String
 
−
|mensajePersonalizado
 
−
|Mensaje personalizado para entrerga por Email, Whatsaap o Telegram
 
−
|-
 
−
|String
 
−
|nitProveedorReceptor
 
−
|NIT del Proveedor Tecnológico receptor, en caso de entrega por Interoperabilidad
 
−
|-
 
−
|String
 
−
|recepcionEmailComentario
 
−
|Comentario de Acuse de Recibo del Cliente
 
−
|-
 
−
|String
 
−
|recepcionEmailEstatus
 
−
|Estatus de recepción del Correo Electrónico
 
−
: 1: Aceptado
 
−
: 2: Rechazado
 
−
: 3: En verificación
 
−
|-
 
−
|String
 
−
|recepcionEmailFecha
 
−
|Fecha de recepción del Correo Electrónico
 
−
|-
 
−
|String
 
−
|recepcionEmailIPAddress
 
−
|Dirección IP de recepción del Correo Electrónico
 
−
|-
 
−
|String
 
−
|telefono
 
−
|Para entrega por Whatsapp/Telegram
 
−
|}
 
−
'''@Importante:''' La estructura de éste Response, aún puede estar sujeta a cambios en una próxima actualización.
 
−
{{clear}}
 
−
===Método EnvioCorreo===
 
−
Permite reenviar a una o varias direcciones de correos el documento indicado.
 
−
; 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="5"|String
 
−
|tokenEmpresa
 
−
|rowspan="2"|Suministrado por The Factory HKA Colombia
 
−
|-
 
−
|tokenPassword
 
−
|-
 
−
|Documento
 
−
|Prefijo y consecutivo del Documento Electrónico concatenado sin separadores. Ejemplo “PRUE980338212”. Permite enviar múltiples destinatarios (máximo 5) separados por coma el carácter coma ‘,’
 
−
|-
 
−
|correo
 
−
|Correo electrónico al que se enviará el documento. Ejemplo nombre@empresa.com
 
−
|-
 
−
|adjuntos
 
−
|
 
−
: “0”: Realiza el reenvio del correo sin adjuntos
 
−
: “1”: Realiza el reenvio del correo con los adjuntos almacenados durante la emisión del documento.
 
−
|}
 
−
; 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
 
−
|codigo
 
−
|Indica el Estado de la operación retornado por el servicio
 
−
|-
 
−
|rowspan="2"|String
 
−
|mensaje
 
−
|Este mensaje está asociado al código, útil para identificación de errores
 
−
|-
 
−
|resultado
 
−
|Resultado del consumo del método:
 
−
: “Procesado” ó “Error”
 
−
|}
 
−
'''@Importante:''' Si durante la emisión del documento (método '''Enviar''') el parámetro '''adjuntos''' se asignó en “10” u “11”, la plataforma The Factory HKA - DFACTURE no generará representación gráfica (PDF) estándar, por lo tanto solo será reenviado a los destinatarios los documentos alojados en la plataforma (AttachedDocument). Para realizar un reenvío de correo (con el AttachedDocument y adjuntos) a una dirección de email diferente a la utilizada durante la emisión se puede consumir nuevamente el método '''CargarAdjuntos''' del Servicio Adjuntos Web SOAP.
 
−
{{clear}}
 
−
===Método DescargaPDF===
 
−
Permite descargar la representación gráfica estándar (PDF generado por TFHKA) del documento para efectos de almacenamiento local, consulta local o reimpresión.
 
−
; 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
 
−
|-
 
−
|documento
 
−
|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
 
−
|codigo
 
−
|Indica el Estado de la operación retornado por el servicio
 
−
|-
 
−
|String
 
−
|cufe
 
−
|“Código Único de Factura Electrónica” correspondiente al documento consultado.
 
−
|-
 
−
|String
 
−
|documento
 
−
|Documento PDF codificado en Base64
 
−
|-
 
−
|String
 
−
|hash
 
−
|Código de detección de errores
 
−
|-
 
−
|String
 
−
|mensaje
 
−
|Este mensaje está asociado al codigo, útil para  identificación de errores
 
−
|-
 
−
|String
 
−
|resultado
 
−
|Resultado del consumo del método:
 
−
: “Procesado” ó “Error”
 
−
|}
 
−
'''@Importante:''' Si durante la emisión del documento (método '''Enviar''') el parámetro '''adjuntos''' se asignó en “10” u “11”, la plataforma The Factory HKA - DFACTURE no generará representación gráfica (PDF) estándar, por lo tanto no se puede consumir éste método ya que el servicio arrojará un error indicando que NO existe PDF asociado, ya que se asume que la representación gráfica ha sido generada de manera local por el software de facturación (ERP).
 
−
{{clear}}
 
−
===Método DescargaXML===
 
−
Permite la descarga del documento XML (solo el documento electrónico Invoice, CreditNote y DebitNote), en caso que se requiera validar la información como la firma o la autenticidad de la misma o para efecto de manejo y almacenamiento local.
 
−
; 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
 
−
|-
 
−
|Documento
 
−
|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
 
−
|codigo
 
−
|Indica el Estado de la operación retornado por el servicio
 
−
|-
 
−
|String
 
−
|cufe
 
−
|“Código Único de Factura Electrónica” correspondiente al documento consultado
 
−
|-
 
−
|String
 
−
|documento
 
−
|Documento XML (Invoice, CreditNote ó DebitNote) codificado en Base64
 
−
|-
 
−
|String
 
−
|hash
 
−
|Código de detección de errores
 
−
|-
 
−
|String
 
−
|mensaje
 
−
|Este mensaje está asociado al codigo, útil para identificación de errores
 
−
|-
 
−
|String
 
−
|resultado
 
−
|Resultado del consumo del método:
 
−
: “Procesado” ó “Error”
 
−
|}
 
−
{{clear}}
 
−
===Método FoliosRestantes===
 
−
Permite consultar los timbres (transacciones) disponibles. Los timbres son consumidos en proporción a las transacciones realizadas.
 
−
; 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="2"|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
 
−
|codigo
 
−
|Indica el Estado de la operación retornado por el servicio
 
−
|-
 
−
|int
 
−
|foliosRestantes
 
−
|Cantidad de folios disponibles
 
−
|-
 
−
|String
 
−
|mensaje
 
−
|Este mensaje está asociado al codigo, útil para identificación de errores
 
−
|-
 
−
|String
 
−
|resultado
 
−
|Resultado del consumo del método:
 
−
: “Procesado” ó “Error”
 
−
|}
 
−
{{clear}}
 
−
===Método CargarCertificado===
 
−
Este método por ahora se mantendrá solo como uso interno de The Factory HKA Colombia.
 
−
{{clear}}
 
−
===Método DescargarEventoXML===
 
−
Permite descargar un evento u ocurrencia (ApplicationResponse) relacionado con un Documento Electrónico (Invoice, CreditNote ó DebitNote), generado por una persona o entidad relacionada con esto documento (DIAN, Emisor, Adquiriente).
 
−
; 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
 
−
|-
 
−
|documentoEvento
 
−
|Consecutivo del evento (ApplicationResponse)
 
−
|-
 
−
|Documento
 
−
|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
 
−
|Cufe
 
−
|CUFE del evento (ApplicationResponse)
 
−
|-
 
−
|String
 
−
|Documento
 
−
|Documento XML (ApplicationResponse) codificado en Base64
 
−
|-
 
−
|String
 
−
|fechaRespuesta
 
−
|Fecha y Hora consumo del método, formato: AAAA-MM-DD HH:MM:SS 
 
−
|-
 
−
|String
 
−
|Hash
 
−
|Código de detección de errores
 
−
|-
 
−
|String
 
−
|Mensaje
 
−
|Este mensaje está asociado al codigo, útil para identificación de errores.
 
−
|-
 
−
|String
 
−
|Resultado
 
−
|Resultado del consumo del método:
 
−
: “Procesado” ó “Error”
 
−
|-
 
−
|String
 
−
|tipoCufe
 
−
|Algoritmo utilizado para calcular CUFE:
 
−
: SHA-256, SHA-384, SHA-512
 
−
|}
 
−
{{clear}}
 
−
===Método GenerarContenedor===
 
−
Un contendor es un tipo de documento AttachedDocument, la estructura de éste tiene por objetivo contener y transmitir en un único archivo XML un documento electrónico (Invoice, CreditNote ó DebitNote) y todos los eventos (ApplicationResponse) generados hasta la fecha.
 
−
; 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
 
−
|-
 
−
|Documento
 
−
|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
 
−
|Contenedor
 
−
|Documento XML (AttachedDocument) codificado en Base64
 
−
|-
 
−
|String
 
−
|Fecha
 
−
|Fecha y Hora consumo del método, formato: AAAA-MM-DD HH:MM:SS
 
−
|-
 
−
|String
 
−
|Hash
 
−
|Código de detección de errores
 
−
|-
 
−
|String
 
−
|Mensaje
 
−
|Este mensaje está asociado al codigo, útil para identificación de errores.
 
−
|-
 
−
|String
 
−
|Resultado
 
−
|Resultado del consumo del método:
 
−
: “Procesado” ó “Error”
 
−
|}
 
−
{{clear}}
 
−
===Método GenerarEvento===
 
−
Permite generar un evento u ocurrencia (ApplicationResponse) asociado a un Documento Electrónico (Invoice, CreditNote ó DebitNote), generado por una persona o entidad relacionada con esto documento (DIAN, Emisor, Adquiriente).
 
−
; 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="2"|String
 
−
|tokenEmpresa
 
−
|rowspan="2"|Suministrado por The Factory HKA Colombia
 
−
|-
 
−
|tokenPassword
 
−
|-
 
−
|DatosEvento
 
−
|datosEvento
 
−
|Objeto con los datos del evento (ApplicationResponse) a generar
 
−
|}
 
−
Donde Class.DatosEvento contiene la siguiente información:
 
−
{| 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
 
−
|codigoEvento
 
−
|Indica el código del evento (Por definir catálogo)
 
−
|-
 
−
|String
 
−
|codigoInterno1
 
−
|Etiqueta
 
−
|-
 
−
|String
 
−
|codigoInterno2
 
−
|Descripción Adicional
 
−
|-
 
−
|String
 
−
|Comentario
 
−
|Comentario o descripción del evento
 
−
|-
 
−
|String
 
−
|Documento
 
−
|Prefijo y consecutivo del Documento Electrónico concatenado sin separadores. Ejemplo “PRUE980338212”
 
−
|-
 
−
|Array <ExtrasEvento>
 
−
|Extras
 
−
|Información adicional del evento
 
−
|}
 
−
Donde Class.ExtrasEvento contiene la siguiente información:
 
−
{| 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
 
−
|codigoInterno1
 
−
|Etiqueta
 
−
|-
 
−
|String
 
−
|codigoInterno2
 
−
|Descripción Adicional
 
−
|-
 
−
|String
 
−
|Nombre Código
 
−
|del campo
 
−
|-
 
−
|String
 
−
|valor
 
−
|Información adicional
 
−
|}
 
−
; 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
 
−
|consecutivoDocumentoEvento
 
−
|Consecutivo del evento (ApplicationResponse)
 
−
|-
 
−
|String
 
−
|Cufe
 
−
|CUFE del evento (ApplicationResponse)
 
−
|-
 
−
|String
 
−
|fechaRespuesta
 
−
|Fecha y Hora consumo del método, formato: AAAA-MM-DD HH:MM:SS
 
−
|-
 
−
|String
 
−
|Hash
 
−
|Código de detección de errores
 
−
|-
 
−
|String
 
−
|Mensaje
 
−
|Este mensaje está asociado al codigo, útil para identificación de errores.
 
−
|-
 
−
|String
 
−
|Resultado
 
−
|Resultado del consumo del método:
 
−
: “Procesado” ó “Error”
 
−
|-
 
−
|String
 
−
|tipoCufe
 
−
|Algoritmo utilizado para calcular CUFE:
 
−
: SHA-256, SHA-384, SHA-512
 
−
|-
 
−
|String
 
−
|Xml
 
−
|Documento XML (ApplicationResponse) codificado en Base64
 
−
|}
 
 
{{clear}}
 
{{clear}}

Revisión del 21:52 25 mar 2021

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
Correlativo/consecutivo del documento electrónico. Concatenación del prefijo + el consecutivoInformaciones relacionadas con anticipos
PATH: /root/NumeroSecuencialXML/(@Numero + Consecutivo)
deducciones Class - SI
Clase relacionada al las deducciones reportadas en el documento
PATH: /root/deducciones
(ver detalle en Class.Dedducciones)
devengados Class SI
Hace referencia al concepto de valor devengado de nómina señalado en el numeral 18, articulo 1 de la presente resolución.
PATH: root/devengados
(ver detalle en Class.Devengados)
documentosReferenciados Array<DocumentoReferenciado> - SI
Clase destinada a la referencia de la nomina individual o nomina de ajuste a reemplazar / eliminar
PATH: /root/(tipoNota)
(ver detalle en Class.documentosReferenciado)
extras Array<Extras> - NO
Campo Opcional
PATH:/NoAplica
fechaEmision String AN|19 SI
Debe ir la fecha de emision del documento. Considerando zona horaria de Colombia (-5), en formato AAAA-MM-DD-
PATH: /root/InformacionGeneral/@(FechaGen + HoraGen)
notas Array<Nota> - NO
Información adicional Texto libre, relativo al documento.
PATH: /root/Nota.
( Ver detalle en Class.Notas)
novedad String N|1 SI
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 "true" o "false"
PATH: /root/Novedad
novedadCUNE String N|96 C/C
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 realizar la Novedad
PATH: /root/Novedad/@CUNENov
lugarGeneracionXML Class - SI
Utilizado para Atributos del Lugar de Generacion del Documento XML
PATH: /root/LugarGeneracionXML
( Ver detalle en Class.LugarGeneracionXM)
pagos Array<Pago> - SI
Pagos por el reconocimiento del logro o cumplimiento por parte del trabajador en el desarrollo de sus labores, de condiciones definidas expresamente entre las partes.
PATH: /root/Pago
(ver detalle en Class.Pago)
periodoNomina String N|1 SI
Corresponde al Codigo de Periodo de Nómina
PATH: /root/InformacionGeneral/@periodoNomina
periodos Array<Periodo> AN|19 SI
Corresponde al periodo de generación del documento (periodo laborable del trabajador)
PATH: /root/periodo
(ver detalle en Class.Periodo)
rangoNumeracion String AN..20 SI
Consecutivo desde el que comienza la serie para el documento a emitir, siempre debe colocarse el prefijo (con guión)
PATH: /root/NumeroSecuencialXML/@Prefijo
Concatenación del prefijo (AN|..4) + el consecutivo DIAN,
según la configuración en portal web:
Manual con prefijo: prefijo requerido (Sin guion). Ejemplo: “PREF2147483647”
Manual sin prefijo: prefijo no requerido. Ejemplo: “2147483647”
Rechazo No se permiten caracteres adicionales como espacios o guiones
Rechazo Número de consecutivo debe ser igual o superior al valor inicial del rango de numeración otorgado por la DIAN
Rechazo Número de consecutivo debe ser igual o inferior al valor final del rango de numeración otorgado por la DIAN
redondeo String N|.. NO
Se utiliza para cuando se realice el Redondeo en el Documento
PATH: /root/redondeo
tipoDocumento String N|3 SI
Tipo de documento de identificación que actualmente tiene el trabajador o aprendiz
PATH: /root/InformacionGeneral/@TipoXML
Tabla 1
tipoMoneda String AN|3 SI
Tipo de Moneda utilizada en el documento
PATH: /root/InformacionGeneral/@tipoMoneda
Tabla 2
tipoNota String N|1 SI
Corresponde al tipo de Nota de Ajuste de Documento Soporte de Pago de Nómina Electrónica que se desee implementar
PATH: /root/tipoNota
Tabla 3
totalComprobante String N|.. SI
Debe ir el total de: Devengados - Deducciones
PATH: /root/comprobanteTotal
totalDeducciones String N|.. SI
Valor total de la Suma de todas las Deducciones del Documento
PATH: /root/deduccionesTotal
totalDevengados String N|.. SI
Valor total de la Suma de todos los Devengados del Documento
PATH: /root/devengadosTotal
trm String N|.. NO
Tasa Representativa del mercado. Corresponde a la tasa de cambio de la moneda utilizada en el documento en el Campo “TipoMoneda” a Pesos Colombianos.
PATH:/root/InformacionGeneral/@trm
trabajador Class - SI
Utilizado para Atributos del Trabajador o Receptor del Documento
PATH: /root/Trabajador

Class.Deducciones

Atributo Tipo Dato Formato Requerido Descripción
afc String N|.. NO
Corresponde a (Ahorro Fomento a la construccion)
PATH: /root.Deducciones/afc
anticipos Array<Anticipo> NO
Utilizado para Todos los Elementos de Anticipos de Deducciones del Documento
PATH: …/root.Deducciones/anticipos
(ver detalle en Class.Anticipos)
cooperativa String N|.. NO
Las cuotas o aportes que los empleados hagan a las cooperativas legalmente constituidas
PATH: …/root.Deducciones/cooperativa
deuda String N|.. NO
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
educación String N|.. NO
Valor Pagado correspondiente a Conceptos Educativos por parte del trabajador
PATH: …/root.Deducciones/educacion
embargoFiscal String N|.. NO
Valor Pagado correspondiente a Embargos Fiscales por parte del trabajador
PATH: …/root.Deducciones/embargoFiscal
fondosPensiones Array<FondoPension> - SI
Utilizado para Atributos de Fondos de Pension del Documento
PATH: …/root.Deducciones/FondoPension
(ver detalle en Class.FondosPension)
fondosSP Array<FondosSP> - NO
Utilizado para Atributos de Fondo de Seguridad Pensional del Documento
PATH: …/root.Deducciones/FondoSP
(ver detalle en Class.FondoSP)
libranzas Array<Libranza> N|.. NO
Utilizado para Todos los Elementos de Libranzas de Deducciones del Documento
PATH: …/root.Deducciones/libranzas
(ver detalle en Class.Libranza)
otrasDeducciones Array<OtrasDeducciones> - NO
Utilizado para Todos los Elementos de Otras Deducciones del Documento
PATH: …/root.Deducciones/otrasDeducciones
(ver detalle en Class.OtraDeduccion)
pagosTerceros Array<PagoTerceros> - NO
Utilizado para Todos los Elementos de Pagos a Tercero de Devengos del Documento
PATH: …/root.Deducciones/pagosTerceros
(ver detalle en Class.PagoTercero)
pensionVoluntaria String N|.. NO
Valor correspondiente al ahorro que hace el trabajador para complementar su pension obligatoria o cumplir metas especificas.
PATH: …/root.Deducciones/pensionVoluntaria
planComplementarios String N|.. NO
Valor de planes complementarios de salud al que el trabajador se encuentran afiliado, siempre que medie autorización del empleado.
PATH: …/root.Deducciones/planComplementarios
retencionFuente String N|.. NO
Si hubiere lugar, la empresa deberá calcular y retener al empleado el valor correspondiente a retención en la fuente por ingresos laborales. Este valor será declarado y consignado en la respectiva declaración mensual de retención en la fuente.
PATH: …/root.Deducciones/retencionFuente
salud Array<Salud> - SI
Utilizado para Atributos de Salud del Documento.
PATH: …/root.Deducciones/Salud
(ver detalle en Class.Salud)
sanciones Array<Sancion> - NO
Utilizado para Todos los Elementos de Sanciones de Deducciones del Documento
PATH: …/root.Deducciones/sanciones
(ver detalle en Class.Sancion)
sindicatos Array<Sindicato> - NO
Utilizado para Todos los Elementos de Sindicatos de Deducciones del Documento.
PATH: …/root.Deducciones/sindicatos
(ver detalle en Class.Sindicato)

Class.Devengados

Atributo Tipo Dato Formato Requerido Descripción
anticipos Array<Anticipo> - NO
Clase relacionada a los devengos correspondientes a anticipos.
PATH: ../root.Devengados/anticipos
(ver detalle en Class.Anticipo)
auxilios Array<Auxilios> - NO
Utilizado para Todos los Elementos de Auxilios de Devengos del Documento
PATH: ../root.Devengados/auxilios
(ver detalle en Class.Auxilio)
apoyoSost String N|.. NO
Corresponde al valor no salarial que el patrocinador paga de forma mensual como ayuda o apoyo economía al aprendiz o practicante universitario durante su etapa lectiva y fase practica.
PATH: /root.Devengados/apoyoSost
basico Array<Basico> - SI
Utilizado para Atributos Básicos de Devengos del Documento
PATH: ../root.Basico
(ver detalle en Class.Basico)
bonificaciones Array<Bonificaciones> - NO
Utilizado para Todos los Elementos de Bonificaciones de Devengos del Documento
PATH: ../root.Devengados/bonificaciones
(ver detalle en Class.Bonificacion)
bonifRetiro String N|.. NO
Valor establecido por mutuo acuerdo por retiro del Trabajador.
PATH: ../root.Devengados/bonifRetiro
bonoEPCTVs Array<BonoEPCTVs> - NO
Utilizado para Todos los Elementos de Bonos Electrónicos o de Papel de Servicio, Cheques, Tarjetas, Vales, etc de Devengos del Documento
PATH: ../root.Devengados/bonoEPCTVs
(ver detalle en Class.BonoEPCTV)
cesantias Array<Cesantia> - NO
Utilizado para Atributos de Cesantias de Devengos del Documento
PATH: ../root.Devengados/cesantias
(ver detalle en Class.Cesantia)
comisiones Array<Comision> - NO
Utilizado para Todos los Elementos de Comisiones de Devengos del Documento
PATH: ../root.Devengados/comisiones
(ver detalle en Class.Comision)
compensaciones Array<Compensacion> - NO
Utilizado para Todos los Elementos de Compensaciones de Devengos del Documento
PATH: ../root.Devengados/compensaciones
(ver detalle en Class.compensacion)
dotacion String N|.. NO
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/dotacion
extras Array<Extra> - NO
Habilitado como campo opcional
PATH: /No Aplica
horasExtras Array<HoraExtra> - NO
Utilizado para Todos los Elementos de Horas Extras Diarias de Devengos del Documento
PATH: /root.Devengado/horasExtras
(ver detalle en Class.HoraExtra)
huelgasLegales Array<HuelgaLegal> - NO
Utilizado para Todos los Elementos de Huelgas Legales de Devengos del Documento
PATH: /root.Devengados/huelgasLegales
(ver detalle en Class.HuelgasLegal)
indemnizacion String N|.. NO
Valor de Indemnizacion establecido por ley
PATH: /root.Devengados/indemnizacion
incapacidades Array<Incapacidad> - NO
Utilizado para Todos los Elementos de Incapacidades de Devengos del Documento
PATH: /root.Devengados/incapacidades
(ver detalle en Class.incapacidad)
licencias Class - NO
Utilizado para Todos los Elementos de Licencias de Devengos del Documento
PATH: /root.Devengados/licencias
(ver detalle en Class.Licencia)
otrosConceptos Array<OtroConcepto> - NO
Utilizado para Todos los Elementos de Otros Conceptos de Devengos del Documento
PATH: /root.Devengados/otrosConceptos
(ver detalle en Class.OtroConcepto)
pagosTerceros Array<PagoTercero> - NO
Utilizado para Todos los Elementos de Pagos a Tercero de Devengos del Documento
PATH: /root.Devengados/pagosTerceros
(ver detalle en Class.PagoTercero)
primas Array<Prima> - NO
Utilizado para Atributos de Primas de Devengos del Documento
PATH: /root.Devengados/primas
(ver detalle en Class.Prima)
reintegro String N|.. NO
Valor que le regresa la empresa al trabajador por una deducción mal realizada en otro pago de nomina
PATH: /root.Devengados/reintegro
teletrabajo String N|.. NO
Valor que debe ser pagado al trabajador cuyo contrato indica expresamente que puede laborar mediante teletrabajo
PATH: /No Aplica
transporte Array<Transporte> - NO
Utilizado para Atributos de Transporte de Devengos del Documento
PATH: /root.Transporte
(ver detalle en Class.Transporte)
vacaciones Class - NO
Utilizado para Todos los Elementos de Vacaciones de Devengos del Documento
PATH: /root.Devengados/vacaciones
(ver detalle en Class.Vacacion)

Class.documentosReferenciados

Atributo Tipo Dato Formato Requerido Descripción
cunePred String AN..20 SI
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.documentosReferenciadoS/@CUNEPred
extras Array<Extra> - NO
Habilitado como campo opcional
PATH: /No definido
fechaGenPred String AN|10 SI
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.documentosReferenciados/fechaGenPred
numeroPred String AN..20 SI
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.documentosReferenciados/numeroPred

Class.Notas

Atributo Tipo Dato Formato Requerido Descripción
descripcion String - NO
Campo de libre uso para Observaciones en el documento
PATH: .. /root.notas/descripcion
extras Array<Extra> - NO
Habilitado como campo opcional
PATH: /No definido

Class.LugarGeneracionXML

Atributo Tipo Dato Formato Requerido Descripción
departamentoEstado String N|2 SI
Código del departamento donde se genera el documento
PATH: ../root.LugarGeneracionXML/departamentoEstado
Tabla 4
extras Array<Extra> - NO
Habilitado como campo opcional
PATH: /No definido
idioma String N|2 SI
Codigo del país donde se genera el documento
PATH: ../root.LugarGeneracionXML/idioma
Tabla 5
municipioCiudad String N|5 SI
Código del municipio o ciudad donde se genera el documento
PATH: ../root.LugarGeneracionXML/municipioCiudad
Tabla 6
pais String AN|2 SI
PATH: ../root.LugarGeneracionXML/municipioCiudad
Tabla 7

Class.Pago

Atributo Tipo Dato Formato Requerido Descripción
extras Array<Extra> - NO
Habilitado como campo opcional
PATH: /No definido
fechasPagos Array<FechasPago> - SI
Utilizado para Todos los Elementos de Fechas de Pagos del Documento
PATH: .. /root/FechasPagos
extras Array<Extra> - NO
Habilitado como campo opcional
PATH: /No definido
fechapagonomina String AN|10 SI
Fecha de Pago de la Nómina
PATH: .. /root.Fechaspagos/@FechaPago
metodoDePago String N|1 SI
Metodos de Pago del Documento
PATH: ../root.Pago/@Forma
Tabla 8
medioPago String AN|3 SI
Métodos de Pago del Documento
PATH: .. /root.Pago/@Metodo
nombreBanco String AN|..50 NC
Nombre de Entidad Bancaria del Empleado donde se realiza la consignación
PATH: .. /root.Pago/@Banco
tipoCuenta String AN|..50 NC
Tipo de Cuenta Bancaria del Empleado donde se realiza la consignación
PATH: .. /root.Pago/@tipoCuenta
numeroCuenta String AN|..50 NC
Numero de Cuenta Bancaria del Empleado donde se realiza la consignación
PATH: .. /root.Pago/@numeroCuenta

Class.Periodo

Atributo Tipo Dato Formato Requerido Descripción
extras Array<Extra> - NO
Habilitado como campo opcional
PATH: /No definido
fechaIngreso String AN|10 SI
Se debe indicar la Fecha de Ingreso del trabajador a la empresa, en formato AAAA-MM-DD
PATH: /root.Periodo/@fechaIngreso
fechaLiquidacionInicio String AN|10 SI
Se debe indicar la Fecha de Inicio del Periodo de Liquidación del documento, en formato AAAA-MM-DD
PATH: /root.Periodo/@fechaLiquidacionInicio
fechaLiquidacionFin String AN|10 SI
Se debe indicar la Fecha de Fin del Periodo de Liquidación del documento, en formato AAAA-MM-DD
PATH: /root.Periodo/@fechaLiquidacionFin
fechaRetiro String AN|10 NO
Se debe indicar la Fecha de Retiro del trabajador a la empresa, en formato AAAA-MM-DD
PATH: /root.Periodo/@fechaRetiro
tiempoLaborado String 5 caracteres enteros n decimales (dias) NO
Cantidad de Tiempo que lleva laborando el Trabajador en la empresa
PATH: /root.Periodo/@tiempoLaborado

Class.Trabajador

Atributo Tipo Dato Formato Requerido Descripción
altoRiesgoPension String N|1 SI
Si el trabajador desarrollo durante el presente periodo alguna de las actividades descritas en el Decreto 2090 de 2003, o la norma que lo modifique, adicione o sustituya.
PATH: /root.Trabajador/@altoRiesgoPension
codigoTrabajador String N|2 SI
Código del tipo de trabajador del Ministerio de salud. Aportes a Seguridad Social de Activos.
PATH: /root.Trabajador/@tipoTrabajador
email String - SI
Email del trabajador para entregarle el Desprendible de Nómina.
PATH: /No.Aplica
extras Array<Extra> - NO
Habilitado como campo opcional
PATH: /No definido
lugarTrabajoDepartamentoEstado String N|2 SI
Código del departamento actual donde se encontraba ubicado el trabajador o aprendiz en el mes reportado.
PATH: /root.Trabajador/@lugarTrabajoDepartamentoEstado
lugarTrabajoDireccion String AN|...100 SI
Debe corresponder a la dirección del lugar físico donde vive el empleado.
PATH: /root.Trabajador/@lugarTrabajoDireccion
lugarTrabajoMunicipioCiudad String N|5 SI
Código del municipio o ciudad actual donde se encontraba ubicado el trabajador o aprendiz en el mes reportado.
PATH: /root.Trabajador/@lugarTrabajoMunicipioCiudad
codigoTrabajador String N|2 SI
Código del tipo de trabajador del Ministerio de salud. Aportes a Seguridad Social de Activos.
PATH: /root.Trabajador/@tipoTrabajador
lugarTrabajoPais String AN|2 SI
Código del país actual donde se encontraba ubicado el trabajador o aprendiz en el mes reportado.
PATH: /root.Trabajador/@lugarTrabajoPais
numeroDocumento String AN|...60 NO
Otros Nombres del trabajador o aprendiz.
PATH: /root.Trabajador/@otrosNombres
primerApellido String AN|...60 SI
Primer Apellido del trabajador o aprendiz.
PATH: /root4.Trabajador/@primerApellido
primerNombre String AN|...60 SI
Primer Nombre del trabajador o aprendiz.
PATH: /root.Trabajador/@primerNombre
salarioIntegral String N|1 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..
PATH: /root.Trabajador/@salarioIntegral
numeroDocumento String AN|...12 SI
Numero de identificación que actualmente el trabajador o aprendiz.
PATH: /root.Trabajador/@numeroDocumento
 numeroDocumento String AN|...12 SI
Numero de identificación que actualmente el trabajador o aprendiz.
PATH: /root.Trabajador/@numeroDocumento
 numeroDocumento String AN|...12 SI
Numero de identificación que actualmente el trabajador o aprendiz.
PATH: /root.Trabajador/@numeroDocumento
 numeroDocumento String AN|...12 SI
Numero de identificación que actualmente el trabajador o aprendiz.
PATH: /root.Trabajador/@numeroDocumento
RESPONSE
Parámetros a Recibir
Tipo Identificación Descripción
int codigo Indica el Estado de la operación retornado por el servicio, (Por definir catálogo)
String consecutivoDocumento Prefijo y Consecutivo del Documento concatenado sin separadores. Para el ejemplo anterior corresponde a: “PRUE980338337”
String cufe “Código Único de Factura Electrónica” correspondiente al documento consultado.
Bool esValidoDian “true” Si 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 fechaRespuesta Día y Hora en la que se generó el documento electrónico, en formato AAAA-MM-DD HH:MM:SS
String hash Código de detección de errores
String mensaje Este mensaje está asociado al código de respuesta, útil para identificación de errores
Array mensajesValidacion Mensajes de validación en caso de notificación o rechazo
String nombre Nombre definido por la DIAN
String qr Concatenación cadena del código QR (elemento de control)
Array reglasNotificacionDIAN Reglas de validación en caso de notificación
Array reglasValidacionDIAN Reglas de validación en caso de rechazo
String resultado Resultado del consumo del método: Procesado” ó “Error”
String tipoCufe Algoritmo del tipo de CUFE. “CUFE-SHA384” ó “CUDE-SHA384”
String xml Archivo XML (tipo AttachedDocument) codificado en Base64

Una vez realizado el envío exitoso de la factura 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.

Obtenido de «http://felcowiki.thefactoryhka.com.co/index.php?title=Métodos_Servicio_Emisión_Nómina_Electrónica_-_Indice_Manual_Integración_Nómina_Electrónica&oldid=1326»