Diferencia entre revisiones de «Métodos Servicio Emisión Web Soap - Indice Manual Integración Directa»
Línea 13: | Línea 13: | ||
| AN || Carácter alfanumérico | | AN || Carácter alfanumérico | ||
|- | |- | ||
− | | <nowiki> A|3 </nowiki> || 3 caracteres alfabéticos ( longitud fija) | + | | <nowiki> A|3 </nowiki> || 3 caracteres alfabéticos (longitud fija) |
|- | |- | ||
− | | <nowiki> N|3 </nowiki> || 3 caracteres numéricos ( longitud fija) | + | | <nowiki> N|3 </nowiki> || 3 caracteres numéricos (longitud fija) |
|- | |- | ||
− | | <nowiki> AN|3 </nowiki> || 3 caracteres alfanumé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> A|..3 </nowiki> || Hasta 3 caracteres alfabéticos (longitud variable) |
|- | |- | ||
| <nowiki> N|..3 </nowiki> || Hasta 3 caracteres numéricos (longitud variable) | | <nowiki> N|..3 </nowiki> || Hasta 3 caracteres numéricos (longitud variable) | ||
Línea 84: | Línea 84: | ||
* En <span style="color:#000; background:#FFFF00"><b>Amarillo</b></span> clases/atributos existentes en el modelo de validación posterior que sufrieron cambios en validación previa. | * En <span style="color:#000; background:#FFFF00"><b>Amarillo</b></span> clases/atributos existentes en el modelo de validación posterior que sufrieron cambios en validación previa. | ||
* En <span style="color:#00; background:#FFA500"><b>Naranja</b></span> clases/atributos existentes en el modelo de validación posterior que están en desuso (eliminados) en validación previa. | * En <span style="color:#00; background:#FFA500"><b>Naranja</b></span> clases/atributos existentes en el modelo de validación posterior que están en desuso (eliminados) en validación previa. | ||
+ | <br> | ||
A continuación se describen con mayor detalle el objeto factura para el modelo de facturación con validación previa: | A continuación se describen con mayor detalle el objeto factura para el modelo de facturación con validación previa: | ||
+ | <br> | ||
− | + | <center>'''Diagrama Class.FacturaGeneral con Class.Anticipos, Class.Autorizado y Class.CargosDescuentos''' | |
[[Archivo:Diagrama Class.FacturaGeneral con Class.Anticipos, Class.Autorizado y Class.CargosDescuentos.png|800px|sinmarco|centro|Diagrama Class.FacturaGeneral con Class.Anticipos, Class.Autorizado y Class.CargosDescuentos]] | [[Archivo:Diagrama Class.FacturaGeneral con Class.Anticipos, Class.Autorizado y Class.CargosDescuentos.png|800px|sinmarco|centro|Diagrama Class.FacturaGeneral con Class.Anticipos, Class.Autorizado y Class.CargosDescuentos]] | ||
− | + | <br> | |
− | + | '''Diagrama Class.FacturaGeneral con Class.Cliente''' | |
[[Archivo:Diagrama Class.FacturaGeneral con Class.Cliente.png|800px|sinmarco|centro|Diagrama Class.FacturaGeneral con Class.Cliente]] | [[Archivo:Diagrama Class.FacturaGeneral con Class.Cliente.png|800px|sinmarco|centro|Diagrama Class.FacturaGeneral con Class.Cliente]] | ||
− | + | <br> | |
− | + | '''Diagrama Class.FacturaGeneral con Class.CondicionPago''' | |
[[Archivo:Diagrama Class.FacturaGeneral con Class.CondicionPago.png|800px|sinmarco|centro|Diagrama Class.FacturaGeneral con Class.CondicionPago]] | [[Archivo:Diagrama Class.FacturaGeneral con Class.CondicionPago.png|800px|sinmarco|centro|Diagrama Class.FacturaGeneral con Class.CondicionPago]] | ||
− | + | <br> | |
− | + | '''Diagrama Class.FacturaGeneral con Class.FacturaDetalle''' | |
[[Archivo:Diagrama Class.FacturaGeneral con Class.FacturaDetalle.png|800px|sinmarco|centro|Diagrama Class.FacturaGeneral con Class.FacturaDetalle]] | [[Archivo:Diagrama Class.FacturaGeneral con Class.FacturaDetalle.png|800px|sinmarco|centro|Diagrama Class.FacturaGeneral con Class.FacturaDetalle]] | ||
− | + | <br> | |
− | + | '''Diagrama Class.FacturaGeneral con Class.DocumentoReferenciado''' | |
[[Archivo:Diagrama Class.FacturaGeneral con Class.DocumentoReferenciado.png|800px|sinmarco|centro|Diagrama Class.FacturaGeneral con Class.DocumentoReferenciado]] | [[Archivo:Diagrama Class.FacturaGeneral con Class.DocumentoReferenciado.png|800px|sinmarco|centro|Diagrama Class.FacturaGeneral con Class.DocumentoReferenciado]] | ||
− | + | <br> | |
− | + | '''Diagrama Class.FacturaGeneral Class.EntregaMercancia''' | |
[[Archivo:Diagrama Class.FacturaGeneral Class. EntregaMercancia.png|800px|sinmarco|centro|Diagrama Class.FacturaGeneral Class.EntregaMercancia]] | [[Archivo:Diagrama Class.FacturaGeneral Class. EntregaMercancia.png|800px|sinmarco|centro|Diagrama Class.FacturaGeneral Class.EntregaMercancia]] | ||
− | + | <br> | |
− | + | '''Diagrama Class.FacturaGeneral con Class.Extras. Class.FacturaImpuestos, Class.ImpuestosTotales, Class.MediosDePago, Class.OrdenDeCompra y Array - informacionAdicional''' | |
[[Archivo:Diagrama Class.FacturaGeneral con Class.Extras. Class.FacturaImpuestos, Class.ImpuestosTotales, Class.MediosDePago, Class.OrdenDeCompra y Array - informacionAdicional.png|800px|sinmarco|centro|Diagrama Class.FacturaGeneral con Class.Extras. Class.FacturaImpuestos, Class.ImpuestosTotales, Class.MediosDePago, Class.OrdenDeCompra y Array - informacionAdicional]] | [[Archivo:Diagrama Class.FacturaGeneral con Class.Extras. Class.FacturaImpuestos, Class.ImpuestosTotales, Class.MediosDePago, Class.OrdenDeCompra y Array - informacionAdicional.png|800px|sinmarco|centro|Diagrama Class.FacturaGeneral con Class.Extras. Class.FacturaImpuestos, Class.ImpuestosTotales, Class.MediosDePago, Class.OrdenDeCompra y Array - informacionAdicional]] | ||
− | + | <br> | |
− | + | '''Diagrama Class.FacturaGeneral con Class.TasaDeCambio, Class.TasaDeCambioAlternativa y Class.TerminosEntrega''' | |
− | [[Archivo:Diagrama Class.FacturaGeneral con Class.TasaDeCambio, Class.TasaDeCambioAlternativa y Class.TerminosEntrega.png|800px|sinmarco|centro|Diagrama Class.FacturaGeneral con Class.TasaDeCambio, Class.TasaDeCambioAlternativa y Class.TerminosEntrega]] | + | [[Archivo:Diagrama Class.FacturaGeneral con Class.TasaDeCambio, Class.TasaDeCambioAlternativa y Class.TerminosEntrega.png|800px|sinmarco|centro|Diagrama Class.FacturaGeneral con Class.TasaDeCambio, Class.TasaDeCambioAlternativa y Class.TerminosEntrega]] |
+ | </center> | ||
{{clear}} | {{clear}} | ||
====Class.FacturaGeneral==== | ====Class.FacturaGeneral==== | ||
Línea 126: | Línea 129: | ||
: Informaciones relacionadas con anticipos | : Informaciones relacionadas con anticipos | ||
: '''PATH''': /root/cac:PrepaidPayment | : '''PATH''': /root/cac:PrepaidPayment | ||
− | : (ver detalle en Class.Anticipos) | + | : (ver detalle en [[#Class.Anticipos|Class.Anticipos]]) |
|- | |- | ||
|autorizado | |autorizado | ||
Línea 135: | Línea 138: | ||
: Informaciones de la persona autorizada para descargar documentos | : Informaciones de la persona autorizada para descargar documentos | ||
: '''PATH''': /root/cac:TaxRepresentativeParty | : '''PATH''': /root/cac:TaxRepresentativeParty | ||
− | : (ver detalle en Class.Autorizado) | + | : (ver detalle en [[#Class.Autorizado|Class.Autorizado]]) |
|- | |- | ||
|cantidadDecimales | |cantidadDecimales | ||
Línea 153: | Línea 156: | ||
: Informaciones relacionadas con un cargo o un descuento a escala de factura que no afecte a la base gravable | : Informaciones relacionadas con un cargo o un descuento a escala de factura que no afecte a la base gravable | ||
: '''PATH''': /root/cac:AllowanceCharge | : '''PATH''': /root/cac:AllowanceCharge | ||
− | : (ver detalle en Class.CargosDescuentos) | + | : (ver detalle en [[#Class.CargosDescuentos|Class.CargosDescuentos]]) |
|- | |- | ||
|cliente | |cliente | ||
Línea 162: | Línea 165: | ||
: Información del adquiriente | : Información del adquiriente | ||
: '''PATH''':/root/cac:AccountingCustomerParty | : '''PATH''':/root/cac:AccountingCustomerParty | ||
− | : (ver detalle en Class.Cliente) | + | : (ver detalle en [[#Class.Cliente|Class.Cliente]]) |
|- | |- | ||
|condicionPago | |condicionPago | ||
Línea 171: | Línea 174: | ||
: Información relacionada con la condición de pago | : Información relacionada con la condición de pago | ||
: '''PATH''': /root/cac:PaymentTerms | : '''PATH''': /root/cac:PaymentTerms | ||
− | : (ver detalle en Class.CondicionPago) | + | : (ver detalle en [[#Class.CondicionPago|Class.CondicionPago]]) |
|- | |- | ||
|consecutivoDocumento | |consecutivoDocumento | ||
Línea 195: | Línea 198: | ||
: Información de detalles o productos | : Información de detalles o productos | ||
: '''PATH''': /root/cac:InvoiceLine | : '''PATH''': /root/cac:InvoiceLine | ||
− | : (ver detalle en Class.FacturaDetalle) | + | : (ver detalle en [[#Class.FacturaDetalle|Class.FacturaDetalle]]) |
|- | |- | ||
|documentosReferenciados | |documentosReferenciados | ||
Línea 209: | Línea 212: | ||
:: /root/cac: DespatchDocumentReference, | :: /root/cac: DespatchDocumentReference, | ||
:: /root/cac: ReceiptDocumentReference | :: /root/cac: ReceiptDocumentReference | ||
− | :(ver detalle en Class.DocumentoReferenciado) | + | :(ver detalle en [[#Class.DocumentoReferenciado|Class.DocumentoReferenciado]]) |
|- | |- | ||
|entregaMercancia | |entregaMercancia | ||
Línea 218: | Línea 221: | ||
: Información de entrega (Delivery) de bienes | : Información de entrega (Delivery) de bienes | ||
: '''PATH''': /root/cac:Delivery | : '''PATH''': /root/cac:Delivery | ||
− | : (ver detalle en Class.Entrega) | + | : (ver detalle en [[#Class.Entrega|Class.Entrega]]) |
|- | |- | ||
|extras | |extras | ||
Línea 227: | Línea 230: | ||
: Campos o información opcional para el modelo de negocio del emisor | : Campos o información opcional para el modelo de negocio del emisor | ||
: '''PATH''': No definido | : '''PATH''': No definido | ||
− | : (ver detalle en Class.Extras) | + | : (ver detalle en [[#Class.Extras|Class.Extras]]) |
|- | |- | ||
|fechaEmision | |fechaEmision | ||
Línea 281: | Línea 284: | ||
: '''PATH''': /root/cac:TaxTotal (impuestos), | : '''PATH''': /root/cac:TaxTotal (impuestos), | ||
: /root/cac: WithholdingTaxTotal (retenciones), | : /root/cac: WithholdingTaxTotal (retenciones), | ||
− | : (ver detalle en Class.FacturaImpuestos) | + | : (ver detalle en [[#Class.FacturaImpuestos|Class.FacturaImpuestos]]) |
|- | |- | ||
|impuestosTotales | |impuestosTotales | ||
Línea 292: | Línea 295: | ||
: '''PATH''': /root/cac:TaxTotal/cbc:TaxAmount (impuestos), | : '''PATH''': /root/cac:TaxTotal/cbc:TaxAmount (impuestos), | ||
: /root/cac: WithholdingTaxTotal/cbc:TaxAmount (retenciones), | : /root/cac: WithholdingTaxTotal/cbc:TaxAmount (retenciones), | ||
− | : (ver detalle en Class.ImpuestosTotales) | + | : (ver detalle en [[#Class.ImpuestosTotales|Class.ImpuestosTotales]]) |
|- | |- | ||
|informacionAdicional | |informacionAdicional | ||
Línea 309: | Línea 312: | ||
: Información relacionada con el pago de la factura | : Información relacionada con el pago de la factura | ||
: '''PATH''': /root/cac:PaymentMeans | : '''PATH''': /root/cac:PaymentMeans | ||
− | : (ver detalle en Class.MediosDePago) | + | : (ver detalle en [[#Class.MediosDePago|Class.MediosDePago]]) |
|- | |- | ||
|moneda | |moneda | ||
Línea 328: | Línea 331: | ||
: Información relacionada a la orden de compra | : Información relacionada a la orden de compra | ||
: '''PATH''': /root/cac:OrderReference | : '''PATH''': /root/cac:OrderReference | ||
− | : (ver detalle en Class.OrdenDeCompra) | + | : (ver detalle en [[#Class.OrdenDeCompra|Class.OrdenDeCompra]]) |
|- | |- | ||
|rangoNumeracion | |rangoNumeracion | ||
Línea 359: | Línea 362: | ||
: '''Obligatorio''' Si tipoDocumento es de exportación/internacional o si la divisa base es diferente a “COP” | : '''Obligatorio''' Si tipoDocumento es de exportación/internacional o si la divisa base es diferente a “COP” | ||
: '''PATH''': /root/cac:PaymentExchangeRate | : '''PATH''': /root/cac:PaymentExchangeRate | ||
− | : (ver detalle en Class.TasaDeCambio) | + | : (ver detalle en [[#Class.TasaDeCambio|Class.TasaDeCambio]]) |
|- | |- | ||
|tasaDeCambioAlternativa | |tasaDeCambioAlternativa | ||
Línea 368: | Línea 371: | ||
: Información utilizada como método alternativo para informar conversiones a otras divisas | : Información utilizada como método alternativo para informar conversiones a otras divisas | ||
: '''PATH''': /root/cac:PaymentAlternativeExchangeRate | : '''PATH''': /root/cac:PaymentAlternativeExchangeRate | ||
− | : (ver detalle en Class.TasaDeCambioAlternativa) | + | : (ver detalle en [[#Class.TasaDeCambioAlternativa|Class.TasaDeCambioAlternativa]]) |
|- | |- | ||
|terminosEntrega | |terminosEntrega | ||
Línea 378: | Línea 381: | ||
: '''Obligatorio''' Si tipoDocumento es de exportación/internacional | : '''Obligatorio''' Si tipoDocumento es de exportación/internacional | ||
: '''PATH''': /root/cac:DeliveryTerms | : '''PATH''': /root/cac:DeliveryTerms | ||
− | : (ver detalle en Class.TerminosEntrega) | + | : (ver detalle en [[#Class.TerminosEntrega|Class.TerminosEntrega]]) |
|- | |- | ||
|tipoDocumento | |tipoDocumento | ||
Línea 446: | Línea 449: | ||
: Descuento Total: Suma de todos los descuentos aplicados a nivel de la factura | : Descuento Total: Suma de todos los descuentos aplicados a nivel de la factura | ||
: <span style="color:#FFFF; background:#FF0000"><b>Rechazo</b></span> Si totalDescuentos no corresponde a la suma de ocurrencias CargosDescuentos.monto cuando CargosDescuentos.indicador es “false” | : <span style="color:#FFFF; background:#FF0000"><b>Rechazo</b></span> Si totalDescuentos no corresponde a la suma de ocurrencias CargosDescuentos.monto cuando CargosDescuentos.indicador es “false” | ||
− | : PATH: /root/LegalMonetaryTotal/cbc:AllowanceTotalAmount | + | : '''PATH''': /root/LegalMonetaryTotal/cbc:AllowanceTotalAmount |
|- | |- | ||
|totalMonto | |totalMonto | ||
Línea 492: | Línea 495: | ||
: Campos o información opcional para el modelo de negocio del emisor | : Campos o información opcional para el modelo de negocio del emisor | ||
: '''PATH''': No definido | : '''PATH''': No definido | ||
− | : (ver detalle en Class.Extensible) | + | : (ver detalle en [[#Class.Extensible|Class.Extensible]]) |
|- | |- | ||
|fechaDeRecibido | |fechaDeRecibido | ||
Línea 685: | Línea 688: | ||
: Campos o información opcional para el modelo de negocio del emisor | : Campos o información opcional para el modelo de negocio del emisor | ||
: '''PATH''': No definido | : '''PATH''': No definido | ||
− | : (ver detalle en Class.Extensible) | + | : (ver detalle en [[#Class.Extensible|Class.Extensible]]) |
|- | |- | ||
|indicador | |indicador | ||
Línea 767: | Línea 770: | ||
: '''Obligatorio''': Si campo notificar = ‘SI’ | : '''Obligatorio''': Si campo notificar = ‘SI’ | ||
: '''PATH''': No definido | : '''PATH''': No definido | ||
− | : (ver detalle en Class.Destinatario) | + | : (ver detalle en [[#Class.Destinatario|Class.Destinatario]]) |
|- | |- | ||
|detallesTributarios | |detallesTributarios | ||
Línea 777: | Línea 780: | ||
: <span style="color:#FFFF; background:#FF0000"><b>Rechazo</b></span> Si la clase no es informada | : <span style="color:#FFFF; background:#FF0000"><b>Rechazo</b></span> Si la clase no es informada | ||
: '''PATH''': /cac:Party/cac:PartyTaxScheme/cac:TaxScheme | : '''PATH''': /cac:Party/cac:PartyTaxScheme/cac:TaxScheme | ||
− | : (ver detalle en Class.Tributos) | + | : (ver detalle en [[#Class.Tributos|Class.Tributos]]) |
|- | |- | ||
|direccionCliente | |direccionCliente | ||
Línea 787: | Línea 790: | ||
: '''Recomendado''': Esta dirección ransf es la que se pinta en la representación gráfica estándar | : '''Recomendado''': Esta dirección ransf es la que se pinta en la representación gráfica estándar | ||
: '''PATH''': ../cac:Party/cac:PhysicalLocation/cac:Address | : '''PATH''': ../cac:Party/cac:PhysicalLocation/cac:Address | ||
− | : (ver detalle en Class.Direccion) | + | : (ver detalle en [[#Class.Direccion|Class.Direccion]]) |
|- | |- | ||
|direccionFiscal | |direccionFiscal | ||
Línea 798: | Línea 801: | ||
: <span style="color:#FFFF; background:#FF0000"><b>Notificación</b></span> Si el adquirente es responsable y no fue informada esta clase | : <span style="color:#FFFF; background:#FF0000"><b>Notificación</b></span> Si el adquirente es responsable y no fue informada esta clase | ||
: '''PATH''': .. /cac:Party/cac:PartyTaxScheme/cac:RegistrationAddress | : '''PATH''': .. /cac:Party/cac:PartyTaxScheme/cac:RegistrationAddress | ||
− | : (ver detalle en Class.Direccion) | + | : (ver detalle en [[#Class.Direccion|Class.Direccion]]) |
|- | |- | ||
|email | |email | ||
Línea 816: | Línea 819: | ||
: Campos o información opcional para el modelo de negocio del emisor | : Campos o información opcional para el modelo de negocio del emisor | ||
: '''PATH''': No definido | : '''PATH''': No definido | ||
− | : (ver detalle en Class.Extensible) | + | : (ver detalle en [[#Class.Extensible|Class.Extensible]]) |
|- | |- | ||
|informacionLegalCliente | |informacionLegalCliente | ||
Línea 826: | Línea 829: | ||
: <span style="color:#FFFF; background:#FF0000"><b>Notificación</b></span> : Si se informa tipoPersona = ‘1’ y el atributo no es reportado | : <span style="color:#FFFF; background:#FF0000"><b>Notificación</b></span> : Si se informa tipoPersona = ‘1’ y el atributo no es reportado | ||
: '''PATH''': ../cac:Party/cac:PartyLegalEntity | : '''PATH''': ../cac:Party/cac:PartyLegalEntity | ||
− | : (ver detalle en Class.InformacionLegalCliente) | + | : (ver detalle en [[#Class.InformacionLegalCliente|Class.InformacionLegalCliente]]) |
|- | |- | ||
|nombreComercial | |nombreComercial | ||
Línea 901: | Línea 904: | ||
: <span style="color:#FFFF; background:#FF0000"><b>Rechazo</b></span> Si la clase no es informada | : <span style="color:#FFFF; background:#FF0000"><b>Rechazo</b></span> Si la clase no es informada | ||
: '''PATH''': ../cac:Party/cac:PartyTaxScheme/cbc:TaxLevelCode | : '''PATH''': ../cac:Party/cac:PartyTaxScheme/cbc:TaxLevelCode | ||
− | : (ver detalle en Class.Obligaciones) | + | : (ver detalle en [[#Class.Obligaciones|Class.Obligaciones]]) |
|- | |- | ||
|segundoNombre | |segundoNombre | ||
Línea 1099: | Línea 1102: | ||
| NO | | NO | ||
| | | | ||
− | : Cantidad de unidad de este artículo por empaque. Por ejemplo, si el artículo son tres “six pack”, la cantidad a reportar en cantidadPorEmpaque es 6, mientras la cantidad a reportar en cantidadReal es 3, y el total de latas que se está describiendo son 18 | + | : Cantidad de unidad de este artículo por empaque. |
+ | : Por ejemplo, si el artículo son tres “six pack”, la cantidad a reportar en cantidadPorEmpaque es 6, mientras la cantidad a reportar en cantidadReal es 3, y el total de latas que se está describiendo son 18 | ||
: '''PATH''': ..cac:Item/cbc:PackSizeNumeric | : '''PATH''': ..cac:Item/cbc:PackSizeNumeric | ||
|- | |- | ||
Línea 1137: | Línea 1141: | ||
: Si un cargo individual general a la factura genera IVA, debe reportarse como ítem | : Si un cargo individual general a la factura genera IVA, debe reportarse como ítem | ||
: '''PATH''': ../cac:AllowanceCharge | : '''PATH''': ../cac:AllowanceCharge | ||
− | : (ver detalle en Class.CargosDescuentos) | + | : (ver detalle en [[#Class.CargosDescuentos|Class.CargosDescuentos]]) |
|- | |- | ||
|codigoFabricante | |codigoFabricante | ||
Línea 1203: | Línea 1207: | ||
: /root/cac: DespatchDocumentReference, | : /root/cac: DespatchDocumentReference, | ||
: /root/cac: ReceiptDocumentReference | : /root/cac: ReceiptDocumentReference | ||
− | : (ver detalle en Class.DocumentoReferenciado) | + | : (ver detalle en [[#Class.DocumentoReferenciado|Class.DocumentoReferenciado]]) |
|- | |- | ||
|estandarCodigo | |estandarCodigo | ||
Línea 1280: | Línea 1284: | ||
: Campos o información opcional para el modelo de negocio del emisor | : Campos o información opcional para el modelo de negocio del emisor | ||
: '''PATH''': No definido | : '''PATH''': No definido | ||
− | : (ver detalle en Class.Extensible) | + | : (ver detalle en [[#Class.Extensible|Class.Extensible]]) |
|- | |- | ||
|impuestosDetalles | |impuestosDetalles | ||
Línea 1294: | Línea 1298: | ||
: '''PATH''': ../cac:TaxTotal (impuestos), | : '''PATH''': ../cac:TaxTotal (impuestos), | ||
: ../cac: WithholdingTaxTotal (retenciones) | : ../cac: WithholdingTaxTotal (retenciones) | ||
− | : (ver detalle en Class.FacturaImpuestos) | + | : (ver detalle en [[#Class.FacturaImpuestos|Class.FacturaImpuestos]]) |
|- | |- | ||
|impuestosTotales | |impuestosTotales | ||
Línea 1307: | Línea 1311: | ||
: '''PATH''': ../cac:TaxTotal/cbc:TaxAmount (impuestos), | : '''PATH''': ../cac:TaxTotal/cbc:TaxAmount (impuestos), | ||
: ../cac: WithholdingTaxTotal/cbc:TaxAmount (retenciones) | : ../cac: WithholdingTaxTotal/cbc:TaxAmount (retenciones) | ||
− | : (ver detalle en Class.ImpuestosTotales) | + | : (ver detalle en [[#Class.ImpuestosTotales|Class.ImpuestosTotales]]) |
|- | |- | ||
|informacionAdicional | |informacionAdicional | ||
Línea 1316: | Línea 1320: | ||
: Sirve para adicionar información específica del producto que puede ser solicitada por autoridades o entidades diferentes a la DIAN | : Sirve para adicionar información específica del producto que puede ser solicitada por autoridades o entidades diferentes a la DIAN | ||
: '''PATH''': ../cac:Item/cac:AdditionalItemProperty | : '''PATH''': ../cac:Item/cac:AdditionalItemProperty | ||
− | : (ver detalle en Class.LineaInformacionAdicional) | + | : (ver detalle en [[#Class.LineaInformacionAdicional|Class.LineaInformacionAdicional]]) |
|- | |- | ||
|mandatorioNumeroIdentificacion | |mandatorioNumeroIdentificacion | ||
Línea 1618: | Línea 1622: | ||
: Campos o información opcional para el modelo de negocio del emisor | : Campos o información opcional para el modelo de negocio del emisor | ||
: '''PATH''': No definido | : '''PATH''': No definido | ||
− | : (ver detalle en Class.Extensible) | + | : (ver detalle en [[#Class.Extensible|Class.Extensible]]) |
|- | |- | ||
|fecha | |fecha | ||
Línea 1656: | Línea 1660: | ||
: Concatenación del prefijo y el número del documento referenciado | : Concatenación del prefijo y el número del documento referenciado | ||
: <span style="color:#FFFF; background:#FF0000"><b>Rechazo</b></span> Si se informa codigoInterno igual a ‘1’, ‘2’, ‘3’, ‘4’ ó ‘5’ y el ID de documento de referencia no está relacionado | : <span style="color:#FFFF; background:#FF0000"><b>Rechazo</b></span> Si se informa codigoInterno igual a ‘1’, ‘2’, ‘3’, ‘4’ ó ‘5’ y el ID de documento de referencia no está relacionado | ||
+ | : '''PATH''': | ||
: /Invoice/cac:BillingReference/cac:CreditNoteDocumentReference/cbc:ID | : /Invoice/cac:BillingReference/cac:CreditNoteDocumentReference/cbc:ID | ||
: /CreditNote/cac:BillingReference/cac:InvoiceDocumentReference/cbc:ID | : /CreditNote/cac:BillingReference/cac:InvoiceDocumentReference/cbc:ID | ||
Línea 1726: | Línea 1731: | ||
: Información de Despacho | : Información de Despacho | ||
: '''PATH''': ../cac:Despatch/cac:DespatchAddress | : '''PATH''': ../cac:Despatch/cac:DespatchAddress | ||
− | : (ver detalle en Class.Direccion) | + | : (ver detalle en [[#Class.Direccion|Class.Direccion]]) |
|- | |- | ||
|direccionEntrega | |direccionEntrega | ||
Línea 1735: | Línea 1740: | ||
: Información de Entrega | : Información de Entrega | ||
: '''PATH''': ../cac:DeliveryAddress | : '''PATH''': ../cac:DeliveryAddress | ||
− | : (ver detalle en Class.Direccion) | + | : (ver detalle en [[#Class.Direccion|Class.Direccion]]) |
|- | |- | ||
|extras | |extras | ||
Línea 1744: | Línea 1749: | ||
: Campos o información opcional para el modelo de negocio del emisor | : Campos o información opcional para el modelo de negocio del emisor | ||
: '''PATH''': No definido | : '''PATH''': No definido | ||
− | : (ver detalle en Class.Extensible) | + | : (ver detalle en [[#Class.Extensible|Class.Extensible]]) |
|- | |- | ||
|fechaEfectivaSalida | |fechaEfectivaSalida | ||
Línea 1828: | Línea 1833: | ||
| | | | ||
: Código del campo extensible a referenciar | : Código del campo extensible a referenciar | ||
− | : (Ver sección USO DE CAMPOS EXTRAS) | + | : (Ver sección [[Caracteristicas adicionales - Indice Manual Integración Directa#Uso de campos extras|USO DE CAMPOS EXTRAS]]) |
: '''PATH''': Variable | : '''PATH''': Variable | ||
|- | |- | ||
Línea 1938: | Línea 1943: | ||
: Campos o información opcional para el modelo de negocio del emisor | : Campos o información opcional para el modelo de negocio del emisor | ||
: '''PATH''': No definido | : '''PATH''': No definido | ||
− | : (ver detalle en Class.Extensible) | + | : (ver detalle en [[#Class.Extensible|Class.Extensible]]) |
|- | |- | ||
|porcentajeTOTALImp | |porcentajeTOTALImp | ||
Línea 1946: | Línea 1951: | ||
|SI | |SI | ||
| | | | ||
− | : Tarifa del tributo. En el caso de que el tributo es un porcentaje del valor tributable: informar la tarifa “porcentaje” a ser aplicada a la base imponible | + | : Tarifa del tributo. |
+ | : En el caso de que el tributo es un porcentaje del valor tributable: informar la tarifa “porcentaje” a ser aplicada a la base imponible | ||
: <span style="color:#FFFF; background:#FF0000"><b>Rechazo</b></span> Si reporta una tarifa diferente para uno de los tributos enunciados en la Tabla 12 | : <span style="color:#FFFF; background:#FF0000"><b>Rechazo</b></span> Si reporta una tarifa diferente para uno de los tributos enunciados en la Tabla 12 | ||
: '''PATH''':../cac:TaxTotal/TaxSubtotal/cac:TaxCategory/cbc:Percent | : '''PATH''':../cac:TaxTotal/TaxSubtotal/cac:TaxCategory/cbc:Percent | ||
Línea 2153: | Línea 2159: | ||
: Documento Referencia | : Documento Referencia | ||
: '''PATH''': ../cac:DocumentReference | : '''PATH''': ../cac:DocumentReference | ||
− | : (ver detalle en Class.DocumentoReferencia) | + | : (ver detalle en [[#Class.DocumentoReferencia|Class.DocumentoReferencia]]) |
|- | |- | ||
|extras | |extras | ||
Línea 2162: | Línea 2168: | ||
: Campos o información opcional para el modelo de negocio del emisor | : Campos o información opcional para el modelo de negocio del emisor | ||
: '''PATH''': No definido | : '''PATH''': No definido | ||
− | : (ver detalle en Class.Extensible) | + | : (ver detalle en [[#Class.Extensible|Class.Extensible]]) |
|- | |- | ||
|fecha | |fecha | ||
Línea 2252: | Línea 2258: | ||
: Campos o información opcional para el modelo de negocio del emisor | : Campos o información opcional para el modelo de negocio del emisor | ||
: '''PATH''': No definido | : '''PATH''': No definido | ||
− | : (ver detalle en Class.Extensible) | + | : (ver detalle en [[#Class.Extensible|Class.Extensible]]) |
|- | |- | ||
|fechaDeTasaDeCambio | |fechaDeTasaDeCambio | ||
Línea 2295: | Línea 2301: | ||
: Operador de Calculo | : Operador de Calculo | ||
: '''PATH''': ../cbc: MathematicOperatorCode | : '''PATH''': ../cbc: MathematicOperatorCode | ||
− | | | + | |- |
|tasaDeCambio | |tasaDeCambio | ||
|String | |String | ||
Línea 2343: | Línea 2349: | ||
: Campos o información opcional para el modelo de negocio del emisor | : Campos o información opcional para el modelo de negocio del emisor | ||
: '''PATH''': No definido | : '''PATH''': No definido | ||
− | : (ver detalle en Class.Extensible) | + | : (ver detalle en [[#Class.Extensible|Class.Extensible]]) |
|- | |- | ||
|fechaDeTasaDeCambio | |fechaDeTasaDeCambio | ||
Línea 2445: | Línea 2451: | ||
| - | | - | ||
|NO | |NO | ||
+ | | | ||
: Campos o información opcional para el modelo de negocio del emisor. | : Campos o información opcional para el modelo de negocio del emisor. | ||
: '''PATH''': No definido | : '''PATH''': No definido |
Revisión del 17:13 23 jul 2020
Sumario
- 1 Método Servicio Emisión Web Soap
- 1.1 Método Enviar
- 1.1.1 Class.FacturaGeneral
- 1.1.2 Class.Anticipos
- 1.1.3 Class.Autorizado
- 1.1.4 Class.CargosDescuentos
- 1.1.5 Class.Cliente
- 1.1.6 Class.CondicionPago
- 1.1.7 Class.FacturaDetalle
- 1.1.8 Class.Destinatario
- 1.1.9 Class.DocumentoReferenciado
- 1.1.10 Class.Entrega
- 1.1.11 Class.Extras
- 1.1.12 Class.Extensible
- 1.1.13 Class.FacturaImpuestos
- 1.1.14 Class.ImpuestosTotales
- 1.1.15 Class.MediosDePago
- 1.1.16 Class.OrdenDeCompra
- 1.1.17 Class.TasaDeCambio
- 1.1.18 Class.TasaDeCambioAlternativa
- 1.1.19 Class.TerminosEntrega
- 1.1.20 Class.Direccion
- 1.1.21 Class.Coordenadas
- 1.1.22 Class.Tributos
- 1.1.23 Class.InformacionLegalCliente
- 1.1.24 Class.Obligaciones
- 1.1.25 Class.LineaInformacionAdicional
- 1.1.26 Class.DatosTransportistas
- 1.1.27 Class.DocumentoReferencia
- 1.2 Método EstadoDocumento
- 1.3 Método EnvioCorreo
- 1.4 Método DescargaPDF
- 1.5 Método DescargaXML
- 1.6 Método FoliosRestantes
- 1.7 Método CargarCertificado
- 1.8 Método DescargarEventoXML
- 1.9 Método GenerarContenedor
- 1.10 Método GenerarEvento
- 1.1 Método Enviar
Método Servicio Emisión 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 |
---|---|---|
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..20 | 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 |
|
tasaDeCambio | TasaDeCambio | - | C/C |
|
tasaDeCambioAlternativa | TasaDeCambioAlternativa | - | NO |
|
terminosEntrega | TerminosEntrega | - | C/C |
|
tipoDocumento | String | AN|2 | 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.FacturaDetalle
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 | SI |
|
descripcionTecnica | String | AN|..300 | NO |
|
documentosReferenciados | Array <DocumentoReferenciado> | - | NO |
|
estandarCodigo | String | AN | NO |
|
estandarCodigoID | String | AN | NO |
|
estandarCodigoIdentificador | String | AN | NO |
|
estandarCodigoNombre | String | AN | NO |
|
estandarCodigoProducto | String | AN | NO |
|
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.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.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.Entrega
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.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.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 | C/C |
|
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.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.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|..50 | NO |
|
ubicación | String | AN|..50 | NO |
|
zonaPostal | String | AN|..10 | 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.Tributos
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
codigoImpuesto | String | AN|2 | SI |
|
extras | Array <Extensible> | - | NO |
|
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.Obligaciones
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
extras | Array <Extensible> | - | NO |
|
obligaciones | String | AN|7 | SI |
|
regimen | String | AN|2 | NO |
|
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.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.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.
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"
- 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 |
- REQUEST
- 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 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 |
|
- REQUEST
- 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” |
- REQUEST
- 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 |
- REQUEST
- 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 |
- REQUEST
- 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 |
- REQUEST
- 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 |
- REQUEST
- 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 |
- REQUEST
- 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 |