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
Línea 814: Línea 814:
 
|medioPago
 
|medioPago
 
|String
 
|String
 +
|<nowiki>AN|3</nowiki>
 +
|SI
 +
|
 +
: Métodos de Pago del Documento
 +
: '''PATH''': .. /Class.Pago/@Metodo
 +
|-
 +
|nombreBanco
 +
|String
 +
|<nowiki>AN|..50</nowiki>
 +
|NC
 +
|
 +
: Nombre de Entidad Bancaria del Empleado donde se realiza la consignación
 +
: '''PATH''': .. /Class.Pago/@Banco
 +
|-
 +
|tipoCuenta
 +
|String
 +
|<nowiki>AN|..50</nowiki>
 +
|NC
 +
|
 +
: Tipo de Cuenta Bancaria del Empleado donde se realiza la consignación
 +
: '''PATH''': .. /Class.Pago/@tipoCuenta
 +
|-
 +
|numeroCuenta
 +
|String
 +
|<nowiki>AN|..50</nowiki>
 +
|NC
 +
|
 +
: Numero de Cuenta Bancaria del Empleado donde se realiza la consignación
 +
: '''PATH''': .. /Class.Pago/@numeroCuenta
 +
|}
 +
====Class.Periodos====
 +
{| 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
 +
|-
 +
|extras
 +
|String
 
| -
 
| -
 
|NO
 
|NO
 
|
 
|
: Código del fabricante correspondiente al artículo
+
:Habilitado como campo opcional
: '''PATH''': .. /cac:Item/cac:
+
: '''PATH''': /No definido
: ManufacturersItemIdentification/cbc:ID
+
|-
 +
|fechaIngreso
 +
|String
 +
|<nowiki>AN|10</nowiki>
 +
|SI
 +
|
 +
:Se debe indicar la Fecha de Ingreso del trabajador a la empresa, en formato AAAA-MM-DD
 +
: '''PATH''': /Class.Periodo/@fechaIngreso
 +
|-
 +
|fechaLiquidacionInicio
 +
|String
 +
|<nowiki>AN|10</nowiki>
 +
|SI
 +
|
 +
:Se debe indicar la Fecha de Inicio del Periodo de Liquidación del documento, en formato AAAA-MM-DD
 +
: '''PATH''': /Class.Periodo/@fechaLiquidacionInicio
 +
|-
 +
|fechaLiquidacionFin
 +
|String
 +
|<nowiki>AN|10</nowiki>
 +
|SI
 +
|
 +
:Se debe indicar la Fecha de Fin del Periodo de Liquidación del documento, en formato AAAA-MM-DD
 +
: '''PATH''': /Class.Periodo/@fechaLiquidacionFin
 +
|-
 +
|fechaRetiro
 +
|String
 +
|<nowiki>AN|10</nowiki>
 +
|NO
 +
|
 +
:Se debe indicar la Fecha de Retiro del trabajador a la empresa, en formato AAAA-MM-DD
 +
: '''PATH''': /Class.Periodo/@fechaRetiro
 
|-
 
|-
|codigoIdentificadorPais
+
|tiempoLaborado
 
|String
 
|String
|<nowiki>A|2</nowiki>
+
|5 caracteres enteros n decimales (dias)
 
|NO
 
|NO
 
|
 
|
: Código Identificador del país de origen del artículo o servicio
+
:Cantidad de Tiempo que lleva laborando el Trabajador en la empresa
: <span style="color:#FFFF; background:#FF0000"><b>Rechazo</b></span> Si el contenido de este elemento no corresponde a un valor del estándar ISO 3166-1 alfa-2
+
: '''PATH''': /Class.Periodo/@tiempoLaborado
: '''PATH''': .. /cac:Item/cac:OriginCountry/cbc:IdentificationCode
 
 
|}
 
|}
 
; RESPONSE: Parámetros a Recibir
 
; RESPONSE: Parámetros a Recibir

Revisión del 14:54 25 mar 2021

Método Servicio Nómina Electrónica Web Soap

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:

Formato Descripción
A Carácter alfabético
N Carácter numérico
AN Carácter alfanumérico
A|3 3 caracteres alfabéticos (longitud fija)
N|3 3 caracteres numéricos (longitud fija)
AN|3 3 caracteres alfanuméricos (longitud fija)
A|..3 Hasta 3 caracteres alfabéticos (longitud variable)
N|..3 Hasta 3 caracteres numéricos (longitud variable)
AN|..3 Hasta 3 caracteres alfanuméricos (longitud variable)
N|2..6 Entre 2 y 6 caracteres numéricos (longitud variable)
INT32 Entero. (Valor Máximo: 2,147,483,647)


Obligatorio Descripción
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)

Método Enviar

La función encargada de construir y enviar los documentos electrónicos al proveedor tecnológico.

