Diferencia entre revisiones de «Métodos Servicio Emisión Web Soap - Indice Manual Integración Directa»
Línea 390: | Línea 390: | ||
: Tipo de documento | : Tipo de documento | ||
: '''PATH''': Invoice, CreditNote, DebitNote | : '''PATH''': Invoice, CreditNote, DebitNote | ||
− | : <span style="color:#FFFF; background:#FF0000"><b>Rechazo</b></span> Si el contenido de este atributo no corresponde a uno de los valores de la Tabla 1 | + | : <span style="color:#FFFF; background:#FF0000"><b>Rechazo</b></span> Si el contenido de este atributo no corresponde a uno de los valores de la [[Tablas de códigos de propiedades para emisión de documentos - Indice Manual Integración Directa#Tabla 1|Tabla 1]] |
|- | |- | ||
|tipoOperacion | |tipoOperacion | ||
Línea 398: | Línea 398: | ||
| | | | ||
: Indicador del tipo de operación | : Indicador del tipo de operación | ||
− | : <span style="color:#FFFF; background:#FF0000"><b>Rechazo</b></span> Si el contenido de este atributo no corresponde a uno de los valores de la Tabla 2 | + | : <span style="color:#FFFF; background:#FF0000"><b>Rechazo</b></span> Si el contenido de este atributo no corresponde a uno de los valores de la [[Tablas de códigos de propiedades para emisión de documentos - Indice Manual Integración Directa#Tabla 2|Tabla 2]] |
: '''PATH''': /root/cbc:CustomizationID | : '''PATH''': /root/cbc:CustomizationID | ||
|- | |- | ||
Línea 578: | Línea 578: | ||
: 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]]) |
|- | |- | ||
|nombreComercial | |nombreComercial | ||
Línea 652: | Línea 652: | ||
: Tipo de Identificación | : Tipo de Identificación | ||
: '''PATH''': /cac:PartyIdentification/cbc:ID@schemeName | : '''PATH''': /cac:PartyIdentification/cbc:ID@schemeName | ||
− | : Ver lista de valores posibles en la Tabla 3 | + | : Ver lista de valores posibles en la [[Tablas de códigos de propiedades para emisión de documentos - Indice Manual Integración Directa#Tabla 3|Tabla 3]] |
|} | |} | ||
+ | |||
====Class.CargosDescuentos==== | ====Class.CargosDescuentos==== | ||
{| class="mw-collapsible mw-collapsed wikitable" | {| class="mw-collapsible mw-collapsed wikitable" | ||
Línea 669: | Línea 670: | ||
: Código para categorizar el descuento | : Código para categorizar el descuento | ||
: '''Obligatorio''': Si es descuento a nivel de factura (general) | : '''Obligatorio''': Si es descuento a nivel de factura (general) | ||
− | : <span style="color:#FFFF; background:#FF0000"><b>Rechazo</b></span> Si es descuento y no se informa algunos de los valores en la Tabla 4 | + | : <span style="color:#FFFF; background:#FF0000"><b>Rechazo</b></span> Si es descuento y no se informa algunos de los valores en la [[Tablas de códigos de propiedades para emisión de documentos - Indice Manual Integración Directa#Tabla 4|Tabla 4]] |
: '''PATH''': …/cbc:AllowanceChargeReasonCode | : '''PATH''': …/cbc:AllowanceChargeReasonCode | ||
|- | |- | ||
Línea 936: | Línea 937: | ||
| | | | ||
: Tipo de Identificación del adquiriente | : Tipo de Identificación del adquiriente | ||
− | : <span style="color:#FFFF; background:#FF0000"><b>Rechazo</b></span> Si el contenido de este atributo no corresponde a uno de los valores de la Tabla 3 | + | : <span style="color:#FFFF; background:#FF0000"><b>Rechazo</b></span> Si el contenido de este atributo no corresponde a uno de los valores de la [[Tablas de códigos de propiedades para emisión de documentos - Indice Manual Integración Directa#Tabla 3|Tabla 3]] |
: <span style="color:#FFFF; background:#FF0000"><b>Nota</b></span>: Para identificar al consumidor final se utiliza el código “13” | : <span style="color:#FFFF; background:#FF0000"><b>Nota</b></span>: Para identificar al consumidor final se utiliza el código “13” | ||
: '''PATH''': ./cac:Party/cac:PartyTaxScheme/cbc:CompanyID/@schemeName | : '''PATH''': ./cac:Party/cac:PartyTaxScheme/cbc:CompanyID/@schemeName | ||
Línea 946: | Línea 947: | ||
| | | | ||
: Identificador de tipo de persona | : Identificador de tipo de persona | ||
− | : <span style="color:#FFFF; background:#FF0000"><b>Rechazo</b></span> Si el contenido de este atributo no corresponde a uno de los valores de la Tabla 5 | + | : <span style="color:#FFFF; background:#FF0000"><b>Rechazo</b></span> Si el contenido de este atributo no corresponde a uno de los valores de la [[Tablas de códigos de propiedades para emisión de documentos - Indice Manual Integración Directa#Tabla 5|Tabla 5]] |
: '''PATH''': …/cbc:AdditionalAccountID | : '''PATH''': …/cbc:AdditionalAccountID | ||
|} | |} | ||
Línea 1120: | Línea 1121: | ||
| | | | ||
: Unidad de la cantidad sobre la cual el precio aplica | : Unidad de la cantidad sobre la cual el precio aplica | ||
− | : <span style="color:#FFFF; background:#FF0000"><b>Notificación</b></span> Si el valor del atributo no se encuentra en la Tabla 6 | + | : <span style="color:#FFFF; background:#FF0000"><b>Notificación</b></span> Si el valor del atributo no se encuentra en la [[Tablas de códigos de propiedades para emisión de documentos - Indice Manual Integración Directa#Tabla 6|Tabla 6]] |
: (Se puede utilizar el código estandár “WSD”, unidad “94” o Acuerdo Mutuo “ZZ” para NO reclasificar los productos) | : (Se puede utilizar el código estandár “WSD”, unidad “94” o Acuerdo Mutuo “ZZ” para NO reclasificar los productos) | ||
: '''PATH''': .. /cac:Price/cbc:BaseQuantity/@unitCode | : '''PATH''': .. /cac:Price/cbc:BaseQuantity/@unitCode | ||
Línea 1176: | Línea 1177: | ||
: Código del tipo de precio informado | : Código del tipo de precio informado | ||
: '''Obligatorio''' Para muestras comerciales (valor = 01) | : '''Obligatorio''' Para muestras comerciales (valor = 01) | ||
− | : <span style="color:#FFFF; background:#FF0000"><b>Rechazo</b></span> Si el valor del atributo no se encuentra en la Tabla 7 | + | : <span style="color:#FFFF; background:#FF0000"><b>Rechazo</b></span> Si el valor del atributo no se encuentra en la [[Tablas de códigos de propiedades para emisión de documentos - Indice Manual Integración Directa#Tabla 7|Tabla 7]] |
: '''PATH''': ../cac:PricingReference/cac:AlternativeConditionPrice/cbc:PriceTypeCode | : '''PATH''': ../cac:PricingReference/cac:AlternativeConditionPrice/cbc:PriceTypeCode | ||
|- | |- | ||
Línea 1215: | Línea 1216: | ||
| | | | ||
: Código del estándar (identificación del artículo o servicio de acuerdo con un estándar) | : Código del estándar (identificación del artículo o servicio de acuerdo con un estándar) | ||
− | : Ver valores del atributo en la Tabla 8 | + | : Ver valores del atributo en la [[Tablas de códigos de propiedades para emisión de documentos - Indice Manual Integración Directa#Tabla 8|Tabla 8]] |
: <span style="color:#FFFF; background:#FF0000"><b>Notificación</b></span> Si es factura de exportación (tipoDocumento = 02), y no se informó la sub partida arancelaria | : <span style="color:#FFFF; background:#FF0000"><b>Notificación</b></span> Si es factura de exportación (tipoDocumento = 02), y no se informó la sub partida arancelaria | ||
: <span style="color:#FFFF; background:#FF0000"><b>Notificación</b></span> Si el código no existe en un estándar cerrado. | : <span style="color:#FFFF; background:#FF0000"><b>Notificación</b></span> Si el código no existe en un estándar cerrado. | ||
Línea 1231: | Línea 1232: | ||
: Asociado al código del estándar (identificación del artículo o servicio de acuerdo con un estándar). | : Asociado al código del estándar (identificación del artículo o servicio de acuerdo con un estándar). | ||
: <span style="color:#FFFF; background:#FF0000"><b>Rechazo</b></span> Si estandarCodigo = 010 y estandarCodigoID es diferente a 9 | : <span style="color:#FFFF; background:#FF0000"><b>Rechazo</b></span> Si estandarCodigo = 010 y estandarCodigoID es diferente a 9 | ||
− | : Ver valores del atributo en la Tabla 8 | + | : Ver valores del atributo en la [[Tablas de códigos de propiedades para emisión de documentos - Indice Manual Integración Directa#Tabla 8|Tabla 8]] |
: '''PATH''': ../cac:Item/cac:StandardItemIdentification/cbc:ID/@schemeAgencyID | : '''PATH''': ../cac:Item/cac:StandardItemIdentification/cbc:ID/@schemeAgencyID | ||
|- | |- | ||
Línea 1240: | Línea 1241: | ||
| | | | ||
: Asociado al código del estándar (identificación del artículo o servicio de acuerdo con un estándar). | : Asociado al código del estándar (identificación del artículo o servicio de acuerdo con un estándar). | ||
− | : Ver valores del atributo en la Tabla 8 | + | : Ver valores del atributo en la [[Tablas de códigos de propiedades para emisión de documentos - Indice Manual Integración Directa#Tabla 8|Tabla 8]] |
: '''PATH''': ../cac:Item/cac:StandardItemIdentification/cbc:ID@schemeDataURI | : '''PATH''': ../cac:Item/cac:StandardItemIdentification/cbc:ID@schemeDataURI | ||
|- | |- | ||
Línea 1249: | Línea 1250: | ||
| | | | ||
: Asociado al código del estándar (identificación del artículo o servicio de acuerdo con un estándar). | : Asociado al código del estándar (identificación del artículo o servicio de acuerdo con un estándar). | ||
− | : Ver valores del atributo en la Tabla 8 | + | : Ver valores del atributo en la [[Tablas de códigos de propiedades para emisión de documentos - Indice Manual Integración Directa#Tabla 8|Tabla 8]] |
: '''PATH''': ../cac:Item/cac:StandardItemIdentification/cbc:ID@schemeAgencyName | : '''PATH''': ../cac:Item/cac:StandardItemIdentification/cbc:ID@schemeAgencyName | ||
|- | |- | ||
Línea 1258: | Línea 1259: | ||
| | | | ||
: Código del producto según el estándar informado en estandarCodigo | : Código del producto según el estándar informado en estandarCodigo | ||
− | : Ver valores del atributo en la Tabla 8 | + | : Ver valores del atributo en la [[Tablas de códigos de propiedades para emisión de documentos - Indice Manual Integración Directa#Tabla 8|Tabla 8]] |
: '''PATH''': ../cac:Item/cac:StandardItemIdentification/cbc:ID | : '''PATH''': ../cac:Item/cac:StandardItemIdentification/cbc:ID | ||
|- | |- | ||
Línea 1347: | Línea 1348: | ||
: Tipo de identificación del mandatario | : Tipo de identificación del mandatario | ||
: '''Obligatorio''' Para facturas por mandato | : '''Obligatorio''' Para facturas por mandato | ||
− | : <span style="color:#FFFF; background:#FF0000"><b>Notificación</b></span> Si mandatorioNumeroIdentificacion es informado y el valor del este campo no se encuentra en la Tabla 3 | + | : <span style="color:#FFFF; background:#FF0000"><b>Notificación</b></span> Si mandatorioNumeroIdentificacion es informado y el valor del este campo no se encuentra en la [[Tablas de códigos de propiedades para emisión de documentos - Indice Manual Integración Directa#Tabla 3|Tabla 3]] |
: '''PATH''': ../cac:Item/cac:InformationContentProviderParty/cac:PowerOfAttorney/cac:AgentParty/cbc:ID/@schemeName | : '''PATH''': ../cac:Item/cac:InformationContentProviderParty/cac:PowerOfAttorney/cac:AgentParty/cbc:ID/@schemeName | ||
|- | |- | ||
Línea 1488: | Línea 1489: | ||
| | | | ||
: Código de Unidad de medida del producto/servicio facturado | : Código de Unidad de medida del producto/servicio facturado | ||
− | : <span style="color:#FFFF; background:#FF0000"><b>Notificación</b></span> Si el valor del atributo no se encuentra en la Tabla 6 | + | : <span style="color:#FFFF; background:#FF0000"><b>Notificación</b></span> Si el valor del atributo no se encuentra en la [[Tablas de códigos de propiedades para emisión de documentos - Indice Manual Integración Directa#Tabla 6|Tabla 6]] |
: (Se puede utilizar el código estandár “WSD”, unidad “94” o Acuerdo Mutuo “ZZ” para NO reclasificar los productos) | : (Se puede utilizar el código estandár “WSD”, unidad “94” o Acuerdo Mutuo “ZZ” para NO reclasificar los productos) | ||
: '''PATH''': ../cbc:InvoicedQuantity@unitCode | : '''PATH''': ../cbc:InvoicedQuantity@unitCode | ||
Línea 1525: | Línea 1526: | ||
: 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]]) |
|- | |- | ||
|fechaProgramada | |fechaProgramada | ||
Línea 1576: | Línea 1577: | ||
: Código o motivo del Documento | : Código o motivo del Documento | ||
: '''Obligatorio''' Cuando codigoInterno sea ‘4’ | : '''Obligatorio''' Cuando codigoInterno sea ‘4’ | ||
− | : <span style="color:#FFFF; background:#FF0000"><b>Rechazo</b></span> Si el contenido de este atributo no corresponde a algún de los valores de | + | : <span style="color:#FFFF; background:#FF0000"><b>Rechazo</b></span> Si el contenido de este atributo no corresponde a algún de los valores de [[Tablas de códigos de propiedades para emisión de documentos - Indice Manual Integración Directa#Tabla 9|Tabla 9]] y [[Tablas de códigos de propiedades para emisión de documentos - Indice Manual Integración Directa#Tabla 10|Tabla 10]] |
: '''PATH''': ../cac:DiscrepancyResponse/cbc:ResponseCode | : '''PATH''': ../cac:DiscrepancyResponse/cbc:ResponseCode | ||
|- | |- | ||
Línea 1694: | Línea 1695: | ||
: Identificador del tipo de documento referenciado. | : Identificador del tipo de documento referenciado. | ||
: '''Obligatorio''' Cuando codigoInterno sea ‘1’ | : '''Obligatorio''' Cuando codigoInterno sea ‘1’ | ||
− | : <span style="color:#FFFF; background:#FF0000"><b>Rechazo</b></span> Si codigoInterno igual a ‘1’ y el contenido de este atributo no corresponde a uno de los valores de la Tabla 21 | + | : <span style="color:#FFFF; background:#FF0000"><b>Rechazo</b></span> Si codigoInterno igual a ‘1’ y el contenido de este atributo no corresponde a uno de los valores de la [[Tablas de códigos de propiedades para emisión de documentos - Indice Manual Integración Directa#Tabla 21|Tabla 21]] |
: '''Nota''': Para ordenes de remisión, informar el código ‘AAJ’ | : '''Nota''': Para ordenes de remisión, informar el código ‘AAJ’ | ||
: '''PATH''': /Invoice/cac:AdditionalDocumentReference/cbc: DocumentTypeCode | : '''PATH''': /Invoice/cac:AdditionalDocumentReference/cbc: DocumentTypeCode | ||
Línea 1722: | Línea 1723: | ||
: Datos del Transportista | : Datos del Transportista | ||
: '''PATH''': ../cac:DeliveryParty | : '''PATH''': ../cac:DeliveryParty | ||
− | : (ver detalle en Class.DatosTransportista) | + | : (ver detalle en [[#Class.DatosTransportista|Class.DatosTransportista]]) |
|- | |- | ||
|direccionDespacho | |direccionDespacho | ||
Línea 1925: | Línea 1926: | ||
| | | | ||
: Identificador del tributo | : Identificador del tributo | ||
− | : <span style="color:#FFFF; background:#FF0000"><b>Rechazo</b></span> Si el contenido de este elemento no corresponde a uno de los códigos de la Tabla 11 | + | : <span style="color:#FFFF; background:#FF0000"><b>Rechazo</b></span> Si el contenido de este elemento no corresponde a uno de los códigos de la [[Tablas de códigos de propiedades para emisión de documentos - Indice Manual Integración Directa#Tabla 11|Tabla 11]] |
: '''PATH''':../cac:TaxTotal/TaxSubtotal/cac:TaxCategory/cac:TaxScheme/cbc:ID | : '''PATH''':../cac:TaxTotal/TaxSubtotal/cac:TaxCategory/cac:TaxScheme/cbc:ID | ||
|- | |- | ||
Línea 1953: | Línea 1954: | ||
: Tarifa del tributo. | : 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 | : 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 [[Tablas de códigos de propiedades para emisión de documentos - Indice Manual Integración Directa#Tabla 12|Tabla 12]] |
: '''PATH''':../cac:TaxTotal/TaxSubtotal/cac:TaxCategory/cbc:Percent | : '''PATH''':../cac:TaxTotal/TaxSubtotal/cac:TaxCategory/cbc:Percent | ||
|- | |- | ||
Línea 1962: | Línea 1963: | ||
| | | | ||
: Identificación de la unidad de medida | : Identificación de la unidad de medida | ||
− | : <span style="color:#FFFF; background:#FF0000"><b>Rechazo</b></span> Si el contenido de este elemento no corresponde a uno de los códigos de la Tabla 6 | + | : <span style="color:#FFFF; background:#FF0000"><b>Rechazo</b></span> Si el contenido de este elemento no corresponde a uno de los códigos de la [[Tablas de códigos de propiedades para emisión de documentos - Indice Manual Integración Directa#Tabla 6|Tabla 6]] |
: '''PATH''':../cac:TaxTotal/cac:TaxSubtotal/cbc:BaseUnitMeasure/@unitCode | : '''PATH''':../cac:TaxTotal/cac:TaxSubtotal/cbc:BaseUnitMeasure/@unitCode | ||
|- | |- | ||
Línea 2013: | Línea 2014: | ||
| | | | ||
: Identificador del tributo | : Identificador del tributo | ||
− | : <span style="color:#FFFF; background:#FF0000"><b>Rechazo</b></span> Si el contenido de este elemento no corresponde a uno de los códigos de la Tabla 11 | + | : <span style="color:#FFFF; background:#FF0000"><b>Rechazo</b></span> Si el contenido de este elemento no corresponde a uno de los códigos de la [[Tablas de códigos de propiedades para emisión de documentos - Indice Manual Integración Directa#Tabla 11|Tabla 11]] |
: '''PATH''': Por Definir | : '''PATH''': Por Definir | ||
|- | |- | ||
Línea 2023: | Línea 2024: | ||
: 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]]) |
|- | |- | ||
|montoTotal | |montoTotal | ||
Línea 2074: | Línea 2075: | ||
: 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]]) |
|- | |- | ||
|fechaDeVencimiento | |fechaDeVencimiento | ||
Línea 2092: | Línea 2093: | ||
| | | | ||
: Código correspondiente al medio de pago | : Código correspondiente al medio de pago | ||
− | : <span style="color:#FFFF; background:#FF0000"><b>Rechazo</b></span>: Si el valor de este atributo no corresponde a un valor de la Tabla 13 | + | : <span style="color:#FFFF; background:#FF0000"><b>Rechazo</b></span>: Si el valor de este atributo no corresponde a un valor de la [[Tablas de códigos de propiedades para emisión de documentos - Indice Manual Integración Directa#Tabla 13|Tabla 13]] |
: '''PATH''': ../cbc:PaymentMeansCode | : '''PATH''': ../cbc:PaymentMeansCode | ||
|- | |- | ||
Línea 2101: | Línea 2102: | ||
| | | | ||
: Método de Pago | : Método de Pago | ||
− | : <span style="color:#FFFF; background:#FF0000"><b>Rechazo</b></span>: Si el valor de este atributo no corresponde a un valor de la Tabla 14 | + | : <span style="color:#FFFF; background:#FF0000"><b>Rechazo</b></span>: Si el valor de este atributo no corresponde a un valor de la [[Tablas de códigos de propiedades para emisión de documentos - Indice Manual Integración Directa#Tabla 14|Tabla 14]] |
: '''PATH''': ../cbc:ID | : '''PATH''': ../cbc:ID | ||
|- | |- | ||
Línea 2418: | Línea 2419: | ||
: Informaciones relacionadas con un cargo o un descuento | : Informaciones relacionadas con un cargo o un descuento | ||
: '''PATH''': ../cac:AllowanceCharge | : '''PATH''': ../cac:AllowanceCharge | ||
− | : (ver detalle en Class.CargosDescuentos) | + | : (ver detalle en [[#Class.CargosDescuentos|Class.CargosDescuentos]]) |
|- | |- | ||
|codigoCondicionEntrega | |codigoCondicionEntrega | ||
Línea 2427: | Línea 2428: | ||
: Código de Condiciones de Entrega | : Código de Condiciones de Entrega | ||
: '''Obligatorio''' Se es factura de exportación/internacional | : '''Obligatorio''' Se es factura de exportación/internacional | ||
− | : <span style="color:#FFFF; background:#FF0000"><b>Rechazo</b></span>: Si el valor de este atributo no corresponde a un valor de la Tabla 15 | + | : <span style="color:#FFFF; background:#FF0000"><b>Rechazo</b></span>: Si el valor de este atributo no corresponde a un valor de la [[Tablas de códigos de propiedades para emisión de documentos - Indice Manual Integración Directa#Tabla 15|Tabla 15]] |
: '''PATH''': ../cbc:LossRiskResponsibilityCode | : '''PATH''': ../cbc:LossRiskResponsibilityCode | ||
|- | |- | ||
Línea 2445: | Línea 2446: | ||
: Información donde se detalle la dirección de entrega | : Información donde se detalle la dirección de entrega | ||
: '''PATH''': ../cac:DeliveryLocation | : '''PATH''': ../cac:DeliveryLocation | ||
− | : (ver detalle en Class.Direccion) | + | : (ver detalle en [[#Class.Direccion|Class.Direccion]]) |
|- | |- | ||
|extras | |extras | ||
Línea 2454: | Línea 2455: | ||
: 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]]) |
|- | |- | ||
|identificacion | |identificacion | ||
Línea 2543: | Línea 2544: | ||
| | | | ||
: Ciudad | : Ciudad | ||
− | : <span style="color:#FFFF; background:#FF0000"><b>Rechazo</b></span> Si país es “CO” y el contenido de este atributo no corresponde a uno de los valores de la columna ‘Nombre’ de la Tabla 19 (columna ‘Nombre : : : : Municipio’ del numeral 6.4.3 del Anexo Técnico) | + | : <span style="color:#FFFF; background:#FF0000"><b>Rechazo</b></span> Si país es “CO” y el contenido de este atributo no corresponde a uno de los valores de la columna ‘Nombre’ de la [[Tablas de códigos de propiedades para emisión de documentos - Indice Manual Integración Directa#Tabla 19|Tabla 19]] (columna ‘Nombre : : : : Municipio’ del numeral 6.4.3 del Anexo Técnico) |
: '''PATH''': ../cac:Address/cbc:CityName | : '''PATH''': ../cac:Address/cbc:CityName | ||
|- | |- | ||
Línea 2552: | Línea 2553: | ||
| | | | ||
: Código del departamento | : Código del departamento | ||
− | : Si pais es “CO”, codigoDepartamento debe corresponder a uno de los valores de la columna Código de la Tabla 16 | + | : Si pais es “CO”, codigoDepartamento debe corresponder a uno de los valores de la columna Código de la [[Tablas de códigos de propiedades para emisión de documentos - Indice Manual Integración Directa#Tabla 16|Tabla 16]] |
: '''Obligatorio''' para Emisores y Adquirentes Responsables | : '''Obligatorio''' para Emisores y Adquirentes Responsables | ||
: '''PATH''': ../cac:Address/cbc:CountrySubentityCode | : '''PATH''': ../cac:Address/cbc:CountrySubentityCode | ||
Línea 2570: | Línea 2571: | ||
| | | | ||
: Nombre del departamento | : Nombre del departamento | ||
− | : <span style="color:#FFFF; background:#FF0000"><b>Rechazo</b></span> Si el código del campo pais es “CO” y el contenido de este atributo no corresponde a uno de los valores de la columna Nombre de la Tabla 16 | + | : <span style="color:#FFFF; background:#FF0000"><b>Rechazo</b></span> Si el código del campo pais es “CO” y el contenido de este atributo no corresponde a uno de los valores de la columna Nombre de la [[Tablas de códigos de propiedades para emisión de documentos - Indice Manual Integración Directa#Tabla 16|Tabla 16]] |
: '''PATH''': ../cac:Address/cbc:CountrySubentity | : '''PATH''': ../cac:Address/cbc:CountrySubentity | ||
|- | |- | ||
Línea 2604: | Línea 2605: | ||
: 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]]) |
|- | |- | ||
|habitacion | |habitacion | ||
Línea 2631: | Línea 2632: | ||
: Coordenadas de la dirección | : Coordenadas de la dirección | ||
: '''PATH''': ../cac:Address/cac:LocationCoordinate | : '''PATH''': ../cac:Address/cac:LocationCoordinate | ||
− | : (ver detalle en Class.Coordenadas) | + | : (ver detalle en [[#Class.Coordenadas|Class.Coordenadas]]) |
|- | |- | ||
|municipio | |municipio | ||
Línea 2639: | Línea 2640: | ||
| | | | ||
: Código del Municipio | : Código del Municipio | ||
− | : <span style="color:#FFFF; background:#FF0000"><b>Notificación</b></span> Si el contenido de este atributo no corresponde a uno de los valores de la Tabla 19 | + | : <span style="color:#FFFF; background:#FF0000"><b>Notificación</b></span> Si el contenido de este atributo no corresponde a uno de los valores de la [[Tablas de códigos de propiedades para emisión de documentos - Indice Manual Integración Directa#Tabla 19|Tabla 19]] |
: '''PATH''': ../cbc:ID | : '''PATH''': ../cbc:ID | ||
|- | |- | ||
Línea 2713: | Línea 2714: | ||
| | | | ||
: Zona Postal | : Zona Postal | ||
− | : <span style="color:#FFFF; background:#FF0000"><b>Notificación</b></span> Si el contenido de este elemento no corresponde a un valor correspondiente de la Tabla 20 | + | : <span style="color:#FFFF; background:#FF0000"><b>Notificación</b></span> Si el contenido de este elemento no corresponde a un valor correspondiente de la [[Tablas de códigos de propiedades para emisión de documentos - Indice Manual Integración Directa#Tabla 20|Tabla 20]] |
: <span style="color:#FFFF; background:#FF0000"><b>Notificación</b></span> Si el valor del atributo codigoDepartamento es diferente a los 2 primeros dígitos del código postal. | : <span style="color:#FFFF; background:#FF0000"><b>Notificación</b></span> Si el valor del atributo codigoDepartamento es diferente a los 2 primeros dígitos del código postal. | ||
: '''PATH''': ../cac:Address/cbc:PostalZone | : '''PATH''': ../cac:Address/cbc:PostalZone | ||
Línea 2789: | Línea 2790: | ||
| | | | ||
: Identificador del tributo | : Identificador del tributo | ||
− | : <span style="color:#FFFF; background:#FF0000"><b>Rechazo</b></span> Si el contenido de este elemento no corresponde a uno de los códigos de la Tabla 11 | + | : <span style="color:#FFFF; background:#FF0000"><b>Rechazo</b></span> Si el contenido de este elemento no corresponde a uno de los códigos de la [[Tablas de códigos de propiedades para emisión de documentos - Indice Manual Integración Directa#Tabla 11|Tabla 11]] |
: '''PATH''': ../cbc:ID | : '''PATH''': ../cbc:ID | ||
|- | |- | ||
Línea 2798: | Línea 2799: | ||
| | | | ||
: 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 (ver detalle en Class.Extensible) | + | : '''PATH''': No definido (ver detalle en [[#Class.Extensible|Class.Extensible]]) |
|} | |} | ||
====Class.InformacionLegalCliente==== | ====Class.InformacionLegalCliente==== | ||
Línea 2882: | Línea 2883: | ||
: 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]]) |
|- | |- | ||
|obligaciones | |obligaciones | ||
Línea 2890: | Línea 2891: | ||
| | | | ||
: Obligaciones del adquiriente | : Obligaciones del adquiriente | ||
− | : <span style="color:#FFFF; background:#FF0000"><b>Rechazo</b></span> Si el contenido de este atributo no corresponde a uno de los valores de la Tabla 17 | + | : <span style="color:#FFFF; background:#FF0000"><b>Rechazo</b></span> Si el contenido de este atributo no corresponde a uno de los valores de la [[Tablas de códigos de propiedades para emisión de documentos - Indice Manual Integración Directa#Tabla 17|Tabla 17]] |
: '''PATH''': ../cbc:TaxLevelCode | : '''PATH''': ../cbc:TaxLevelCode | ||
|- | |- | ||
Línea 3017: | Línea 3018: | ||
: Tipos de Impuesto | : Tipos de Impuesto | ||
: '''PATH''': ../cac:PartyTaxScheme/cac:TaxScheme | : '''PATH''': ../cac:PartyTaxScheme/cac:TaxScheme | ||
− | : (ver detalle en Class.Tributos) | + | : (ver detalle en [[#Class.Tributos|Class.Tributos]]) |
|- | |- | ||
|direccionResponsableEntrega | |direccionResponsableEntrega | ||
Línea 3026: | Línea 3027: | ||
: Información de la Dirección del Responsable de Entrega | : Información de la Dirección del Responsable de Entrega | ||
: '''PATH''': ../cac:Address/cbc:PhysicalLocation | : '''PATH''': ../cac:Address/cbc:PhysicalLocation | ||
− | : (ver detalle en Class.Direccion) | + | : (ver detalle en [[#Class.Direccion|Class.Direccion]]) |
|- | |- | ||
|email | |email | ||
Línea 3043: | Línea 3044: | ||
: 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]]) |
|- | |- | ||
|indicadordeAtencion | |indicadordeAtencion | ||
Línea 3124: | Línea 3125: | ||
: Responsabilidad del Transportista | : Responsabilidad del Transportista | ||
: '''PATH''': ../cac:PartyTaxScheme/cbc:TaxLevelCode | : '''PATH''': ../cac:PartyTaxScheme/cbc:TaxLevelCode | ||
− | : (ver detalle en Class.Obligaciones) | + | : (ver detalle en [[#Class.Obligaciones|Class.Obligaciones]]) |
|- | |- | ||
|telefax | |telefax | ||
Línea 3148: | Línea 3149: | ||
| | | | ||
: Tipo de Identificación del Transportista | : Tipo de Identificación del Transportista | ||
− | : <span style="color:#FFFF; background:#FF0000"><b>Rechazo</b></span> Si el contenido de este atributo no corresponde a uno de los valores de la en Tabla 3 | + | : <span style="color:#FFFF; background:#FF0000"><b>Rechazo</b></span> Si el contenido de este atributo no corresponde a uno de los valores de la en [[Tablas de códigos de propiedades para emisión de documentos - Indice Manual Integración Directa#Tabla 3|Tabla 3]] |
: '''PATH''': ../cac:PartyTaxScheme/cbc:CompanyID/@schemeName | : '''PATH''': ../cac:PartyTaxScheme/cbc:CompanyID/@schemeName | ||
|- | |- | ||
Línea 3158: | Línea 3159: | ||
: Dirección fiscal del transportador | : Dirección fiscal del transportador | ||
: '''PATH''': ../cac:PartyLegalEntity/cac:RegistrationAddress | : '''PATH''': ../cac:PartyLegalEntity/cac:RegistrationAddress | ||
− | : (ver detalle en Class.Direccion) | + | : (ver detalle en [[#Class.Direccion|Class.Direccion]]) |
|- | |- | ||
|transportadorNombre | |transportadorNombre | ||
Línea 3207: | Línea 3208: | ||
: Código o motivo del Documento | : Código o motivo del Documento | ||
: '''Obligatorio''' Cuando codigoInterno sea ‘4’ | : '''Obligatorio''' Cuando codigoInterno sea ‘4’ | ||
− | : <span style="color:#FFFF; background:#FF0000"><b>Rechazo</b></span> Si el contenido de este atributo no corresponde a algún de los valores de | + | : <span style="color:#FFFF; background:#FF0000"><b>Rechazo</b></span> Si el contenido de este atributo no corresponde a algún de los valores de [[Tablas de códigos de propiedades para emisión de documentos - Indice Manual Integración Directa#Tabla 9|Tabla 9]] y [[Tablas de códigos de propiedades para emisión de documentos - Indice Manual Integración Directa#Tabla 10|Tabla 10]] |
: '''PATH''': ../cac:DiscrepancyResponse/cbc:ResponseCode | : '''PATH''': ../cac:DiscrepancyResponse/cbc:ResponseCode | ||
|- | |- | ||
Línea 3252: | Línea 3253: | ||
: 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 3325: | Línea 3326: | ||
: Identificador del tipo de documento referenciado | : Identificador del tipo de documento referenciado | ||
: '''Obligatorio''' Cuando codigoInterno sea ‘1’ | : '''Obligatorio''' Cuando codigoInterno sea ‘1’ | ||
− | : <span style="color:#FFFF; background:#FF0000"><b>Rechazo</b></span> Si codigoInterno igual a ‘1’ y el contenido de este atributo no corresponde a uno de los valores de la Tabla 21 | + | : <span style="color:#FFFF; background:#FF0000"><b>Rechazo</b></span> Si codigoInterno igual a ‘1’ y el contenido de este atributo no corresponde a uno de los valores de la [[Tablas de códigos de propiedades para emisión de documentos - Indice Manual Integración Directa#Tabla 21|Tabla 21]] |
: '''PATH''': No definido | : '''PATH''': No definido | ||
|} | |} | ||
Línea 3568: | Línea 3569: | ||
|tipoDocumento | |tipoDocumento | ||
|Identificador del tipo de documento de referencia | |Identificador del tipo de documento de referencia | ||
− | : Ver Tabla 1 | + | : Ver [[Tablas de códigos de propiedades para emisión de documentos - Indice Manual Integración Directa#Tabla 1|Tabla 1]] |
|- | |- | ||
|String | |String |
Revisión del 17:56 2 sep 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 |