Diferencia entre revisiones de «Web Soap Broadcast Service Methods - Direct Integration Manual Index»
(→Class.Anticipos) |
|||
Línea 503: | Línea 503: | ||
! style="background:#f2f2f2; text-align:center;"|Format | ! style="background:#f2f2f2; text-align:center;"|Format | ||
! style="background:#f2f2f2; text-align:center;"|Required | ! style="background:#f2f2f2; text-align:center;"|Required | ||
− | ! style="background:#f2f2f2; text-align:center;"| | + | ! style="background:#f2f2f2; text-align:center;"|Description |
|- | |- | ||
|extras | |extras | ||
Línea 570: | Línea 570: | ||
! style="background:#f2f2f2; text-align:center;"|Format | ! style="background:#f2f2f2; text-align:center;"|Format | ||
! style="background:#f2f2f2; text-align:center;"|Required | ! style="background:#f2f2f2; text-align:center;"|Required | ||
− | ! style="background:#f2f2f2; text-align:center;"| | + | ! style="background:#f2f2f2; text-align:center;"|Description |
|- | |- | ||
|direccion | |direccion | ||
Línea 678: | Línea 678: | ||
! style="background:#f2f2f2; text-align:center;"|Format | ! style="background:#f2f2f2; text-align:center;"|Format | ||
! style="background:#f2f2f2; text-align:center;"|Required | ! style="background:#f2f2f2; text-align:center;"|Required | ||
− | ! style="background:#f2f2f2; text-align:center;"| | + | ! style="background:#f2f2f2; text-align:center;"|Description |
|- | |- | ||
|codigo | |codigo | ||
Línea 762: | Línea 762: | ||
! style="background:#f2f2f2; text-align:center;"|Format | ! style="background:#f2f2f2; text-align:center;"|Format | ||
! style="background:#f2f2f2; text-align:center;"|Required | ! style="background:#f2f2f2; text-align:center;"|Required | ||
− | ! style="background:#f2f2f2; text-align:center;"| | + | ! style="background:#f2f2f2; text-align:center;"|Description |
|- | |- | ||
|actividadEconomicaCIIU | |actividadEconomicaCIIU | ||
Línea 973: | Línea 973: | ||
! style="background:#f2f2f2; text-align:center;"|Format | ! style="background:#f2f2f2; text-align:center;"|Format | ||
! style="background:#f2f2f2; text-align:center;"|Required | ! style="background:#f2f2f2; text-align:center;"|Required | ||
− | ! style="background:#f2f2f2; text-align:center;"| | + | ! style="background:#f2f2f2; text-align:center;"|Description |
|- | |- | ||
|codigoEvento | |codigoEvento | ||
Línea 1113: | Línea 1113: | ||
! style="background:#f2f2f2; text-align:center;"|Format | ! style="background:#f2f2f2; text-align:center;"|Format | ||
! style="background:#f2f2f2; text-align:center;"|Required | ! style="background:#f2f2f2; text-align:center;"|Required | ||
− | ! style="background:#f2f2f2; text-align:center;"| | + | ! style="background:#f2f2f2; text-align:center;"|Description |
|- | |- | ||
|cantidadPorEmpaque | |cantidadPorEmpaque | ||
Línea 1533: | Línea 1533: | ||
! style="background:#f2f2f2; text-align:center;"|Format | ! style="background:#f2f2f2; text-align:center;"|Format | ||
! style="background:#f2f2f2; text-align:center;"|Required | ! style="background:#f2f2f2; text-align:center;"|Required | ||
− | ! style="background:#f2f2f2; text-align:center;"| | + | ! style="background:#f2f2f2; text-align:center;"|Description |
|- | |- | ||
|canalDeEntrega | |canalDeEntrega | ||
Línea 1602: | Línea 1602: | ||
! style="background:#f2f2f2; text-align:center;"|Format | ! style="background:#f2f2f2; text-align:center;"|Format | ||
! style="background:#f2f2f2; text-align:center;"|Required | ! style="background:#f2f2f2; text-align:center;"|Required | ||
− | ! style="background:#f2f2f2; text-align:center;"| | + | ! style="background:#f2f2f2; text-align:center;"|Description |
|- | |- | ||
|codigoEstatusDocumento | |codigoEstatusDocumento | ||
Línea 1748: | Línea 1748: | ||
! style="background:#f2f2f2; text-align:center;"|Format | ! style="background:#f2f2f2; text-align:center;"|Format | ||
! style="background:#f2f2f2; text-align:center;"|Required | ! style="background:#f2f2f2; text-align:center;"|Required | ||
− | ! style="background:#f2f2f2; text-align:center;"| | + | ! style="background:#f2f2f2; text-align:center;"|Description |
|- | |- | ||
|datosTransportistas | |datosTransportistas | ||
Línea 1844: | Línea 1844: | ||
! style="background:#f2f2f2; text-align:center;"|Format | ! style="background:#f2f2f2; text-align:center;"|Format | ||
! style="background:#f2f2f2; text-align:center;"|Required | ! style="background:#f2f2f2; text-align:center;"|Required | ||
− | ! style="background:#f2f2f2; text-align:center;"| | + | ! style="background:#f2f2f2; text-align:center;"|Description |
|- | |- | ||
|controlInterno1 | |controlInterno1 | ||
Línea 1903: | Línea 1903: | ||
! style="background:#f2f2f2; text-align:center;"|Format | ! style="background:#f2f2f2; text-align:center;"|Format | ||
! style="background:#f2f2f2; text-align:center;"|Required | ! style="background:#f2f2f2; text-align:center;"|Required | ||
− | ! style="background:#f2f2f2; text-align:center;"| | + | ! style="background:#f2f2f2; text-align:center;"|Description |
|- | |- | ||
|controlInterno1 | |controlInterno1 | ||
Línea 1943: | Línea 1943: | ||
! style="background:#f2f2f2; text-align:center;"|Format | ! style="background:#f2f2f2; text-align:center;"|Format | ||
! style="background:#f2f2f2; text-align:center;"|Required | ! style="background:#f2f2f2; text-align:center;"|Required | ||
− | ! style="background:#f2f2f2; text-align:center;"| | + | ! style="background:#f2f2f2; text-align:center;"|Description |
|- | |- | ||
|baseImponibleTOTALImp | |baseImponibleTOTALImp | ||
Línea 2040: | Línea 2040: | ||
! style="background:#f2f2f2; text-align:center;"|Format | ! style="background:#f2f2f2; text-align:center;"|Format | ||
! style="background:#f2f2f2; text-align:center;"|Required | ! style="background:#f2f2f2; text-align:center;"|Required | ||
− | ! style="background:#f2f2f2; text-align:center;"| | + | ! style="background:#f2f2f2; text-align:center;"|Description |
|- | |- | ||
|codigoTOTALImp | |codigoTOTALImp |
Revisión del 16:29 1 mar 2022
Sumario
- 1 Web Soap Broadcast Service Methods
- 1.1 Enviar Method
- 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.1.28 Class.sectorSalud
- 1.1.29 Class.Beneficiario
- 1.1.30 Class.DatosPacientesSalud
- 1.1.31 Class.GeneralSalud
- 1.2 EstadoDocumento Method
- 1.3 EnvioCorreo Method
- 1.4 DescargaPDF Method
- 1.5 DescargaXML Method
- 1.6 FoliosRestantes Method
- 1.7 CargarCertificado Method
- 1.8 DescargarEventoXML Method
- 1.9 GenerarContenedor Method
- 1.10 GenerarEvento Method
- 1.1 Enviar Method
Web Soap Broadcast Service Methods
The parameters to be incorporated in the methods of this Web Service must comply with the format and the corresponding directives according to the following rules:
Format | Description |
---|---|
A | Alphabetic character |
N | Numeric character |
AN | AlphaNumeric character |
A|3 | 3 Alphabetic characters (fixed length) |
N|3 | 3 Numeric characters (fixed length) |
AN|3 | 3 alphaNumeric characters (fixed length) |
A|..3 | Up to 3 Alphabetic characters (variable length) |
N|..3 | Up to 3 Numeric characters (variable length) |
AN|..3 | Up to 3 alphaNumeric characters (variable length) |
N|2..6 | Between 2 and 6 Numeric characters (variable length) |
INT32 | Whole. (Maximum Value: 2,147,483,647) |
Mandatory | Description |
---|---|
YES | If it is mandatory for the DIAN |
NOT | It is not mandatory for the DIAN |
C/C | It is required where applicable (or under certain conditions by the client's business model) |
Enviar Method
The function in charge of building and sending the electronic documents to the technology provider.
- REQUEST
- Parameters to Send
Type | Identifier | Description |
---|---|---|
String | tokenEmpresa | Provided by technology provider |
tokenPassword | ||
FacturaGeneral | factura | See the detail of the Invoice Object below |
String | adjuntos |
Possible values:
|
@IMPORTANT: If the value “1” or “11” is sent in the attachments parameter, no email will be sent until the method is consumed CargarAdjuntos (ServicE Adjuntos Web SOAP). For documents that accept attachments, the fieldDestinatario.email of the client is required and the notify field must be set to “YES”.
WARNING: If options '10' or '11' are used in the attachments parameter, our platform will not generate standard graphic representation (PDF), therefore PDF is not hosted on it and the graphic representation cannot be viewed from the platform. web portal, in the notification email to the acquirer (view document section), nor download through the DescargaPDF method of the SOAP Web Broadcast Service or forward the graphical representation through the EnvioCorreo method, since it is being assumed that it has been generated locally by the billing software (ERP).
Next, the diagram of the invoice object for the billing model with prior validation is exposed, where the changes in its structure can be seen with respect to the object used in the model with post validation :
- In Blue new classes/attributes that were not present in the post validation model.
- In Yellow existing classes/attributes in the post-validation model that underwent changes in pre-validation.
- In Orange existing classes/attributes in post-validation model that are deprecated (removed) in pre-validation.
The invoice object for the billing model with prior validation is described in greater detail below:
Diagram Class.FacturaGeneral con Class.Cliente
Diagram Class.FacturaGeneral con Class.CondicionPago
Diagram Class.FacturaGeneral con Class.FacturaDetalle
Diagram Class.FacturaGeneral con Class.DocumentoReferenciado
Diagram Class.FacturaGeneral Class.EntregaMercancia
Diagram Class.FacturaGeneral con Class.Extras. Class.FacturaImpuestos, Class.ImpuestosTotales, Class.MediosDePago, Class.OrdenDeCompra y Array - informacionAdicional
Diagram Class.FacturaGeneral con Class.TasaDeCambio, Class.TasaDeCambioAlternativa y Class.TerminosEntrega
Class.FacturaGeneral
Attribute | Data Type | Format | Required | Description |
---|---|---|---|---|
anticipos | Array <Anticipos> | - | NOT |
|
autorizado | Autorizado | - | NOT |
|
cantidadDecimales | String | N|1 | YES |
|
cargosDescuentos | Array <CargosDescuentos> | - | NOT |
|
cliente | Cliente | - | YES |
|
condicionPago | Array <CondicionPago> | - | NOT |
|
consecutivoDocumento | String | AN..20 | YES |
|
detalleDeFactura | Array <FacturaDetalle> | - | YES |
|
documentosReferenciados | Array <DocumentoReferenciado> | - | C/C |
|
entregaMercancia | Entrega | - | NOT |
|
extras | Array <Extras> | - | NOT |
|
fechaEmision | String | AN|19 | YES |
|
fechaFinPeriodoFacturacion | String | AN|19 | NOT |
|
fechaInicioPeriodoFacturacion | String | AN|19 | NOT |
|
fechaPagoImpuestos | String | AN|19 | NOT |
|
fechaVencimiento | String | AN|10 | NOT |
|
impuestosGenerales | Array <FacturaImpuestos> | - | YES |
|
impuestosTotales | Array <ImpuestosTotales> | - | YES |
|
informacionAdicional | Array <String> | AN|...10000 | NOT |
|
mediosDePago | Array <MediosDePago> | - | YES |
|
moneda | String | AN|3 | YES |
|
ordenDeCompra | Array <OrdenDeCompra> | - | NOT |
|
rangoNumeracion | String | AN|20 | YES |
|
redondeoAplicado | String | Ent: N|..15
Dec: N|0..6 |
YES |
|
sectorSalud | sectorSalud | - | C/C |
|
tasaDeCambio | TasaDeCambio | - | C/C |
|
tasaDeCambioAlternativa | TasaDeCambioAlternativa | - | NOT |
|
terminosEntrega | TerminosEntrega | - | C/C |
|
tipoDocumento | String | AN|2 | YES |
|
tipoSector | String | N|| | YES |
|
tipoOperacion | String | AN|..4 | YES |
|
totalAnticipos | String | Ent: N|..15
Dec: N|0..6 |
NOT |
|
totalBaseImponible | String | Ent: N|..15
Dec: N|0..6 |
YES |
|
totalBrutoConImpuesto | String | Ent: N|..15
Dec: N|0..6 |
YES |
|
totalCargosAplicados | String | Ent: N|..15
Dec: N|0..6 |
NOT |
|
totalDescuentos | String | Ent: N|..15
Dec: N|0..6 |
NOT |
|
totalMonto | String | Ent: N|..15
Dec: N|0..6 |
YES |
|
totalProductos | String | AN|..5 | YES |
|
totalSinImpuestos | String | Ent: N|..15
Dec: N|0..6 |
YES |
|
Class.Anticipos
Attribute | Data Type | Format | Required | Description |
---|---|---|---|---|
extras | Array <Extensible> | - | NOT |
|
fechaDeRecibido | String | AN|10 | YES |
|
fechadePago | String | AN|10 | NOT |
|
horaDePago | String | AN|8 | NOT |
|
id | String | A|..150 | YES |
|
instrucciones | String | AN|15..500 | YES |
|
montoPagado | String | Ent: N|..15
Dec: N|0..6 |
YES |
|
Class.Autorizado
Attribute | Data Type | Format | Required | Description |
---|---|---|---|---|
direccion | Direccion | - | NOT |
|
String | AN|..50 | NOT |
| |
extras | Array <Extensible> | - | NOT |
|
nombreComercial | String | AN|..50 | NOT |
|
nombreContacto | String | AN|..50 | NOT |
|
nota | String | AN|..50 | NOT |
|
numeroDocumento | String | AN|..12 | YES |
|
numeroDocumentoDV | String | AN|..2 | C/C |
|
razonSocial | String | AN|..50 | NOT |
|
telefax | String | AN|..50 | NOT |
|
telefono | String | AN|..50 | NOT |
|
tipoIdentificacion | String | AN|..2 | YES |
|
Class.CargosDescuentos
Attribute | Data Type | Format | Required | Description |
---|---|---|---|---|
codigo | String | AN|2 | C/C |
|
Description | String | AN|10..5000 | YES |
|
extras | Array <Extensible> | - | NOT |
|
indicador | String | N|1 | YES |
|
monto | String | Ent: N|..15
Dec: N|0..6 |
YES |
|
montoBase | String | Ent: N|..15
Dec: N|0..6 |
YES |
|
porcentaje | String | Ent: N|..6
Dec: N|2 |
YES |
|
secuencia | String | N|..3 | YES |
|
Class.Cliente
Attribute | Data Type | Format | Required | Description |
---|---|---|---|---|
actividadEconomicaCIIU | String | AN|…4 | NOT |
|
apellido | String | AN|…50 | NOT |
|
destinatario | Array <Destinatario> | - | C/C |
|
detallesTributarios | Array <Tributos> | - | YES |
|
direccionCliente | Direccion | - | C/C |
|
direccionFiscal | Direccion | - | C/C |
|
String | AN|..50 | C/C |
| |
extras | Array <Extensible> | - | NOT |
|
informacionLegalCliente | InformacionLegalCliente | - | C/C |
|
nombreComercial | String | AN|5..450 | C/C |
|
nombreContacto | String | AN|5..450 | NOT |
|
nombreRazonSocial | String | AN|5..450 | YES |
|
nota | String | AN|..450 | NOT |
|
notificar | String | AN|2 | YES |
|
numeroDocumento | String | AN|..12 | YES |
|
numeroIdentificacionDV | String | AN|..2 | C/C |
|
responsabilidadesRut | Array <Obligaciones> | - | YES |
|
segundoNombre | String | AN|..50 | NOT |
|
telefax | String | N|..20 | NOT |
|
telefono | String | AN|..20 | NOT |
|
tipoIdentificacion | String | N|2 | YES |
|
tipoPersona | String | N|1 | YES |
|
Class.CondicionPago
Atributte | Data Type | Format | Required | Description |
---|---|---|---|---|
codigoEvento | String | AN|..3 | NOT |
|
comentario | String | AN|..50 | NOT |
|
duracionPeriodo | String | AN|..2 | NOT |
|
duracionPeriodoMedida | String | AN|..10 | NOT |
|
extras | Array <Extensible> | - | NOT |
|
fechaVencimiento | String | AN|..10 | YES |
|
identificador | String | AN|..2 | NO |
|
medioPagoAsociado | String | AN|..2 | NO |
|
monto | String | Ent: N|..15 | YES |
|
montoMulta | String | Ent: N|..15
Dec: N|0..6 |
YES |
|
montoPenalidad | String | Ent: N|..15
Dec: N|0..6 |
YES |
|
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 |
YES |
|
referenciaAnticipo | String | AN|..20 | NO |
|
Class.FacturaDetalle
Atributte | Data Type | Format | Required | Description |
---|---|---|---|---|
cantidadPorEmpaque | String | N|..3 | NO |
|
cantidadReal | String | N|..6 | YES |
|
cantidadRealUnidadMedida | String | AN|..6 | YES |
|
cantidadUnidades | String | N|..6 | YES |
|
cargosDescuentos | Array <CargosDescuentos> | - | C/C |
|
codigoFabricante | String | - | NO |
|
codigoIdentificadorPais | String | A|2 | NO |
|
codigoProducto | String | AN|..50 | YES |
|
codigoTipoPrecio | String | AN|..3 | C/C |
|
Description | String | AN|..300 | YES |
|
Description2 | String | AN|..300 | YES |
|
Description3 | String | AN|..300 | YES |
|
DescriptionTecnica | 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 > | - | YES |
|
impuestosTotales | Array <ImpuestosTotales> | - | YES |
|
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 |
YES |
|
precioVentaUnitario | String | Ent: N|..15
Dec: N|0..6 |
YES |
|
secuencia | String | AN|..4 | YES |
|
seriales | String | AN|..500 | NO |
|
subCodigoFabricante | String | AN|..50 | NO |
|
subCodigoProducto | String | AN|..50 | NO |
|
tipoAIU | String | AN|..50 | NO |
|
unidadMedida | String | AN|..3 | YES |
|
Class.Destinatario
Attribute | Data Type | Format | Required | Description |
---|---|---|---|---|
canalDeEntrega | String | - | YES |
|
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
Attribute | Data Type | Format | Required | Description |
---|---|---|---|---|
codigoEstatusDocumento | String | - | C/C | |
codigoInterno | String | N|1 | YES |
|
cufeDocReferenciado | String | AN|..90 | C/C |
|
Description | 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 | YES |
|
tipoCUFE | String | AN|..11 | C/C |
|
tipoDocumento | String | AN|..50 | NO |
|
tipoDocumentoCodigo | String | AN|2 | C/C |
|
@IMPORTANT: # To reference sales invoices when issuing a NC or ND, two objects of type DocumentsReferenced must be sent indicating the following:
- Object 1: indicating the fields codigoEstatusDocumento; internalCode = '4', documentNumber, transfer.
- Object 2: if the tipoOperacion is equal to 20 (for NC) or 30 (for ND) and codigoInterno = '5', the fields are validated: cufeDocReferenciado, date, and DocumentNumber.
- When transmitting a Contingency Invoice, an array of the ReferenceDocuments type must be sent, indicating the fields: internal code = '1', numberDocument, date, typeDocumentCode (corresponding to Contingency Invoice).
- To reference Dispatch Documents (internal code = '2') or Reception Documents (internal code = '3') the fields are validated: documentnumber and date.
Class.Entrega
Attribute | Data Type | Format | Required | Description |
---|---|---|---|---|
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
Atributte | Data Type | Format | Required | Description |
---|---|---|---|---|
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 | YES |
|
xml | String | N|1 | YES |
|
Class.Extensible
Attribute | Data Type | Format | Required | Description |
---|---|---|---|---|
controlInterno1 | String | AN|100 | C/C |
|
controlInterno2 | String | Depende del Campo | C/C |
|
nombre | String | Depende del Campo | YES |
|
valor | String | Depende del Campo | YES |
|
Class.FacturaImpuestos
Attribute | Data Type | Format | Required | Description |
---|---|---|---|---|
baseImponibleTOTALImp | String | Ent: N|..15
Dec: N|0..6 |
YES |
|
codigoTOTALImp | String | AN|2 | YES |
|
controlInterno | String | N|1 | C/C |
|
extras | Array <Extensible> | - | NO |
|
porcentajeTOTALImp | String | Ent: N|..2
Dec: N|2* |
YES |
|
unidadMedida | String | AN|..5 | YES |
|
unidadMedidaTributo | String | Ent: N|..2
Dec: N|2 |
C/C |
|
valorTOTALImp | String | Ent: N|..15
Dec: N|0..6 |
YES |
|
valorTributoUnidad | String | Ent: N|..15
Dec: N|0..6 |
C/C |
|
@IMPORTANT: In the case of the ICA and RETEICA in which the value of the percentage is based on a thousand, the value of said percentage must be reported based on a hundred, that is, if you want to report a percentage of 11.04% thousand for any of these taxes, it must be indicated in the TOTALImp percentage field as 1,104.
Class.ImpuestosTotales
Attribute | Data Type | Format | Required | Description |
---|---|---|---|---|
codigoTOTALImp | String | AN|2 | YES |
|
extras | Array <Extensible> | - | NO |
|
montoTotal | String | Ent: N|..15
Dec: N|0..6 |
YES |
|
Class.MediosDePago
Attribute | Data Type | Format | Required | Description |
---|---|---|---|---|
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 | YES |
|
metodoDePago | String | AN|..2 | YES |
|
nombreBanco | String | AN|..50 | NO |
|
numeroDeReferencia | String | AN|..200 | NO |
|
numeroDias | String | N|..3 | NO |
|
numeroTransferencia | String | AN|..20 | NO |
|
Class.OrdenDeCompra
Attribute | Data Type | Format | Required | Description |
---|---|---|---|---|
codigoCliente | String | AN|..20 | NO |
|
documentoReferencia | DocumentoReferencia | - | NO |
|
extras | Array <Extensible> | - | NO |
|
fecha | String | AN|10 | NO |
|
numeroOrden | String | AN|..20 | YES |
|
numeroPedido | String | AN|..20 | C/C |
|
tipoCUFE | String | AN|..20 | NO |
|
tipoOrden | String | AN|..20 | NO |
|
uuid | String | AN|..90 | NO |
|
NOTE: As it is a delivery order, the OrdemDeCompra class must be informed, if it is necessary to indicate more than one order, it must be informed through the DocumentReferenced class with codigoInterno ='1 ', this in order to send the information referring to them in the AdditionalDocumentReference group.
Class.TasaDeCambio
Attribute | Data Type | Format | Required | Description |
---|---|---|---|---|
baseMonedaDestino | String | Ent: N|..15
Dec: N|0..6 |
YES |
|
baseMonedaOrigen | String | Ent: N|..15
Dec: N|0..6 |
YES |
|
extras | Array <Extensible> | - | NO |
|
fechaDeTasaDeCambio | String | AN|10 | YES |
|
indicadorDeTasa | String | - | NO |
|
monedaDestino | String | AN|3 | YES |
|
monedaOrigen | String | AN|3 | YES |
PATH: ../cbc:SourceCurrencyCode |
operadorCalculo | String | - | NO |
|
tasaDeCambio | String | Ent: N|..15
Dec: N|0..6 |
YES |
|
Class.TasaDeCambioAlternativa
Attribute | Data Type | Format | Required | Description |
---|---|---|---|---|
baseMonedaDestino | String | Ent: N|..15
Dec: N|0..6 |
SI |
|
baseMonedaOrigen | String | Ent: N|..15
Dec: N|0..6 |
YES |
|
extras | Array <Extensible> | - | NO |
|
fechaDeTasaDeCambio | String | AN|10 | YES |
|
indicadorDeTasa | String | - | NO |
|
monedaDestino | String | AN|3 | YES |
|
monedaOrigen | String | AN|3 | YES |
|
operadorCalculo | String | - | NO |
|
tasaDeCambio | String | Ent: N|..15
Dec: N|0..6 |
YES |
|
Class.TerminosEntrega
Attribute | Dato Type | Format | Required | Description |
---|---|---|---|---|
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
Attribute | Data Type | Format | Required | Description |
---|---|---|---|---|
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 | YES |
|
codigoDepartamento | String | AN|…5 | YES |
|
correccionHusoHorario | String | AN|6 | NO |
|
departamento | String | AN|…50 | YES |
|
departamentoOrg | String | AN|..50 | NO |
|
direccion | String | AN|…100 | YES |
|
distrito | String | AN|..50 | NO |
|
extras | Array <Extensible> | - | NO |
|
habitacion | String | AN|..50 | NO |
|
lenguaje | String | A|2 ISO 639-1 | YES |
|
localizacion | Array <Coordenadas> | AN|..50 | NO |
|
municipio | String | AN|..50 | YES |
|
nombreEdificio | String | AN|..50 | NO |
|
numeroEdificio | String | AN|..50 | NO |
|
numeroParcela | String | AN|..50 | NO |
|
pais | String | A|2 | YES |
|
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
Attribute | Dato Type | Format | Required | Description |
---|---|---|---|---|
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
Atribute | Data Type | Format | Required | Description |
---|---|---|---|---|
codigoImpuesto | String | AN|2 | SI |
|
extras | Array <Extensible> | - | NO |
|
Class.InformacionLegalCliente
Attribute | Dato Type | Format | Required | Description |
---|---|---|---|---|
codigoEstablecimiento | String | - | NO |
|
nombreRegistroRUT | String | AN|..450 | YES |
|
numeroIdentificacion | String | AN|..12 | YES |
|
numeroIdentificacionDV | String | N|..2 | C/C |
|
numeroMatriculaMercantil | String | N|9 | NO |
|
prefijoFacturacion | String | - | NO |
|
tipoIdentificacion | String | N|2 | YES |
|
Class.Obligaciones
Attribute | Data Type | Format | Required | Description |
---|---|---|---|---|
extras | Array <Extensible> | - | NO |
|
obligaciones | String | AN|7 | YES |
|
regimen | String | AN|2 | NO |
|
Class.LineaInformacionAdicional
Attribute | Data Type | Format | Required | Description |
---|---|---|---|---|
cantidad | String | AN|..5 | NO |
|
codigo | String | AN|..5 | NO |
|
codigoInterno1 | String | - | NO |
|
codigoInterno2 | String | - | NO |
|
Description | 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
Attribute | Data Type | Format | Requerido | Description |
---|---|---|---|---|
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
Attribute | Data Type | Format | Required | Description |
---|---|---|---|---|
codigoEstatusDocumento | String | - | C/C | |
codigoInterno | String | N|1 | YES |
|
cufeDocReferenciado | String | AN|..90 | C/C |
|
Description | 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 |
|
@IMPORTANT:
- To reference sales invoices when issuing a NC or ND, two objects of type DocumentosReferenciados must be sent indicating the following:
- Object 1: indicating the fields codigoEstatusDocumento; CodihoInterno = '4', numeroDocumento, Description.
- Object 2: if the tipoOperacion is equal to 20 (for NC) or 30 (for ND) and codigoInterno = '5', the fields are validated: cufeDocReferenciado, date, and DocumentNumber.
- When transmitting a Factura de Contingencia , an array of the documentosReferenciados type must be sent, indicating the fields: internal code = '1', numberDocument, date, tipoDocumentCode (corresponding to Contingenc Invoice).
- To reference Dispatch Documents (internal code = '2') or Reception Documents (internal code = '3') the fields are validated: documentnumber and date.
Class.sectorSalud
Attribute | Data Type | Format | Required | Description |
---|---|---|---|---|
Beneficiario | Beneficiario | - | C/C |
|
extras | Array <Extras> | - | NO |
|
IdPersonalizacion | String | Por definir | C/C |
|
Pacientes | Array <DatosPacienteSalud> | - | C/C | For the report of the additional data fields of the Health Sector
|
TipoEscenario | String | N|1 | YES |
|
NOTE: The issuance of health sector documents is only available through version 4 of the issuance service.
Class.Beneficiario
Attribute | Data Type | Format | Required | Description |
---|---|---|---|---|
DireccionResidencia | Direccion | - | C/C |
|
TipoIdentificacion | Array <GeneralSalud> | - | C/C |
|
Class.DatosPacientesSalud
Attribute | Data Type | Format | Required | Description |
---|---|---|---|---|
CamposGenerales | Array <GeneralSalud> | - | C/C |
|
TipoIdentificacion | Array <GeneralSalud> | - | C/C |
|
Class.GeneralSalud
Attribute | Data Type | Format | Required | Description |
---|---|---|---|---|
nombre | String | ..2 | Si |
|
valor | String | depends on the field | Yes |
|
Important: In the case of the field rangoNumeracion, this value must always have the following format (Pefijo-campoDesde), that is, said field is independent of the sequential mode configured in the portal (manual with prefix or manual without prefix).
In the case of the field consecutivoDocumento, This field does depend on the sequential mode configured in the web portal.
- If the assigned modality is“manual sin prefijo”, the values for the fields rangoNumeracion and consecutivoDocumento’ They should be for example:
- Invoice #1: rangoNumeracion= "PRUE-1", consecutivoDocumento= "1"
- Invoice #2: rangeNumeracion= "PRUE-1", consecutiveDocument= "2"
- ...
- Invoice #1000: rangoNumeracion= "PRUE-1", consecutivoDocumento= "1000"
- If the assigned modality is “manual with prefix”, the values for the fields rangoNumeracion and consecutivoDocumento must be, for example:
- Invoice #1: rangeNumeracion= "PRUE-1", consecutiveDocument= "PRUE1"
- Invoice #2: rangoNumeracion= "PRUE-1", consecutivoDocumento= "PRUE2"
- ...
- Invoice #1000: rangeNumeracion= "PRUE-1", consecutivoDocumento= "PRUE1000"
- RESPONSE
- Parameters to Receive
Type | ID | Description |
---|---|---|
int | codigo | Indicates the status of the operation returned by the service, (to define catalog) |
String | consecutivoDocumento | Prefix and Consecutive of the Concatenated Document without separators. For the example above it corresponds to: “PRUE980338337” |
String | cufe | "Unique Electronic Invoice Code" corresponding to the document consulted. |
Bool | esValidoDian | “true” if valid |
String | fechaAceptacionDIAN | Day and time in which the DIAN accepted the electronic document, in YYYY-MM-DD HH:MM:SS format |
String | fechaRespuesta | Day and time in which the electronic document was generated, in format AAAA-MM-DD HH:MM:SS |
String | hash | Error detection code |
String | mensaje | This message is associated with the response code, useful for error identification |
Array | mensajesValidacion | Validation messages in case of notification or rejection |
String | nombre | Name defined by the DIAN |
String | qr | QR code string concatenation (control element) |
Array | reglasNotificacionDIAN | Validation rules in case of notification |
Array | reglasValidacionDIAN | Validation rules in case of rejection |
String | resultado | Method consumption result: Processed” or “Error” |
String | tipoCufe | CUFE type algorithm. “CUFE-SHA384” or “CUDE-SHA384” |
String | xml | XML file (type AttachedDocument) encoded in Base64 |
Once the electronic invoice has been sent successfully (code '200' or '201' in the response), the attached files are sent (through the methodCargarAdjuntos) consuming the SOAP Web Attachments Service, in the scenario that the attachments parameter has been assigned to “1” or “11”, otherwise the SOAP Web Attachments Service will return an error indicating that the document does NOT support attachments.
EstadoDocumento Method
It allows you to consult the status of the document indicated before the Acquirer, before the DIAN, the type of delivery and if it was successful, the list of associated events (ApplicationResponse) and other parameters of interest that can be useful in the software control processes billing (ERP) or for the business model of the issuing client.
- REQUEST
- Parameters to Send
Type | Identifier | Description |
---|---|---|
String | tokenEmpresa | Supplied by The Factory HKA Colombia |
tokenPassword | ||
Documento | Prefix and Consecutive of the electronic Document concatenated without separators. Example “PRUE980338212 |
- RESPONSE
- Parameters to Receive
Typr | Identifier | Description |
---|---|---|
Bool | aceptacionFisica | Indicates if the document has physical acceptance (physically delivered): “true” or “false” |
String | acuseComentario | Comment informed by the acquirer when making the acknowledgment |
String | acuseEstatus | 0: Acknowledgment not made ; 1: Acknowledgment made |
String | acuseResponsable | Email of the person responsible for making the acknowledgment |
String | acuseRespuesta | 0: Response not sent; 1: Reply Sent |
String | ambiente | Type of document generation environment:
|
String | cadenaCodigoQR | QR code string concatenation (control element) |
String | cadenaCufe | Chain concatenation of the CUFE code prior to calculation by the corresponding algorithm of the service |
int | Codigo | Indicates the status of the operation returned by the service |
String | consecutivo | Consecutive Document TFHKA/DIAN |
String | cufe | "Unique Code of Electronic Invoice" corresponding to the document consulted, calculated by the corresponding algorithm of the service |
String | DescriptionDocumento | Reference document type identifier,
|
String | DescriptionEstatusDocumento | Description corresponding to the statusDocument before the DIAN: "Processed Correctly" |
String | entregaMetodoDIAN | Indicates the delivery method to the DIAN
|
Bool | esValidoDIAN |
|
String | estatusDocumento | Code obtained in the response corresponding to the status of the document before the DIAN (Catalogue to be defined) |
Array <Evento> | eventos | List of Electronic Document events |
String | fechaAceptacionDIAN | Day and time in which the DIAN accepted the electronic document, in format AAAA-MM-DD HH:MM:SS |
String | fechaDocumento | Date on which the document was generated, in format: AAAA-MM-DD |
Array <HistorialDeEntregas> | historialDeEntregas | History of document deliveries |
String | mensaje | This message is associated with the code, useful for identifying errors |
String | mensajeDocumento | Provides a description of the error of each of the initial validations. If there are no errors, no description is provided. |
Bool | poseeAdjuntos | Indicates if the document has attachments:
|
Bool | poseeRepresentacionGrafica | Indicates if the document has a graphic representation:
|
Array <String> | reglasValidacionDIAN | Validation messages by the DIAN |
String | resultado | Result of method consumption:
|
String | tipoCufe | Algorithm used to calculate CUFE:
|
String | tipoDocumento | Reference document type identifier
|
String | trackID | This element corresponds to the TrackId of the processed document |
Where Class.Evento contains the following information:
Type | identifier | Description |
---|---|---|
String | ambienteDIAN | Generation environment in the DIAN
|
String | codigo | Code the document of the Application Response (event) |
String | comentario | event commentary |
String | cufe | CUFE of the electronic document |
String | DescriptionEvento | Description of use/source of the event |
String | emisorNumeroDocumento | Issuer Identification Number |
String | emisorNumeroDocumentoDV | Issuer Document Number Check Digit |
String | emisorRazonSocial | Company Name of the Issuer |
String | emisorTipoIdentificacion | Issuer Identification Type |
Array <ExtrasEvento> | extras | Extra information corresponding to the event |
String | fechaEmision | Date of Issue of the Application Response (event) |
String | fechaRecepcion | Application Response Reception Date (event) |
String | hash | Application Response document hash |
String | idPerfilDIAN | DIAN Profile |
String | mensaje | ApplicationResponse description message |
String | nombreArchivoXML | XML file name |
String | nota | Content of the Note field of the Application Response |
String | numeroDelEvento | Consecutive Application Response |
String | receptorNumeroDocumento | Receiver Identification Number |
String | receptorNumeroDocumentoDV | Receiver Document Number Check Digit |
String | receptorRazonSocial | Receiver's Business Name |
String | receptorTipoIdentificacion | Receiver Identification Type |
String | resultado | Result of method consumption:
|
String | tipoCufe | Algorithm used to calculate CUDE of the event:
|
String | tipoEvento | Event type identifier:
|
String | versionUBL | UBL version of the XML |
And Class.ExtrasEvento contains the following information:
Type | Identifier | Description |
---|---|---|
String | codigoInterno1 | Hashtag |
String | codigoInterno2 | Additional Description |
String | nombre | Additional Description |
String | valor | Información Adicional |
Class.HistorialDeEntregas will correspond to:
Type | Identifier | Description |
---|---|---|
String | LeidoEmailIPAddress | IP address of the computer in which the acknowledgment of the notification mail was made |
String | LeidoEstatus | Notification mail acknowledgment status |
String | LeidoFecha | Date of acknowledgment of notification mail |
String | canalDeEntrega | Electronic document delivery channel |
Array <String> | Email of the recipient of the electronic document | |
String | entregaEstatus | Delivery status:
|
String | entregaEstatusDescription | Delivery Status Description |
String | entregaFecha | Document delivery date |
String | fechaProgramada | Delivery Date |
String | mensajePersonalizado | Personalized message to be delivered by Email, WhatsApp or Telegram |
String | nitProveedorReceptor | NIT of the receiving Technological Provider, in case of delivery by Interoperability |
String | recepcionEmailComentario | Customer Acknowledgment Comment |
String | recepcionEmailEstatus | E-mail reception status
|
String | recepcionEmailFecha | Date of receipt of the Email |
String | recepcionEmailIPAddress | Email receiving IP address |
String | telefono | For delivery by Whatsapp/Telegram |
@Important: The structure of this Response may still be subject to change in a future update.
EnvioCorreo Method
Allows you to forward the indicated document to one or more email addresses.
- REQUEST
- Parameters to Send
Type | Identifier | Description |
---|---|---|
String | tokenEmpresa | Supplied by The Factory HKA Colombia |
tokenPassword | ||
Documento | Prefix and consecutive of the Electronic Document concatenated without separators. Example “PRUE980338212”. Allows sending multiple recipients (maximum 5) separated by a comma character ',' | |
correo | Email to which the document will be sent. Example name@company.com | |
adjuntos |
|
- RESPONSE
- Parameters to Receive
Type | Identifier | Description |
---|---|---|
int | codigo | Indicates the status of the operation returned by the service |
String | mensaje | This message is associated with the code, useful for identifying errors |
resultado | Result of method consumption:
|
@Important: If during the issuance of the document (Send method) the attachments parameter was set to “10” or “11”, The Factory HKA - DFACTURE platform does not will generate standard graphical representation (PDF), therefore only the documents hosted on the platform (AttachedDocument) will be forwarded to the recipients. To forward the mail (with the AttachedDocument and attachments) to an email address different from the one used during the transmission, the CargarAtjuntos method of the SOAP Web Attachments Service can be used again.
DescargaPDF Method
Allows you to download the standard graphic representation (PDF generated by TFHKA) of the document for local storage, local consultation or reprint purposes.
- REQUEST
- Parameters to Send
Type | Identifier | Description |
---|---|---|
String | tokenEmpresa | Supplied by The Factory HKA Colombia |
tokenPassword | ||
documento | prefix and consecutive of the Electronic Document concatenated without separators. Example “PRUE980338212” |
- RESPONSE
- Parameters to Receive
Type | Identifier | Description |
---|---|---|
int | codigo | Indicates the status of the operation returned by the service |
String | cufe | “Unique Electronic Invoice Code” corresponding to the document consulted. |
String | documento | Base64 encoded PDF document |
String | hash | Error detection code |
String | mensaje | This message is associated with the code, useful for identifying errors |
String | resultado | Result of method consumption:
|
@Important: If during the issuance of the document (Enviar method) the adjuntos parameter was set to “10” or “11”, The Factory HKA - DFACTURE platform will not will generate standard graphic representation (PDF), therefore this method cannot be used since the service will throw an error indicating that there is NO associated PDF, since it is assumed that the graphic representation has been generated locally by the billing software (ERP).
DescargaXML Method
It allows the download of the XML document (only the electronic document Invoice, CreditNote and DebitNote), in case it is required to validate the information such as the signature or its authenticity or for the purpose of local management and storage.
- REQUEST
- Parameters to Send
Type | Identifier | Description |
---|---|---|
String | tokenEmpresa | Supplied by The Factory HKA Colombia |
tokenPassword | ||
Documento | Prefix and Consecutive of the electronic Document concatenated without separators. Example “PRUE980338212 |
- RESPONSE
- Parameters to Receive
Type | Identifier | Description |
---|---|---|
int | codigo | Indicates the status of the operation returned by the service |
String | cufe | “Unique Electronic Invoice Code” corresponding to the document consulted |
String | documento | XML document (Invoice, CreditNote or DebitNote) encoded in Base64 |
String | hash | Error detection code |
String | mensaje | This message is associated with the code, useful for identifying errors |
String | resultado | Result of method consumption:
|
FoliosRestantes Method
Allows you to consult the stamps (transactions) available. The stamps are consumed in proportion to the transactions made.
- REQUEST
- Parameters to Send
Type | Identifier | Description |
---|---|---|
String | tokenEmpresa | Supplied by The Factory HKA Colombia |
tokenPassword |
- RESPONSE
- Parameters to Receive
Type | Identifier | Description |
---|---|---|
int | codigo | Indicates the status of the operation returned by the service |
int | foliosRestantes | Number of sheets available |
String | mensaje | This message is associated with the code, useful for identifying errors |
String | resultado | Result of method consumption:
|
CargarCertificado Method
For now, this method will only be used internally by The Factory HKA Colombia.
DescargarEventoXML Method
It allows downloading an event or occurrence (ApplicationResponse) related to an Electronic Document (Invoice, CreditNote or DebitNote), generated by a person or entity related to this document (DIAN, Issuer, Acquirer).
- REQUEST
- Parameters to Send
Type | Identifier | Description |
---|---|---|
String | tokenEmpresa | Supplied by The Factory HKA Colombia |
tokenPassword | ||
documentoEvento | Consecutive of the event (ApplicationResponse) | |
Documento | Prefix and Consecutive of the electronic Document concatenated without separators. Example “PRUE980338212 |
- RESPONSE
- Parameters to Receive
Type | Identifier | Description |
---|---|---|
int | Código | Indicates the status of the operation returned by the service |
String | Cufe | Event CUFE (ApplicationResponse) |
String | Documento | XML document (ApplicationResponse) encoded in Base64 |
String | fechaRespuesta | Date and Time consumption of the method, format: AAAA-MM-DD HH:MM:SS |
String | Hash | Error detection code |
String | Mensaje | This message is associated with the code, useful for error identification. |
String | Resultado | Result of method consumption:
|
String | tipoCufe | Algorithm used to calculate CUFE:
|
GenerarContenedor Method
UA container is a type of AttachedDocument document, its structure is intended to contain and transmit an electronic document (Invoice, CreditNote or DebitNote) and all the events (ApplicationResponse) generated to date in a single XML file.
- REQUEST
- Parameters to Send
Type | Identifier | Description |
---|---|---|
String | tokenEmpresa | Supplied by The Factory HKA Colombia |
tokenPassword | ||
Documento | Prefix and Consecutive of the electronic Document concatenated without separators. Example “PRUE980338212 |
- RESPONSE
- Parameters to Receive
Type | Identifier | Description |
---|---|---|
int | Código | Indicates the status of the operation returned by the service |
String | Contenedor | XML document (AttachedDocument) encoded in Base64 |
String | Fecha | Date and Time consumption of the method, format: AAAA-MM-DD HH:MM:SS |
String | Hash | Error detection code |
String | Mensaje | This message is associated with the code, useful for error identification. |
String | Resultado | Result of method consumption:
|
GenerarEvento Method
Allows the generation of an event or occurrence (ApplicationResponse) associated with an Electronic Document (Invoice, CreditNote or DebitNote), generated by a person or entity related to this document (DIAN, Issuer, Acquirer).
- REQUEST
- Parameters to Send
Type | Identifier | Description |
---|---|---|
String | tokenEmpresa | Supplied by The Factory HKA Colombia |
tokenPassword | ||
DatosEvento | datosEvento | Object with the data of the event (ApplicationResponse) to generate |
Where Class.DatosEvento contains the following information:
Type | Identifier | Description |
---|---|---|
String | codigoEvento | Indicates the code of the event (to define catalog) |
String | codigoInterno1 | Hashtag |
String | codigoInterno2 | Additional Description |
String | Comentario | Comment or description of the event |
String | Documento | Prefix and consecutive of the Electronic Document concatenated without separators. Example “PRUE980338212” |
Array <ExtrasEvento> | Extras | Additional event information |
Where Class.ExtrasEvento contains the following information:
Type | Identifier | Description |
---|---|---|
String | codigoInterno1 | Hashtag |
String | codigoInterno2 | Additional Description |
String | Nombre Código | of the field |
String | valor | Additional Information |
- RESPONSE
- Parameters to Receive
Type | Identifier | Description |
---|---|---|
int | Código | Indicates the status of the operation returned by the service |
String | consecutivoDocumentoEvento | Consecutive of the event (ApplicationResponse) |
String | Cufe | Event CUFE (ApplicationResponse) |
String | fechaRespuesta | Date and Time consumption of the method, format: AAAA-MM-DD HH:MM:SS |
String | Hash | Error detection code |
String | Mensaje | This message is associated with the code, useful for error identification. |
String | Resultado | Result of method consumption:
|
String | tipoCufe | Algorithm used to calculate CUFE:
|
String | Xml | XML document (ApplicationResponse) encoded in Base64 |