REQUEST
Parámetros a Enviar
Tipo Identificador Descripción
idSoftware iD Identificador Software: Identificador del software habilitado para la emisión de nóminas
String tokenEmpresa Suministrado por el proveedor tecnológico
tokenPassword
nitEmpleador Nit Debe corresponder al NIT del Empleador que realiza el DE
ObjetoNomina Objeto 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 - NO
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 - 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 String - NO
Campo Opcional
PATH:/NoAplica
fechaEmision String<CondicionPago> 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 - NO
Información adicional Texto libre, relativo al documento.
PATH: /root/Notas.
( 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 <Extras> - 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.pagos)
periodoNomina String N|1 SI
Corresponde al Codigo de Periodo de Nómina
PATH: /root/InformacionGeneral/@periodoNomina
periodos Array AN|19 SI
Corresponde al periodo de generación del documento (periodo laborable del trabajador)
PATH: /root/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: /Class.Deducciones/afc
anticipos Array<String> NO
Utilizado para Todos los Elementos de Anticipos de Deducciones del Documento
PATH: …/Class.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: …/Class.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: …/Class.Deducciones/deuda
educación String N|.. NO
Valor Pagado correspondiente a Conceptos Educativos por parte del trabajador
PATH: …/Class.Deducciones/educacion
embargoFiscal String N|.. NO
Valor Pagado correspondiente a Embargos Fiscales por parte del trabajador
PATH: …/Class.Deducciones/embargoFiscal
fondosPensiones Array<String> - SI
Utilizado para Atributos de Fondos de Pension del Documento
PATH: …/Class.Deducciones/FondoPension
(ver detalle en Class.FondosPensiones)
fondosSP Array<String> - NO
Utilizado para Atributos de Fondo de Seguridad Pensional del Documento
PATH: …/Class.Deducciones/FondoSP
(ver detalle en Class.FondosSP)
libranzas Array<String> N|.. NO
Utilizado para Todos los Elementos de Libranzas de Deducciones del Documento
PATH: …/Class.Deducciones/libranzas
(ver detalle en Class.Libranzas)
otrasDeducciones Array<String> - NO
Utilizado para Todos los Elementos de Otras Deducciones del Documento
PATH: …/Class.Deducciones/otrasDeducciones
(ver detalle en Class.OtrasDeducciones)
pagosTerceros Array<String> - NO
Utilizado para Todos los Elementos de Pagos a Tercero de Devengos del Documento
PATH: …/Class.Deducciones/pagosTerceros
(ver detalle en Class.PagosTerceros)
pensionVoluntaria String N|.. NO
Valor correspondiente al ahorro que hace el trabajador para complementar su pension obligatoria o cumplir metas especificas.
PATH: …/Class.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: …/Class.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: …/Class.Deducciones/retencionFuente
salud Array<String> - SI
Utilizado para Atributos de Salud del Documento.
PATH: …/Class.Deducciones/Salud
(ver detalle en Class.Salud)
sanciones Array<String> - NO
Utilizado para Todos los Elementos de Sanciones de Deducciones del Documento
PATH: …/Class.Deducciones/sanciones
(ver detalle en Class.Sanciones)
sindicatos Array<String> - NO
Utilizado para Todos los Elementos de Sindicatos de Deducciones del Documento.
PATH: …/Class.Deducciones/sindicatos
(ver detalle en Class.Sindicatos)

Class.Devengados

