Métodos Servicio Emisión Web TFHKA - Indice Manual Integración Directa
Sumario
- 1 Método Enviar
- 1.1 Class.FacturaGeneral
- 1.2 Class.Anticipos
- 1.3 Class.Autorizado
- 1.4 Class.CargosDescuentos
- 1.5 Class.Cliente
- 1.6 Class.CondicionPago
- 1.7 Class.Coordenadas
- 1.8 Class.DatosTransportistas
- 1.9 Class.Destinatario
- 1.10 Class.DetalleDeFactura
- 1.11 Class.Direccion
- 1.12 Class.DocumentoReferencia
- 1.13 Class.DocumentoReferenciado
- 1.14 Class.EntregaMercancia
- 1.15 Class.Extras
- 1.16 Class.Extensible
- 1.17 Class.FacturaImpuestos
- 1.18 Class.ImpuestosTotales
- 1.19 Class.InformacionLegalCliente
- 1.20 Class.LineaInformacionAdicional
- 1.21 Class.MediosDePago
- 1.22 Class.Obligaciones
- 1.23 Class.OrdenDeCompra
- 1.24 Class.sectorSalud
- 1.25 Class.Beneficiario
- 1.26 Class.DatosPacientesSalud
- 1.27 Class.GeneralSalud
- 1.28 Class.TasaDeCambio
- 1.29 Class.TasaDeCambioAlternativa
- 1.30 Class.TerminosEntrega
- 1.31 Class.Tributos
- 2 Método EstadoDocumento
- 3 Método EstadoLegalDocumentos
- 4 Método EnvioCorreo
- 5 Método DescargaPDF
- 6 Método DescargaXML
- 7 Método FoliosRestantes
- 8 Método CargarCertificado
- 9 Método DescargarEventoXML
- 10 Método GenerarContenedor
- 11 Método GenerarEvento
- 12 Método EstadoCertificado
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 |
---|---|---|
String | tokenEmpresa | Suministrado por el proveedor tecnológico |
tokenPassword | ||
FacturaGeneral | factura | Ver el detalle del Objeto Factura más abajo |
String | adjuntos |
Posibles valores:
|
@IMPORTANTE: En caso de enviarse en el parámetro adjuntos el valor “1” u “11”, no se enviará correo electrónico hasta que se consuma el método CargarAdjuntos (Servicio Adjuntos Web SOAP). Para documentos que admiten adjuntos el campo Destinatario.email del cliente es requerido y el campo notificar debe estar en “SI”.
ADVERTENCIA: Si se utiliza las opciones ‘10’ u ‘11’ en el parámetro adjuntos, nuestra plataforma no generará representación gráfica (PDF) estándar, por lo tanto no se aloja PDF en la misma y no se podrá visualizar la representación gráfica desde el portal web, en el correo de notificación hacia el adquiriente (sección visualizar documento), tampoco realizar la descarga a través del método DescargaPDF del Servicio Emisión Web SOAP o reenviar la representación gráfica a través del método EnvioCorreo, ya que se está asumiendo que la misma ha sido generada de manera local por el software de facturación (ERP).
A continuación, se expone el diagrama del objeto factura para el modelo de facturación con validación previa, donde se pueden apreciar los cambios en la estructura del mismo con respecto al objeto utilizado en el modelo con validación posterior:
- En Azul clases/atributos nuevos que no estaban presentes en el modelo de validación posterior.
- En Amarillo clases/atributos existentes en el modelo de validación posterior que sufrieron cambios en validación previa.
- En Naranja clases/atributos existentes en el modelo de validación posterior que están en desuso (eliminados) en validación previa.
A continuación se describen con mayor detalle el objeto factura para el modelo de facturación con validación previa:
Diagrama Class.FacturaGeneral con Class.Cliente
Diagrama Class.FacturaGeneral con Class.CondicionPago
Diagrama Class.FacturaGeneral con Class.FacturaDetalle
Diagrama Class.FacturaGeneral con Class.DocumentoReferenciado
Diagrama Class.FacturaGeneral Class.EntregaMercancia
Diagrama Class.FacturaGeneral con Class.Extras. Class.FacturaImpuestos, Class.ImpuestosTotales, Class.MediosDePago, Class.OrdenDeCompra y Array - informacionAdicional
Diagrama Class.FacturaGeneral con Class.TasaDeCambio, Class.TasaDeCambioAlternativa y Class.TerminosEntrega
Class.FacturaGeneral
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
anticipos | Array <Anticipos> | - | NO |
|
autorizado | Autorizado | - | NO |
|
cantidadDecimales | String | N|1 | SI |
|
cargosDescuentos | Array <CargosDescuentos> | - | NO |
|
cliente | Cliente | - | SI |
|
condicionPago | Array <CondicionPago> | - | NO |
|
consecutivoDocumento | String | AN..14 | SI |
|
detalleDeFactura | Array <FacturaDetalle> | - | SI |
|
documentosReferenciados | Array <DocumentoReferenciado> | - | C/C |
|
entregaMercancia | Entrega | - | NO |
|
extras | Array <Extras> | - | NO |
|
fechaEmision | String | AN|19 | SI |
|
fechaFinPeriodoFacturacion | String | AN|19 | NO |
|
fechaInicioPeriodoFacturacion | String | AN|19 | NO |
|
fechaPagoImpuestos | String | AN|19 | NO |
|
fechaVencimiento | String | AN|10 | NO |
|
impuestosGenerales | Array <FacturaImpuestos> | - | SI |
|
impuestosTotales | Array <ImpuestosTotales> | - | SI |
|
informacionAdicional | Array <String> | AN|...10000 | NO |
|
mediosDePago | Array <MediosDePago> | - | SI |
|
moneda | String | AN|3 | SI |
|
ordenDeCompra | Array <OrdenDeCompra> | - | NO |
|
rangoNumeracion | String | AN|20 | SI |
|
redondeoAplicado | String | Ent: N|..15
Dec: N|0..6 |
SI |
|
sectorSalud | sectorSalud | - | C/C |
|
tasaDeCambio | TasaDeCambio | - | C/C |
|
tasaDeCambioAlternativa | TasaDeCambioAlternativa | - | NO |
|
terminosEntrega | TerminosEntrega | - | C/C |
|
tipoDocumento | String | AN|2 | SI |
|
tipoSector | String | N|| | SI |
|
tipoOperacion | String | AN|..4 | SI |
|
totalAnticipos | String | Ent: N|..15
Dec: N|0..6 |
NO |
|
totalBaseImponible | String | Ent: N|..15
Dec: N|0..6 |
SI |
|
totalBrutoConImpuesto | String | Ent: N|..15
Dec: N|0..6 |
SI |
|
totalCargosAplicados | String | Ent: N|..15
Dec: N|0..6 |
NO |
|
totalDescuentos | String | Ent: N|..15
Dec: N|0..6 |
NO |
|
totalMonto | String | Ent: N|..15
Dec: N|0..6 |
SI |
|
totalProductos | String | AN|..5 | SI |
|
totalSinImpuestos | String | Ent: N|..15
Dec: N|0..6 |
SI |
|
Class.Anticipos
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
extras | Array <Extensible> | - | NO |
|
fechaDeRecibido | String | AN|10 | SI |
|
fechadePago | String | AN|10 | NO |
|
horaDePago | String | AN|8 | NO |
|
id | String | A|..150 | SI |
|
instrucciones | String | AN|15..500 | SI |
|
montoPagado | String | Ent: N|..15
Dec: N|0..6 |
SI |
|
Class.Autorizado
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
direccion | Direccion | - | NO |
|
String | AN|..50 | NO |
| |
extras | Array <Extensible> | - | NO |
|
nombreComercial | String | AN|..50 | NO |
|
nombreContacto | String | AN|..50 | NO |
|
nota | String | AN|..50 | NO |
|
numeroDocumento | String | AN|..12 | SI |
|
numeroDocumentoDV | String | AN|..2 | C/C |
|
razonSocial | String | AN|..50 | NO |
|
telefax | String | AN|..50 | NO |
|
telefono | String | AN|..50 | NO |
|
tipoIdentificacion | String | AN|..2 | SI |
|
Class.CargosDescuentos
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
codigo | String | AN|2 | C/C |
|
descripcion | String | AN|10..5000 | SI |
|
extras | Array <Extensible> | - | NO |
|
indicador | String | N|1 | SI |
|
monto | String | Ent: N|..15
Dec: N|0..6 |
SI |
|
montoBase | String | Ent: N|..15
Dec: N|0..6 |
SI |
|
porcentaje | String | Ent: N|..6
Dec: N|2 |
SI |
|
secuencia | String | N|..3 | SI |
|
Class.Cliente
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
actividadEconomicaCIIU | String | AN|…4 | NO |
|
apellido | String | AN|…50 | NO |
|
destinatario | Array <Destinatario> | - | C/C |
|
detallesTributarios | Array <Tributos> | - | SI |
|
direccionCliente | Direccion | - | C/C |
|
direccionFiscal | Direccion | - | C/C |
|
String | AN|..50 | C/C |
| |
extras | Array <Extensible> | - | NO |
|
informacionLegalCliente | InformacionLegalCliente | - | C/C |
|
nombreComercial | String | AN|5..450 | C/C |
|
nombreContacto | String | AN|5..450 | NO |
|
nombreRazonSocial | String | AN|5..450 | SI |
|
nota | String | AN|..450 | NO |
|
notificar | String | AN|2 | SI |
|
numeroDocumento | String | AN|..12 | SI |
|
numeroIdentificacionDV | String | AN|..2 | C/C |
|
responsabilidadesRut | Array <Obligaciones> | - | SI |
|
segundoNombre | String | AN|..50 | NO |
|
telefax | String | N|..20 | NO |
|
telefono | String | AN|..20 | NO |
|
tipoIdentificacion | String | N|2 | SI |
|
tipoPersona | String | N|1 | SI |
|
Class.CondicionPago
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
codigoEvento | String | AN|..3 | NO |
|
comentario | String | AN|..50 | NO |
|
duracionPeriodo | String | AN|..2 | NO |
|
duracionPeriodoMedida | String | AN|..10 | NO |
|
extras | Array <Extensible> | - | NO |
|
fechaVencimiento | String | AN|..10 | SI |
|
identificador | String | AN|..2 | NO |
|
medioPagoAsociado | String | AN|..2 | NO |
|
monto | String | Ent: N|..15 | SI |
|
montoMulta | String | Ent: N|..15
Dec: N|0..6 |
SI |
|
montoPenalidad | String | Ent: N|..15
Dec: N|0..6 |
SI |
|
periodoDesde | String | AN|..10 | NO |
|
periodoHasta | String | AN|..10 | NO |
|
porcentajeDescuento | String | Ent: N|..6
Dec: N|2 |
NO |
|
porcentajePago | String | Ent: N|..6
Dec: N|2 |
SI |
|
referenciaAnticipo | String | AN|..20 | NO |
|
Class.Coordenadas
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
gradosLatitud | String | Por Definir | NO |
|
gradosLongitud | String | Por Definir | NO |
|
minutosLatitud | String | N|…5|2.2 | NO |
|
minutosLongitud | String | N|…5|2.2 | NO |
|
orientacionLatitud | String | AN|1 | NO |
|
orientacionLongitud | String | AN|1 | NO |
|
Class.DatosTransportistas
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
detallesTributarios | Tributos | - | NO |
|
direccionResponsableEntrega | Direccion | - | NO |
|
String | AN|..50 | NO |
| |
extras | Array <Extensible> | - | NO |
|
indicadordeAtencion | String | AN|..50 | NO |
|
indicadordeCuidado | String | AN|..50 | NO |
|
nombreContacto | String | AN|..50 | NO |
|
nombreResponsableEntrega | String | AN|..50 | NO |
|
nota | String | - | NO |
|
numeroIdentificacion | String | AN|…12 | NO |
|
numeroIdentificacionDV | String | N|..2 | NO |
|
numeroMatriculaMercantil | String | AN|..20 | NO |
|
prefijoFacturacion | String | AN|..20 | NO |
|
responsabilidadesRut | Array <Obligaciones> | - | NO |
|
telefax | String | AN|..20 | NO |
|
telefono | String | AN|..20 | NO |
|
tipoIdentificacion | String | N|2 | NO |
|
transportadorDireccion | Direccion | - | NO |
|
transportadorNombre | String | AN|..50 | NO |
|
transportadorNumeroDocumento | String | AN|..12 | NO |
|
transportadorNumeroDocumentoDV | String | AN|..2 | NO |
|
transportadorTipoIdentificacion | String | N|2 | NO |
|
Class.Destinatario
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
canalDeEntrega | String | - | SI |
|
Array <String> | - | C/C |
| |
extras | Array <Extensible> | - | NO |
|
fechaProgramada | String | AN|19 | NO |
|
mensajeProgramado | String | - | NO |
|
nitProveedorReceptor | String | N|..12 | C/C |
|
telefono | String | AN|..20 | C/C |
|
Class.DetalleDeFactura
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
cantidadPorEmpaque | String | N|..3 | NO |
|
cantidadReal | String | N|..6 | SI |
|
cantidadRealUnidadMedida | String | AN|..6 | SI |
|
cantidadUnidades | String | N|..6 | SI |
|
cargosDescuentos | Array <CargosDescuentos> | - | C/C |
|
codigoFabricante | String | - | NO |
|
codigoIdentificadorPais | String | A|2 | NO |
|
codigoProducto | String | AN|..50 | SI |
|
codigoTipoPrecio | String | AN|..3 | C/C |
|
descripcion | String | AN|..300 | C/C |
|
descripcion2 | String | AN|..300 | C/C |
|
descripcion3 | String | AN|..300 | C/C |
|
descripcionTecnica | String | AN|..300 | NO |
|
documentosReferenciados | Array <DocumentoReferenciado> | - | NO |
|
estandarCodigo | String | AN | C/C |
|
estandarCodigoID | String | AN | NO |
|
estandarCodigoIdentificador | String | AN | NO |
|
estandarCodigoNombre | String | AN | NO |
|
estandarCodigoProducto | String | AN | C/C |
|
estandarOrganizacion | String | - | NO |
|
estandarSubCodigoProducto | String | - | NO |
|
extras | Array <Extensible> | - | NO |
|
impuestosDetalles | Array <FacturaImpuestos > | - | SI |
|
impuestosTotales | Array <ImpuestosTotales> | - | SI |
|
informacionAdicional | Array <LineaInformacionAdicional> | - | NO |
|
mandatorioNumeroIdentificacion | String | N|..12 | C/C |
|
mandatorioNumeroIdentificacionDV | String | N|..2 | C/C |
|
mandatorioTipoIdentificacion | String | N|2 | C/C |
|
marca | String | AN|..100 | C/C |
|
modelo | String | AN|..100 | C/C |
|
muestraGratis | String | N|1 | C/C |
|
nombreFabricante | String | AN|..100 | NO |
|
nota | String | AN|20..5000 | C/C |
|
precioReferencia | String | Ent: N|..15
Dec: N|0..6 |
C/C |
|
precioTotal | String | Ent: N|..15
Dec: N|0..6 |
C/C |
|
precioTotalSinImpuestos | String | Ent: N|..15
Dec: N|0..6 |
SI |
|
precioVentaUnitario | String | Ent: N|..15
Dec: N|0..6 |
SI |
|
secuencia | String | AN|..4 | SI |
|
seriales | String | AN|..500 | NO |
|
subCodigoFabricante | String | AN|..50 | NO |
|
subCodigoProducto | String | AN|..50 | NO |
|
tipoAIU | String | AN|..50 | NO |
|
unidadMedida | String | AN|..3 | SI |
|
Class.Direccion
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
aCuidadoDe | String | AN|..50 | NO |
|
aLaAtenciónDe | String | AN|..50 | NO |
|
bloque | String | AN|..50 | NO |
|
buzon | String | AN|..50 | NO |
|
calle | String | AN|..50 | NO |
|
calleAdicional | String | AN|..50 | NO |
|
ciudad | String | AN|…50 | SI |
|
codigoDepartamento | String | AN|…5 | SI |
|
correccionHusoHorario | String | AN|6 | NO |
|
departamento | String | AN|…50 | SI |
|
departamentoOrg | String | AN|..50 | NO |
|
direccion | String | AN|…100 | SI |
|
distrito | String | AN|..50 | NO |
|
extras | Array <Extensible> | - | NO |
|
habitacion | String | AN|..50 | NO |
|
lenguaje | String | A|2 ISO 639-1 | SI |
|
localizacion | Array <Coordenadas> | AN|..50 | NO |
|
municipio | String | AN|..50 | SI |
|
nombreEdificio | String | AN|..50 | NO |
|
numeroEdificio | String | AN|..50 | NO |
|
numeroParcela | String | AN|..50 | NO |
|
pais | String | A|2 | SI |
|
piso | String | AN|..50 | NO |
|
region | String | AN|..50 | NO |
|
subDivision | String | AN|..40 | NO |
|
ubicación | String | AN|..50 | NO |
|
zonaPostal | String | AN|..10 | NO |
|
Class.DocumentoReferencia
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
codigoEstatusDocumento | String | - | C/C | |
codigoInterno | String | N|1 | SI |
|
cufeDocReferenciado | String | AN|..90 | C/C |
|
descripcion | Array <String> | AN|20..5000 | C/C |
|
extras | Array <Extensible> | - | NO |
|
fecha | String | AN|10 | C/C |
|
fechaFinValidez | String | AN|10 | NO |
|
fechaInicioValidez | String | AN|10 | NO |
|
numeroDocumento | String | AN..20 | SI |
|
tipoCUFE | String | AN|..11 | C/C |
|
tipoDocumento | String | AN|..50 | NO |
|
tipoDocumentoCodigo | String | AN|2 | C/C |
|
@IMPORTANTE:
- Para referenciar facturas de venta al emitir una NC o ND, se deben enviar dos objetos de tipo DocumentosReferenciados indicando lo siguiente:
- Objeto 1: indicando los campos codigoEstatusDocumento; codigoInterno = ‘4’, numeroDocumento, descripción.
- Objeto 2: si el tipoOperacion es igual a 20 (para NC) ó 30 (para ND) y codigoInterno = ‘5’, se validan los campos: cufeDocReferenciado, fecha, y numeroDocumento.
- Al transmitir una Factura de Contingencia, se debe enviar un arreglo de tipo DocumentosReferenciados indicando los campos: codigoInterno = ‘1’, numeroDocumento, fecha, tipoDocumentoCodigo (correspondiente a Factura de Contingencia).
- Para referenciar Documentos de Despacho (codigoInterno = ’2’) o Documentos de Recepción (codigoInterno = ‘3’) se validan los campos: numeroDocumento y fecha.
|}
Class.DocumentoReferenciado
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
codigoEstatusDocumento | String | - | C/C | |
codigoInterno | String | N|1 | SI |
|
cufeDocReferenciado | String | AN|..90 | C/C |
|
descripcion | Array <String> | AN|20..5000 | C/C |
|
extras | Array <Extensible> | - | NO |
|
fecha | String | AN|10 | C/C |
|
fechaFinValidez | String | AN|10 | NO |
|
fechaInicioValidez | String | AN|10 | NO |
|
numeroDocumento | String | AN..20 | SI |
|
tipoCUFE | String | AN|..11 | C/C |
|
tipoDocumento | String | AN|..50 | NO |
|
tipoDocumentoCodigo | String | AN|2 | C/C |
|
@IMPORTANTE: # Para referenciar facturas de venta al emitir una NC o ND, se deben enviar dos objetos de tipo DocumentosReferenciados indicando lo siguiente:
- Objeto 1: indicando los campos codigoEstatusDocumento; codigoInterno = ‘4’, numeroDocumento, ransferênc.
- Objeto 2: si el tipoOperacion es igual a 20 (para NC) ó 30 (para ND) y codigoInterno = ‘5’, se validan los campos: cufeDocReferenciado, fecha, y numeroDocumento.
- Al transmitir una Factura de Contingencia, se debe enviar un arreglo de tipo DocumentosReferenciados indicando los campos: codigoInterno = ‘1’, numeroDocumento, fecha, tipoDocumentoCodigo (correspondiente a Factura de Contingencia).
- Para referenciar Documentos de Despacho (codigoInterno = ’2’) o Documentos de Recepción (codigoInterno = ‘3’) se validan los campos: numeroDocumento y fecha.
Class.EntregaMercancia
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
datosTransportistas | DatoTransportistas | - | NO |
|
direccionDespacho | Direccion | - | NO |
|
direccionEntrega | Direccion | - | NO |
|
extras | Array <Extensible> | - | NO |
|
fechaEfectivaSalida | String | AN|19 | NO |
|
fechaEstimada | String | AN|19 | NO |
|
fechaReal | String | AN|19 | NO |
|
fechaSolicitada | String | AN|19 | NO |
|
identificacionTransporte | String | AN|..20 | NO |
|
matriculaTransporte | String | AN|..20 | NO |
|
Class.Extras
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
controlInterno1 | String | AN|100 | C/C |
|
controlInterno2 | String | Depende del Campo | C/C |
|
nombre | String | Depende del Campo | SI |
|
String | N|1 | SI |
| |
valor | String | Depende del Campo | SI |
|
xml | String | N|1 | SI |
|
Class.Extensible
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
controlInterno1 | String | AN|100 | C/C |
|
controlInterno2 | String | Depende del Campo | C/C |
|
nombre | String | Depende del Campo | SI |
|
valor | String | Depende del Campo | SI |
|
Class.FacturaImpuestos
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
baseImponibleTOTALImp | String | Ent: N|..15
Dec: N|0..6 |
SI |
|
codigoTOTALImp | String | AN|2 | SI |
|
controlInterno | String | N|1 | C/C |
|
extras | Array <Extensible> | - | NO |
|
porcentajeTOTALImp | String | Ent: N|..2
Dec: N|2* |
SI |
|
unidadMedida | String | AN|..5 | SI |
|
unidadMedidaTributo | String | Ent: N|..2
Dec: N|2 |
C/C |
|
valorTOTALImp | String | Ent: N|..15
Dec: N|0..6 |
SI |
|
valorTributoUnidad | String | Ent: N|..15
Dec: N|0..6 |
C/C |
|
@IMPORTANTE: Para el caso del ICA y RETEICA en el cual el valor del porcentaje se maneja en base a mil, se debe informar el valor de dicho porcentaje en base a cien, es decir, si se desea informar un porcentaje de 11.04%mil para alguno de estos tributos, se debe indicar en el campo porcentajeTOTALImp como 1.104.
Class.ImpuestosTotales
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
codigoTOTALImp | String | AN|2 | SI |
|
extras | Array <Extensible> | - | NO |
|
montoTotal | String | Ent: N|..15
Dec: N|0..6 |
SI |
|
Class.InformacionLegalCliente
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
codigoEstablecimiento | String | - | NO |
|
nombreRegistroRUT | String | AN|..450 | SI |
|
numeroIdentificacion | String | AN|..12 | SI |
|
numeroIdentificacionDV | String | N|..2 | C/C |
|
numeroMatriculaMercantil | String | N|9 | NO |
|
prefijoFacturacion | String | - | NO |
|
tipoIdentificacion | String | N|2 | SI |
|
Class.LineaInformacionAdicional
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
cantidad | String | AN|..5 | NO |
|
codigo | String | AN|..5 | NO |
|
codigoInterno1 | String | - | NO |
|
codigoInterno2 | String | - | NO |
|
descripcion | String | AN|..450 | NO |
|
fechaFin | String | AN|10 | NO |
|
fechaInicio | String | AN|10 | NO |
|
nombre | String | AN|..50 | NO |
|
secuencia | String | AN|..3 | NO |
|
tipo | String | N|1 | NO |
|
valor | String | AN|..50 | NO |
|
Class.MediosDePago
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
codigoBanco | String | AN|..20 | NO |
|
codigoCanalPago | String | AN|..20 | NO |
|
codigoReferencia | String | AN|..20 | NO |
|
extras | Array <Extensible> | - | NO |
|
fechaDeVencimiento | String | AN|19 | C/C |
|
medioPago | String | AN|..2 | SI |
|
metodoDePago | String | AN|..2 | SI |
|
nombreBanco | String | AN|..50 | NO |
|
numeroDeReferencia | String | AN|..200 | NO |
|
numeroDias | String | N|..3 | NO |
|
numeroTransferencia | String | AN|..20 | NO |
|
Class.Obligaciones
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
extras | Array <Extensible> | - | NO |
|
obligaciones | String | AN|7 | SI |
|
regimen | String | AN|2 | NO |
|
Class.OrdenDeCompra
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
codigoCliente | String | AN|..20 | NO |
|
documentoReferencia | DocumentoReferencia | - | NO |
|
extras | Array <Extensible> | - | NO |
|
fecha | String | AN|10 | NO |
|
numeroOrden | String | AN|..20 | SI |
|
numeroPedido | String | AN|..20 | C/C |
|
tipoCUFE | String | AN|..20 | NO |
|
tipoOrden | String | AN|..20 | NO |
|
uuid | String | AN|..90 | NO |
|
NOTA: Al tratarse de una orden de entrega se debe informar la clase OrdenDeCompra, si es necesario indicar más de una orden se debe informar a través de la clase DocumentoReferenciado con codigoInterno =’1’, esto con el fin de enviar la información referente a las mismas en el grupo AdditionalDocumentReference.
Class.sectorSalud
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
Beneficiario | Beneficiario | - | C/C |
|
extras | Array <Extras> | - | NO |
|
idPersonalizacion | String | - | SI |
|
Pacientes | Array <DatosPacienteSalud> | - | C/C | Para el reporte de los campos de datos adicionales del Sector Salud
|
TipoEscenario | String | N|1 | SI |
|
NOTA: La emisión de documentos del sector salud solo se encuentra disponible a través de la versión 4 del servicio de emisión.
Class.Beneficiario
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
DireccionResidencia | Direccion | - | C/C |
|
TipoIdentificacion | Array <GeneralSalud> | - | C/C |
|
Class.DatosPacientesSalud
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
CamposGenerales | Array <GeneralSalud> | - | C/C |
|
TipoIdentificacion | Array <GeneralSalud> | - | C/C |
|
Class.GeneralSalud
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
nombre | String | ..2 | Si |
|
valor | String | Depende del campo | Si |
|
Importante: En el caso del campo rangoNumeracion, éste valor siempre debe tener el siguiente formato (Pefijo-campoDesde), es decir, dicho campo es independiente de la modalidad de secuencial configurado en el portal (manual con prefijo o manual sin prefijo).
En el caso del campo consecutivoDocumento, este campo si depende de la modalidad de secuenciales configurados en el portal web.
- Si la modalidad asignada es “manual sin prefijo”, los valores para los campos rangoNumeracion y consecutivoDocumento’ deben ser por ejemplo:
- Factura #1: rangoNumeracion= "PRUE-1", consecutivoDocumento= "1"
- Factura #2: rangoNumeracion= "PRUE-1", consecutivoDocumento= "2"
- ...
- Factura #1000: rangoNumeracion= "PRUE-1", consecutivoDocumento= "1000"
- Si la modalidad asignada es “manual con prefijo”, los valores para los campos rangoNumeracion y consecutivoDocumento deben ser por ejemplo:
- Factura #1: rangoNumeracion= "PRUE-1", consecutivoDocumento= "PRUE1"
- Factura #2: rangoNumeracion= "PRUE-1", consecutivoDocumento= "PRUE2"
- ...
- Factura #1000: rangoNumeracion= "PRUE-1", consecutivoDocumento= "PRUE1000"
Class.TasaDeCambio
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
baseMonedaDestino | String | Ent: N|..15
Dec: N|0..6 |
SI |
|
baseMonedaOrigen | String | Ent: N|..15
Dec: N|0..6 |
SI |
|
extras | Array <Extensible> | - | NO |
|
fechaDeTasaDeCambio | String | AN|10 | SI |
|
indicadorDeTasa | String | - | NO |
|
monedaDestino | String | AN|3 | SI |
|
monedaOrigen | String | AN|3 | SI |
PATH: ../cbc:SourceCurrencyCode |
operadorCalculo | String | - | NO |
|
tasaDeCambio | String | Ent: N|..15
Dec: N|0..6 |
SI |
|
Class.TasaDeCambioAlternativa
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
baseMonedaDestino | String | Ent: N|..15
Dec: N|0..6 |
SI |
|
baseMonedaOrigen | String | Ent: N|..15
Dec: N|0..6 |
SI |
|
extras | Array <Extensible> | - | NO |
|
fechaDeTasaDeCambio | String | AN|10 | SI |
|
indicadorDeTasa | String | - | NO |
|
monedaDestino | String | AN|3 | SI |
|
monedaOrigen | String | AN|3 | SI |
|
operadorCalculo | String | - | NO |
|
tasaDeCambio | String | Ent: N|..15
Dec: N|0..6 |
SI |
|
Class.TerminosEntrega
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
cargosDescuentos | Array <CargosDescuentos> | - | NO |
|
codigoCondicionEntrega | String | AN|3 | C/C |
|
costoTransporte | String | Por Definir | NO |
|
direccionEntrega | Class.Direccion | - | NO |
|
extras | Array <Extensible> | - | NO |
|
identificacion | String | AN|..12 | NO |
|
monto | String | Ent: N|..15
Dec: N|0..6 |
NO |
|
responsableEntrega | String | AN|..50 | NO |
|
Class.Tributos
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
codigoImpuesto | String | AN|2 | SI |
|
extras | Array <Extensible> | - | NO |
|
- 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:
|
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,
|
String | descripcionEstatusDocumento | Descripción correspondiente al estatusDocumento ante la DIAN: “Procesado Correctamente” |
String | entregaMetodoDIAN | Indica el método de Entrega a la DIAN
|
Bool | esValidoDIAN |
|
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:
|
Bool | poseeRepresentacionGrafica | Indica si el documento posee representación gráfica:
|
Array <String> | reglasValidacionDIAN | Mensajes de validación por parte de la DIAN |
String | resultado | Resultado del consumo del método:
|
String | tipoCufe | Algoritmo utilizado para calcular CUFE:
|
String | tipoDocumento | Identificador del tipo de documento de referencia
|
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:
|
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:
|
String | tipoCufe | Algoritmo utilizado para calcular CUDE del evento:
|
String | tipoEvento | Identificador del tipo de Evento:
|
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 del receptor del documento electrónico | |
String | entregaEstatus | Estatus de la entrega:
|
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
|
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 EstadoLegalDocumentos
Permite verificar si el documento indicado tiene validez legal frente al comprador y la autoridad tributaria (DIAN), además concede validar el historial de eventos relacionados con el documento ante la DIAN. Los clientes de ERP que cuenten con el servicio de Recepción podrán consultar el Estado Legal de un documento en particular, a través del nuevo método denominado (EstadoLegalDocumentos). El cliente debe tener el servicio de recepción electrónica activo y contratado con The Factory HKA Colombia.
Nota: De momento este método de integración se encuentra en prueba, es importante aclarar que este método posteriormente tendrá un costo, el cual se informará desde el área comercial de The Factory HKA Colombia.
- REQUEST
- Parámetros a Enviar
Tipo | Identificador | Descripción |
---|---|---|
String | tokenEmpresa | Suministrado por The Factory HKA Colombia |
tokenPassword | ||
CUFE | “Código Único de Factura Electrónica” correspondiente al documento consultado, calculado por el algoritmo correspondiente del servicio | |
SupplierIdentification | Nit del emisor. | |
DocumentoId | Prefijo y Consecutivo del Documento electrónico concatenado sin separadores. Ejemplo “PRUE980338212" |
En la siguiente tabla se muestran los estados posibles del documento, se deben pasar los siguientes parámetros de entrada: token de empresa, token password, cufe, nit y número de documento y devuelve como respuesta la siguiente información:
Ejemplo de entrada
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tempuri.org/"> <soapenv:Header/> <soapenv:Body> <tem:EstadoLegalDocumentos> <!--Optional:--> <tem:tokenEmpresa>2afb</tem:tokenEmpresa> <!--Optional:--> <tem:tokenPassword>a809aee92bd</tem:tokenPassword> <!--Optional:--> <tem:cufe>794847abf0edfd959b38a2246</tem:cufe> <!--Optional:--> <tem:supplierIdentification>900390126</tem:supplierIdentification> <!--Optional:--> <tem:documentId>SETP990183</tem:documentId> </tem:EstadoLegalDocumentos> </soapenv:Body> </soapenv:Envelope>
Ejemplo de Salida
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <EstadoLegalDocumentosResponse xmlns="http://tempuri.org/"> <EstadoLegalDocumentosResult xmlns:a="http://schemas.datacontract.org/2004/07/ServiceSoap.Models.Response" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <a:EstadoDocumentoDIANResult> <a:codigoEstadoFacturaDIAN>200</a:codigoEstadoFacturaDIAN> <a:DocumentoValidoenDIAN>Valido</a:DocumentoValidoenDIAN> <a:numeroDocumento>SETP990054183</a:numeroDocumento> <a:cufeCudeDocumento>794847abf0edfc5f8c432a094648e944bdfce8789e00f31662c76c7037236c52b6c2b515849327a0f082d959b38a2246</a:cufeCudeDocumento> <a:numeroIdentificacionEmisor>900390126</a:numeroIdentificacionEmisor> <a:tipoIdentificacionEmisor>31</a:tipoIdentificacionEmisor> <a:numeroIdentificacionReceptor>900390126</a:numeroIdentificacionReceptor> <a:TipoIdentificacionReceptor>31</a:TipoIdentificacionReceptor> </a:EstadoDocumentoDIANResult> <a:EventosResult xmlns:b="http://schemas.datacontract.org/2004/07/WebApi.Domain.Models"> <b:EventsDocumentResponse> <b:codigoEvento>030</b:codigoEvento> <b:descripcionEvento>Acuse de recibo de Factura Electrónica de Venta</b:descripcionEvento> <b:fechaEvento>2024-01-22T17:10:39Z</b:fechaEvento> <b:numeroEvento>240122389968251</b:numeroEvento> <b:cudeEvento>5333a02e2a29cbed56c8989221b4e4712818c4f98dfd7347a61f2cd4619b21d6e7e2169f62f0b15e121a51d40127402e</b:cudeEvento> <b:emisorEvento>RUT ALEJANDRO</b:emisorEvento> <b:tipoIdentificacionEmisor>31</b:tipoIdentificacionEmisor> <b:numeroIdentificacionEmisor>900390126</b:numeroIdentificacionEmisor> <b:receptorEvento>DRodriguez</b:receptorEvento> <b:numeroIdentificacionReceptor>31</b:numeroIdentificacionReceptor> <b:tipoIdentificacionReceptor>900390126</b:tipoIdentificacionReceptor> </b:EventsDocumentResponse> <b:EventsDocumentResponse> <b:codigoEvento>032</b:codigoEvento> <b:descripcionEvento>Recibo del bien y/o prestación del servicio</b:descripcionEvento> <b:fechaEvento>2024-01-22T17:10:40Z</b:fechaEvento> <b:numeroEvento>240122429077715</b:numeroEvento> <b:cudeEvento>d6015b90e7cd86ffe2273ad14095935a61cadaef963ae9bbb3eac9615a4948b03127561c56e8939004bba1699b059c68</b:cudeEvento> <b:emisorEvento>RUT ALEJANDRO</b:emisorEvento> <b:tipoIdentificacionEmisor>31</b:tipoIdentificacionEmisor> <b:numeroIdentificacionEmisor>900390126</b:numeroIdentificacionEmisor> <b:receptorEvento>D Rodriguez</b:receptorEvento> <b:numeroIdentificacionReceptor>31</b:numeroIdentificacionReceptor> <b:tipoIdentificacionReceptor>900390126</b:tipoIdentificacionReceptor> </b:EventsDocumentResponse> <b:EventsDocumentResponse> <b:codigoEvento>033</b:codigoEvento> <b:descripcionEvento>Aceptación expresa</b:descripcionEvento> <b:fechaEvento>2024-01-22T17:10:41Z</b:fechaEvento> <b:numeroEvento>240122276806767</b:numeroEvento> <b:cudeEvento>2da1e89e3f4c7c039b25aaca0f241f1c115dd09556a4226b8e0bf0b7db303a4eac07481a83994ef6d8bad384499a284a</b:cudeEvento> <b:emisorEvento>RUT ALEJANDRO</b:emisorEvento> <b:tipoIdentificacionEmisor>31</b:tipoIdentificacionEmisor> <b:numeroIdentificacionEmisor>900390126</b:numeroIdentificacionEmisor> <b:receptorEvento>D Rodriguez</b:receptorEvento> <b:numeroIdentificacionReceptor>31</b:numeroIdentificacionReceptor> <b:tipoIdentificacionReceptor>900390126</b:tipoIdentificacionReceptor> </b:EventsDocumentResponse> </a:EventosResult> <a:CódigoRespuesta>0</a:CódigoRespuesta> <a:MensajeRespuesta i:nil="true"/> <a:ResumenEventosDocumento> <a:CódigoRespuesta>201</a:CódigoRespuesta> <a:MensajeRespuesta>Se retorna el ultimo estatus legal de la factura</a:MensajeRespuesta> <a:CantidadEventos>3</a:CantidadEventos> <a:EsAceptada>Si</a:EsAceptada> <a:AceptaciónTácita>No</a:AceptaciónTácita> <a:EsBienoServicio>Recibido</a:EsBienoServicio> <a:EsReclamada>No</a:EsReclamada> <a:EsRecibida>Si</a:EsRecibida> <a:TieneEventos>Si</a:TieneEventos> <a:EsTituloValor>No</a:EsTituloValor> <a:EstaEndosada>No</a:EstaEndosada> </a:ResumenEventosDocumento> </EstadoLegalDocumentosResult> </EstadoLegalDocumentosResponse> </s:Body> </s:Envelope>
- RESPONSE
- Parámetros a Recibir
Tipo | Identificador | Descripción |
---|---|---|
Array <EstadoDocumentoDIANResult> | EstadoDocumentoDIANResult | Indica el estatus actual en el que se encuentra actualmente el documento ante la DIAN con los detalles del documento. |
Array <EventosResult> | EventosResult | Detalle del documento ante la DIAN, resultado de los eventos obtenidos. |
String | CodigoRespuesta | |
String | MensajeRespuesta | Mensaje de respuesta del método. |
Array <ResumenEventosDocumento> | ResumenEventosDocumento | Resumen a nivel general de los diferentes estatus que tiene el documento. |
Donde Class.EstadoDocumentoDIANResult contiene la siguiente información:
Tipo | Identificador | Descripción |
---|---|---|
int | codigoEstadoFacturaDIAN | Indica el estado de la operación retornado por la DIAN. |
String | DocumentoValidoenDIAN | Indica validación del documento ante la DIAN. |
String | numeroDocumento | Consecutivo del Documento TFHKA/DIAN. |
String | cufeCudeDocumento | CUFE del documento electronico |
String | numeroIdentificacionEmisor | Número de Identificación del Emisor. |
int | tipoIdentificacionEmisor | Indicador del Emisor |
String | numeroIdentificacionReceptor | Número de Identificación del Receptor o adquieriente del documento. |
int | TipoIdentificacionReceptor | Indicador del Receptor |
Y Class.EventosResult contiene la siguiente información:
Tipo | Identificador | Descripción |
---|---|---|
String | codigoEvento | Etiqueta |
String | descripcionEvento | Descripción del evento actual |
String | fechaEvento | fecha de registro del evento |
String | cudeEvento | Código Único de Documento Electrónico del evento. |
String | emisorEvento | Evento ejecutado por la persona encargada. |
String | tipoIdentificacionEmisor | Tipo indentificación del emisor |
String | numeroIdentificacionEmisor | Indentificación del emisor |
String | receptorEvento | Usuario que recibe los eventos(emisor) |
String | numeroIdentificacionReceptor | Indentificación del receptor. |
String | tipoIdentificacionReceptor | Tipo indentificación del receptor. |
Class.ResumenEventosDocumento corresponderá a:
Tipo | Identificador | Descripción |
---|---|---|
String | CódigoRespuesta | Código correspondiente al catalogo de la tabla. |
String | MensajeRespuesta | Mensaje de satisfacción o error de resumen de eventos del documento. |
String | CantidadEventos | Número de eventos que se han dado al documento (1, 2 ó 3) |
String | EsAceptada | Si el documento tiene los 3 eventos y tiene una aceptación expresa como evento.(SI/NO) |
String | AceptaciónTácita | Si el documento tiene una aceptación tácita como evento realizada por el emisor.(SI/NO) |
String | EsBienoServicio | Si el documento tiene un segundo evento DIAN, recibo del bien o prestación del servicio como evento.(SI/NO) |
String | EsReclamada | Si el documento tiene un reclamo como evento por parte del receptor.(SI/NO) |
String | EsRecibida | Si el documento tiene un acuse de recibo como evento por parte del receptor.(SI/NO) |
String | TieneEventos | Si cumple con por lo menos un evento por parte del receptor.(SI/NO) |
String | EsTituloValor | El documento cuenta con titulo valor despues de dar los 3 eventos por parte del receptor |
String | EstaEndosada |
@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 |
|
- 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:
|
@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:
|
@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:
|
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:
|
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:
|
String | tipoCufe | Algoritmo utilizado para calcular CUFE:
|
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:
|
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:
|
String | tipoCufe | Algoritmo utilizado para calcular CUFE:
|
String | Xml | Documento XML (ApplicationResponse) codificado en Base64 |
Método EstadoCertificado
Permite conocer el estado del certificado digital adquirido en ambiente demo o ambiente producción, indica su vigencia y los días restantes para cumplir su vencimiento.
- 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 |
---|---|---|
String | active | Indica el Estatus actual en el que se encuentra el certificado digital |
String | dateFrom | Indica la fecha desde la cual se encuentra activo el certificado digital |
String | dateTo | Indica la fecha de vencimiento del certificado digital. |
Int | identification | Muestra el numero de identificación del contribuyente al que pertenece el certificado |
Int | codigo | Indica el Estado de la operación retornado por el servicio |
String | mensaje | Este mensaje está asociado a los días faltantes para el vencimiento del certificado digital. |
@IMPORTANTE: El consumo de este método está contemplado solamente con la versión url V4 del servicio a través de Web Service.
- Para mayor información pude visitar la siguiente sección:
Tips Urls de Emisión