Atributo Tipo Dato Formato Requerido Descripción
anticipos Array<String> - NO
Clase relacionada a los devengos correspondientes a anticipos.
PATH: ../Class.Devengados/anticipos
auxilios Array<String> - NO
Utilizado para Todos los Elementos de Auxilios de Devengos del Documento
PATH: ../Class.Devengados/auxilios
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: /Class.Devengados/apoyoSost
basico Array<String> - SI
Utilizado para Atributos Basicos de Devengos del Documento
PATH: ../Class.Basico
(ver detalle en Class.Basico)
bonificaciones Array<String> - NO
Utilizado para Todos los Elementos de Bonificaciones de Devengos del Documento
PATH: ../Class.Devengados/bonificaciones
(ver detalle en Class.Bonificaciones)
bonifRetiro String N|.. NO
Valor establecido por mutuo acuerdo por retiro del Trabajador.
PATH: ../Class.Devengados/bonifRetiro
bonoEPCTVs Array<String> - NO
Utilizado para Todos los Elementos de Bonos Electronicos o de Papel de Servicio, Cheques, Tarjetas, Vales, etc de Devengos del Documento
PATH: ../Class.Devengados/bonoEPCTVs
(ver detalle en Class.bonoEPCTVs)
cesantias Array<String> - NO
Utilizado para Atributos de Cesantias de Devengos del Documento
PATH: ../Class.Devengados/cesantias
(ver detalle en Class.Cesantias)
comisiones Array<String> - NO
Utilizado para Todos los Elementos de Comisiones de Devengos del Documento
PATH: ../Class.Devengados/comisiones
compensaciones Array<String> - NO
Utilizado para Todos los Elementos de Compensaciones de Devengos del Documento
PATH: ../Class.Devengados/compensaciones
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: ../Class.Devengados/dotacion
extras String - NO
Habilitado como campo opcional
PATH: /No Aplica
horasExtras Array<String> - NO
Utilizado para Todos los Elementos de Horas Extras Diarias de Devengos del Documento
PATH: /Class.Devengado/horasExtras
huelgasLegales Array<String> - NO
Utilizado para Todos los Elementos de Huelgas Legales de Devengos del Documento
PATH: /Class.Devengados/huelgasLegales
(ver detalle en Class.HuelgasLegales)
indemnizacion String N|.. NO
Valor de Indemnizacion establecido por ley
PATH: /Class.Devengados/indemnizacion
incapacidades Array<String> - NO
Utilizado para Todos los Elementos de Incapacidades de Devengos del Documento
PATH: /Class.Devengados/incapacidades
(ver detalle en Class.incapacidades)
licencias Class - NO
Utilizado para Todos los Elementos de Licencias de Devengos del Documento
PATH: /Class.Devengados/licencias
(ver detalle en Class.Licencias)
otrosConceptos Array<String> - NO
Utilizado para Todos los Elementos de Otros Conceptos de Devengos del Documento
PATH: /Class.Devengados/otrosConceptos
(ver detalle en Class.otrosConceptos)
pagosTerceros Array<String> - NO
Utilizado para Todos los Elementos de Pagos a Tercero de Devengos del Documento
PATH: /Class.Devengados/pagosTerceros
(ver detalle en Class.otrosConceptos)
primas Array<String> - NO
Utilizado para Atributos de Primas de Devengos del Documento
PATH: /Class.Devengados/primas
(ver detalle en Class.Primas)
reintegro String N|.. NO
Valor que le regresa la empresa al trabajador por una deducción mal realizada en otro pago de nomina
PATH: /Class.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<String> - NO
Utilizado para Atributos de Transporte de Devengos del Documento
PATH: /Class.Transporte
(ver detalle en Class.Transporte)
vacaciones Class - NO
Utilizado para Todos los Elementos de Vacaciones de Devengos del Documento
PATH: /Class.Devengados/vacaciones
(ver detalle en Class.Vacaciones)

Class.documentosReferenciados

Atributo Tipo Dato Formato Requerido Descripción
cunePred String - 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 Reemplazar
PATH: /Class.documentosReferenciados/@CUNEPred
extras String - NO
Habilitado como campo opcional
PATH: /No definido
fechaGenPred String - 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
PATH: /Class.documentosReferenciados/fechaGenPred
numeroPred String - 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: …/Class.documentosReferenciados/numeroPred

Class.Notas

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

Class.LugarGeneracionXML

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

Class.Pagos

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

Class.Periodos

Atributo Tipo Dato Formato Requerido Descripción
extras String - 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: /Class.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: /Class.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: /Class.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: /Class.Periodo/@fechaRetiro
tiempoLaborado String 5 caracteres enteros n decimales (dias) NO
Cantidad de Tiempo que lleva laborando el Trabajador en la empresa
PATH: /Class.Periodo/@tiempoLaborado
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.

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
Tipo Identificador Descripción
String tokenEmpresa 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
Tipo Identificador Descripción
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 Tabla 1
String trackID Este elemento corresponde al TrackId del documento procesado

Donde Class.Evento contiene la siguiente información:

Tipo Identificador Descripción
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:

Tipo Identificador Descripción
String codigoInterno1 Etiqueta
String codigoInterno2 Descripción Adicional
String nombre Código del campo
String valor Información Adicional

Class.HistorialDeEntregas corresponderá a:

Tipo Identificador Descripción
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.

Método EnvioCorreo

Permite reenviar a una o varias direcciones de correos el documento indicado.

REQUEST
Parámetros a Enviar
Tipo Identificador Descripción
String tokenEmpresa 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
Tipo Identificador Descripción
int codigo Indica el Estado de la operación retornado por el servicio
String mensaje Este mensaje está asociado al código, útil para identificación de errores
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.

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
Tipo Identificador Descripción
String tokenEmpresa 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
Tipo Identificador Descripción
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).

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
Tipo Identificador Descripción
String tokenEmpresa 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
Tipo Identificador Descripción
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”

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
Tipo Identificador Descripción
String tokenEmpresa Suministrado por The Factory HKA Colombia
tokenPassword
RESPONSE
Parámetros a Recibir
Tipo Identificador Descripción
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”

Método CargarCertificado

Este método por ahora se mantendrá solo como uso interno de The Factory HKA Colombia.

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
Tipo Identificador Descripción
String tokenEmpresa 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
Tipo Identificador Descripción
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

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
Tipo Identificador Descripción
String tokenEmpresa 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
Tipo Identificador Descripción
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”

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
Tipo Identificador Descripción
String tokenEmpresa 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:

Tipo Identificador Descripción
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:

Tipo Identificador Descripción
String codigoInterno1 Etiqueta
String codigoInterno2 Descripción Adicional
String Nombre Código del campo
String valor Información adicional
RESPONSE
Parámetros a Recibir
Tipo Identificador Descripción
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