tfhkacolwiki - Contribuciones del usuario [es]

Sección para clientes de Integración

2026-04-27T21:04:29Z

Dmrodriguez2:

{| style="width:100%; border:1px solid #d0d7e1; border-radius:10px; background-color:#ffffff; box-shadow:0 1px 3px rgba(0,0,0,0.08);"
|-
| style="vertical-align:top; padding:20px;" |

<div style="font-size:1.9em; font-weight:bold; color:#003366;">
Integración – The Factory HKA Colombia
</div>

<div style="font-size:1.05em; color:#444; line-height:1.6; margin-bottom:15px;">
Bienvenido a Integración de The Factory HKA Colombia, el espacio diseñado para brindar una experiencia técnica clara, eficiente y centralizada para nuestros clientes y aliados.
 
Aquí encontrará la documentación completa para la integración de los servicios de Factura Electrónica, Nómina Electrónica, Recepción Electrónica y Documentos Equivalentes, incluyendo manuales, APIs, herramientas y recomendaciones para el cumplimiento de las resoluciones DIAN vigentes.
</div>

<div style="background:linear-gradient(90deg, #0073e6 0%, #0099ff 100%); color:#fff; padding:12px 18px; border-radius:6px; font-weight:bold; font-size:1.05em;">
Acceso rápido: Consulte las secciones de pasos de integración, canales de comunicación y ejemplos de APIs según su tipo de documento electrónico.
</div>

| style="width:140px; text-align:center; vertical-align:middle; background-color:#f7f9fc; border-left:1px solid #e0e6ef; padding:15px;" |
[[Archivo:Tfhka-co.png|140px|center|sinmarco]]
|}

{| style="width:100%; border:none; background-color:#ffffff; padding:2px;"
|-
| style="vertical-align:top; padding:18px 5px;" |

<div style="font-size:1.7em; font-weight:bold; color:#003366; margin-bottom:8px;">
¿Qué hacemos?
</div>

<div style="font-size:1.05em; color:#444; line-height:1.6; margin-bottom:15px;">
En The Factory HKA Colombia ofrecemos soluciones tecnológicas que optimizan la emisión, recepción y gestión de documentos electrónicos requeridos por la DIAN.
Nuestros servicios web (APIs) están orientados a empresas, desarrolladores y casas de software que buscan integraciones seguras, escalables y de alta disponibilidad.
</div>

<div style="background-color:#f4f9fc; border-left:6px solid #0073e6; border-radius:4px; padding:12px; color:#003366; font-size:1.05em; margin-bottom:15px;">
Servicios principales: 
• Facturación Electrónica con validación previa ante la DIAN. 
• Nómina Electrónica con soporte para documentos individuales y masivos. 
• Recepción de Documentos Electrónicos con trazabilidad y respuesta. 
• Emisión de Documentos Equivalentes conforme a la Resolución 000165 del 2023.
</div>
<div style="font-size:1.7em; font-weight:bold; color:#003366; margin-top:25px; margin-bottom:10px;">
¿Cómo contactarnos?
</div>

<div style="font-size:1.05em; color:#444; line-height:1.6; margin-bottom:15px;">
Si necesita soporte técnico o acompañamiento durante su proceso de integración, puede comunicarse a través de los siguientes canales:
</div>

<table style="width:100%; border-collapse:collapse; font-size:1.02em; color:#333;">
<tr style="background-color:#eef4fb; text-align:left;">
<th style="padding:8px; border:1px solid #5a6a7a; width:25%;">Canal</th>
<th style="padding:8px; border:1px solid #5a6a7a;">Información de contacto</th>
</tr>
<tr>
<td style="padding:8px; border:1px solid #5a6a7a;">
[[File:icono-correo-electronico.png|20px]] Correo electrónico
</td>
<td style="padding:8px; border:1px solid #5a6a7a;">integracion_fel_co@thefactoryhka.com</td>
</tr>
<tr style="background-color:#f8fafd;">
<td style="padding:8px; border:1px solid #5a6a7a;">
[[File:icono-telefono.png|20px]] Teléfonos
</td>
<td style="padding:8px; border:1px solid #5a6a7a;">Opción 5, luego Opción 1 
+57 317 668 7663 | +57 (601) 390 95 39 </td>
</tr>
<tr>
<td style="padding:8px; border:1px solid #5a6a7a;">
[[File:icono-whatsapp.png|20px]] WhatsApp
</td>
<td style="padding:8px; border:1px solid #5a6a7a;">Escríbanos al canal de soporte técnico https://wa.me/573163192251</td>
</tr>
<tr style="background-color:#f8fafd;">
<td style="padding:8px; border:1px solid #5a6a7a;">
[[File:icono-sesiones-grupales.png|20px]] Sesiones grupales de integración
</td>
<td style="padding:8px; border:1px solid #5a6a7a;">Martes y jueves de 08:30 a.m. a 10:00 a.m. (hora Colombia). https://meet.google.com/jeo-jfvj-ckd</td>
</tr>
</table>

<div style="font-size:1.7em; font-weight:bold; color:#003366; margin-top:25px; margin-bottom:10px;">
Principales métodos o APIs por producto
</div>

<div style="font-size:1.02em; color:#444; line-height:1.6; margin-bottom:10px;">
La siguiente tabla presenta los métodos principales de integración por producto.
Cada servicio dispone de endpoints para emisión, validación, consulta, descarga y gestión de documentos conforme a los estándares DIAN.
</div>

{| style="width:100%; border:none; margin-bottom:25px;"
|-
| style="width:49%; vertical-align:top; padding-right:15px; border:none;" |
<div style="font-size:1.5em; font-weight:bold; color:#003366; margin-bottom:15px;">Factura Electrónica - SOAP</div>
{| class="wikitable" style="width:100%; border-collapse:collapse; font-size:0.95em; color:#333; border:1px solid #5a6a7a;"
|-
! style="background-color:#003366; color:#fff; text-align:left; padding:8px;" | Producto
! style="background-color:#003366; color:#fff; text-align:left; padding:8px;" | Servicio
! style="background-color:#003366; color:#fff; text-align:left; padding:8px;" | Descripción
|-
| style="padding:8px; border:1px solid #5a6a7a;" | FEL
| SOAP
|
'''FacturaElectronica - Enviar'''. Envío y validación ante la DIAN, con verificación de requisitos técnicos y legales. '''Entornos:''' Demo / Producción
|-
| style="background-color:#f8fafd; padding:8px; border:1px solid #5a6a7a;" | FEL
| SOAP
|
'''FacturaElectronica - EstadoDocumento'''. Consulta en tiempo real del estado y validación ante la DIAN.
|-
| style="padding:8px; border:1px solid #5a6a7a;" | FEL
| SOAP
|
'''FacturaElectronica - DescargaPDF'''. Generación automática del PDF conforme a estándares DIAN.
|-
| style="background-color:#f8fafd; padding:8px; border:1px solid #5a6a7a;" | FEL
| SOAP
|
'''FacturaElectronica - EnvioCorreo'''. Distribución automatizada a clientes con PDF y XML.
|}
| style="width:49%; vertical-align:top; padding-left:15px; border:none;" |
<div style="font-size:1.5em; font-weight:bold; color:#003366; margin-bottom:15px;">Factura Electrónica - REST</div>
{| class="wikitable" style="width:100%; border-collapse:collapse; font-size:0.95em; color:#333; border:1px solid #5a6a7a;"
|-
! style="background-color:#003366; color:#fff; text-align:left; padding:8px;" | Producto
! style="background-color:#003366; color:#fff; text-align:left; padding:8px;" | Servicio
! style="background-color:#003366; color:#fff; text-align:left; padding:8px;" | Descripción
! style="background-color:#003366; color:#fff; text-align:left; padding:8px;" | Método
|-
| style="padding:8px; border:1px solid #5a6a7a;" | FEL
| REST
|
'''Api/documentos/enviar'''. Envío y validación ante la DIAN, con verificación de requisitos técnicos y legales. '''Entornos:''' Demo / Producción
| POST
|-
| style="background-color:#f8fafd; padding:8px; border:1px solid #5a6a7a;" | FEL
| REST
|
'''Api/documentos/EstadoDocumento'''. Consulta en tiempo real del estado y validación ante la DIAN.
| GET
|-
| style="padding:8px; border:1px solid #5a6a7a;" | FEL
| REST
|
'''Api/documentos/DescargaPDF'''. Generación automática del PDF conforme a estándares DIAN.
| GET
|-
| style="background-color:#f8fafd; padding:8px; border:1px solid #5a6a7a;" | FEL
| REST
|
'''FacturaElectronica - EnvioCorreo'''. Distribución automatizada a clientes con PDF y XML.
| POST
|}
|}

{| style="width:100%; border:none; margin-bottom:25px;"
|-
| style="width:49%; vertical-align:top; padding-right:15px; border:none;" |
<div style="font-size:1.5em; font-weight:bold; color:#003366; margin-bottom:15px;">Nómina Electrónica - SOAP</div>
{| class="wikitable" style="width:100%; border-collapse:collapse; font-size:0.95em; color:#333; border:1px solid #5a6a7a;"
|-
! style="background-color:#003366; color:#fff; text-align:left; padding:8px;" | Producto
! style="background-color:#003366; color:#fff; text-align:left; padding:8px;" | Servicio
! style="background-color:#003366; color:#fff; text-align:left; padding:8px;" | Descripción
|-
| style="padding:8px; border:1px solid #5a6a7a;" | Nomina
| SOAP
|
'''NominaElectronica - Enviar''' 
Procesamiento de nóminas electrónicas individuales o masivas conforme a requisitos DIAN. 
'''Entornos:''' Demo / Producción
|-
| style="background-color:#f8fafd; padding:8px; border:1px solid #5a6a7a;" | Nomina
| SOAP
|
'''NominaElectronica - ConsultarDocumento''' 
Consulta del estado de tramitación y validación de nóminas electrónicas.
|-
| style="padding:8px; border:1px solid #5a6a7a;" | Nomina
| SOAP
|
'''NominaElectronica - EnviarCorreo''' 
Envío automatizado de nóminas electrónicas a los colaboradores con sus representaciones gráficas.
|-
| style="background-color:#f8fafd; padding:8px; border:1px solid #5a6a7a;" | Nomina
| SOAP
|
'''NominaElectronica - ConsultarFolios''' 
Consulta y gestión de numeración autorizada por la DIAN para emisión de nóminas.
|}
| style="width:49%; vertical-align:top; padding-left:15px; border:none;" |
<div style="font-size:1.5em; font-weight:bold; color:#003366; margin-bottom:15px;">Nómina Electrónica - REST</div>
{| class="wikitable" style="width:100%; border-collapse:collapse; font-size:0.95em; color:#333; border:1px solid #5a6a7a;"
|-
! style="background-color:#003366; color:#fff; text-align:left; padding:8px;" | Producto
! style="background-color:#003366; color:#fff; text-align:left; padding:8px;" | Servicio
! style="background-color:#003366; color:#fff; text-align:left; padding:8px;" | Descripción
! style="background-color:#003366; color:#fff; text-align:left; padding:8px;" | Método
|-
| style="padding:8px; border:1px solid #5a6a7a;" | Nomina
| REST
|
'''Api/documentos/Enviar''' 
Procesamiento de nóminas electrónicas individuales o masivas conforme a requisitos DIAN. 
'''Entornos:''' Demo / Producción
| POST
|-
| style="background-color:#f8fafd; padding:8px; border:1px solid #5a6a7a;" | Nomina
| REST
|
'''Api/documentos/ConsultarDocumento''' 
Consulta del estado de tramitación y validación de nóminas electrónicas.
| GET
|-
| style="padding:8px; border:1px solid #5a6a7a;" | Nomina
| REST
|
'''Api/documentos/EnviarCorreo''' 
Envío automatizado de nóminas electrónicas a los colaboradores con sus representaciones gráficas.
| POST
|-
| style="background-color:#f8fafd; padding:8px; border:1px solid #5a6a7a;" | Nomina
| REST
|
'''Api/documentos/ConsultarFolios''' 
Consulta y gestión de numeración autorizada por la DIAN para emisión de nóminas.
| GET
|}
|}

{| style="width:100%; border:none; margin-bottom:25px;"
|-
| style="width:49%; vertical-align:top; padding-right:15px; border:none;" |
<div style="font-size:1.5em; font-weight:bold; color:#003366; margin-bottom:15px;">Recepción Electrónica</div>
{| class="wikitable" style="width:100%; border-collapse:collapse; font-size:0.95em; color:#333; border:1px solid #5a6a7a;"
|-
! style="background-color:#003366; color:#fff; text-align:left; padding:8px;" | Producto
! style="background-color:#003366; color:#fff; text-align:left; padding:8px;" | Servicio
! style="background-color:#003366; color:#fff; text-align:left; padding:8px;" | Descripción
|-
| style="padding:8px; border:1px solid #5a6a7a;" | Recepcion
| SOAP
|
'''Recepcion - ReporteStatus''' 
Procesa documentos recibidos de proveedores, validando autenticidad e integridad ante la DIAN. 
'''Entornos:''' Demo / Producción
|-
| style="background-color:#f8fafd; padding:8px; border:1px solid #5a6a7a;" | Recepcion
| SOAP
|
'''Recepcion - EstadoDocumento''' 
Consulta del estado y trazabilidad de documentos recibidos ante la DIAN.
|-
| style="padding:8px; border:1px solid #5a6a7a;" | Recepcion
| SOAP
|
'''Recepcion - Respuesta''' 
Aceptación o rechazo formal de documentos recibidos, registrando eventos ante la DIAN.
|-
| style="background-color:#f8fafd; padding:8px; border:1px solid #5a6a7a;" | Recepcion
| SOAP
|
'''Recepcion - RepresentacionGrafica''' 
Generación de PDFs de documentos recibidos conforme a estándares DIAN.
|}
| style="width:49%; vertical-align:top; padding-left:15px; border:none;" |
<div style="font-size:1.5em; font-weight:bold; color:#003366; margin-bottom:15px;">Documentos Equivalentes</div>
{| class="wikitable" style="width:100%; border-collapse:collapse; font-size:0.95em; color:#333; border:1px solid #5a6a7a;"
|-
! style="background-color:#003366; color:#fff; text-align:left; padding:8px;" | Producto
! style="background-color:#003366; color:#fff; text-align:left; padding:8px;" | Servicio
! style="background-color:#003366; color:#fff; text-align:left; padding:8px;" | Descripción
! style="background-color:#003366; color:#fff; text-align:left; padding:8px;" | Método
|-
| style="padding:8px; border:1px solid #5a6a7a;" | Doc Equivalente
| REST
|
'''Equivalente - EnviarRequest''' 
Envío de documentos equivalentes a la DIAN, cumpliendo validaciones oficiales. 
'''Entornos:''' Demo / Producción
| POST
|-
| style="background-color:#f8fafd; padding:8px; border:1px solid #5a6a7a;" | Doc Equivalente
| REST
|
'''Equivalente - GenerarContenedor''' 
Genera contenedores estructurados según requisitos técnicos de la DIAN.
| GET
|-
| style="padding:8px; border:1px solid #5a6a7a;" | Doc Equivalente
| REST
|
'''Equivalente - DescargaPDF''' 
Generación de PDF para documentos equivalentes conforme a normativa vigente.
| POST
|-
| style="background-color:#f8fafd; padding:8px; border:1px solid #5a6a7a;" | Doc Equivalente
| REST
|
'''Equivalente - EstadoDocumento''' 
Consulta del estado de validación y trazabilidad ante la DIAN.
| POST
|}
|}

|}
 
[[File:HKAFactura 3.png|200px]]
 

* [[Índice del Manual de Integración Directa]]

* [[Direct Integration Manual Index - Electronic Invoice]]
* '''[[Facturación Electrónica bajo Resoluciones DIAN]]'''
* [[Herramientas Alternativas de Integración Facturación]]
* '''[[Servicio Gestión Contribuyentes]]'''
* [[Representaciones Gráficas en el proceso de Emisión]]
* [[Reglas de Rechazo DIAN - Integración]]
* [[Preguntas Frecuentes de Integración con servicio Web (Val. Previa)]]
* [[Tips Urls de Emisión]]

 
[[File:HKANomina 3.png|200px]]
 

* [[Índice del Manual de Integración Nómina Electrónica]]
* [[Portal Web Nómina Electrónica]]
* [[Habilitación Nómina Electrónica]]
* '''[[Herramientas Alternativas de Integración Nómina]]'''
* [[Nómina Electrónica según Concepto Unificado DIAN 0106 – 19 agosto 2022 ]]
* [[Preguntas Frecuentes de Integración Nómina Electrónica]]
* [[Tips Urls de Emisión Nómina Electrónica]]

 
[[File:HKARecepcion 3.png|260px]]
 

* [[Índice del Manual de Integración Directa HKA Recepción]]
* [[HKA Reception Direct Integration Manual Index]]
* [[Preguntas Frecuentes de Integración Recepción Electrónica]]
* [[Tips Urls de Recepción Integración]]

 
[[File:HKAEquivalente1.png|260px]]
 
* [[Indice del Manual Integración Directa HKA Documentos Equivalentes Electrónicos]]
* [[Requisitos minimos de las Representaciones grafica para documento equivalente]]
* [[Preguntas Frecuentes de Integración Documento Equivalente Electrónico]]
* [[Tips Urls de documento equivalente Integración]]

 
[[File:HKA_ Fácil_ RIPS.png|260px]]
 
* [[Indice del Manual Integración Directa HKA Fácil RIPS]]
* [[Tips Urls HKA Fácil RIPS]]
 
 
 

 
[[File:ArticulosInteresIntegracion.png|260px]]
 
* [[HKA TIPS]]
* [[Consideraciones Url Versión 4]]
* [[Recomendaciones para integraciones ante escenarios de intermitencia o Timeouts DIAN]]
* [[Manejo de SoapUI para pruebas en Demo]]
* [[Manejo de Postman para pruebas en Demo]]
* [[Campo extra para informar el Fabricante de Software]]
* [[Recomendaciones en la implementación de la factura electronica]]
* [[Politicas de seguridad de la información para aliados de The Factory HKA]]
* [[Actualización de Seguridad Requerida Migración a TLS 1.2 o superior en nuestros servicios web]]
 

<center>'''<big>[[Archivo:Copyright.png|100px|sinmarco|centro|Copyright]]THE FACTORY HKA COLOMBIA</big>
 Copyright © 2016 The Factory HKA. Todos los derechos reservados.</center>

 
{{clear}}

Códigos de Respuesta - Indice Manual Integración Directa HKA Fácil RIPS

2026-04-14T23:25:35Z

Dmrodriguez2:

[[Categoría:Manuales]]
= Códigos de Respuesta - Indice Manual Integración Directa HKA Fácil RIPS =

La API HKA Fácil RIPS retorna dos tipos de códigos en cada respuesta:

* '''Código HTTP:''' Código de estado estándar del protocolo HTTP.
* '''Código de negocio:''' Código específico retornado en el campo <code>codigo</code> del cuerpo JSON. Este código es el que determina el resultado real de la operación.

'''@IMPORTANTE:''' El código HTTP puede variar según el contexto, pero el '''código de negocio''' siempre refleja el resultado específico de la operación. Se debe verificar siempre el campo <code>codigo</code> del cuerpo de la respuesta para determinar el resultado correcto.

==Códigos de Negocio Generales==

{| class="mw-collapsible wikitable" style="margin: auto;"
|-
! style="background:#f2f2f2; text-align:center;"|Código
! style="background:#f2f2f2; text-align:center;"|HTTP Status
! style="background:#f2f2f2; text-align:center;"|estado
! style="background:#f2f2f2; text-align:center;"|Aplica en
! style="background:#f2f2f2; text-align:center;"|Descripción
|-
| '''200''' || <code>200 OK</code> || <code>true</code> || Enviar, Estado
|
: Operación exitosa.
: El RIPS fue enviado y aceptado por el Ministerio de Salud (Enviar) o el RIPS está en estado VALIDADO (Estado).
: La respuesta incluye el <code>archivoRetornado</code> con el Código Único de Validación (CUV).
|-
| '''99''' || <code>422 Unprocessable Entity</code> || <code>false</code> || Enviar, Estado
|
: RIPS rechazado por el Ministerio de Salud.
: El Ministerio validó la estructura del paquete pero encontró errores en los datos.
: Revisar el campo <code>archivoRetornado.resultadosValidacion</code> para ver los errores específicos.
: Corregir los datos y volver a enviar el RIPS.
|-
| '''101''' || <code>401 Unauthorized</code> || <code>false</code> || Enviar, Estado
|
: Error de autenticación.
: Las credenciales <code>tokenEmpresa</code> y/o <code>tokenPassword</code> son inválidas o no corresponden a una empresa registrada.
: Verificar que los tokens sean correctos. Si el problema persiste, contactar al área de integración TFHKA.
|-
| '''102''' || <code>400 Bad Request</code> / <code>404 Not Found</code> || <code>false</code> || Enviar, Estado
|
: RIPS no encontrado o <code>idRips</code> inválido.
: El identificador UUID proporcionado en <code>idRips</code> no existe en el sistema.
: Verificar el valor del <code>idRips</code>. Si se tiene certeza de que fue creado, contactar al soporte.
|-
| '''109''' || <code>400 Bad Request</code> || <code>false</code> || Enviar
|
: Error de validación al crear el RIPS.
: Se presentó un error en la estructura o contenido del request antes de procesar el RIPS.
: Causas frecuentes:
:: Campos obligatorios faltantes (<code>tokenEmpresa</code>, <code>tokenPassword</code>, <code>tipoRips</code>, <code>ripsJson</code>).
:: Valor de <code>tipoRips</code> inválido (debe ser <code>01</code>, <code>02</code>, <code>03</code>, <code>04</code> o <code>05</code>).
: Revisar el campo <code>errors</code> en la respuesta para ver los mensajes específicos.
|-
| '''111''' || <code>400 Bad Request</code> || <code>false</code> || Enviar, Estado
|
: Error de validación de tokens (formato incorrecto).
: Los tokens no cumplen con el formato requerido.
: Ambos tokens deben ser cadenas de texto con exactamente '''40 caracteres alfanuméricos''' (letras a-z, A-Z y dígitos 0-9).
: Verificar que los tokens no contengan caracteres especiales, espacios en blanco ni tengan longitud diferente a 40.
|-
| '''114''' || <code>409 Conflict</code> || <code>false</code> || Enviar, Estado
|
: RIPS ya procesado.
: El RIPS identificado con el <code>idRips</code> ya fue aceptado por el Ministerio. No es posible volver a enviarlo.
: Si se requiere corregir datos o enviar nueva información, crear un nuevo RIPS sin proporcionar <code>idRips</code>.
|-
| '''162''' || <code>200 OK</code> || <code>false</code> || Estado
|
: RIPS en estado CREADO.
: El RIPS fue registrado en el sistema pero aún no ha sido enviado al Ministerio de Salud.
: Usar el método [[Métodos API REST HKA Fácil RIPS - Indice Manual Integración Directa HKA Fácil RIPS#Método Enviar|Enviar]] con el <code>idRips</code> correspondiente para transmitirlo al Ministerio.
|-
| '''500''' || <code>500 Internal Server Error</code> || <code>false</code> || Enviar, Estado
|
: Error interno del servidor.
: Se produjo un error inesperado durante el procesamiento de la solicitud.
: Reintentar la operación. Si el error persiste, contactar al soporte técnico de The Factory HKA Colombia indicando los detalles de la petición.
|}
{{clear}}

==Método Enviar==

Códigos de respuesta específicos del método <code>POST /api/rips/enviar</code>.

===Códigos HTTP — Método Enviar===

{| class="mw-collapsible mw-collapsed wikitable" style="margin: auto;"
|-
! style="background:#f2f2f2; text-align:center;"|HTTP Status
! style="background:#f2f2f2; text-align:center;"|Código de negocio
! style="background:#f2f2f2; text-align:center;"|Descripción
|-
| <code>200 OK</code> || <code>200</code> || El RIPS fue enviado y validado exitosamente por el Ministerio de Salud. Se retorna el CUV en <code>archivoRetornado.codigoUnicoValidacion</code>.
|-
| <code>400 Bad Request</code> || <code>109</code> || Error de validación del request. Campos obligatorios faltantes o valor de <code>tipoRips</code> inválido. Revisar campo <code>errors</code>.
|-
| <code>400 Bad Request</code> || <code>102</code> || El <code>idRips</code> proporcionado no existe en el sistema.
|-
| <code>400 Bad Request</code> || <code>111</code> || Los tokens no tienen el formato correcto (exactamente 40 caracteres alfanuméricos).
|-
| <code>401 Unauthorized</code> || <code>101</code> || Los tokens son inválidos o no corresponden a una empresa registrada.
|-
| <code>409 Conflict</code> || <code>114</code> || El RIPS ya fue procesado y aceptado. No se puede volver a enviar.
|-
| <code>422 Unprocessable Entity</code> || <code>99</code> || El Ministerio de Salud rechazó el RIPS. Revisar <code>archivoRetornado.resultadosValidacion</code>.
|-
| <code>500 Internal Server Error</code> || <code>500</code> || Error interno del servidor. Reintentar o contactar soporte.
|}
{{clear}}

===Acciones recomendadas — Método Enviar===

{| class="mw-collapsible mw-collapsed wikitable" style="margin: auto;"
|-
! style="background:#f2f2f2; text-align:center;"|Código
! style="background:#f2f2f2; text-align:center;"|Acción recomendada
|-
| <code>200</code> || Guardar el <code>idRips</code> y el CUV (<code>archivoRetornado.codigoUnicoValidacion</code>) para los registros de radicación ante el pagador.
|-
| <code>99</code> || Revisar cada objeto en <code>archivoRetornado.resultadosValidacion</code>, identificar el campo con error usando <code>pathFuente</code>, corregirlo y reenviar.
|-
| <code>101</code> || Verificar los valores de <code>tokenEmpresa</code> y <code>tokenPassword</code> con el equipo de integración TFHKA.
|-
| <code>102</code> || Verificar el UUID del <code>idRips</code>. Si el RIPS existe, contactar soporte.
|-
| <code>109</code> || Revisar el campo <code>errors</code> en la respuesta. Verificar que <code>tipoRips</code> sea <code>01</code>-<code>05</code> y que todos los campos obligatorios estén presentes.
|-
| <code>111</code> || Verificar que ambos tokens tengan exactamente 40 caracteres alfanuméricos sin espacios ni caracteres especiales.
|-
| <code>114</code> || El RIPS ya fue aceptado. No reenviar. Si se requiere corrección, crear un nuevo RIPS.
|-
| <code>500</code> || Reintentar la operación. Si persiste, contactar soporte técnico con los detalles de la petición.
|}
{{clear}}

==Método EstadoRIPS==

Códigos de respuesta específicos del método <code>POST /api/rips/estado</code>.

===Códigos HTTP — Método EstadoRIPS===

{| class="mw-collapsible mw-collapsed wikitable" style="margin: auto;"
|-
! style="background:#f2f2f2; text-align:center;"|HTTP Status
! style="background:#f2f2f2; text-align:center;"|Código de negocio
! style="background:#f2f2f2; text-align:center;"|Descripción
|-
| <code>200 OK</code> || <code>200</code> || El RIPS está en estado VALIDADO. Se retorna el CUV en <code>archivoRetornado.codigoUnicoValidacion</code>.
|-
| <code>200 OK</code> || <code>162</code> || El RIPS está en estado CREADO. Aún no ha sido enviado al Ministerio. Usar el método Enviar.
|-
| <code>400 Bad Request</code> || <code>102</code> || El <code>idRips</code> proporcionado no existe en el sistema.
|-
| <code>400 Bad Request</code> || <code>111</code> || Los tokens no tienen el formato correcto (exactamente 40 caracteres alfanuméricos).
|-
| <code>401 Unauthorized</code> || <code>101</code> || Los tokens son inválidos o no corresponden a una empresa registrada.
|-
| <code>409 Conflict</code> || <code>114</code> || El RIPS ya fue procesado y aceptado previamente.
|-
| <code>422 Unprocessable Entity</code> || <code>99</code> || El RIPS está en estado RECHAZADO. Revisar <code>archivoRetornado.resultadosValidacion</code>.
|-
| <code>500 Internal Server Error</code> || <code>500</code> || Error interno del servidor.
|}
{{clear}}

===Estados posibles del RIPS===

{| class="wikitable" style="margin: auto;"
|-
! style="background:#e9e9e9; text-align:center;"|Estado
! style="background:#e9e9e9; text-align:center;"|Código de negocio
! style="background:#e9e9e9; text-align:center;"|estado
! style="background:#e9e9e9; text-align:center;"|archivoRetornado
! style="background:#e9e9e9; text-align:center;"|Descripción
|- valign="center"
| '''VALIDADO''' || <code>200</code> || <code>true</code> || Presente con <code>resultState: true</code> || El Ministerio aceptó y validó el RIPS correctamente.
|-
| '''RECHAZADO''' || <code>99</code> || <code>false</code> || Presente con <code>resultState: false</code> y lista de errores || El Ministerio rechazó el RIPS por errores en los datos.
|-
| '''CREADO''' || <code>162</code> || <code>false</code> || <code>null</code> || El RIPS fue creado en el sistema pero aún no ha sido enviado al Ministerio. Usar el método Enviar para transmitirlo.
|-
| No encontrado || <code>102</code> || <code>false</code> || <code>null</code> || El <code>idRips</code> proporcionado no existe en el sistema.
|-
| Error autenticación || <code>101</code> || <code>false</code> || <code>null</code> || Los tokens son inválidos o no corresponden a una empresa registrada.
|}
{{clear}}

 
 
 
 

<center>'''<big>[[Archivo:Copyright.png|100px|sinmarco|centro|Copyright]]THE FACTORY HKA COLOMBIA</big>
 Copyright © 2016 The Factory HKA. Todos los derechos reservados.</center>

{{clear}}

Indice del Manual Integración Directa HKA Fácil RIPS

2026-04-14T23:21:53Z

Dmrodriguez2:

[[Archivo:HKA_ Fácil_ RIPS.png|500px|center|HKA Fácil RIPS]]

<includeonly>=</includeonly>==[[Generalidades - Indice Manual Integración Directa HKA Fácil RIPS|Generalidades]]==<includeonly>=</includeonly>
# [[Generalidades - Indice Manual Integración Directa HKA Fácil RIPS#Historial de versiones|Historial de versiones]]
# [[Generalidades - Indice Manual Integración Directa HKA Fácil RIPS#Cómo obtener soporte|Cómo obtener soporte]]
# [[Generalidades - Indice Manual Integración Directa HKA Fácil RIPS#Descripción general|Descripción general]]
## [[Generalidades - Indice Manual Integración Directa HKA Fácil RIPS#¿Qué es HKA Fácil RIPS?|¿Qué es HKA Fácil RIPS?]]
## [[Generalidades - Indice Manual Integración Directa HKA Fácil RIPS#¿Qué son los RIPS?|¿Qué son los RIPS?]]
## [[Generalidades - Indice Manual Integración Directa HKA Fácil RIPS#Tipos de RIPS soportados|Tipos de RIPS soportados]]
## [[Generalidades - Indice Manual Integración Directa HKA Fácil RIPS#Ambientes de integración|Ambientes de integración]]
## [[Generalidades - Indice Manual Integración Directa HKA Fácil RIPS#Autenticación|Autenticación]]
## [[Generalidades - Indice Manual Integración Directa HKA Fácil RIPS#Requerimientos técnicos|Requerimientos técnicos]]

<includeonly>=</includeonly>==[[Métodos API REST HKA Fácil RIPS - Indice Manual Integración Directa HKA Fácil RIPS|Métodos API REST HKA Fácil RIPS]]==<includeonly>=</includeonly>
# [[Métodos API REST HKA Fácil RIPS - Indice Manual Integración Directa HKA Fácil RIPS#Método Enviar|Método Enviar]]
## [[Métodos API REST HKA Fácil RIPS - Indice Manual Integración Directa HKA Fácil RIPS#Request Método Enviar|Request Método Enviar]]
## [[Métodos API REST HKA Fácil RIPS - Indice Manual Integración Directa HKA Fácil RIPS#Object.ripsJson|Object.ripsJson]]
## [[Métodos API REST HKA Fácil RIPS - Indice Manual Integración Directa HKA Fácil RIPS#Object.rips|Object.rips]]
## [[Métodos API REST HKA Fácil RIPS - Indice Manual Integración Directa HKA Fácil RIPS#Response Método Enviar|Response Método Enviar]]
# [[Métodos API REST HKA Fácil RIPS - Indice Manual Integración Directa HKA Fácil RIPS#Método EstadoRIPS|Método EstadoRIPS]]
## [[Métodos API REST HKA Fácil RIPS - Indice Manual Integración Directa HKA Fácil RIPS#Request Método EstadoRIPS|Request Método EstadoRIPS]]
## [[Métodos API REST HKA Fácil RIPS - Indice Manual Integración Directa HKA Fácil RIPS#Ejemplo de Request|Ejemplo de Request]]
## [[Métodos API REST HKA Fácil RIPS - Indice Manual Integración Directa HKA Fácil RIPS#Response Método EstadoRIPS|Response Método EstadoRIPS]]

<includeonly>=</includeonly>==[[Estructura JSON del RIPS Ministerio de Salud - Indice Manual Integración Directa HKA Fácil RIPS|Estructura JSON del RIPS Ministerio de Salud]]==<includeonly>=</includeonly>
# [[Estructura JSON del RIPS Ministerio de Salud - Indice Manual Integración Directa HKA Fácil RIPS#Object.transaccion|Object.transaccion]]
# [[Estructura JSON del RIPS Ministerio de Salud - Indice Manual Integración Directa HKA Fácil RIPS#Object.usuario|Object.usuario]]
# [[Estructura JSON del RIPS Ministerio de Salud - Indice Manual Integración Directa HKA Fácil RIPS#Object.consultas|Object.consultas]]
# [[Estructura JSON del RIPS Ministerio de Salud - Indice Manual Integración Directa HKA Fácil RIPS#Object.procedimientos|Object.procedimientos]]
# [[Estructura JSON del RIPS Ministerio de Salud - Indice Manual Integración Directa HKA Fácil RIPS#Object.urgencias|Object.urgencias]]
# [[Estructura JSON del RIPS Ministerio de Salud - Indice Manual Integración Directa HKA Fácil RIPS#Object.hospitalizacion|Object.hospitalizacion]]
# [[Estructura JSON del RIPS Ministerio de Salud - Indice Manual Integración Directa HKA Fácil RIPS#Object.recienNacido|Object.recienNacido]]
# [[Estructura JSON del RIPS Ministerio de Salud - Indice Manual Integración Directa HKA Fácil RIPS#Object.medicamentos|Object.medicamentos]]
# [[Estructura JSON del RIPS Ministerio de Salud - Indice Manual Integración Directa HKA Fácil RIPS#Object.otrosServicios|Object.otrosServicios]]
# [[Estructura JSON del RIPS Ministerio de Salud - Indice Manual Integración Directa HKA Fácil RIPS#Tablas de Referencia SISPRO|Tablas de Referencia SISPRO]]

<includeonly>=</includeonly>==[[Resultados de Validación - Indice Manual Integración Directa HKA Fácil RIPS|Resultados de Validación]]==<includeonly>=</includeonly>
# [[Resultados de Validación - Indice Manual Integración Directa HKA Fácil RIPS#Object.archivoRetornado|Object.archivoRetornado]]
# [[Resultados de Validación - Indice Manual Integración Directa HKA Fácil RIPS#Object.ResultadoValidacion|Object.ResultadoValidacion]]
# [[Resultados de Validación - Indice Manual Integración Directa HKA Fácil RIPS#Ejemplo de Rechazo del Ministerio|Ejemplo de Rechazo del Ministerio]]

<includeonly>=</includeonly>==[[Códigos de Respuesta - Indice Manual Integración Directa HKA Fácil RIPS|Códigos de Respuesta]]==<includeonly>=</includeonly>
# [[Códigos de Respuesta - Indice Manual Integración Directa HKA Fácil RIPS#Códigos de Negocio Generales|Códigos de Negocio Generales]]
# [[Códigos de Respuesta - Indice Manual Integración Directa HKA Fácil RIPS#Método Enviar|Códigos de Respuesta Método Enviar]]
# [[Códigos de Respuesta - Indice Manual Integración Directa HKA Fácil RIPS#Método EstadoRIPS|Códigos de Respuesta Método EstadoRIPS]]

 
 
 
 

<center>'''<big>[[Archivo:Copyright.png|100px|sinmarco|centro|Copyright]]THE FACTORY HKA COLOMBIA</big>
 Copyright © 2016 The Factory HKA. Todos los derechos reservados.</center>

{{clear}}

Resultados de Validación - Indice Manual Integración Directa HKA Fácil RIPS

2026-04-14T23:00:28Z

Dmrodriguez2: Página creada con «Categoría:Manuales = Resultados de Validación - Indice Manual Integración Directa HKA Fácil RIPS = Cuando se realiza una petición a los métodos de la API HKA Fácil RIPS, el sistema interactúa con el Ministerio de Salud para validar el documento. El resultado de esta validación se entrega dentro del objeto <code>archivoRetornado</code>. ==Object.archivoRetornado== Este objeto contiene los detalles del…»

[[Categoría:Manuales]]
= Resultados de Validación - Indice Manual Integración Directa HKA Fácil RIPS =

Cuando se realiza una petición a los métodos de la API HKA Fácil RIPS, el sistema interactúa con el Ministerio de Salud para validar el documento. El resultado de esta validación se entrega dentro del objeto <code>archivoRetornado</code>.

==Object.archivoRetornado==

Este objeto contiene los detalles del resultado retornado por el Ministerio de Salud. Solo estará presente (no nulo) cuando el RIPS haya alcanzado la etapa de validación en el Ministerio.

{| class="mw-collapsible mw-collapsed wikitable" style="margin: auto;"
|-
! style="background:#f2f2f2; text-align:center;"|Atributo
! style="background:#f2f2f2; text-align:center;"|Tipo Dato
! style="background:#f2f2f2; text-align:center;"|Formato
! style="background:#f2f2f2; text-align:center;"|Descripción
|-
| codigoUnicoValidacion
| String
| AN
|
: Código Único de Validación (CUV) asignado por el Ministerio de Salud al RIPS aceptado.
: Solo presente cuando el RIPS fue aceptado (<code>resultState: true</code>).
: Cuando el RIPS es rechazado, este campo retorna: <code>"No aplica a paquetes procesados en estado [RECHAZADO]"</code>
|-
| fechaRadicacion
| String
| datetime
|
: Fecha y hora de radicación del RIPS ante el Ministerio de Salud.
: Formato: <code>YYYY-MM-DDThh:mm:ssZ</code>
|-
| fechaRespuesta
| String
| datetime
|
: Fecha y hora de la respuesta del Ministerio de Salud.
: <code>null</code> si el Ministerio aún no ha emitido respuesta.
|-
| numFactura
| String
| AN
|
: Número de la factura electrónica asociada al RIPS.
: Para RIPS sin FEV (<code>tipoRips: "02"</code>), retorna el valor <code>"SINFEV"</code>.
|-
| procesoId
| integer
| INT32
|
: Identificador interno del proceso de validación en el Ministerio de Salud.
: Retorna <code>0</code> cuando el RIPS es rechazado.
|-
| resultadosValidacion
| Array <Object.ResultadoValidacion>
| -
|
: Lista de errores de validación retornados por el Ministerio de Salud cuando el RIPS es rechazado.
: Array vacío <code>[]</code> cuando el RIPS es aceptado.
: (ver detalle en [[#Object.ResultadoValidacion|Object.ResultadoValidacion]])
|-
| resultState
| boolean
| boolean
|
: Resultado de la validación por parte del Ministerio de Salud.
: <code>true</code> El Ministerio aceptó el RIPS (estado: VALIDADO).
: <code>false</code> El Ministerio rechazó el RIPS (estado: RECHAZADO).
|-
| rutaArchivos
| String
| AN
|
: Ruta interna de almacenamiento de los archivos generados del RIPS.
|-
| message
| String
| AN
|
: Mensaje adicional retornado por el Ministerio de Salud.
: <code>null</code> si no hay mensajes adicionales.
|}
{{clear}}

==Object.ResultadoValidacion==

Cuando el Ministerio de Salud rechaza un RIPS (código de negocio <code>99</code>), el campo <code>resultadosValidacion</code> contendrá una lista de objetos que describen cada uno de los errores encontrados en la estructura o contenido de los datos.

{| class="mw-collapsible mw-collapsed wikitable" style="margin: auto;"
|-
! style="background:#f2f2f2; text-align:center;"|Atributo
! style="background:#f2f2f2; text-align:center;"|Tipo Dato
! style="background:#f2f2f2; text-align:center;"|Formato
! style="background:#f2f2f2; text-align:center;"|Descripción
|-
| clase
| String
| AN
|
: Clasificación del resultado de validación.
: Valor posible: <code>RECHAZADO</code>
|-
| codigo
| String
| AN
|
: Código único del error de validación asignado por el Ministerio de Salud.
: Ejemplo: <code>RVG06</code>
|-
| descripcion
| String
| AN
|
: Descripción general del error de validación.
|-
| fuente
| String
| AN
|
: Componente del paquete RIPS donde se encontró el error.
: Ejemplo: <code>Rips</code>
|-
| observaciones
| String
| AN
|
: Detalle específico del error. Incluye el valor incorrecto enviado y los valores permitidos según la normativa.
|-
| pathFuente
| String
| AN
|
: Ruta JSON al campo específico donde se encontró el error.
: Usar esta ruta para localizar y corregir el dato incorrecto en el <code>ripsJson</code> original.
: Ejemplo: <code>usuarios[0].servicios.otrosServicios[0].conceptoRecaudo</code>
|}
{{clear}}

===Ejemplo de Rechazo del Ministerio===

El siguiente es un ejemplo de cómo se visualizan los errores de validación cuando el Ministerio rechaza el RIPS por un valor inválido en el campo <code>conceptoRecaudo</code>:

{
"codigo": 99,
"mensaje": "Error al enviar el RIPS: El dato informado no corresponde al contenido requerido.",
"estado": false,
"idRips": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"archivoRetornado": {
"codigoUnicoValidacion": "No aplica a paquetes procesados en estado [RECHAZADO]",
"fechaRadicacion": "2025-10-27T10:30:00Z",
"fechaRespuesta": null,
"numFactura": "SINFEV",
"procesoId": 0,
"resultadosValidacion": [
{
"clase": "RECHAZADO",
"codigo": "RVG06",
"descripcion": "El dato informado no corresponde al contenido requerido.",
"fuente": "Rips",
"observaciones": "El valor del campo conceptoRecaudo no es válido. Debe ser uno de los valores permitidos: 01, 02, 03, 04, 05.",
"pathFuente": "usuarios[0].servicios.otrosServicios[0].conceptoRecaudo"
}
],
"resultState": false,
"message": "Error al enviar el RIPS: El dato informado no corresponde al contenido requerido."
}
}

'''Interpretación del error:'''
* '''Código de error:''' <code>RVG06</code> - Error de validación de dato incorrecto.
* '''Campo con error:''' <code>usuarios[0].servicios.otrosServicios[0].conceptoRecaudo</code> - El campo <code>conceptoRecaudo</code> del primer servicio del primer usuario tiene un valor no permitido.
* '''Acción:''' Corregir el valor de <code>conceptoRecaudo</code> usando uno de los valores válidos (<code>01</code>, <code>02</code>, <code>03</code>, <code>04</code>, <code>05</code>) y volver a enviar el RIPS.

Tips Urls HKA Fácil RIPS

2026-04-14T22:55:17Z

Dmrodriguez2: Página creada con «<includeonly>=</includeonly>== URL´s Servicio de integración para HKA Fácil RIPS Demo==<includeonly>=</includeonly> A continuación documentamos las versiones de URL establecidas por The Factory HKA Colombia para el uso de su API REST en el ambiente Demo, para que realice toda clase de pruebas funcionales y de integración. ===Demo=== *URL:[https://demoapi-facilrips.thefactoryhka.com.co https://demoapi-…»

<includeonly>=</includeonly>== URL´s Servicio de integración para HKA Fácil RIPS Demo==<includeonly>=</includeonly>
 
A continuación documentamos las versiones de URL establecidas por The Factory HKA Colombia para el uso de su API REST en el ambiente Demo, para que realice toda clase de pruebas funcionales y de integración.
 
===Demo===
*URL:[https://demoapi-facilrips.thefactoryhka.com.co https://demoapi-facilrips.thefactoryhka.com.co]
 
<includeonly>=</includeonly>== URL´s Servicio de integración para HKA Fácil RIPS Producción ==<includeonly>=</includeonly>
 
A continuación documentamos las versiones de URL establecidas por The Factory HKA Colombia para el uso de su API REST en el ambiente de Producción, para que realice el proceso de generación y validación de RIPS directamente con el Ministerio de Salud.
 
===Producción===
*URL:[https://api-facilrips.thefactoryhka.com.co https://api-facilrips.thefactoryhka.com.co]

Indice del Manual Integración Directa HKA Fácil RIPS

2026-04-14T22:51:22Z

Dmrodriguez2:

Estructura JSON del RIPS Ministerio de Salud - Indice Manual Integración Directa HKA Fácil RIPS

2026-04-14T22:48:49Z

Dmrodriguez2: Página creada con «Categoría:Manuales = Estructura JSON del RIPS Ministerio de Salud - Indice Manual Integración Directa HKA Fácil RIPS = Este artículo documenta la estructura completa de datos del archivo JSON del RIPS según los lineamientos técnicos del Ministerio de Salud y Protección Social (Resolución 2275 de 2023, versión 3.2 - mayo 2025). Cada nodo corresponde a un objeto o arreglo dentro del JSON que se envía al mecanismo único de valida…»

[[Categoría:Manuales]]
= Estructura JSON del RIPS Ministerio de Salud - Indice Manual Integración Directa HKA Fácil RIPS =

Este artículo documenta la estructura completa de datos del archivo JSON del RIPS según los lineamientos técnicos del Ministerio de Salud y Protección Social (Resolución 2275 de 2023, versión 3.2 - mayo 2025). Cada nodo corresponde a un objeto o arreglo dentro del JSON que se envía al mecanismo único de validación del Ministerio.

; Fuente oficial: [https://www.sispro.gov.co/central-financiamiento/Pages/facturacion-electronica.aspx Micrositio Factura Electrónica en Salud - SISPRO]

==Object.transaccion==

El nodo raíz del RIPS contiene los datos de identificación de la transacción. Corresponde a los campos T01 a T04 del Anexo Técnico 1 de la Resolución 2275 de 2023.

{| class="mw-collapsible mw-collapsed wikitable" style="margin: auto;"
|-
! style="background:#f2f2f2; text-align:center;"|Atributo
! style="background:#f2f2f2; text-align:center;"|Cód.
! style="background:#f2f2f2; text-align:center;"|Tipo Dato
! style="background:#f2f2f2; text-align:center;"|Formato
! style="background:#f2f2f2; text-align:center;"|Requerido
! style="background:#f2f2f2; text-align:center;"|Descripción
|-
| numDocumentoIdObligado
| T01
| String
| AN|4..12
| SI
|
: NIT del facturador electrónico en salud (PSS/PTS) obligado a reportar RIPS.
: Tipo cadena. Todos los PSS/PTS deben usar tipo de documento NIT.
: Rechazo Si el NIT no coincide con el registrado en la FEV (RVC001) o no existe en las tablas IPSCodHabilitacion / IPSNoREPS (RVC002).
|-
| numFactura
| T02
| String
| AN
| SI
|
: Número de la Factura Electrónica de Venta (FEV), según especificaciones de la DIAN.
: Informar <code>null</code> para entidades con objeto social diferente (EOSD) o profesionales independientes no obligados a generar FEV (RIPS sin factura).
|-
| tipoNota
| T03
| String
| AN|0..2
| SI
|
: Tipo del documento que soporta el RIPS. Valores permitidos:
:: <code>NC</code> Nota Crédito
:: <code>ND</code> Nota Débito
:: <code>NA</code> Nota de Ajuste de RIPS
:: <code>RS</code> RIPS sin Factura (profesionales independientes o EOSD)
: Cuando en el mismo trámite corresponda NC parcial y NA, el campo debe ser <code>NC</code>.
: Tabla de referencia SISPRO: <code>TipoNota</code>
|-
| numNota
| T04
| String
| AN|0..20
| SI
|
: Número de la nota crédito, nota débito, nota ajuste o consecutivo asignado por el prestador.
: Para RIPS sin FEV (profesionales independientes/EOSD), informar un consecutivo de 1 a infinito asignado por el prestador.
|}
{{clear}}

==Object.usuario==

Arreglo que contiene los datos de identificación de cada usuario (paciente) atendido. Corresponde a los campos U01 a U11 del Anexo Técnico 1.

{| class="mw-collapsible mw-collapsed wikitable" style="margin: auto;"
|-
! style="background:#f2f2f2; text-align:center;"|Atributo
! style="background:#f2f2f2; text-align:center;"|Cód.
! style="background:#f2f2f2; text-align:center;"|Tipo Dato
! style="background:#f2f2f2; text-align:center;"|Formato
! style="background:#f2f2f2; text-align:center;"|Requerido
! style="background:#f2f2f2; text-align:center;"|Descripción
|-
| tipoDocumentoIdentificacion
| U01
| String
| AN|2
| SI
|
: Tipo de documento de identificación del paciente. Valores según edad y nacionalidad:
:: <code>CC</code> Cédula de Ciudadanía (≥18 años, colombianos)
:: <code>TI</code> Tarjeta de Identidad (7 a 17 años)
:: <code>RC</code> Registro Civil (≤6 años)
:: <code>CN</code> Certificado de Nacido Vivo (hasta 3 años, 9 a 20 chars)
:: <code>PA</code> Pasaporte (extranjeros con visa de trabajo, ≤7 años, refugiados)
:: <code>CE</code> Cédula de Extranjería
:: <code>CD</code> Carné Diplomático
:: <code>SC</code> Salvoconducto
:: <code>PE</code> Permiso Especial de Permanencia (migrantes venezolanos)
:: <code>DE</code> Documento Extranjero
:: <code>AS</code> Adulto sin Identificación (>18 años)
:: <code>MS</code> Menor sin Identificación
:: <code>SI</code> Sin identificación
: Tabla de referencia SISPRO: <code>TipoIdPISIS</code>
|-
| numDocumentoIdentificacion
| U02
| String
| AN|..20
| SI
|
: Número del documento de identificación del paciente.
: Longitudes máximas por tipo: CC: 10; CE: 6; CD: 16; PA: 16; SC: 16; PE: 15; RC: 11; TI: 11; CN: 9-20; AS: 10; MS: 12; DE: 20; PT: 20; SI: 20.
: Para TI y CC, solo se permiten números.
|-
| tipoUsuario
| U03
| String
| AN|2
| SI
|
: Código del tipo de usuario según el régimen de afiliación al SGSSS.
: Debe ser consistente con el campo COBERTURA_PLAN_BENEFICIOS del XML de la FEV.
: Valores permitidos (tabla SISPRO <code>RIPSTipoUsuarioVersion2</code>):
:: <code>01</code> Contributivo cotizante
:: <code>02</code> Contributivo beneficiario
:: <code>03</code> Contributivo adicional
:: <code>04</code> Subsidiado
:: <code>05</code> No afiliado
:: <code>06</code> Especial o Excepción cotizante
:: <code>07</code> Especial o Excepción beneficiario
:: <code>08</code> Personas privadas de la libertad (Fondo Nacional de Salud)
:: <code>09</code> Tomador / Amparado ARL
:: <code>10</code> Tomador / Amparado SOAT
:: <code>11</code> Tomador / Amparado Planes Voluntarios de Salud
:: <code>12</code> Particular
:: <code>13</code> Especial o Excepción no cotizante (Ley 352/97 - servicio militar)
|-
| fechaNacimiento
| U04
| String
| date
| SI
|
: Fecha de nacimiento del paciente.
: Formato: <code>YYYY-MM-DD</code>. Ejemplo: <code>1990-01-15</code>
|-
| codSexo
| U05
| String
| AN|1
| SI
|
: Código del sexo según el documento de identificación emitido por la Registraduría Nacional.
: Tomar de la columna Extra_III de la tabla SISPRO <code>Sexo</code>:
:: <code>M</code> Masculino
:: <code>F</code> Femenino
:: <code>I</code> Indeterminado o Intersexual
|-
| codPaisResidencia
| U06
| String
| AN
| SI
|
: Código del país de residencia habitual del usuario (donde vivió más tiempo en el último año calendario).
: Tabla de referencia SISPRO: <code>País</code>
|-
| codMunicipioResidencia
| U07
| String
| AN|5
| C/C
|
: Código DIVIPOLA del municipio de residencia habitual (dos primeros dígitos = departamento + tres últimos = municipio).
: '''Obligatorio''' cuando el país de residencia (U06) es Colombia.
: Tabla de referencia SISPRO: <code>Municipio</code>
|-
| codZonaTerritorialResidencia
| U08
| String
| AN|1
| SI
|
: Zona territorial de residencia del usuario.
: Tabla de referencia SISPRO: <code>ZonaVersion2</code>
|-
| incapacidad
| U09
| String
| AN|2
| SI
|
: Indica si el profesional tratante expidió un certificado de incapacidad durante el proceso de atención.
: Valores: <code>SI</code> o <code>NO</code>
: Tabla de referencia SISPRO: <code>LstSiNo</code>
|-
| consecutivo
| U10
| Integer
| INT32
| SI
|
: Posición del usuario en el RIPS. Inicia en 1, se incrementa de uno en uno, no puede repetirse.
: En facturas multiusuario depende de la cantidad de usuarios informados.
|-
| codPaisOrigen
| U11
| String
| AN
| SI
|
: Código del país de nacimiento del usuario.
: Tabla de referencia SISPRO: <code>País</code>
|}
{{clear}}

; Nota: Debajo de cada usuario se registran los datos de los servicios prestados dentro del objeto <code>servicios</code>, que puede contener los arreglos: <code>consultas</code>, <code>procedimientos</code>, <code>urgencias</code>, <code>hospitalizacion</code>, <code>recienNacido</code>, <code>medicamentos</code> y <code>otrosServicios</code>.

==Object.consultas==

Arreglo con los datos de las consultas realizadas (médicas, odontológicas, de enfermería, interconsultas, etc.). Corresponde a los campos C01 a C21.

{| class="mw-collapsible mw-collapsed wikitable" style="margin: auto;"
|-
! style="background:#f2f2f2; text-align:center;"|Atributo
! style="background:#f2f2f2; text-align:center;"|Cód.
! style="background:#f2f2f2; text-align:center;"|Tipo Dato
! style="background:#f2f2f2; text-align:center;"|Formato
! style="background:#f2f2f2; text-align:center;"|Requerido
! style="background:#f2f2f2; text-align:center;"|Descripción
|-
| codPrestador
| C01
| String
| AN|12
| SI
|
: Código de habilitación del prestador de servicios de salud (número de habilitación con sede, 12 caracteres).
: Tabla de referencia SISPRO: <code>IPSCodHabilitacion</code> / <code>IPSNoREPS</code>
|-
| fechaInicioAtencion
| C02
| String
| AN|16
| SI
|
: Fecha y hora en que el usuario fue atendido. Debe estar dentro del periodo de facturación de la FEV.
: Formato: <code>AAAA-MM-DD hh:mm</code> (16 caracteres). Ejemplo: <code>2025-10-16 08:30</code>
|-
| numAutorizacion
| C03
| String
| AN|..30
| C/C
|
: Número de autorización emitida por la EPS o aseguradora para realizar la consulta.
: Informar si el pagador exigió autorización previa.
|-
| codConsulta
| C04
| String
| AN
| SI
|
: Código CUPS de la consulta realizada según la Clasificación Única de Procedimientos en Salud vigente.
: Tabla de referencia SISPRO: <code>CUPSRips</code>
|-
| modalidadGrupoServicioTecSal
| C05
| String
| AN|2
| SI
|
: Modalidad de atención de la consulta.
: Valores permitidos (tabla SISPRO <code>ModalidadAtencion</code>):
:: <code>01</code> Intramural
:: <code>02</code> Extramural unidad móvil
:: <code>03</code> Extramural domiciliaria
:: <code>04</code> Extramural jornada de salud
:: <code>06</code> Telemedicina interactiva
:: <code>07</code> Telemedicina no interactiva
:: <code>08</code> Telemedicina telexperticia
:: <code>09</code> Telemedicina telemonitoreo
|-
| grupoServicios
| C06
| String
| AN|2
| SI
|
: Agrupación del servicio según la Resolución 3100 de 2019 (REPS).
: Valores permitidos (tabla SISPRO <code>GrupoServicios</code>):
:: <code>01</code> Consulta externa
:: <code>02</code> Apoyo diagnóstico y complementación terapéutica
:: <code>03</code> Internación
:: <code>04</code> Quirúrgico
:: <code>05</code> Atención inmediata
|-
| codServicio
| C07
| String
| AN|3
| SI
|
: Código de tres dígitos del servicio según la Resolución 3100 de 2019.
: Tabla de referencia SISPRO: <code>Servicios</code>
|-
| finalidadTecnologiaSalud
| C08
| String
| AN|2
| SI
|
: Código de la finalidad de la tecnología en salud aplicada en la consulta.
: Tomar de la columna ExtraI: Consultas de la tabla SISPRO <code>RIPSFinalidadConsultaVersion2</code>.
: Código numérico de dos caracteres. No todas las opciones aplican para consultas.
|-
| causaMotivoAtencion
| C09
| String
| AN|2
| SI
|
: Código de la causa externa que motivó la atención. Valores del 21 al 30.
: Tabla de referencia SISPRO: <code>RIPSCausaExternaVersion2</code>
|-
| codDiagnosticoPrincipal
| C10
| String
| AN|..8
| SI
|
: Código CIE-10 del diagnóstico principal definido al finalizar el proceso de atención.
: Ejemplo: <code>Z000</code>, <code>J189</code>
: Tabla de referencia: <code>CIE10</code>
|-
| codDiagnosticoRelacionado1
| C11
| String
| AN|..8
| NO
|
: Código CIE-10 de otras afecciones o problemas relacionados con la consulta que coexistieron durante el manejo de la afección principal.
: Tabla de referencia: <code>CIE10</code>
|-
| codDiagnosticoRelacionado2
| C12
| String
| AN|..8
| NO
|
: Código CIE-10 de diagnóstico relacionado 2 (opcional).
: Tabla de referencia: <code>CIE10</code>
|-
| codDiagnosticoRelacionado3
| C13
| String
| AN|..8
| NO
|
: Código CIE-10 de diagnóstico relacionado 3 (opcional).
: Tabla de referencia: <code>CIE10</code>
|-
| tipoDiagnosticoPrincipal
| C14
| String
| AN|2
| SI
|
: Tipo del diagnóstico principal según el grado de aproximación y confirmación.
:: <code>01</code> Impresión diagnóstica
:: <code>02</code> Confirmado nuevo
:: <code>03</code> Confirmado repetido
|-
| tipoDocumentoIdentificacionMedico
| C15
| String
| AN|2
| SI
|
: Tipo de documento de identificación del profesional que realizó la consulta.
: El profesional debe estar registrado en RETHUS.
: Tabla de referencia SISPRO: <code>TipoIdPISIS</code>
|-
| numDocumentoIdentificacionMedico
| C16
| String
| AN
| SI
|
: Número del documento de identificación del profesional que realizó la consulta.
|-
| vrServicio
| C17
| Decimal
| -
| SI
|
: Valor monetario del servicio en pesos colombianos (COP).
: Modalidad pago por evento: informar el valor pactado (ya con descuentos).
: Otras modalidades (capitación, PGP, paquete): informar <code>0</code>.
|-
| conceptoRecaudo
| C18
| String
| AN|2
| SI
|
: Código del tipo de pago moderador aplicado al usuario.
: Valores (tabla SISPRO <code>conceptoRecaudo</code>):
:: <code>01</code> Copago
:: <code>02</code> Cuota moderadora
:: <code>03</code> Pagos compartidos en planes voluntarios de salud
:: <code>04</code> Anticipos
:: <code>05</code> No aplica
: Rechazo Si el valor no corresponde a los permitidos por el Ministerio de Salud
|-
| valorPagoModerador
| C19
| Decimal
| -
| SI
|
: Valor del pago moderador recaudado al usuario, en pesos colombianos (COP).
: Informar <code>0</code> si no aplica pago moderador.
: En facturas monousuario, no puede ser mayor que el valor del servicio.
|-
| numFEVPagoModerador
| C20
| String
| AN
| C/C
|
: Número de la FEV expedida al paciente por concepto del pago moderador.
: Informar <code>null</code> si no aplica.
|-
| consecutivo
| C21
| Integer
| INT32
| SI
|
: Posición de la consulta dentro del arreglo de consultas del usuario. Inicia en 1.
|}
{{clear}}

==Object.procedimientos==

Arreglo con los datos de los procedimientos realizados (diagnósticos, terapéuticos, quirúrgicos, no quirúrgicos, de protección específica, de detección temprana, vacunación, etc.). Corresponde a los campos P01 a P20.

{| class="mw-collapsible mw-collapsed wikitable" style="margin: auto;"
|-
! style="background:#f2f2f2; text-align:center;"|Atributo
! style="background:#f2f2f2; text-align:center;"|Cód.
! style="background:#f2f2f2; text-align:center;"|Tipo Dato
! style="background:#f2f2f2; text-align:center;"|Formato
! style="background:#f2f2f2; text-align:center;"|Requerido
! style="background:#f2f2f2; text-align:center;"|Descripción
|-
| codPrestador
| P01
| String
| AN|12
| SI
|
: Código de habilitación del prestador de servicios de salud con sede (12 caracteres).
: Tabla de referencia SISPRO: <code>IPSCodHabilitacion</code> / <code>IPSNoREPS</code>
|-
| fechaInicioAtencion
| P02
| String
| AN|16
| SI
|
: Fecha y hora de realización del procedimiento. Debe estar dentro del periodo de facturación.
: Formato: <code>AAAA-MM-DD hh:mm</code>. Ejemplo: <code>2025-10-16 09:00</code>
|-
| idEntrega
| P03
| String
| AN
| C/C
|
: Número de ID de entrega si el procedimiento no es financiado con cargo a la UPC.
: Informar <code>null</code> si el procedimiento es financiado con la UPC, salvo los que deban prescribirse desde MIPRES.
: Si es financiado con presupuesto máximo, debe coincidir con el ID de prescripción MIPRES.
|-
| numAutorizacion
| P04
| String
| AN|..30
| C/C
|
: Número de autorización emitida por el pagador para realizar el procedimiento.
|-
| codProcedimiento
| P05
| String
| AN
| SI
|
: Código CUPS del procedimiento según la resolución de CUPS vigente del Ministerio de Salud.
: Solo se aceptan CUPS definidos por el Ministerio. No se pueden crear códigos propios.
: Tabla de referencia SISPRO: <code>CUPSRips</code>
|-
| viaIngreso
| P06
| String
| AN|2
| SI
|
: Vía de ingreso al servicio donde se ejecuta el procedimiento.
: Tabla de referencia SISPRO correspondiente.
|-
| modalidadGrupoServicioTecSal
| P07
| String
| AN|2
| SI
|
: Modalidad de atención del procedimiento.
: Tabla de referencia SISPRO: <code>ModalidadAtencion</code> (mismos valores que C05)
|-
| grupoServicios
| P08
| String
| AN|2
| SI
|
: Agrupación del servicio según la Resolución 3100 de 2019.
: Tabla de referencia SISPRO: <code>GrupoServicios</code> (mismos valores que C06)
|-
| codServicio
| P09
| String
| AN|3
| SI
|
: Código de tres dígitos del servicio según la Resolución 3100 de 2019.
: Tabla de referencia SISPRO: <code>Servicios</code>
|-
| finalidadTecnologiaSalud
| P10
| String
| AN|2
| SI
|
: Código de la finalidad de la tecnología en salud del procedimiento.
: Tomar de la columna Extra II: Procedimientos de la tabla SISPRO <code>RIPSFinalidadConsultaVersion2</code>.
: Valores permitidos: del 12 al 20, y del 22 al 44.
|-
| tipoDocumentoIdentificacionMedico
| P11
| String
| AN|2
| SI
|
: Tipo de documento de identificación del profesional que realizó el procedimiento.
: Tabla de referencia SISPRO: <code>TipoIdPISIS</code>
|-
| numDocumentoIdentificacionMedico
| P12
| String
| AN
| SI
|
: Número del documento de identificación del profesional que realizó el procedimiento.
|-
| codDiagnosticoPrincipal
| P13
| String
| AN|..8
| SI
|
: Código CIE-10 del diagnóstico principal de la atención.
: Preferentemente no debe iniciar por R, W, V o Z (salvo excepciones como hemoclasificación, TSH neonatal).
: Tabla de referencia: <code>CIE10</code>
|-
| codDiagnosticoRelacionado1
| P14
| String
| AN|..8
| NO
|
: Código CIE-10 del diagnóstico relacionado 1.
: Tabla de referencia: <code>CIE10</code>
|-
| codComplicacion
| P15
| String
| AN|..8
| NO
|
: Código CIE-10 de la complicación presentada durante el procedimiento.
: Tabla de referencia: <code>CIE10</code>
|-
| vrServicio
| P16
| Decimal
| -
| SI
|
: Valor monetario del procedimiento en COP.
: Pago por evento: debe ser mayor a 1. Otras modalidades: informar <code>0</code>.
|-
| conceptoRecaudo
| P17
| String
| AN|2
| SI
|
: Código del tipo de pago moderador aplicado.
: Tabla de referencia SISPRO: <code>conceptoRecaudo</code> (mismos valores que C18)
: Rechazo Si el valor no corresponde a los permitidos por el Ministerio de Salud
|-
| valorPagoModerador
| P18
| Decimal
| -
| SI
|
: Valor del pago moderador en COP. Informar <code>0</code> si no aplica.
|-
| numFEVPagoModerador
| P19
| String
| AN
| C/C
|
: Número de la FEV por concepto del pago moderador. Informar <code>null</code> si no aplica.
|-
| consecutivo
| P20
| Integer
| INT32
| SI
|
: Posición del procedimiento dentro del arreglo de procedimientos del usuario.
|}
{{clear}}

==Object.urgencias==

Arreglo con los datos de atenciones de urgencias con observación. Se requiere que exista una consulta de urgencia registrada con fecha y hora mayor o igual a la fecha de ingreso a urgencias. Corresponde a los campos R01 a R11+.

{| class="mw-collapsible mw-collapsed wikitable" style="margin: auto;"
|-
! style="background:#f2f2f2; text-align:center;"|Atributo
! style="background:#f2f2f2; text-align:center;"|Cód.
! style="background:#f2f2f2; text-align:center;"|Tipo Dato
! style="background:#f2f2f2; text-align:center;"|Formato
! style="background:#f2f2f2; text-align:center;"|Requerido
! style="background:#f2f2f2; text-align:center;"|Descripción
|-
| codPrestador
| R01
| String
| AN|12
| SI
|
: Código de habilitación del prestador con sede (12 caracteres).
: Tabla de referencia SISPRO: <code>IPSCodHabilitacion</code> / <code>IPSNoREPS</code>
|-
| fechaInicioAtencion
| R02
| String
| AN|16
| SI
|
: Fecha y hora de inicio de la atención de urgencias. Debe estar dentro del periodo de facturación de la FEV.
: Formato: <code>AAAA-MM-DD hh:mm</code>
|-
| causaMotivoAtencion
| R03
| String
| AN|2
| SI
|
: Código de la causa externa que motivó la urgencia. Debe coincidir con el de la consulta de urgencia asociada.
: Tabla de referencia SISPRO: <code>RIPSCausaExternaVersion2</code>
|-
| codDiagnosticoPrincipalIngreso
| R04
| String
| AN|..8
| SI
|
: Código CIE-10 del diagnóstico principal al ingreso a urgencias.
: Tabla de referencia: <code>CIE10</code>
|-
| codDiagnosticoRelacionadoIngreso1
| R05
| String
| AN|..8
| NO
|
: Código CIE-10 de diagnóstico relacionado al ingreso (1).
: Tabla de referencia: <code>CIE10</code>
|-
| codDiagnosticoRelacionadoIngreso2
| R06
| String
| AN|..8
| NO
|
: Código CIE-10 de diagnóstico relacionado al ingreso (2).
: Tabla de referencia: <code>CIE10</code>
|-
| codDiagnosticoRelacionadoIngreso3
| R07
| String
| AN|..8
| NO
|
: Código CIE-10 de diagnóstico relacionado al ingreso (3).
: Tabla de referencia: <code>CIE10</code>
|-
| codDiagnosticoPrincipalEgreso
| R08
| String
| AN|..8
| SI
|
: Código CIE-10 del diagnóstico principal al egreso de urgencias.
: Tabla de referencia: <code>CIE10</code>
|-
| condicionSalidaUrgencia
| R09
| String
| AN|2
| SI
|
: Condición en que egresó el usuario del servicio de urgencias.
: Tabla de referencia SISPRO correspondiente (condición de salida).
|-
| codDiagnosticoRelacionadoEgreso
| R10
| String
| AN|..8
| NO
|
: Código CIE-10 de diagnóstico relacionado al egreso de urgencias.
: Tabla de referencia: <code>CIE10</code>
|-
| fechaEgreso
| R11
| String
| AN|16
| SI
|
: Fecha y hora de egreso de urgencias. Debe estar dentro del periodo de facturación de la FEV.
: Formato: <code>AAAA-MM-DD hh:mm</code>
|-
| consecutivo
| -
| Integer
| INT32
| SI
|
: Posición del registro de urgencias dentro del arreglo del usuario.
|}
{{clear}}

==Object.hospitalizacion==

Arreglo con los datos de hospitalización. Para estancias prolongadas o cambio de pagador (por ejemplo, víctimas de accidentes de tránsito) se utilizan los campos de fecha de inicio y egreso. Corresponde a los campos H01 a H14+.

{| class="mw-collapsible mw-collapsed wikitable" style="margin: auto;"
|-
! style="background:#f2f2f2; text-align:center;"|Atributo
! style="background:#f2f2f2; text-align:center;"|Cód.
! style="background:#f2f2f2; text-align:center;"|Tipo Dato
! style="background:#f2f2f2; text-align:center;"|Formato
! style="background:#f2f2f2; text-align:center;"|Requerido
! style="background:#f2f2f2; text-align:center;"|Descripción
|-
| codPrestador
| H01
| String
| AN|12
| SI
|
: Código de habilitación del prestador con sede (12 caracteres).
: Tabla de referencia SISPRO: <code>IPSCodHabilitacion</code> / <code>IPSNoREPS</code>
|-
| viaIngreso
| H02
| String
| AN|2
| SI
|
: Vía o forma de ingreso al servicio de hospitalización.
: Tabla de referencia SISPRO correspondiente.
|-
| fechaInicioAtencion
| H03
| String
| AN|16
| SI
|
: Fecha y hora de inicio de la hospitalización. Debe estar dentro del periodo de facturación.
: Formato: <code>AAAA-MM-DD hh:mm</code>
|-
| numAutorizacion
| H04
| String
| AN|..30
| C/C
|
: Número de autorización emitida por la EPS/aseguradora para la hospitalización.
|-
| causaMotivoAtencion
| H05
| String
| AN|2
| SI
|
: Código de la causa externa que motivó la hospitalización.
: Tabla de referencia SISPRO: <code>RIPSCausaExternaVersion2</code>
|-
| codDiagnosticoPrincipalIngreso
| H06
| String
| AN|..8
| SI
|
: Código CIE-10 del diagnóstico principal al ingreso a hospitalización.
: Tabla de referencia: <code>CIE10</code>
|-
| codDiagnosticoRelacionadoIngreso1
| H07
| String
| AN|..8
| NO
|
: Código CIE-10 de diagnóstico relacionado al ingreso (1).
: Tabla de referencia: <code>CIE10</code>
|-
| codDiagnosticoRelacionadoIngreso2
| H08
| String
| AN|..8
| NO
|
: Código CIE-10 de diagnóstico relacionado al ingreso (2).
: Tabla de referencia: <code>CIE10</code>
|-
| codDiagnosticoRelacionadoIngreso3
| H09
| String
| AN|..8
| NO
|
: Código CIE-10 de diagnóstico relacionado al ingreso (3).
: Tabla de referencia: <code>CIE10</code>
|-
| codDiagnosticoPrincipalEgreso
| H10
| String
| AN|..8
| SI
|
: Código CIE-10 del diagnóstico principal al egreso de hospitalización.
: Tabla de referencia: <code>CIE10</code>
|-
| codDiagnosticoRelacionadoEgreso1
| H11
| String
| AN|..8
| NO
|
: Código CIE-10 de diagnóstico relacionado al egreso.
: Tabla de referencia: <code>CIE10</code>
|-
| condicionSalidaHospitalizacion
| H12
| String
| AN|2
| SI
|
: Condición en que egresó el usuario de hospitalización.
: Incluye la opción <code>08</code>: Paciente continúa en el servicio (corte de facturación).
: Tabla de referencia SISPRO correspondiente.
|-
| codDiagnosticoCausaMuerte
| H13
| String
| AN|..8
| C/C
|
: Código CIE-10 de la causa de muerte, si aplica.
: Tabla de referencia: <code>CIE10</code>
|-
| fechaEgreso
| H14
| String
| AN|16
| SI
|
: Fecha y hora de egreso de hospitalización. Debe estar dentro del periodo de facturación.
: Formato: <code>AAAA-MM-DD hh:mm</code>
|-
| consecutivo
| -
| Integer
| INT32
| SI
|
: Posición del registro de hospitalización dentro del arreglo del usuario.
|}
{{clear}}

==Object.recienNacido==

Arreglo con los datos del recién nacido. Se registra obligatoriamente cuando se atiende un parto vaginal o cesárea, en el RIPS de la madre. Si el recién nacido debe hospitalizarse, se hace una admisión independiente con su propia FEV y RIPS. Corresponde a los campos N01 a N11+.

{| class="mw-collapsible mw-collapsed wikitable" style="margin: auto;"
|-
! style="background:#f2f2f2; text-align:center;"|Atributo
! style="background:#f2f2f2; text-align:center;"|Cód.
! style="background:#f2f2f2; text-align:center;"|Tipo Dato
! style="background:#f2f2f2; text-align:center;"|Formato
! style="background:#f2f2f2; text-align:center;"|Requerido
! style="background:#f2f2f2; text-align:center;"|Descripción
|-
| codPrestador
| N01
| String
| AN|12
| SI
|
: Código de habilitación del prestador con sede (12 caracteres).
: Tabla de referencia SISPRO: <code>IPSCodHabilitacion</code> / <code>IPSNoREPS</code>
|-
| tipoDocumentoIdentificacion
| N02
| String
| AN|..20
| SI
|
: Tipo de documento del recién nacido. Todo niño nacido en el prestador debe tener documento (CN, RC o MS para poblaciones especiales).
: No se registra el documento de la madre.
: Tabla de referencia SISPRO: <code>TipoIdPISIS</code>
|-
| numDocumentoIdentificacion
| N03
| String
| AN|..20
| SI
|
: Número del documento de identificación del recién nacido.
|-
| fechaNacimiento
| N04
| String
| date
| SI
|
: Fecha de nacimiento del recién nacido.
: Formato: <code>YYYY-MM-DD</code>
|-
| edadGestacional
| N05
| Integer
| INT32
| SI
|
: Edad gestacional del recién nacido al momento del nacimiento, expresada en semanas completas.
|-
| pesoAlNacer
| N06
| Decimal
| -
| SI
|
: Peso del recién nacido al momento del nacimiento, expresado en gramos.
|-
| codSexoBiologico
| N07
| String
| AN|2
| SI
|
: Código del sexo biológico del recién nacido.
: Tomar de la columna Extra II de la tabla SISPRO <code>Sexo</code>:
:: <code>01</code> Hombre
:: <code>02</code> Mujer
:: <code>03</code> Indeterminado
|-
| codDiagnosticoPrincipal
| N08
| String
| AN|..8
| SI
|
: Código CIE-10 del diagnóstico principal del recién nacido.
: Tabla de referencia: <code>CIE10</code>
|-
| condicionDestinoUsuarioEgreso
| N09
| String
| AN|2
| SI
|
: Condición y destino del recién nacido al egreso.
: Tabla de referencia SISPRO correspondiente (condición de egreso).
|-
| codDiagnosticoCausaMuerte
| N10
| String
| AN|..8
| C/C
|
: Código CIE-10 de la causa de muerte del recién nacido, si aplica.
: Tabla de referencia: <code>CIE10</code>
|-
| codDiagnosticoRelacionado
| N11
| String
| AN|..8
| NO
|
: Código CIE-10 de diagnóstico relacionado del recién nacido.
: Tabla de referencia: <code>CIE10</code>
|-
| consecutivo
| -
| Integer
| INT32
| SI
|
: Posición del registro de recién nacido dentro del arreglo del usuario.
|}
{{clear}}

==Object.medicamentos==

Arreglo con los datos de medicamentos dispensados o administrados. Incluye medicamentos del plan de beneficios, de presupuesto máximo, preparaciones magistrales y medicamentos no POS. Corresponde a los campos M01 a M20+.

{| class="mw-collapsible mw-collapsed wikitable" style="margin: auto;"
|-
! style="background:#f2f2f2; text-align:center;"|Atributo
! style="background:#f2f2f2; text-align:center;"|Cód.
! style="background:#f2f2f2; text-align:center;"|Tipo Dato
! style="background:#f2f2f2; text-align:center;"|Formato
! style="background:#f2f2f2; text-align:center;"|Requerido
! style="background:#f2f2f2; text-align:center;"|Descripción
|-
| codPrestador
| M01
| String
| AN|12
| SI
|
: Código de habilitación del prestador con sede (12 caracteres).
: Tabla de referencia SISPRO: <code>IPSCodHabilitacion</code> / <code>IPSNoREPS</code>
|-
| numAutorizacion
| M02
| String
| AN
| C/C
|
: Número de autorización del medicamento emitida por la EPS.
|-
| idEntrega
| M03
| String
| AN
| C/C
|
: Número de ID de entrega para medicamentos no financiados con cargo a la UPC.
: Coincide con el ID de prescripción MIPRES para medicamentos de presupuesto máximo.
|-
| fechaDispensAdmon
| M04
| String
| AN|16
| SI
|
: Fecha y hora de dispensación o administración del medicamento.
: Pacientes hospitalarios/urgencias: fecha y hora de cada administración.
: Pacientes ambulatorios: fecha y hora de entrega al paciente.
: Formato: <code>AAAA-MM-DD hh:mm</code>
|-
| codDiagnosticoPrincipal
| M05
| String
| AN|..8
| SI
|
: Código CIE-10 que justifica la prescripción del medicamento.
: Preferentemente no debe iniciar por V o Y.
: Tabla de referencia: <code>CIE10</code>
|-
| codDiagnosticoRelacionado
| M06
| String
| AN|..8
| NO
|
: Código CIE-10 del diagnóstico relacionado con la prescripción.
: Tabla de referencia: <code>CIE10</code>
|-
| tipoMedicamento
| M07
| String
| AN
| SI
|
: Tipo de medicamento dispensado.
: Para preparaciones magistrales (PM): registrar un objeto por cada principio activo.
: Tabla de referencia SISPRO: <code>TipoMedicamentoPOSVersion2</code>
:: <code>01</code> Medicamento POS (Plan de Beneficios)
:: <code>02</code> Medicamento No POS
:: <code>03</code> Preparación Magistral
:: (y demás opciones según tabla SISPRO)
|-
| codTecnologiaSalud
| M08
| String
| AN
| SI
|
: Código del medicamento.
: Usar el '''IUM''' (Identificador Único de Medicamento) preferentemente.
: Si no tiene IUM, usar el '''CUM''' (Código Único de Medicamento).
: Para preparaciones magistrales: CUM/IUM de cada principio activo o código DCI de Cannabis.
: Tablas SISPRO: <code>IUM</code> o <code>CatalogoCUMs</code>
|-
| nomMedicamento
| M09
| String
| AN
| NO
|
: Nombre del medicamento (se obtiene de M08, se puede dejar en blanco manteniendo el campo).
|-
| concentracionMedicamento
| M10
| String
| AN
| C/C
|
: Concentración de cada principio activo dentro de la formulación.
: '''Obligatorio''' para preparaciones magistrales (cuando M07 = <code>03</code>). Informar <code>null</code> para otros tipos.
|-
| unidadMedida
| M11
| String
| AN
| SI
|
: Unidad de medida del medicamento.
: Tabla de referencia SISPRO: <code>UMM</code> (Unidad de Medida de Medicamento)
|-
| formaFarmaceutica
| M12
| String
| AN
| SI
|
: Forma farmacéutica del medicamento (tableta, cápsula, ampolla, etc.).
: Tabla de referencia SISPRO: <code>FFM</code>
|-
| unidadMinDispensa
| M13
| String
| AN
| SI
|
: Unidad mínima de medida en la que se dispensó el medicamento (vial, tableta, frasco).
: Para preparaciones magistrales: la misma unidad de medida de la preparación en todos los principios activos.
: Tablas de referencia SISPRO: <code>UPR</code> y <code>UMM</code>
|-
| cantidadMedicamento
| M14
| Decimal
| -
| SI
|
: Cantidad de unidades mínimas dispensadas o administradas.
: Para preparaciones magistrales: diligenciar en uno de los principios activos; en los demás informar <code>0</code>.
|-
| diasTratamiento
| M15
| Integer
| INT32
| SI
|
: Número de días de tratamiento. No acepta decimales, aproximar al número más alto.
: Para preparaciones magistrales: diligenciar en uno de los principios activos; en los demás informar <code>0</code>.
|-
| tipoDocumentoIdentificacionMedico
| M16
| String
| AN|2
| SI
|
: Tipo de documento de identificación del profesional que prescribió el medicamento.
: Tabla de referencia SISPRO: <code>TipoIdPISIS</code>
|-
| numDocumentoIdentificacionMedico
| M17
| String
| AN
| SI
|
: Número del documento de identificación del profesional prescriptor.
|-
| vrUnitMedicamento
| M18
| Decimal
| -
| SI
|
: Valor unitario del medicamento (por unidad mínima de dispensación). Ya con descuentos pactados.
: Pago por evento: debe ser mayor a <code>0</code>. Otras modalidades: informar <code>0</code>.
: Para PM: valor de cada principio activo o sumatoria en uno de ellos (los demás en 0).
|-
| vrServicio
| M19
| Decimal
| -
| SI
|
: Valor total del medicamento en COP.
: Para PM: sumatoria de todos los principios activos, diligenciado en uno de ellos (los demás en 0).
|-
| conceptoRecaudo
| M20
| String
| AN|2
| SI
|
: Código del tipo de pago moderador.
: Valores (tabla SISPRO <code>conceptoRecaudo</code>):
:: <code>01</code> Copago
:: <code>02</code> Cuota moderadora
:: <code>03</code> Pagos compartidos en planes voluntarios de salud
:: <code>04</code> Anticipos
:: <code>05</code> No aplica
: Rechazo Si el valor no corresponde a los permitidos
|-
| valorPagoModerador
| -
| Decimal
| -
| SI
|
: Valor del pago moderador en COP. Informar <code>0</code> si no aplica.
|-
| numFEVPagoModerador
| -
| String
| AN
| C/C
|
: Número de la FEV por pago moderador. Informar <code>null</code> si no aplica.
|-
| consecutivo
| -
| Integer
| INT32
| SI
|
: Posición del medicamento dentro del arreglo del usuario.
|}
{{clear}}

==Object.otrosServicios==

Arreglo con los datos de otros servicios y tecnologías de salud: dispositivos médicos, insumos, estancias, honorarios profesionales, traslados y servicios complementarios MIPRES. Corresponde a los campos S01 a S12+.

{| class="mw-collapsible mw-collapsed wikitable" style="margin: auto;"
|-
! style="background:#f2f2f2; text-align:center;"|Atributo
! style="background:#f2f2f2; text-align:center;"|Cód.
! style="background:#f2f2f2; text-align:center;"|Tipo Dato
! style="background:#f2f2f2; text-align:center;"|Formato
! style="background:#f2f2f2; text-align:center;"|Requerido
! style="background:#f2f2f2; text-align:center;"|Descripción
|-
| codPrestador
| S01
| String
| AN|12
| SI
|
: Código de habilitación del prestador con sede (12 caracteres).
: Tabla de referencia SISPRO: <code>IPSCodHabilitacion</code> / <code>IPSNoREPS</code>
|-
| fechaInicioAtencion
| S02
| String
| AN|16
| SI
|
: Fecha y hora de inicio del servicio. Dentro del periodo de facturación.
: Formato: <code>AAAA-MM-DD hh:mm</code>
|-
| numAutorizacion
| S03
| String
| AN|..30
| C/C
|
: Número de autorización emitida por la EPS o aseguradora.
|-
| idEntrega
| S04
| String
| AN
| C/C
|
: Número de ID de entrega para servicios no financiados con UPC. Puede coincidir con ID MIPRES.
|-
| tipoOtroServicio
| S05
| String
| AN|2
| SI
|
: Tipo del otro servicio. Valores (tabla de referencia SISPRO):
:: <code>01</code> Dispositivos médicos / insumos
:: <code>02</code> Estancias
:: <code>03</code> Honorarios profesionales
:: <code>04</code> Traslados
:: <code>05</code> Servicios complementarios (MIPRES)
: Si se registran estancias, debe haber datos en hospitalización y/o urgencias con observación.
|-
| codTecnologiaSalud
| S06
| String
| AN
| SI
|
: Código del servicio u tecnología:
:: Dispositivos médicos: usar IDM (Identificador del Dispositivo Médico) o UDI (Unique Device Identifier).
:: Estancias, honorarios y traslados: usar el código CUPS correspondiente.
:: Honorarios: usar el CUPS del procedimiento realizado.
:: Servicios complementarios: usar códigos de la tabla de referencia MIPRES.
: Tabla de referencia SISPRO: <code>CUPSRips</code> (para estancias/traslados/honorarios)
|-
| nomOtroServicio
| S07
| String
| AN
| C/C
|
: Nombre del dispositivo médico o insumo. Informar <code>null</code> para otros tipos de servicio.
|-
| cantidad
| S08
| Decimal
| -
| SI
|
: Cantidad del servicio en unidades.
: Para honorarios, informar siempre <code>1</code>.
|-
| tipoDocumentoIdentificacionMedico
| S09
| String
| AN|2
| SI
|
: Tipo de documento del profesional que prescribió u ordenó el servicio.
: Tabla de referencia SISPRO: <code>TipoIdPISIS</code>
|-
| numDocumentoIdentificacionMedico
| S10
| String
| AN
| SI
|
: Número del documento del profesional que prescribió u ordenó el servicio.
|-
| vrServicio
| S11
| Decimal
| -
| SI
|
: Valor total del servicio en COP.
: Si el dispositivo está gravado con IVA, informar el valor con IVA.
|-
| conceptoRecaudo
| S12
| String
| AN|2
| SI
|
: Código del tipo de pago moderador.
: Tabla de referencia SISPRO: <code>conceptoRecaudo</code> (mismos valores que C18)
: Rechazo Si el valor no corresponde a los permitidos
|-
| valorPagoModerador
| -
| Decimal
| -
| SI
|
: Valor del pago moderador en COP. Informar <code>0</code> si no aplica.
|-
| numFEVPagoModerador
| -
| String
| AN
| C/C
|
: Número de la FEV por pago moderador. Informar <code>null</code> si no aplica.
|-
| consecutivo
| -
| Integer
| INT32
| SI
|
: Posición del registro dentro del arreglo de otros servicios del usuario.
|}
{{clear}}

==Tablas de Referencia SISPRO==

Para el correcto diligenciamiento de los campos de datos del RIPS, se deben consultar las tablas de referencia publicadas en el micrositio oficial del Ministerio de Salud y Protección Social.

; Enlace oficial: [https://web.sispro.gov.co web.sispro.gov.co] — Sección: Tablas de referencia FEV-RIPS

{| class="mw-collapsible wikitable" style="margin: auto;"
|-
! style="background:#e9e9e9; text-align:center;"|Tabla SISPRO
! style="background:#e9e9e9; text-align:center;"|Campos que la utilizan
! style="background:#e9e9e9; text-align:center;"|Descripción
|-
| <code>TipoNota</code>
| T03
|
: Valores permitidos para el tipo de nota del RIPS (NC, ND, NA, RS).
|-
| <code>TipoIdPISIS</code>
| U01, C15, P11, N02, M16, S09
|
: Tipos de documento de identificación válidos en el sistema de salud.
|-
| <code>RIPSTipoUsuarioVersion2</code>
| U03
|
: Tipos de usuario según régimen de afiliación al SGSSS (13 opciones).
|-
| <code>Sexo</code>
| U05, N07
|
: Códigos de sexo biológico. Extra_III para usuarios (M/F/I), Extra_II para recién nacidos (01/02/03).
|-
| <code>País</code>
| U06, U11
|
: Códigos de países del mundo para residencia y origen del usuario.
|-
| <code>Municipio</code>
| U07
|
: Códigos DIVIPOLA de municipios de Colombia.
|-
| <code>ZonaVersion2</code>
| U08
|
: Códigos de zona territorial de residencia.
|-
| <code>LstSiNo</code>
| U09
|
: Valores SI/NO para el campo de incapacidad.
|-
| <code>IPSCodHabilitacion</code>
| C01, P01, R01, H01, N01, M01, S01
|
: Códigos de habilitación de prestadores de servicios de salud (IPS registradas en REPS).
|-
| <code>IPSNoREPS</code>
| C01, P01, R01, H01, N01, M01, S01
|
: Códigos de proveedores de tecnologías en salud y prestadores no REPS.
|-
| <code>CUPSRips</code>
| C04, P05, S06
|
: Clasificación Única de Procedimientos en Salud vigente para RIPS.
|-
| <code>ModalidadAtencion</code>
| C05, P07
|
: Modalidades de atención (intramural, extramural, telemedicina, etc.).
|-
| <code>GrupoServicios</code>
| C06, P08
|
: Grupos de servicios según la Resolución 3100 de 2019.
|-
| <code>Servicios</code>
| C07, P09
|
: Códigos de tres dígitos de los servicios habilitados.
|-
| <code>RIPSFinalidadConsultaVersion2</code>
| C08, P10
|
: Finalidad de la tecnología en salud. Columna ExtraI para consultas, Extra II para procedimientos.
|-
| <code>RIPSCausaExternaVersion2</code>
| C09, R03, H05
|
: Causas externas que motivan la atención (valores 21 a 30).
|-
| <code>CIE10</code>
| C10-C13, P13-P15, R04-R10, H06-H13, N08-N11, M05-M06
|
: Clasificación Internacional de Enfermedades, versión 10. Códigos de diagnóstico.
|-
| <code>conceptoRecaudo</code>
| C18, P17, M20, S12
|
: Tipos de pago moderador: copago, cuota moderadora, planes voluntarios, anticipos, no aplica.
|-
| <code>TipoMedicamentoPOSVersion2</code>
| M07
|
: Tipos de medicamento: POS, No POS, preparación magistral, UNIRS, MVND, Cannabis, entre otros.
|-
| <code>IUM</code>
| M08
|
: Identificador Único de Medicamento.
|-
| <code>CatalogoCUMs</code>
| M08
|
: Código Único de Medicamento (cuando no tiene IUM).
|-
| <code>UMM</code>
| M11
|
: Unidades de medida de medicamentos.
|-
| <code>FFM</code>
| M12
|
: Formas farmacéuticas de medicamentos.
|-
| <code>UPR</code>
| M13
|
: Unidades de presentación para dispensación.
|}
{{clear}}

; '''@IMPORTANTE:''' Los campos y valores permitidos están sujetos a actualización continua por parte del Ministerio de Salud. Siempre consultar la versión vigente de las tablas en [https://web.sispro.gov.co web.sispro.gov.co] y el documento de lineamientos técnicos vigente publicado en el micrositio de Factura Electrónica en Salud.

 
 
 
 

<center>'''<big>[[Archivo:Copyright.png|100px|sinmarco|centro|Copyright]]THE FACTORY HKA COLOMBIA</big>
 Copyright © 2016 The Factory HKA. Todos los derechos reservados.</center>

{{clear}}

Indice del Manual Integración Directa HKA Fácil RIPS

2026-04-14T22:17:30Z

Dmrodriguez2:

[[Archivo:HKA_ Fácil_ RIPS.png|500px|center|HKA Fácil RIPS]]

<includeonly>=</includeonly>==[[Generalidades - Indice Manual Integración Directa HKA Fácil RIPS|Generalidades]]==<includeonly>=</includeonly>
# [[Generalidades - Indice Manual Integración Directa HKA Fácil RIPS#Historial de versiones|Historial de versiones]]
# [[Generalidades - Indice Manual Integración Directa HKA Fácil RIPS#Cómo obtener soporte|Cómo obtener soporte]]
# [[Generalidades - Indice Manual Integración Directa HKA Fácil RIPS#Descripción general|Descripción general]]
## [[Generalidades - Indice Manual Integración Directa HKA Fácil RIPS#¿Qué es HKA Fácil RIPS?|¿Qué es HKA Fácil RIPS?]]
## [[Generalidades - Indice Manual Integración Directa HKA Fácil RIPS#¿Qué son los RIPS?|¿Qué son los RIPS?]]
## [[Generalidades - Indice Manual Integración Directa HKA Fácil RIPS#Tipos de RIPS soportados|Tipos de RIPS soportados]]
## [[Generalidades - Indice Manual Integración Directa HKA Fácil RIPS#Ambientes de integración|Ambientes de integración]]
## [[Generalidades - Indice Manual Integración Directa HKA Fácil RIPS#Autenticación|Autenticación]]
## [[Generalidades - Indice Manual Integración Directa HKA Fácil RIPS#Requerimientos técnicos|Requerimientos técnicos]]

<includeonly>=</includeonly>==[[Métodos API REST HKA Fácil RIPS - Indice Manual Integración Directa HKA Fácil RIPS|Métodos API REST HKA Fácil RIPS]]==<includeonly>=</includeonly>
# [[Métodos API REST HKA Fácil RIPS - Indice Manual Integración Directa HKA Fácil RIPS#Método Enviar|Método Enviar]]
## [[Métodos API REST HKA Fácil RIPS - Indice Manual Integración Directa HKA Fácil RIPS#Request Método Enviar|Request Método Enviar]]
## [[Métodos API REST HKA Fácil RIPS - Indice Manual Integración Directa HKA Fácil RIPS#Object.ripsJson|Object.ripsJson]]
## [[Métodos API REST HKA Fácil RIPS - Indice Manual Integración Directa HKA Fácil RIPS#Object.rips|Object.rips]]
## [[Métodos API REST HKA Fácil RIPS - Indice Manual Integración Directa HKA Fácil RIPS#Response Método Enviar|Response Método Enviar]]
# [[Métodos API REST HKA Fácil RIPS - Indice Manual Integración Directa HKA Fácil RIPS#Método EstadoRIPS|Método EstadoRIPS]]
## [[Métodos API REST HKA Fácil RIPS - Indice Manual Integración Directa HKA Fácil RIPS#Request Método EstadoRIPS|Request Método EstadoRIPS]]
## [[Métodos API REST HKA Fácil RIPS - Indice Manual Integración Directa HKA Fácil RIPS#Ejemplo de Request|Ejemplo de Request]]
## [[Métodos API REST HKA Fácil RIPS - Indice Manual Integración Directa HKA Fácil RIPS#Response Método EstadoRIPS|Response Método EstadoRIPS]]

<includeonly>=</includeonly>==[[Estructura JSON del RIPS Ministerio de Salud - Indice Manual Integración Directa HKA Fácil RIPS|Estructura JSON del RIPS Ministerio de Salud]]==<includeonly>=</includeonly>
# [[Estructura JSON del RIPS Ministerio de Salud - Indice Manual Integración Directa HKA Fácil RIPS#Object.transaccion|Object.transaccion]]
# [[Estructura JSON del RIPS Ministerio de Salud - Indice Manual Integración Directa HKA Fácil RIPS#Object.usuario|Object.usuario]]
# [[Estructura JSON del RIPS Ministerio de Salud - Indice Manual Integración Directa HKA Fácil RIPS#Object.consultas|Object.consultas]]
# [[Estructura JSON del RIPS Ministerio de Salud - Indice Manual Integración Directa HKA Fácil RIPS#Object.procedimientos|Object.procedimientos]]
# [[Estructura JSON del RIPS Ministerio de Salud - Indice Manual Integración Directa HKA Fácil RIPS#Object.urgencias|Object.urgencias]]
# [[Estructura JSON del RIPS Ministerio de Salud - Indice Manual Integración Directa HKA Fácil RIPS#Object.hospitalizacion|Object.hospitalizacion]]
# [[Estructura JSON del RIPS Ministerio de Salud - Indice Manual Integración Directa HKA Fácil RIPS#Object.recienNacido|Object.recienNacido]]
# [[Estructura JSON del RIPS Ministerio de Salud - Indice Manual Integración Directa HKA Fácil RIPS#Object.medicamentos|Object.medicamentos]]
# [[Estructura JSON del RIPS Ministerio de Salud - Indice Manual Integración Directa HKA Fácil RIPS#Object.otrosServicios|Object.otrosServicios]]
# [[Estructura JSON del RIPS Ministerio de Salud - Indice Manual Integración Directa HKA Fácil RIPS#Tablas de Referencia SISPRO|Tablas de Referencia SISPRO]]

<includeonly>=</includeonly>==[[Códigos de Respuesta - Indice Manual Integración Directa HKA Fácil RIPS|Códigos de Respuesta]]==<includeonly>=</includeonly>
# [[Códigos de Respuesta - Indice Manual Integración Directa HKA Fácil RIPS#Códigos de Negocio Generales|Códigos de Negocio Generales]]
# [[Códigos de Respuesta - Indice Manual Integración Directa HKA Fácil RIPS#Método Enviar|Códigos de Respuesta Método Enviar]]
# [[Códigos de Respuesta - Indice Manual Integración Directa HKA Fácil RIPS#Método EstadoRIPS|Códigos de Respuesta Método EstadoRIPS]]

 
 
 
 

<center>'''<big>[[Archivo:Copyright.png|100px|sinmarco|centro|Copyright]]THE FACTORY HKA COLOMBIA</big>
 Copyright © 2016 The Factory HKA. Todos los derechos reservados.</center>

Métodos API REST HKA Fácil RIPS - Indice Manual Integración Directa HKA Fácil RIPS

2026-04-14T14:42:38Z

Dmrodriguez2: /* Método Enviar */

[[Categoría:Manuales]]
==Método Servicio Emisión Web HKA Fácil RIPS==

Los parámetros a incorporar en los métodos de esta API deberán cumplir con el formato y las directivas que correspondan según las siguientes reglas:

{| class="mw-collapsible mw-collapsed wikitable" style="margin: auto;"
|-
! style="background:#e9e9e9; text-align:center;"|Formato
! style="background:#e9e9e9; text-align:center;"|Descripción
|- valign="center"
| AN || Carácter alfanumérico
|-
| UUID || Identificador único universal (formato: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)
|-
| date || Fecha en formato ISO 8601: YYYY-MM-DD
|-
| datetime || Fecha y hora en formato ISO 8601: YYYY-MM-DDThh:mm:ssZ
|-
| boolean || Valor lógico: <code>true</code> o <code>false</code>
|-
| integer || Número entero (INT32). Valor máximo: 2,147,483,647
|-
| decimal || Número decimal
|-
| base64 || Cadena codificada en Base64
|}
{{clear}}
 
{| class="mw-collapsible mw-collapsed wikitable" style="margin: auto;"
|-
! style="background:#e9e9e9; text-align:center;"|Requerido
! style="background:#e9e9e9; text-align:center;"|Descripción
|- valign="center"
| SI || Campo obligatorio
|-
| NO || Campo opcional
|-
| C/C || Requerido cuando corresponda (bajo una condición específica)
|}
{{clear}}

==Método Enviar==

La función encargada de enviar un RIPS (Registro Individual de Prestación de Servicios) al Ministerio de Salud de Colombia. El proceso incluye autenticación automática, creación del RIPS (si no se proporciona <code>idRips</code>) y generación/envío al Ministerio.

{{clear}}

===Request Método Enviar===

{| class="mw-collapsible mw-collapsed wikitable" style="margin: auto;"
|-
! style="background:#f2f2f2; text-align:center;"|Atributo
! style="background:#f2f2f2; text-align:center;"|Tipo Dato
! style="background:#f2f2f2; text-align:center;"|Formato
! style="background:#f2f2f2; text-align:center;"|Requerido
! style="background:#f2f2f2; text-align:center;"|Descripción
|-
| tokenEmpresa
| String
| AN|40
| SI
|
: Token de identificación de la empresa en la plataforma HKA Fácil RIPS.
: Suministrado por The Factory HKA Colombia al momento de la habilitación.
: Rechazo Si el token no tiene exactamente 40 caracteres alfanuméricos (ver código de negocio 111)
|-
| tokenPassword
| String
| AN|40
| SI
|
: Token contraseña de acceso a la plataforma HKA Fácil RIPS.
: Suministrado por The Factory HKA Colombia al momento de la habilitación.
: Rechazo Si el token no tiene exactamente 40 caracteres alfanuméricos (ver código de negocio 111)
|-
| tipoRips
| String
| AN|2
| SI
|
: Tipo de documento RIPS a generar y enviar.
: Valores permitidos:
:: <code>01</code> RIPS con Factura Electrónica de Venta (FEV)
:: <code>02</code> RIPS sin Factura Electrónica de Venta (Sin FEV)
:: <code>03</code> RIPS con Nota Crédito
:: <code>04</code> RIPS con Nota Débito
:: <code>05</code> RIPS con documento de contingencia
: Rechazo Si el valor no corresponde a uno de los tipos permitidos (ver código de negocio 109)
|-
| idRips
| String
| UUID
| NO
|
: Identificador único (UUID) de un RIPS previamente creado en el sistema.
: Si se omite o se envía nulo, el sistema crea un nuevo RIPS automáticamente y retorna el <code>idRips</code> generado en la respuesta.
: Usar este campo para reintentar el envío de un RIPS ya creado pero no enviado al Ministerio.
: Rechazo Si el UUID proporcionado no existe en el sistema (ver código de negocio 102)
|-
| ripsJson
| Object
| -
| SI
|
: Objeto JSON con la estructura de datos del RIPS a enviar al Ministerio de Salud.
: Contiene dos propiedades: <code>rips</code> (estructura del RIPS) y <code>xmlFevFile</code> (archivo XML de la FEV en Base64).
: (ver detalle en [[#Object.ripsJson|Object.ripsJson]])
|}
{{clear}}

====Object.ripsJson====
{| class="mw-collapsible mw-collapsed wikitable" style="margin: auto;"
|-
! style="background:#f2f2f2; text-align:center;"|Atributo
! style="background:#f2f2f2; text-align:center;"|Tipo Dato
! style="background:#f2f2f2; text-align:center;"|Formato
! style="background:#f2f2f2; text-align:center;"|Requerido
! style="background:#f2f2f2; text-align:center;"|Descripción
|-
| rips
| Object
| -
| SI
|
: Objeto con la estructura de datos del RIPS según la normativa del Ministerio de Salud.
: (ver detalle en [[#Object.rips|Object.rips]])
|-
| xmlFevFile
| String
| base64
| C/C
|
: Contenido del archivo XML de la Factura Electrónica de Venta (FEV) codificado en Base64.
: '''Obligatorio''' cuando <code>tipoRips</code> es <code>01</code> (RIPS con FEV).
: Enviar cadena vacía <code>""</code> cuando <code>tipoRips</code> es <code>02</code> (sin FEV).
|}
{{clear}}

====Object.rips====
{| class="mw-collapsible mw-collapsed wikitable" style="margin: auto;"
|-
! style="background:#f2f2f2; text-align:center;"|Atributo
! style="background:#f2f2f2; text-align:center;"|Tipo Dato
! style="background:#f2f2f2; text-align:center;"|Formato
! style="background:#f2f2f2; text-align:center;"|Requerido
! style="background:#f2f2f2; text-align:center;"|Descripción
|-
| numDocumentoIdObligado
| String
| AN|..20
| SI
|
: NIT o número de identificación del prestador de servicios de salud obligado a reportar RIPS.
|-
| numNota
| String
| AN|..50
| SI
|
: Número de la nota, factura o documento asociado al RIPS.
|-
| tipoNota
| String
| AN|2
| SI
|
: Tipo del documento asociado al RIPS.
: Valores ejemplo:
:: <code>NC</code> Nota Crédito
:: <code>FV</code> Factura de Venta
|-
| usuarios
| Array <Object.usuario>
| -
| SI
|
: Lista de usuarios/pacientes con los servicios de salud prestados.
: Debe contener al menos un usuario.
: (ver detalle en [[#Object.usuario|Object.usuario]])
|}
{{clear}}

===Ejemplo de Request===

<syntaxhighlight lang="json">
{
"tokenEmpresa": "abc123def456ghi789jkl012mno345pqr678stu9",
"tokenPassword": "xyz987wvu654tsr321qpo098nml765kji432hgf1",
"tipoRips": "02",
"idRips": null,
"ripsJson": {
"rips": {
"numDocumentoIdObligado": "900390126",
"numNota": "RT45657",
"tipoNota": "NC",
"usuarios": [
{
"tipoDocumentoIdentificacion": "CC",
"numDocumentoIdentificacion": "1234567890",
"tipoUsuario": "12",
"fechaNacimiento": "1990-01-01",
"codSexo": "M",
"servicios": {
"otrosServicios": [
{
"codPrestador": "900390126",
"fechaInicioAtencion": "2025-10-16",
"numAutorizacion": "12345",
"codServicio": "890201",
"finalidadTecnologiaSalud": "01",
"causaMotivoAtencion": "01",
"codDiagnosticoPrincipal": "Z000",
"tipoDiagnosticoPrincipal": "01",
"vrServicio": 0,
"conceptoRecaudo": "05",
"valorPagoModerador": 0,
"numFEVPagoModerador": ""
}
]
}
}
]
},
"xmlFevFile": ""
}
}
</syntaxhighlight>

===Response Método Enviar===

{| class="mw-collapsible mw-collapsed wikitable" style="margin: auto;"
|-
! style="background:#f2f2f2; text-align:center;"|Atributo
! style="background:#f2f2f2; text-align:center;"|Tipo Dato
! style="background:#f2f2f2; text-align:center;"|Formato
! style="background:#f2f2f2; text-align:center;"|Descripción
|-
| codigo
| integer
| INT32
|
: Código de negocio del resultado de la operación.
: Ver [[Códigos de Respuesta - Indice Manual Integración Directa HKA Fácil RIPS#Método Enviar|Códigos de Respuesta - Método Enviar]]
|-
| mensaje
| String
| AN
|
: Mensaje descriptivo del resultado de la operación.
|-
| estado
| boolean
| boolean
|
: Indica si la operación fue exitosa.
: <code>true</code> El RIPS fue enviado y aceptado por el Ministerio.
: <code>false</code> La operación falló o el RIPS fue rechazado.
|-
| idRips
| String
| UUID
|
: Identificador único del RIPS procesado.
: '''Conservar este valor''' para consultas posteriores con el método EstadoRIPS.
|-
| archivoRetornado
| Object
| -
|
: Objeto con los detalles del resultado retornado por el Ministerio de Salud.
: <code>null</code> si la operación falló antes de llegar al Ministerio.
: (ver detalle en [[#Object.archivoRetornado|Object.archivoRetornado]])
|-
| errors
| Array <String>
| AN
|
: Lista de mensajes de error de validación de campos del request.
: Solo presente cuando el código de negocio es <code>109</code> o <code>111</code>.
|}
{{clear}}

==Método EstadoRIPS==

La función encargada de consultar el estado actual de un RIPS que fue enviado previamente al Ministerio de Salud de Colombia. Un RIPS puede estar en uno de los siguientes estados: '''VALIDADO''', '''RECHAZADO''' o '''CREADO'''.

''@NOTA:''' Este método es útil para verificar el resultado de un envío cuando el método Enviar no retornó una respuesta definitiva (por ejemplo, por timeout de red).

===Request Método EstadoRIPS===

{| class="mw-collapsible mw-collapsed wikitable" style="margin: auto;"
|-
! style="background:#f2f2f2; text-align:center;"|Atributo
! style="background:#f2f2f2; text-align:center;"|Tipo Dato
! style="background:#f2f2f2; text-align:center;"|Formato
! style="background:#f2f2f2; text-align:center;"|Requerido
! style="background:#f2f2f2; text-align:center;"|Descripción
|-
| tokenEmpresa
| String
| AN|40
| SI
|
: Token de identificación de la empresa en la plataforma HKA Fácil RIPS.
: Suministrado por The Factory HKA Colombia al momento de la habilitación.
: Rechazo Si el token no tiene exactamente 40 caracteres alfanuméricos (ver código de negocio 111)
|-
| tokenPassword
| String
| AN|40
| SI
|
: Token contraseña de acceso a la plataforma HKA Fácil RIPS.
: Suministrado por The Factory HKA Colombia al momento de la habilitación.
: Rechazo Si el token no tiene exactamente 40 caracteres alfanuméricos (ver código de negocio 111)
|-
| idRips
| String
| UUID
| SI
|
: Identificador único (UUID) del RIPS a consultar.
: Este valor es retornado por el método Enviar en el campo <code>idRips</code> de la respuesta.
: Formato: <code>xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx</code>
: Ejemplo: <code>3fa85f64-5717-4562-b3fc-2c963f66afa6</code>
: Rechazo Si el UUID proporcionado no existe en el sistema (ver código de negocio 102)
|}
{{clear}}

===Ejemplo de Request===

<syntaxhighlight lang="json">
{
"tokenEmpresa": "abc123def456ghi789jkl012mno345pqr678stu9",
"tokenPassword": "xyz987wvu654tsr321qpo098nml765kji432hgf1",
"idRips": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
</syntaxhighlight>

===Response Método EstadoRIPS===

{| class="mw-collapsible mw-collapsed wikitable" style="margin: auto;"
|-
! style="background:#f2f2f2; text-align:center;"|Atributo
! style="background:#f2f2f2; text-align:center;"|Tipo Dato
! style="background:#f2f2f2; text-align:center;"|Formato
! style="background:#f2f2f2; text-align:center;"|Descripción
|-
| codigo
| integer
| INT32
|
: Código de negocio del resultado de la operación.
: Ver [[Códigos de Respuesta - Indice Manual Integración Directa HKA Fácil RIPS#Método EstadoRIPS|Códigos de Respuesta - Método EstadoRIPS]]
|-
| mensaje
| String
| AN
|
: Mensaje descriptivo del estado actual del RIPS.
|-
| estado
| boolean
| boolean
|
: Indica si la consulta fue exitosa y el RIPS está validado.
: <code>true</code> El RIPS fue aceptado por el Ministerio (estado: VALIDADO).
: <code>false</code> En cualquier otro caso (RECHAZADO, CREADO, no encontrado, error).
|-
| idRips
| String
| UUID
|
: Identificador único del RIPS consultado.
|-
| archivoRetornado
| Object
| -
|
: Objeto con los detalles del resultado retornado por el Ministerio de Salud.
: <code>null</code> cuando el RIPS está en estado CREADO, no fue encontrado, o hubo error de autenticación.
: (ver detalle en [[Método Enviar - Indice Manual Integración Directa HKA Fácil RIPS#Object.archivoRetornado|Object.archivoRetornado]])
|-
| errors
| Array <String>
| AN
|
: Lista de mensajes de error de validación de campos del request.
: Solo presente cuando el código de negocio es <code>109</code> o <code>111</code>.
|}
{{clear}}

Códigos de Respuesta - Indice Manual Integración Directa HKA Fácil RIPS

2026-04-14T14:18:58Z

Dmrodriguez2: Página creada con «Categoría:Manuales == Tabla de Códigos de Negocio == Los endpoints de la API HKA Fácil RIPS retornan '''códigos de negocio''' en el campo <code>codigo</code> de la respuesta JSON. Estos códigos indican el resultado específico de la operación realizada y son '''independientes del código HTTP''' de la respuesta. @Importante: El código HTTP de la respuesta puede variar según el contexto, pero el '''código de negocio''' siempre r…»

[[Categoría:Manuales]]
== Tabla de Códigos de Negocio ==

Los endpoints de la API HKA Fácil RIPS retornan '''códigos de negocio''' en el campo <code>codigo</code> de la respuesta JSON. Estos códigos indican el resultado específico de la operación realizada y son '''independientes del código HTTP''' de la respuesta.

@Importante: El código HTTP de la respuesta puede variar según el contexto, pero el '''código de negocio''' siempre refleja el resultado específico de la operación. Para determinar el resultado correcto, se debe verificar el campo <code>codigo</code> del cuerpo de la respuesta.

{| class="wikitable"
|-
! Código !! Significado !! HTTP Status !! estado !! Aplica en
|-
| '''200''' || Operación exitosa. El RIPS fue enviado/consultado exitosamente. || <code>200 OK</code> || <code>true</code> || Enviar, Estado
|-
| '''99''' || RIPS rechazado por el Ministerio. El RIPS contiene errores de validación según el Ministerio de Salud. || <code>422 Unprocessable Entity</code> || <code>false</code> || Enviar, Estado
|-
| '''101''' || Error de autenticación. Las credenciales (<code>tokenEmpresa</code> / <code>tokenPassword</code>) son inválidas o no corresponden a una empresa registrada. || <code>401 Unauthorized</code> || <code>false</code> || Enviar, Estado
|-
| '''102''' || RIPS no encontrado o <code>idRips</code> inválido. El identificador UUID proporcionado no existe en el sistema. || <code>400 Bad Request</code> / <code>404 Not Found</code> || <code>false</code> || Enviar, Estado
|-
| '''109''' || Error de validación. Error al crear o generar el RIPS. Generalmente causado por campos obligatorios faltantes o con valores inválidos. || <code>400 Bad Request</code> || <code>false</code> || Enviar
|-
| '''111''' || Error de validación de tokens. Los tokens no cumplen con el formato requerido: deben ser exactamente '''40 caracteres alfanuméricos'''. || <code>400 Bad Request</code> || <code>false</code> || Enviar, Estado
|-
| '''114''' || RIPS ya procesado. El RIPS ya ha sido aceptado y procesado por el Ministerio. No se puede volver a enviar. || <code>409 Conflict</code> || <code>false</code> || Enviar, Estado
|-
| '''162''' || RIPS en estado creado. El RIPS fue creado en el sistema pero aún no ha sido enviado al Ministerio. Se debe usar el método Enviar para transmitirlo. || <code>200 OK</code> || <code>false</code> || Estado
|-
| '''500''' || Error interno del servidor. Se produjo un error inesperado en el procesamiento. Contactar al soporte técnico. || <code>500 Internal Server Error</code> || <code>false</code> || Enviar, Estado
|}

=== Notas sobre los códigos de negocio ===

==== Código 200 - Operación exitosa ====
El RIPS fue procesado satisfactoriamente. En la respuesta se incluye el campo <code>archivoRetornado</code> con el '''Código Único de Validación (CUV)''' asignado por el Ministerio de Salud.

==== Código 99 - RIPS rechazado ====
El Ministerio de Salud validó la estructura del paquete RIPS pero encontró errores en los datos. La respuesta incluye el campo <code>archivoRetornado.resultadosValidacion</code> con la lista de errores específicos.

'''Acción recomendada:''' Revisar el campo <code>resultadosValidacion</code> para identificar los campos con errores, corregirlos y volver a enviar el RIPS.

==== Código 101 - Error de autenticación ====
Los tokens proporcionados no son válidos o no están asociados a ninguna empresa en el sistema.

'''Acción recomendada:''' Verificar que los valores de <code>tokenEmpresa</code> y <code>tokenPassword</code> sean los correctos. Si el problema persiste, contactar al área de integración de The Factory HKA Colombia.

==== Código 102 - RIPS no encontrado ====
El <code>idRips</code> proporcionado no existe en el sistema. Puede ocurrir si:
* El UUID fue digitado incorrectamente.
* El RIPS fue enviado con credenciales de una empresa diferente.
* El <code>idRips</code> nunca fue creado en el sistema.

'''Acción recomendada:''' Verificar el valor del <code>idRips</code>. Si se tiene certeza de que el RIPS fue creado, contactar al soporte.

==== Código 109 - Error de validación al crear el RIPS ====
Error en la estructura o contenido del <code>ripsJson</code>. Puede ocurrir por:
* Campos obligatorios faltantes en el request.
* Valores de <code>tipoRips</code> inválidos (debe ser <code>01</code>, <code>02</code>, <code>03</code>, <code>04</code> o <code>05</code>).
* Estructura del <code>ripsJson</code> incorrecta.

'''Acción recomendada:''' Revisar el campo <code>errors</code> en la respuesta para identificar los campos con errores.

==== Código 111 - Error de validación de tokens (formato) ====
Los tokens no tienen el formato correcto. Ambos tokens deben ser cadenas de texto con exactamente '''40 caracteres alfanuméricos''' (letras a-z, A-Z y dígitos 0-9).

'''Acción recomendada:''' Verificar que los tokens no contengan caracteres especiales, espacios en blanco, ni tengan una longitud diferente a 40 caracteres.

==== Código 114 - RIPS ya procesado ====
El RIPS identificado con el <code>idRips</code> proporcionado ya fue enviado y aceptado por el Ministerio de Salud. No es posible volver a procesarlo.

'''Acción recomendada:''' Si se requiere enviar información adicional o corregir datos, se debe crear un nuevo RIPS (sin proporcionar <code>idRips</code>, o con un nuevo UUID).

==== Código 162 - RIPS en estado creado ====
El RIPS existe en el sistema pero solo fue creado, no enviado al Ministerio. Este código solo aparece en el '''método EstadoRIPS'''.

'''Acción recomendada:''' Llamar al método Enviar con el <code>idRips</code> correspondiente para transmitirlo al Ministerio.

==== Código 500 - Error interno del servidor ====
Error inesperado en el servidor de HKA Fácil RIPS.

'''Acción recomendada:''' Reintentar la operación. Si el error persiste, contactar al soporte técnico de The Factory HKA Colombia con los detalles de la petición realizada.

----

== Catálogo de Errores de Validación ==

Cuando el Ministerio de Salud rechaza un RIPS (código de negocio <code>99</code>), la respuesta incluye en el campo <code>archivoRetornado.resultadosValidacion</code> una lista de objetos que describen cada uno de los errores de validación encontrados.

=== Estructura del objeto ResultadoValidacion ===

{| class="wikitable"
|-
! Campo !! Tipo !! Descripción
|-
| <code>clase</code> || <code>string</code> || Clasificación del resultado. Valor posible: <code>"RECHAZADO"</code>.
|-
| <code>codigo</code> || <code>string</code> || Código único del error asignado por el Ministerio de Salud. Ejemplo: <code>"RVG06"</code>.
|-
| <code>descripcion</code> || <code>string</code> || Descripción general del error.
|-
| <code>fuente</code> || <code>string</code> || Fuente del error. Indica en qué componente del paquete se encontró el error. Ejemplo: <code>"Rips"</code>.
|-
| <code>observaciones</code> || <code>string</code> || Detalle específico del error. Incluye el valor incorrecto y los valores permitidos.
|-
| <code>pathFuente</code> || <code>string</code> || Ruta JSON al campo específico donde se encontró el error. Útil para localizar el dato incorrecto dentro del <code>ripsJson</code>. Ejemplo: <code>"usuarios[0].servicios.otrosServicios[0].conceptoRecaudo"</code>.
|}

=== Ejemplo de rechazo del Ministerio ===

<syntaxhighlight lang="json">
{
"codigo": 99,
"mensaje": "Error al enviar el RIPS: El dato informado no corresponde al contenido requerido.",
"estado": false,
"idRips": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"archivoRetornado": {
"codigoUnicoValidacion": "No aplica a paquetes procesados en estado [RECHAZADO]",
"fechaRadicacion": "2025-10-27T10:30:00Z",
"fechaRespuesta": null,
"numFactura": "SINFEV",
"procesoId": 0,
"resultadosValidacion": [
{
"clase": "RECHAZADO",
"codigo": "RVG06",
"descripcion": "El dato informado no corresponde al contenido requerido.",
"fuente": "Rips",
"observaciones": "El valor del campo conceptoRecaudo no es válido. Debe ser uno de los valores permitidos: 01, 02, 03...",
"pathFuente": "usuarios[0].servicios.otrosServicios[0].conceptoRecaudo"
}
],
"resultState": false,
"message": "Error al enviar el RIPS: El dato informado no corresponde al contenido requerido."
}
}
</syntaxhighlight>

'''Interpretación del error:'''
* '''Código de error:''' <code>RVG06</code> - Error de validación de dato incorrecto.
* '''Campo con error:''' <code>usuarios[0].servicios.otrosServicios[0].conceptoRecaudo</code> - El campo <code>conceptoRecaudo</code> del primer servicio del primer usuario tiene un valor no permitido.
* '''Acción:''' Corregir el valor de <code>conceptoRecaudo</code> usando uno de los valores válidos (<code>01</code>, <code>02</code>, <code>03</code>, <code>04</code>, <code>05</code>) y volver a enviar el RIPS.

=== Diferencia entre errores de validación de API y errores del Ministerio ===

{| class="wikitable"
|-
! Tipo de error !! Código de negocio !! Origen !! Dónde aparecen los detalles
|-
| '''Error de validación de campos del request''' || <code>109</code>, <code>111</code> || API HKA Fácil RIPS || Campo <code>errors</code> (array de strings en la raíz de la respuesta)
|-
| '''Error de validación del Ministerio''' || <code>99</code> || Ministerio de Salud || Campo <code>archivoRetornado.resultadosValidacion</code> (array de objetos <code>ResultadoValidacion</code>)
|}

Indice del Manual Integración Directa HKA Fácil RIPS

2026-04-14T14:08:05Z

Dmrodriguez2:

Indice del Manual Integración Directa HKA Fácil RIPS

2026-04-14T13:45:11Z

Dmrodriguez2:

Indice del Manual Integración Directa HKA Fácil RIPS

2026-04-14T13:42:54Z

Dmrodriguez2:

Indice del Manual Integración Directa HKA Fácil RIPS

2026-04-14T13:39:21Z

Dmrodriguez2:

Métodos API REST HKA Fácil RIPS - Indice Manual Integración Directa HKA Fácil RIPS

2026-04-13T21:49:10Z

Dmrodriguez2: Página creada con «Categoría:Manuales ==Método Enviar - Indice Manual Integración Directa HKA Fácil RIPS== Los parámetros a incorporar en los métodos de esta API deberán cumplir con el formato y las directivas que correspondan según las siguientes reglas: {| class="mw-collapsible mw-collapsed wikitable" style="margin: auto;" |- ! style="background:#e9e9e9; text-align:center;"|Formato ! style="background:#e9e9e9; text-align:center;"|Descripción |…»

[[Categoría:Manuales]]
==Método Enviar - Indice Manual Integración Directa HKA Fácil RIPS==

Los parámetros a incorporar en los métodos de esta API deberán cumplir con el formato y las directivas que correspondan según las siguientes reglas:

{| class="mw-collapsible mw-collapsed wikitable" style="margin: auto;"
|-
! style="background:#e9e9e9; text-align:center;"|Formato
! style="background:#e9e9e9; text-align:center;"|Descripción
|- valign="center"
| AN || Carácter alfanumérico
|-
| UUID || Identificador único universal (formato: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)
|-
| date || Fecha en formato ISO 8601: YYYY-MM-DD
|-
| datetime || Fecha y hora en formato ISO 8601: YYYY-MM-DDThh:mm:ssZ
|-
| boolean || Valor lógico: <code>true</code> o <code>false</code>
|-
| integer || Número entero (INT32). Valor máximo: 2,147,483,647
|-
| decimal || Número decimal
|-
| base64 || Cadena codificada en Base64
|}
{{clear}}
 
{| class="mw-collapsible mw-collapsed wikitable" style="margin: auto;"
|-
! style="background:#e9e9e9; text-align:center;"|Requerido
! style="background:#e9e9e9; text-align:center;"|Descripción
|- valign="center"
| SI || Campo obligatorio
|-
| NO || Campo opcional
|-
| C/C || Requerido cuando corresponda (bajo una condición específica)
|}
{{clear}}

==Método Enviar==

La función encargada de enviar un RIPS (Registro Individual de Prestación de Servicios) al Ministerio de Salud de Colombia. El proceso incluye autenticación automática, creación del RIPS (si no se proporciona <code>idRips</code>) y generación/envío al Ministerio.

{{clear}}

===Request Método Enviar===

{| class="mw-collapsible mw-collapsed wikitable" style="margin: auto;"
|-
! style="background:#f2f2f2; text-align:center;"|Atributo
! style="background:#f2f2f2; text-align:center;"|Tipo Dato
! style="background:#f2f2f2; text-align:center;"|Formato
! style="background:#f2f2f2; text-align:center;"|Requerido
! style="background:#f2f2f2; text-align:center;"|Descripción
|-
| tokenEmpresa
| String
| AN|40
| SI
|
: Token de identificación de la empresa en la plataforma HKA Fácil RIPS.
: Suministrado por The Factory HKA Colombia al momento de la habilitación.
: Rechazo Si el token no tiene exactamente 40 caracteres alfanuméricos (ver código de negocio 111)
|-
| tokenPassword
| String
| AN|40
| SI
|
: Token contraseña de acceso a la plataforma HKA Fácil RIPS.
: Suministrado por The Factory HKA Colombia al momento de la habilitación.
: Rechazo Si el token no tiene exactamente 40 caracteres alfanuméricos (ver código de negocio 111)
|-
| tipoRips
| String
| AN|2
| SI
|
: Tipo de documento RIPS a generar y enviar.
: Valores permitidos:
:: <code>01</code> RIPS con Factura Electrónica de Venta (FEV)
:: <code>02</code> RIPS sin Factura Electrónica de Venta (Sin FEV)
:: <code>03</code> RIPS con Nota Crédito
:: <code>04</code> RIPS con Nota Débito
:: <code>05</code> RIPS con documento de contingencia
: Rechazo Si el valor no corresponde a uno de los tipos permitidos (ver código de negocio 109)
|-
| idRips
| String
| UUID
| NO
|
: Identificador único (UUID) de un RIPS previamente creado en el sistema.
: Si se omite o se envía nulo, el sistema crea un nuevo RIPS automáticamente y retorna el <code>idRips</code> generado en la respuesta.
: Usar este campo para reintentar el envío de un RIPS ya creado pero no enviado al Ministerio.
: Rechazo Si el UUID proporcionado no existe en el sistema (ver código de negocio 102)
|-
| ripsJson
| Object
| -
| SI
|
: Objeto JSON con la estructura de datos del RIPS a enviar al Ministerio de Salud.
: Contiene dos propiedades: <code>rips</code> (estructura del RIPS) y <code>xmlFevFile</code> (archivo XML de la FEV en Base64).
: (ver detalle en [[#Object.ripsJson|Object.ripsJson]])
|}
{{clear}}

====Object.ripsJson====
{| class="mw-collapsible mw-collapsed wikitable" style="margin: auto;"
|-
! style="background:#f2f2f2; text-align:center;"|Atributo
! style="background:#f2f2f2; text-align:center;"|Tipo Dato
! style="background:#f2f2f2; text-align:center;"|Formato
! style="background:#f2f2f2; text-align:center;"|Requerido
! style="background:#f2f2f2; text-align:center;"|Descripción
|-
| rips
| Object
| -
| SI
|
: Objeto con la estructura de datos del RIPS según la normativa del Ministerio de Salud.
: (ver detalle en [[#Object.rips|Object.rips]])
|-
| xmlFevFile
| String
| base64
| C/C
|
: Contenido del archivo XML de la Factura Electrónica de Venta (FEV) codificado en Base64.
: '''Obligatorio''' cuando <code>tipoRips</code> es <code>01</code> (RIPS con FEV).
: Enviar cadena vacía <code>""</code> cuando <code>tipoRips</code> es <code>02</code> (sin FEV).
|}
{{clear}}

====Object.rips====
{| class="mw-collapsible mw-collapsed wikitable" style="margin: auto;"
|-
! style="background:#f2f2f2; text-align:center;"|Atributo
! style="background:#f2f2f2; text-align:center;"|Tipo Dato
! style="background:#f2f2f2; text-align:center;"|Formato
! style="background:#f2f2f2; text-align:center;"|Requerido
! style="background:#f2f2f2; text-align:center;"|Descripción
|-
| numDocumentoIdObligado
| String
| AN|..20
| SI
|
: NIT o número de identificación del prestador de servicios de salud obligado a reportar RIPS.
|-
| numNota
| String
| AN|..50
| SI
|
: Número de la nota, factura o documento asociado al RIPS.
|-
| tipoNota
| String
| AN|2
| SI
|
: Tipo del documento asociado al RIPS.
: Valores ejemplo:
:: <code>NC</code> Nota Crédito
:: <code>FV</code> Factura de Venta
|-
| usuarios
| Array <Object.usuario>
| -
| SI
|
: Lista de usuarios/pacientes con los servicios de salud prestados.
: Debe contener al menos un usuario.
: (ver detalle en [[#Object.usuario|Object.usuario]])
|}
{{clear}}

===Response Método Enviar===

{| class="mw-collapsible mw-collapsed wikitable" style="margin: auto;"
|-
! style="background:#f2f2f2; text-align:center;"|Atributo
! style="background:#f2f2f2; text-align:center;"|Tipo Dato
! style="background:#f2f2f2; text-align:center;"|Formato
! style="background:#f2f2f2; text-align:center;"|Descripción
|-
| codigo
| integer
| INT32
|
: Código de negocio del resultado de la operación.
: Ver [[Códigos de Respuesta - Indice Manual Integración Directa HKA Fácil RIPS#Método Enviar|Códigos de Respuesta - Método Enviar]]
|-
| mensaje
| String
| AN
|
: Mensaje descriptivo del resultado de la operación.
|-
| estado
| boolean
| boolean
|
: Indica si la operación fue exitosa.
: <code>true</code> El RIPS fue enviado y aceptado por el Ministerio.
: <code>false</code> La operación falló o el RIPS fue rechazado.
|-
| idRips
| String
| UUID
|
: Identificador único del RIPS procesado.
: '''Conservar este valor''' para consultas posteriores con el método EstadoRIPS.
|-
| archivoRetornado
| Object
| -
|
: Objeto con los detalles del resultado retornado por el Ministerio de Salud.
: <code>null</code> si la operación falló antes de llegar al Ministerio.
: (ver detalle en [[#Object.archivoRetornado|Object.archivoRetornado]])
|-
| errors
| Array <String>
| AN
|
: Lista de mensajes de error de validación de campos del request.
: Solo presente cuando el código de negocio es <code>109</code> o <code>111</code>.
|}
{{clear}}

==Método EstadoRIPS==

La función encargada de consultar el estado actual de un RIPS que fue enviado previamente al Ministerio de Salud de Colombia. Un RIPS puede estar en uno de los siguientes estados: '''VALIDADO''', '''RECHAZADO''' o '''CREADO'''.

''@NOTA:''' Este método es útil para verificar el resultado de un envío cuando el método Enviar no retornó una respuesta definitiva (por ejemplo, por timeout de red).

===Request Método EstadoRIPS===

{| class="mw-collapsible mw-collapsed wikitable" style="margin: auto;"
|-
! style="background:#f2f2f2; text-align:center;"|Atributo
! style="background:#f2f2f2; text-align:center;"|Tipo Dato
! style="background:#f2f2f2; text-align:center;"|Formato
! style="background:#f2f2f2; text-align:center;"|Requerido
! style="background:#f2f2f2; text-align:center;"|Descripción
|-
| tokenEmpresa
| String
| AN|40
| SI
|
: Token de identificación de la empresa en la plataforma HKA Fácil RIPS.
: Suministrado por The Factory HKA Colombia al momento de la habilitación.
: Rechazo Si el token no tiene exactamente 40 caracteres alfanuméricos (ver código de negocio 111)
|-
| tokenPassword
| String
| AN|40
| SI
|
: Token contraseña de acceso a la plataforma HKA Fácil RIPS.
: Suministrado por The Factory HKA Colombia al momento de la habilitación.
: Rechazo Si el token no tiene exactamente 40 caracteres alfanuméricos (ver código de negocio 111)
|-
| idRips
| String
| UUID
| SI
|
: Identificador único (UUID) del RIPS a consultar.
: Este valor es retornado por el método Enviar en el campo <code>idRips</code> de la respuesta.
: Formato: <code>xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx</code>
: Ejemplo: <code>3fa85f64-5717-4562-b3fc-2c963f66afa6</code>
: Rechazo Si el UUID proporcionado no existe en el sistema (ver código de negocio 102)
|}
{{clear}}

===Ejemplo de Request===

<syntaxhighlight lang="json">
{
"tokenEmpresa": "abc123def456ghi789jkl012mno345pqr678stu9",
"tokenPassword": "xyz987wvu654tsr321qpo098nml765kji432hgf1",
"idRips": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
</syntaxhighlight>

===Response Método EstadoRIPS===

{| class="mw-collapsible mw-collapsed wikitable" style="margin: auto;"
|-
! style="background:#f2f2f2; text-align:center;"|Atributo
! style="background:#f2f2f2; text-align:center;"|Tipo Dato
! style="background:#f2f2f2; text-align:center;"|Formato
! style="background:#f2f2f2; text-align:center;"|Descripción
|-
| codigo
| integer
| INT32
|
: Código de negocio del resultado de la operación.
: Ver [[Códigos de Respuesta - Indice Manual Integración Directa HKA Fácil RIPS#Método EstadoRIPS|Códigos de Respuesta - Método EstadoRIPS]]
|-
| mensaje
| String
| AN
|
: Mensaje descriptivo del estado actual del RIPS.
|-
| estado
| boolean
| boolean
|
: Indica si la consulta fue exitosa y el RIPS está validado.
: <code>true</code> El RIPS fue aceptado por el Ministerio (estado: VALIDADO).
: <code>false</code> En cualquier otro caso (RECHAZADO, CREADO, no encontrado, error).
|-
| idRips
| String
| UUID
|
: Identificador único del RIPS consultado.
|-
| archivoRetornado
| Object
| -
|
: Objeto con los detalles del resultado retornado por el Ministerio de Salud.
: <code>null</code> cuando el RIPS está en estado CREADO, no fue encontrado, o hubo error de autenticación.
: (ver detalle en [[Método Enviar - Indice Manual Integración Directa HKA Fácil RIPS#Object.archivoRetornado|Object.archivoRetornado]])
|-
| errors
| Array <String>
| AN
|
: Lista de mensajes de error de validación de campos del request.
: Solo presente cuando el código de negocio es <code>109</code> o <code>111</code>.
|}
{{clear}}

Indice del Manual Integración Directa HKA Fácil RIPS

2026-04-13T17:43:36Z

Dmrodriguez2:

Generalidades - Indice Manual Integración Directa HKA Fácil RIPS

2026-04-13T17:02:45Z

Dmrodriguez2: Página creada con «<includeonly>=</includeonly>==Historial de versiones==<includeonly>=</includeonly> {| class="wikitable" |- ! Versión !! Fecha lanzamiento !! Descripción |- | 1.0.0 || 2025 || Versión inicial de la API REST HKA Fácil RIPS |- | 1.1.0 || 2025 || Mejoras en los códigos de negocio y documentación de respuestas |} <includeonly>=</includeonly>==Cómo obtener soporte==<includeonly>=</includeonly> * '''Soporte de 1er…»

<includeonly>=</includeonly>==Historial de versiones==<includeonly>=</includeonly>

{| class="wikitable"
|-
! Versión !! Fecha lanzamiento !! Descripción
|-
| 1.0.0 || 2025 || Versión inicial de la API REST HKA Fácil RIPS
|-
| 1.1.0 || 2025 || Mejoras en los códigos de negocio y documentación de respuestas
|}

<includeonly>=</includeonly>==Cómo obtener soporte==<includeonly>=</includeonly>

* '''Soporte de 1er nivel:'''

::Soporte telefónico / email / chat o tele-conferencias en horario 5×8 para atención de consultas y fallas de usuario.

* '''Soporte de 2do nivel:'''

::Soporte resolución remota de incidencias en el sistema en horario 5×8. 
:::Escriba a [mailto:soporte@thefactoryhka.com.co soporte@thefactoryhka.com.co]

Para consultas referente a configuraciones y errores en el Portal:
* soporte_fel_co@thefactoryhka.com

Para consultas referente a configuraciones de ERP, casa de software e integración:
* integracion_fel_co@thefactoryhka.com

'''Líneas de atención telefónica:'''
* '''MASTER''' +57 (1) 746.08.12
** Soporte Técnico → Opción 2
** Integración → Opción 5, luego Opción 1

<includeonly>=</includeonly>===Para Sesiones:===<includeonly>=</includeonly>

<includeonly>=</includeonly>====Sesiones Área Integración<includeonly>=</includeonly>====
Solución Casos de Integración

'''Dirigido a:''' Clientes que realicen desarrollos de Software para integrarse con TFHKA, Casas de Software Aliadas

'''Horario:''' Martes y Jueves a partir de las 8:30 AM

[http://meet.google.com/jeo-jfvj-ckd Enlace Sesiones Integración]
{{clear}}

<includeonly>=</includeonly>==Descripción general==<includeonly>=</includeonly>
En el presente documento se describe el proceso de integración utilizando la '''API HKA Fácil RIPS REST''' para la generación, validación y transmisión del Registro Individual de Prestación de Servicios de Salud (RIPS) y su vinculación con la Factura Electrónica de Venta. Todo esto de acuerdo con las actualizaciones normativas y técnicas exigidas por el Ministerio de Salud y Protección Social (MinSalud), la DIAN, y los controles propios de nuestro modelo de integración.

Para el desarrollo de este documento, se tomaron como referencia las normativas vigentes para el sector salud, específicamente la '''Resolución 2275 de 2023 (MinSalud)''', su respectivo Anexo Técnico para la generación del RIPS (formato JSON), y los lineamientos de la DIAN correspondientes.

=== ¿Qué es HKA Fácil RIPS? ===

'''HKA Fácil RIPS''' es un servicio API REST (middleware) desarrollado por The Factory HKA Colombia que actúa como intermediario para la integración de los RIPS (Registro Individual de Prestación de Servicios) con el '''Ministerio de Salud y Protección Social de Colombia'''.

El servicio simplifica el proceso de generación, validación y envío de RIPS al Ministerio de Salud, ofreciendo un único punto de integración que maneja internamente la autenticación, la creación del paquete RIPS y la comunicación con el Ministerio.

=== ¿Qué son los RIPS? ===

Los '''RIPS''' (Registro Individual de Prestación de Servicios de Salud) son el conjunto de datos mínimos que el Sistema General de Seguridad Social en Salud requiere para el procesamiento de las reclamaciones de los servicios de salud prestados.

Toda Institución Prestadora de Servicios de Salud (IPS) o entidad que preste servicios de salud está obligada a reportar los RIPS al Ministerio de Salud conforme a la normativa vigente.

=== Tipos de RIPS soportados ===

El campo <code>tipoRips</code> indica el tipo de documento RIPS a generar:

{| class="wikitable"
|-
! Valor !! Descripción
|-
| <code>01</code> || RIPS con Factura Electrónica de Venta (FEV)
|-
| <code>02</code> || RIPS sin Factura Electrónica de Venta (Sin FEV)
|-
| <code>03</code> || RIPS con Nota Crédito
|-
| <code>04</code> || RIPS con Nota Débito
|-
| <code>05</code> || RIPS con documento de contingencia
|}

@Importante: El valor del campo <code>tipoRips</code> debe ser uno de los valores listados anteriormente. Un valor inválido retornará el código de negocio <code>109</code>.

<includeonly>=</includeonly>== Ambientes de integración ==<includeonly>=</includeonly>

La integración a traves de la API HKA Fácil RIPS está disponible en los siguientes dos ambientes:

==== Ambiente Demo (Pruebas) ====

Ambiente en el cual las operaciones '''no son transmitidas''' al Ministerio de Salud. Úselo durante el desarrollo y las pruebas de su integración.

URL Base: https://demoapi-facilrips.thefactoryhka.com.co

Endpoints disponibles:
* <code>POST https://demoapi-facilrips.thefactoryhka.com.co/api/rips/enviar</code>
* <code>POST https://demoapi-facilrips.thefactoryhka.com.co/api/rips/estado</code>

==== Ambiente Productivo ====

Ambiente en el cual se realizan las operaciones reales que son transmitidas al Ministerio de Salud.

URL Base: https://api-facilrips.thefactoryhka.com.co

Endpoints disponibles:
* <code>POST https://api-facilrips.thefactoryhka.com.co/api/rips/enviar</code>
* <code>POST https://api-facilrips.thefactoryhka.com.co/api/rips/estado</code>

@IMPORTANTE: La URL del servicio en producción solo funciona bajo el protocolo '''HTTPS'''.

<includeonly>=</includeonly>== Autenticación ==<includeonly>=</includeonly>

La API HKA Fácil RIPS utiliza un modelo de autenticación basado en '''tokens de empresa'''. Cada petición debe incluir los siguientes campos en el cuerpo del request (body):

{| class="wikitable"
|-
! Campo !! Tipo !! Descripción
|-
| <code>tokenEmpresa</code> || <code>string</code> || Token de identificación de la empresa. Debe tener exactamente '''40 caracteres alfanuméricos'''.
|-
| <code>tokenPassword</code> || <code>string</code> || Token contraseña de acceso. Debe tener exactamente '''40 caracteres alfanuméricos'''.
|}

Estos tokens son proporcionados por el equipo de Integración de The Factory HKA Colombia al momento de la habilitación de la empresa en la plataforma.

@Importante: Si alguno de los tokens no cumple con el formato requerido (40 caracteres alfanuméricos), el servicio retornará el '''código de negocio 111'''. Si las credenciales son incorrectas o inválidas, retornará el '''código de negocio 101'''.

'''Ejemplo de tokens (formato):'''
tokenEmpresa: abc123def456ghi789jkl012mno345pqr678stu9
tokenPassword: xyz987wvu654tsr321qpo098nml765kji432hgf1

<includeonly>=</includeonly>== Requerimientos técnicos ==<includeonly>=</includeonly>

HKA Fácil RIPS es una plataforma tipo '''SaaS (Software as a Service)'''. Los servicios, la información, el procesamiento y los resultados están alojados en los servidores de The Factory HKA Colombia.

Para integrarse con la API, el sistema de facturación o ERP del cliente debe tener:

* Capacidad de consumir '''servicios REST''' con peticiones HTTP/HTTPS tipo <code>POST</code>.
* Capacidad de enviar y recibir cuerpos en formato '''JSON'''.
* Capacidad de capturar y validar los datos de entrada antes del envío.
* Conexión a internet con acceso saliente a los puertos '''TCP 443 (HTTPS)'''.
* Acceso habilitado a los dominios:
** <code>*.thefactoryhka.com.co</code>
** <code>demoapi-facilrips.thefactoryhka.com.co</code> (Integración – Demo)
** <code>api-facilrips.thefactoryhka.com.co</code> (Integración – Producción)

No se requiere infraestructura adicional de procesamiento ni almacenamiento propio, ya que The Factory HKA Colombia se encarga del mantenimiento, operación, cambios normativos y soporte de la solución.

Indice del Manual Integración Directa HKA Fácil RIPS

2026-04-13T16:07:07Z

Dmrodriguez2:

Generalidades HKA Facil RIPS

2026-04-08T16:42:38Z

Dmrodriguez2: Página creada con «= Generalidades - HKA Fácil RIPS = <includeonly>=</includeonly>== Historial de versiones ==<includeonly>=</includeonly> {| class="wikitable" |- ! Versión !! Fecha lanzamiento !! Descripción |- | 1.0.0 || 2025 || Versión inicial de la API REST HKA Fácil RIPS |- | 1.1.0 || 2025 || Mejoras en los códigos de negocio y documentación de respuestas |} ---- == Cómo obtener soporte == * '''Soporte de 1er nivel:''' Soporte telefónico / e…»

= Generalidades - HKA Fácil RIPS =

<includeonly>=</includeonly>== Historial de versiones ==<includeonly>=</includeonly>

{| class="wikitable"
|-
! Versión !! Fecha lanzamiento !! Descripción
|-
| 1.0.0 || 2025 || Versión inicial de la API REST HKA Fácil RIPS
|-
| 1.1.0 || 2025 || Mejoras en los códigos de negocio y documentación de respuestas
|}

----

== Cómo obtener soporte ==

* '''Soporte de 1er nivel:'''

Soporte telefónico / email / chat o tele-conferencias en horario 5×8 para atención de consultas y fallas de usuario.

* '''Soporte de 2do nivel:'''

Soporte resolución remota de incidencias en el sistema en horario 5×8. 
Escriba a [mailto:soporte@thefactoryhka.com.co soporte@thefactoryhka.com.co]

'''Líneas de atención telefónica:'''

+57 (1) 311.3063

* Soporte Técnico → Opción 2
* Integración → Opción 5, luego Opción 1

=== Sesiones de Soporte ===

Dirigido a: Agencias Comerciales – Casas de Software Aliadas – Clientes Finales.

Horario: Martes y Jueves a partir de las 8:30 AM.

=== Sesiones Área Integración ===

Solución de casos de integración.

Dirigido a: Clientes que realicen desarrollos de software para integrarse con TFHKA, Casas de Software Aliadas.

Horario: Martes y Jueves a partir de las 8:30 AM.

----

== Descripción general ==

=== ¿Qué es HKA Fácil RIPS? ===

'''HKA Fácil RIPS''' es un servicio API REST (middleware) desarrollado por The Factory HKA Colombia que actúa como intermediario para la integración de los RIPS (Registro Individual de Prestación de Servicios) con el '''Ministerio de Salud y Protección Social de Colombia'''.

El servicio simplifica el proceso de generación, validación y envío de RIPS al Ministerio de Salud, ofreciendo un único punto de integración que maneja internamente la autenticación, la creación del paquete RIPS y la comunicación con el Ministerio.

=== ¿Qué son los RIPS? ===

Los '''RIPS''' (Registro Individual de Prestación de Servicios de Salud) son el conjunto de datos mínimos que el Sistema General de Seguridad Social en Salud requiere para el procesamiento de las reclamaciones de los servicios de salud prestados.

Toda Institución Prestadora de Servicios de Salud (IPS) o entidad que preste servicios de salud está obligada a reportar los RIPS al Ministerio de Salud conforme a la normativa vigente.

=== Tipos de RIPS soportados ===

El campo <code>tipoRips</code> indica el tipo de documento RIPS a generar:

{| class="wikitable"
|-
! Valor !! Descripción
|-
| <code>01</code> || RIPS con Factura Electrónica de Venta (FEV)
|-
| <code>02</code> || RIPS sin Factura Electrónica de Venta (Sin FEV)
|-
| <code>03</code> || RIPS con Nota Crédito
|-
| <code>04</code> || RIPS con Nota Débito
|-
| <code>05</code> || RIPS con documento de contingencia
|}

@IMPORTANTE: El valor del campo <code>tipoRips</code> debe ser uno de los valores listados anteriormente. Un valor inválido retornará el código de negocio <code>109</code>.

----

== Ambientes de integración ==

La API HKA Fácil RIPS está disponible en dos ambientes:

=== Ambiente Demo (Pruebas) ===

Ambiente en el cual las operaciones '''no son transmitidas''' al Ministerio de Salud. Úselo durante el desarrollo y las pruebas de su integración.

URL Base: https://demoapi-facilrips.thefactoryhka.com.co

Endpoints disponibles:
* <code>POST https://demoapi-facilrips.thefactoryhka.com.co/api/rips/enviar</code>
* <code>POST https://demoapi-facilrips.thefactoryhka.com.co/api/rips/estado</code>

=== Ambiente Productivo ===

Ambiente en el cual se realizan las operaciones reales que son transmitidas al Ministerio de Salud.

URL Base: https://api-facilrips.thefactoryhka.com.co

Endpoints disponibles:
* <code>POST https://api-facilrips.thefactoryhka.com.co/api/rips/enviar</code>
* <code>POST https://api-facilrips.thefactoryhka.com.co/api/rips/estado</code>

@IMPORTANTE: La URL del servicio en producción solo funciona bajo el protocolo '''HTTPS'''.

----

== Autenticación ==

La API HKA Fácil RIPS utiliza un modelo de autenticación basado en '''tokens de empresa'''. Cada petición debe incluir los siguientes campos en el cuerpo del request (body):

{| class="wikitable"
|-
! Campo !! Tipo !! Descripción
|-
| <code>tokenEmpresa</code> || <code>string</code> || Token de identificación de la empresa. Debe tener exactamente '''40 caracteres alfanuméricos'''.
|-
| <code>tokenPassword</code> || <code>string</code> || Token contraseña de acceso. Debe tener exactamente '''40 caracteres alfanuméricos'''.
|}

Estos tokens son proporcionados por el equipo de Integración de The Factory HKA Colombia al momento de la habilitación de la empresa en la plataforma.

@IMPORTANTE: Si alguno de los tokens no cumple con el formato requerido (40 caracteres alfanuméricos), el servicio retornará el '''código de negocio 111'''. Si las credenciales son incorrectas o inválidas, retornará el '''código de negocio 101'''.

'''Ejemplo de tokens (formato):'''
tokenEmpresa: abc123def456ghi789jkl012mno345pqr678stu9
tokenPassword: xyz987wvu654tsr321qpo098nml765kji432hgf1

----

== Requerimientos técnicos ==

HKA Fácil RIPS es una plataforma tipo '''SaaS (Software as a Service)'''. Los servicios, la información, el procesamiento y los resultados están alojados en los servidores de The Factory HKA Colombia.

Para integrarse con la API, el sistema de facturación o ERP del cliente debe tener:

* Capacidad de consumir '''servicios REST''' con peticiones HTTP/HTTPS tipo <code>POST</code>.
* Capacidad de enviar y recibir cuerpos en formato '''JSON'''.
* Capacidad de capturar y validar los datos de entrada antes del envío.
* Conexión a internet con acceso saliente a los puertos '''TCP 443 (HTTPS)'''.
* Acceso habilitado a los dominios:
** <code>*.thefactoryhka.com.co</code>
** <code>demoapi-facilrips.thefactoryhka.com.co</code> (Integración – Demo)
** <code>api-facilrips.thefactoryhka.com.co</code> (Integración – Producción)

No se requiere infraestructura adicional de procesamiento ni almacenamiento propio, ya que The Factory HKA Colombia se encarga del mantenimiento, operación, cambios normativos y soporte de la solución.

[[Categoría:Manuales]]

Indice del Manual Integración Directa HKA Fácil RIPS

2026-04-08T15:41:47Z

Dmrodriguez2:

= Índice del Manual de HKA Fácil RIPS =

[[Archivo:HKA_ Fácil_ RIPS.png|500px|center|HKA Fácil RIPS]]

== Generalidades ==

# [[Generalidades_HKA_Facil_RIPS#Historial_de_versiones|Historial de versiones]]
# [[Generalidades_HKA_Facil_RIPS#C.C3.B3mo_obtener_soporte|Cómo obtener soporte]]
# [[Generalidades_HKA_Facil_RIPS#Descripci.C3.B3n_general|Descripción general]]
## [[Generalidades_HKA_Facil_RIPS#.C2.BFQu.C3.A9_es_HKA_F.C3.A1cil_RIPS.3F|¿Qué es HKA Fácil RIPS?]]
## [[Generalidades_HKA_Facil_RIPS#.C2.BFQu.C3.A9_son_los_RIPS.3F|¿Qué son los RIPS?]]
## [[Generalidades_HKA_Facil_RIPS#Tipos_de_RIPS_soportados|Tipos de RIPS soportados]]
## [[Generalidades_HKA_Facil_RIPS#Ambientes_de_integraci.C3.B3n|Ambientes de integración]]
## [[Generalidades_HKA_Facil_RIPS#Autenticaci.C3.B3n|Autenticación]]
## [[Generalidades_HKA_Facil_RIPS#Requerimientos_t.C3.A9cnicos|Requerimientos técnicos]]

Indice del Manual Integración Directa HKA Fácil RIPS

2026-04-08T15:36:08Z

Dmrodriguez2: Página creada con «= Índice del Manual de HKA Fácil RIPS = HKA Fácil RIPS == Generalidades == # Historial de versiones # Cómo obtener soporte # Descripción general ## ¿Qué es HKA Fácil RIPS? ## Gen…»

= Índice del Manual de HKA Fácil RIPS =

[[Archivo:HKA_ Fácil_ RIPS.png|HKA Fácil RIPS]]

== Generalidades ==

# [[Generalidades_HKA_Facil_RIPS#Historial_de_versiones|Historial de versiones]]
# [[Generalidades_HKA_Facil_RIPS#C.C3.B3mo_obtener_soporte|Cómo obtener soporte]]
# [[Generalidades_HKA_Facil_RIPS#Descripci.C3.B3n_general|Descripción general]]
## [[Generalidades_HKA_Facil_RIPS#.C2.BFQu.C3.A9_es_HKA_F.C3.A1cil_RIPS.3F|¿Qué es HKA Fácil RIPS?]]
## [[Generalidades_HKA_Facil_RIPS#.C2.BFQu.C3.A9_son_los_RIPS.3F|¿Qué son los RIPS?]]
## [[Generalidades_HKA_Facil_RIPS#Tipos_de_RIPS_soportados|Tipos de RIPS soportados]]
## [[Generalidades_HKA_Facil_RIPS#Ambientes_de_integraci.C3.B3n|Ambientes de integración]]
## [[Generalidades_HKA_Facil_RIPS#Autenticaci.C3.B3n|Autenticación]]
## [[Generalidades_HKA_Facil_RIPS#Requerimientos_t.C3.A9cnicos|Requerimientos técnicos]]

Sección para clientes de Integración

2026-04-06T22:23:26Z

Dmrodriguez2:

{| style="width:100%; border:1px solid #d0d7e1; border-radius:10px; background-color:#ffffff; box-shadow:0 1px 3px rgba(0,0,0,0.08);"
|-
| style="vertical-align:top; padding:20px;" |

<div style="font-size:1.9em; font-weight:bold; color:#003366;">
Integración – The Factory HKA Colombia
</div>

<div style="font-size:1.05em; color:#444; line-height:1.6; margin-bottom:15px;">
Bienvenido a Integración de The Factory HKA Colombia, el espacio diseñado para brindar una experiencia técnica clara, eficiente y centralizada para nuestros clientes y aliados.
 
Aquí encontrará la documentación completa para la integración de los servicios de Factura Electrónica, Nómina Electrónica, Recepción Electrónica y Documentos Equivalentes, incluyendo manuales, APIs, herramientas y recomendaciones para el cumplimiento de las resoluciones DIAN vigentes.
</div>

<div style="background:linear-gradient(90deg, #0073e6 0%, #0099ff 100%); color:#fff; padding:12px 18px; border-radius:6px; font-weight:bold; font-size:1.05em;">
Acceso rápido: Consulte las secciones de pasos de integración, canales de comunicación y ejemplos de APIs según su tipo de documento electrónico.
</div>

| style="width:140px; text-align:center; vertical-align:middle; background-color:#f7f9fc; border-left:1px solid #e0e6ef; padding:15px;" |
[[Archivo:Tfhka-co.png|140px|center|sinmarco]]
|}

{| style="width:100%; border:none; background-color:#ffffff; padding:2px;"
|-
| style="vertical-align:top; padding:18px 5px;" |

<div style="font-size:1.7em; font-weight:bold; color:#003366; margin-bottom:8px;">
¿Qué hacemos?
</div>

<div style="font-size:1.05em; color:#444; line-height:1.6; margin-bottom:15px;">
En The Factory HKA Colombia ofrecemos soluciones tecnológicas que optimizan la emisión, recepción y gestión de documentos electrónicos requeridos por la DIAN.
Nuestros servicios web (APIs) están orientados a empresas, desarrolladores y casas de software que buscan integraciones seguras, escalables y de alta disponibilidad.
</div>

<div style="background-color:#f4f9fc; border-left:6px solid #0073e6; border-radius:4px; padding:12px; color:#003366; font-size:1.05em; margin-bottom:15px;">
Servicios principales: 
• Facturación Electrónica con validación previa ante la DIAN. 
• Nómina Electrónica con soporte para documentos individuales y masivos. 
• Recepción de Documentos Electrónicos con trazabilidad y respuesta. 
• Emisión de Documentos Equivalentes conforme a la Resolución 000165 del 2023.
</div>
<div style="font-size:1.7em; font-weight:bold; color:#003366; margin-top:25px; margin-bottom:10px;">
¿Cómo contactarnos?
</div>

<div style="font-size:1.05em; color:#444; line-height:1.6; margin-bottom:15px;">
Si necesita soporte técnico o acompañamiento durante su proceso de integración, puede comunicarse a través de los siguientes canales:
</div>

<table style="width:100%; border-collapse:collapse; font-size:1.02em; color:#333;">
<tr style="background-color:#eef4fb; text-align:left;">
<th style="padding:8px; border:1px solid #cfd7e0; width:25%;">Canal</th>
<th style="padding:8px; border:1px solid #cfd7e0;">Información de contacto</th>
</tr>
<tr>
<td style="padding:8px; border:1px solid #cfd7e0;">
[[File:icono-correo-electronico.png|20px]] Correo electrónico
</td>
<td style="padding:8px; border:1px solid #cfd7e0;">integracion_fel_co@thefactoryhka.com</td>
</tr>
<tr style="background-color:#f8fafd;">
<td style="padding:8px; border:1px solid #cfd7e0;">
[[File:icono-telefono.png|20px]] Teléfonos
</td>
<td style="padding:8px; border:1px solid #cfd7e0;">Opción 5, luego Opción 1 
+57 317 668 7663 | +57 (601) 390 95 39 </td>
</tr>
<tr>
<td style="padding:8px; border:1px solid #cfd7e0;">
[[File:icono-whatsapp.png|20px]] WhatsApp
</td>
<td style="padding:8px; border:1px solid #cfd7e0;">Escríbanos al canal de soporte técnico https://wa.me/573163192251</td>
</tr>
<tr style="background-color:#f8fafd;">
<td style="padding:8px; border:1px solid #cfd7e0;">
[[File:icono-sesiones-grupales.png|20px]] Sesiones grupales de integración
</td>
<td style="padding:8px; border:1px solid #cfd7e0;">Martes y jueves de 08:30 a.m. a 10:00 a.m. (hora Colombia). https://meet.google.com/jeo-jfvj-ckd</td>
</tr>
</table>

<div style="font-size:1.7em; font-weight:bold; color:#003366; margin-top:25px; margin-bottom:10px;">
Principales métodos o APIs por producto
</div>

<div style="font-size:1.02em; color:#444; line-height:1.6; margin-bottom:10px;">
La siguiente tabla presenta los métodos principales de integración por producto.
Cada servicio dispone de endpoints para emisión, validación, consulta, descarga y gestión de documentos conforme a los estándares DIAN.
</div>

<div style="font-size:1.5em; font-weight:bold; color:#003366; margin-top:25px; margin-bottom:15px;">
Factura Electrónica - SOAP
</div>

{| class="wikitable" style="width:100%; border-collapse:collapse; font-size:0.95em; color:#333;"
|-
! style="background-color:#003366; color:#fff; text-align:left; padding:8px;" | Producto
! style="background-color:#003366; color:#fff; text-align:left; padding:8px;" | Servicio
! style="background-color:#003366; color:#fff; text-align:left; padding:8px;" | Descripción
|-
| style="padding:8px; border:1px solid #b8c6db;" | FEL
| SOAP
|
'''FacturaElectronica - Enviar''' 
Servicio dedicado al envío y validación de facturas electrónicas ante la DIAN, garantizando el cumplimiento normativo mediante la verificación integral de todos los requisitos técnicos y legales exigidos por la autoridad tributaria colombiana. 
'''Entornos:''' Demo / Producción
|-
| style="background-color:#f8fafd; padding:8px; border:1px solid #b8c6db;" | FEL
| SOAP
|
'''FacturaElectronica - EstadoDocumento''' 
Consulta del estado de tramitación de documentos ante la DIAN, proporcionando información en tiempo real sobre la validación y aceptación definitiva.
|-
| style="padding:8px; border:1px solid #b8c6db;" | FEL
| SOAP
|
'''FacturaElectronica - DescargaPDF''' 
Generación automática de la representación gráfica en PDF según especificaciones DIAN, lista para distribución comercial conforme a los estándares requeridos.
|-
| style="background-color:#f8fafd; padding:8px; border:1px solid #b8c6db;" | FEL
| SOAP
|
'''FacturaElectronica - EnvioCorreo''' 
Envío automatizado de facturas electrónicas a los destinatarios con PDF y XML técnico, asegurando entrega completa y trazable.
|}

<div style="font-size:1.5em; font-weight:bold; color:#003366; margin-top:25px; margin-bottom:15px;">
Factura Electrónica - REST
</div>

{| class="wikitable" style="width:100%; border-collapse:collapse; font-size:0.95em; color:#333;"
|-
! style="background-color:#003366; color:#fff; text-align:left; padding:8px;" | Producto
! style="background-color:#003366; color:#fff; text-align:left; padding:8px;" | Servicio
! style="background-color:#003366; color:#fff; text-align:left; padding:8px;" | Descripción
! style="background-color:#003366; color:#fff; text-align:left; padding:8px;" | Método
|-
| style="padding:8px; border:1px solid #b8c6db;" | FEL
| REST
|
'''Api/documentos/enviar''' 
Servicio dedicado al envío y validación de facturas electrónicas ante la DIAN, con verificación completa de los requisitos técnicos y legales. 
'''Entornos:''' Demo / Producción
| POST
|-
| style="background-color:#f8fafd; padding:8px; border:1px solid #b8c6db;" | FEL
| REST
|
'''Api/documentos/EstadoDocumento''' 
Consulta en tiempo real del estado del documento y validación ante la DIAN, mostrando incidencias o aceptación definitiva.
| GET
|-
| style="padding:8px; border:1px solid #b8c6db;" | FEL
| REST
|
'''Api/documentos/DescargaPDF''' 
Generación automática del PDF representativo del documento, conforme a los estándares de presentación exigidos.
| GET
|-
| style="background-color:#f8fafd; padding:8px; border:1px solid #b8c6db;" | FEL
| REST
|
'''FacturaElectronica - EnvioCorreo''' 
Distribución electrónica automatizada de facturas a clientes, incluyendo PDF y XML técnico.
| POST
|}

<div style="font-size:1.5em; font-weight:bold; color:#003366; margin-top:25px; margin-bottom:15px;">
Nómina Electrónica - SOAP
</div>

{| class="wikitable" style="width:100%; border-collapse:collapse; font-size:0.95em; color:#333;"
|-
! style="background-color:#003366; color:#fff; text-align:left; padding:8px;" | Producto
! style="background-color:#003366; color:#fff; text-align:left; padding:8px;" | Servicio
! style="background-color:#003366; color:#fff; text-align:left; padding:8px;" | Descripción
|-
| style="padding:8px; border:1px solid #b8c6db;" | Nomina
| SOAP
|
'''NominaElectronica - Enviar''' 
Procesamiento de nóminas electrónicas individuales o masivas conforme a requisitos DIAN. 
'''Entornos:''' Demo / Producción
|-
| style="background-color:#f8fafd; padding:8px; border:1px solid #b8c6db;" | Nomina
| SOAP
|
'''NominaElectronica - ConsultarDocumento''' 
Consulta del estado de tramitación y validación de nóminas electrónicas.
|-
| style="padding:8px; border:1px solid #b8c6db;" | Nomina
| SOAP
|
'''NominaElectronica - EnviarCorreo''' 
Envío automatizado de nóminas electrónicas a los colaboradores con sus representaciones gráficas.
|-
| style="background-color:#f8fafd; padding:8px; border:1px solid #b8c6db;" | Nomina
| SOAP
|
'''NominaElectronica - ConsultarFolios''' 
Consulta y gestión de numeración autorizada por la DIAN para emisión de nóminas.
|}

<div style="font-size:1.5em; font-weight:bold; color:#003366; margin-top:25px; margin-bottom:15px;">
Nómina Electrónica - REST
</div>

{| class="wikitable" style="width:100%; border-collapse:collapse; font-size:0.95em; color:#333;"
|-
! style="background-color:#003366; color:#fff; text-align:left; padding:8px;" | Producto
! style="background-color:#003366; color:#fff; text-align:left; padding:8px;" | Servicio
! style="background-color:#003366; color:#fff; text-align:left; padding:8px;" | Descripción
! style="background-color:#003366; color:#fff; text-align:left; padding:8px;" | Método
|-
| style="padding:8px; border:1px solid #b8c6db;" | Nomina
| REST
|
'''Api/documentos/Enviar''' 
Procesamiento de nóminas electrónicas individuales o masivas conforme a requisitos DIAN. 
'''Entornos:''' Demo / Producción
| POST
|-
| style="background-color:#f8fafd; padding:8px; border:1px solid #b8c6db;" | Nomina
| REST
|
'''Api/documentos/ConsultarDocumento''' 
Consulta del estado de tramitación y validación de nóminas electrónicas.
| GET
|-
| style="padding:8px; border:1px solid #b8c6db;" | Nomina
| REST
|
'''Api/documentos/EnviarCorreo''' 
Envío automatizado de nóminas electrónicas a los colaboradores con sus representaciones gráficas.
| POST
|-
| style="background-color:#f8fafd; padding:8px; border:1px solid #b8c6db;" | Nomina
| REST
|
'''Api/documentos/ConsultarFolios''' 
Consulta y gestión de numeración autorizada por la DIAN para emisión de nóminas.
| GET
|}

<div style="font-size:1.5em; font-weight:bold; color:#003366; margin-top:25px; margin-bottom:15px;">
Recepción Electrónica
</div>

{| class="wikitable" style="width:100%; border-collapse:collapse; font-size:0.95em; color:#333;"
|-
! style="background-color:#003366; color:#fff; text-align:left; padding:8px;" | Producto
! style="background-color:#003366; color:#fff; text-align:left; padding:8px;" | Servicio
! style="background-color:#003366; color:#fff; text-align:left; padding:8px;" | Descripción
|-
| style="padding:8px; border:1px solid #b8c6db;" | Recepcion
| SOAP
|
'''Recepcion - ReporteStatus''' 
Procesa documentos recibidos de proveedores, validando autenticidad e integridad para integración contable. 
'''Entornos:''' Demo / Producción
|-
| style="background-color:#f8fafd; padding:8px; border:1px solid #b8c6db;" | Recepcion
| SOAP
|
'''Recepcion - EstadoDocumento''' 
Consulta del estado y trazabilidad de documentos recibidos ante la DIAN.
|-
| style="padding:8px; border:1px solid #b8c6db;" | Recepcion
| SOAP
|
'''Recepcion - Respuesta''' 
Gestión formal de aceptación o rechazo de documentos recibidos, registrando eventos ante la DIAN.
|-
| style="background-color:#f8fafd; padding:8px; border:1px solid #b8c6db;" | Recepcion
| SOAP
|
'''Recepcion - RepresentacionGrafica''' 
Descarga y generación de PDFs de documentos recibidos conforme a los estándares DIAN.
|}

<div style="font-size:1.5em; font-weight:bold; color:#003366; margin-top:25px; margin-bottom:15px;">
Documentos Equivalentes
</div>

{| class="wikitable" style="width:100%; border-collapse:collapse; font-size:0.95em; color:#333;"
|-
! style="background-color:#003366; color:#fff; text-align:left; padding:8px;" | Producto
! style="background-color:#003366; color:#fff; text-align:left; padding:8px;" | Servicio
! style="background-color:#003366; color:#fff; text-align:left; padding:8px;" | Descripción
! style="background-color:#003366; color:#fff; text-align:left; padding:8px;" | Método
|-
| style="padding:8px; border:1px solid #b8c6db;" | Doc Equivalente
| REST
|
'''Equivalente - EnviarRequest''' 
Envío de documentos equivalentes electrónicos a la DIAN, cumpliendo con las validaciones oficiales. 
'''Entornos:''' Demo / Producción
| POST
|-
| style="background-color:#f8fafd; padding:8px; border:1px solid #b8c6db;" | Doc Equivalente
| REST
|
'''Equivalente - GenerarContenedor''' 
Genera contenedores de información estructurados según los requisitos técnicos de la DIAN.
| GET
|-
| style="padding:8px; border:1px solid #b8c6db;" | Doc Equivalente
| REST
|
'''Equivalente - DescargaPDF''' 
Generación de representaciones gráficas PDF para documentos equivalentes conforme a la normativa vigente.
| POST
|-
| style="background-color:#f8fafd; padding:8px; border:1px solid #b8c6db;" | Doc Equivalente
| REST
|
'''Equivalente - EstadoDocumento''' 
Consulta del estado de validación y trazabilidad de documentos equivalentes ante la DIAN.
| POST
|}

|}
 
[[File:HKAFactura 3.png|200px]]
 

* [[Índice del Manual de Integración Directa]]

* [[Direct Integration Manual Index - Electronic Invoice]]
* '''[[Facturación Electrónica bajo Resoluciones DIAN]]'''
* [[Herramientas Alternativas de Integración Facturación]]
* '''[[Servicio Gestión Contribuyentes]]'''
* [[Representaciones Gráficas en el proceso de Emisión]]
* [[Reglas de Rechazo DIAN - Integración]]
* [[Preguntas Frecuentes de Integración con servicio Web (Val. Previa)]]
* [[Tips Urls de Emisión]]

 
[[File:HKANomina 3.png|200px]]
 

* [[Índice del Manual de Integración Nómina Electrónica]]
* [[Portal Web Nómina Electrónica]]
* [[Habilitación Nómina Electrónica]]
* '''[[Herramientas Alternativas de Integración Nómina]]'''
* [[Nómina Electrónica según Concepto Unificado DIAN 0106 – 19 agosto 2022 ]]
* [[Preguntas Frecuentes de Integración Nómina Electrónica]]
* [[Tips Urls de Emisión Nómina Electrónica]]

 
[[File:HKARecepcion 3.png|260px]]
 

* [[Índice del Manual de Integración Directa HKA Recepción]]
* [[HKA Reception Direct Integration Manual Index]]
* [[Preguntas Frecuentes de Integración Recepción Electrónica]]
* [[Tips Urls de Recepción Integración]]

 
[[File:HKAEquivalente1.png|260px]]
 
* [[Indice del Manual Integración Directa HKA Documentos Equivalentes Electrónicos]]
* [[Requisitos minimos de las Representaciones grafica para documento equivalente]]
* [[Preguntas Frecuentes de Integración Documento Equivalente Electrónico]]
* [[Tips Urls de documento equivalente Integración]]

 
[[File:HKA_ Fácil_ RIPS.png|260px]]
 
* [[Indice del Manual Integración Directa HKA Fácil RIPS]]
* [[Tips Urls HKA Fácil RIPS]]
 
 
 

 
[[File:ArticulosInteresIntegracion.png|260px]]
 
* [[HKA TIPS]]
* [[Consideraciones Url Versión 4]]
* [[Recomendaciones para integraciones ante escenarios de intermitencia o Timeouts DIAN]]
* [[Manejo de SoapUI para pruebas en Demo]]
* [[Manejo de Postman para pruebas en Demo]]
* [[Campo extra para informar el Fabricante de Software]]
* [[Recomendaciones en la implementación de la factura electronica]]
* [[Politicas de seguridad de la información para aliados de The Factory HKA]]
* [[Actualización de Seguridad Requerida Migración a TLS 1.2 o superior en nuestros servicios web]]
 

<center>'''<big>[[Archivo:Copyright.png|100px|sinmarco|centro|Copyright]]THE FACTORY HKA COLOMBIA</big>
 Copyright © 2016 The Factory HKA. Todos los derechos reservados.</center>

 
{{clear}}

Archivo:HKA Fácil RIPS.png

2026-04-06T22:23:13Z

Dmrodriguez2: Archivo subido con MsUpload

Archivo subido con MsUpload

Métodos Servicio Emisión Web TFHKA - Indice del Manual Integración Directa HKA Documentos Equivalentes Electrónicos

2026-03-27T17:05:13Z

Dmrodriguez2: /* Método EnviarRequest */

===Método EnviarRequest===
La función encargada de construir y enviar los documentos electrónicos al proveedor tecnológico.
; REQUEST: Parámetros a EnviarRequest
{| class="mw-collapsible mw-collapsed wikitable" style="margin: auto;"
|-
! style="background:#f2f2f2; text-align:center;"|Tipo
! style="background:#f2f2f2; text-align:center;"|Identificador
! style="background:#f2f2f2; text-align:center;"|Descripción
|- valign="center"
|-
|rowspan="2"|String
|tokenEmpresa
|rowspan="2"|Suministrado por el proveedor tecnológico
|-
|tokenPassword
|-
|FacturaGeneral
|factura
|Ver el detalle del Objeto Factura más abajo
|}

====Class.FacturaGeneral====
{| class="mw-collapsible mw-collapsed wikitable"
! style="background:#f2f2f2; text-align:center;"|Atributo
! style="background:#f2f2f2; text-align:center;"|Tipo Dato
! style="background:#f2f2f2; text-align:center;"|Formato
! style="background:#f2f2f2; text-align:center;"|Requerido
! style="background:#f2f2f2; text-align:center;"|Descripción
|-
|anticipos
|Array <Anticipos>
| -
|NO
|
: Informaciones relacionadas con anticipos
: '''PATH''': /root/cac:PrepaidPayment
: (ver detalle en [[#Class.Anticipos|Class.Anticipos]])
|-
|autorizado
|Autorizado
| -
|NO
|
: Informaciones de la persona autorizada para descargar documentos
: '''PATH''': /root/cac:TaxRepresentativeParty
: (ver detalle en [[#Class.Autorizado|Class.Autorizado]])
|-
|boletaIngreso
|Array<BoletaIngreso>
| -
|NO
|
: Información referente a boleta de ingreso
: (ver detalle en [[#Class.BoletaIngreso]])
|-
|bolsaValores
|Array<BolsaValores>
| -
|NO
|
: Información referente a bolsa de valores
: (ver detalle en [[#Class.BolsaValores]])
|-
|cajaVenta
|Array<CajaVenta>
| -
|NO
|
: Información referente a caja de venta
: (ver detalle en [[#Class.CajaVenta]])
|-
|cantidadDecimales
|String
| <nowiki>N|1</nowiki>
|SI
|
: Se envía la cantidad de decimales a utilizar (mínimo 0, máximo 6)
: Rechazo Si se reciben más decimales en los montos a los indicados en este campo
: '''PATH''': No aplica
|-
|cargosDescuentos
|Array <CargosDescuentos>
| -
|NO
|
: Informaciones relacionadas con un cargo o un descuento a escala de factura que no afecte a la base gravable
: '''PATH''': /root/cac:AllowanceCharge
: (ver detalle en [[#Class.CargosDescuentos|Class.CargosDescuentos]])
|-
|cliente
|Cliente
| -
|SI
|
: Información del adquiriente
: Para Documento Soporte en adquisiciones a No Obligados a Facturar se debe utiliza para registrar los datos del proveedor o del no obligado
: '''PATH''':/root/cac:AccountingCustomerParty
: (ver detalle en [[#Class.Cliente|Class.Cliente]])
|-
|codigoCosto
|String
| -
|NO
|
: Código de para centro de costos

: '''PATH''': ../cbc:
|-
|consecutivoDocumento
|String
| AN..14
|SI
|
: Correlativo/consecutivo del documento electrónico
: Concatenación del prefijo (<nowiki>AN|..4</nowiki>) + el consecutivo DIAN,
: según la configuración en portal web:
:: Manual con prefijo: prefijo requerido (Sin guion). Ejemplo: “PREF2147483647”
:: Manual sin prefijo: prefijo no requerido. Ejemplo: “2147483647”
: Rechazo No se permiten caracteres adicionales como espacios o guiones
: Rechazo Número de consecutivo debe ser igual o superior al valor inicial del rango de numeración otorgado por la DIAN
: Rechazo Número de consecutivo debe ser igual o inferior al valor final del rango de numeración otorgado por la DIAN
: '''PATH''': /root/cbc:ID
|-
|detalleDeFactura
|Array <FacturaDetalle>
| -
|SI
|
: Información de detalles o productos
: '''PATH''': /root/cac:InvoiceLine
: (ver detalle en [[#Class.FacturaDetalle|Class.FacturaDetalle]])
|-
|DocumentosAdjuntos
|Adjunto
| -
|C/C
|
Posibles valores:
: “0” No se admiten adjuntos. Se genera XML y representación Gráfica estándar por The Factory HKA
: “2” Admite archivos adjuntos. Se genera XML y representación Gráfica estándar por The Factory HKA
|-
|documentosReferenciados
|Array <DocumentoReferenciado>
| -
|C/C
|
: Informaciones que describen un documento referenciado
: '''Obligatorio''' en facturas tipoDocumento contingencia (AdditionalDocumentReference), en facturas que afecten una nota (BillingReference), en Notas de Crédito y Débito (DiscrepancyResponse y BillingReference)
: '''PATH''': /root/cac:DiscrepancyResponse,
:: /root/cac:BillingReference,
:: /root/cac: AdditionalDocumentReference,
:: /root/cac: DespatchDocumentReference,
:: /root/cac: ReceiptDocumentReference
:(ver detalle en [[#Class.DocumentoReferenciado|Class.DocumentoReferenciado]])
|-
|entregaMercancia
|Entrega
| -
|NO
|
: Información de entrega (Delivery) de bienes
: '''PATH''': /root/cac:Delivery
: (ver detalle en [[#Class.Entrega|Class.Entrega]])
|-
|extras
|Array <Extras>
| -
|NO
|
: Campos o información opcional para el modelo de negocio del emisor
: '''PATH''': No definido
: (ver detalle en [[#Class.Extras|Class.Extras]])
|-
|fabricantesoftware
|Array<FabricanteSoftware>
| -
|SI
|
: Código de para centro de costos
: (ver detalle en [[#Class.fabricanteSoftware]])
|-
|fechaEmision
|String
| <nowiki>AN|19</nowiki>
|SI
|
: Fecha y hora de emisión del documento, en formato: YYYY-MM-DD HH:MM:SS
: Notificación Si la fecha de emisión es anterior a cinco (5) días de la fecha calendario
: Rechazo Si la fecha de emisión es posterior a diez días calendario
: '''PATH''': /root/cbc:IssueDate, root/cbc:IssueTime
|-
|fechaFinPeriodoFacturacion
|String
| <nowiki>AN|19</nowiki>
|NO
|
: Fecha/Hora de fin del periodo de facturación (Intervalo de fechas a las que referencia la factura por ejemplo en servicios públicos), en formato: YYYY-MM-DD HH:MM:SS
: '''PATH''': /root/cac:InvoicePeriod/cbc:EndDate, /root/cac:InvoicePeriod/cbc:EndTime
|-
|fechaInicioPeriodoFacturacion
|String
| <nowiki>AN|19</nowiki>
|NO
|
: Fecha/Hora de inicio del periodo de facturación, en formato: YYYY-MM-DD HH:MM:SS
: '''PATH''':
: /root/cac:InvoicePeriod/cbc:StartDate, /root/cac:InvoicePeriod/cbc:StartTime
|-
|fechaPagoImpuestos
|String
| <nowiki>AN|19</nowiki>
|NO
|
: Fecha de pago de impuestos, en formato: YYYY-MM-DD HH:MM:SS
: '''PATH''': root/cbc:TaxPointDate
|-
|fechaVencimiento
|String
| <nowiki>AN|10</nowiki>
|NO
|
: Fecha vencimiento de la factura, en formato: YYYY-MM-DD
: '''PATH''': /root/cbc:DueDate
|-
|impuestosGenerales
|Array <FacturaImpuestos>
| -
|SI
|
: Información de impuestos generales o globales
: Rechazo Si los impuestos/retenciones reportados en este arreglo no corresponden con lo reportado en los detalles
: '''PATH''': /root/cac:TaxTotal (impuestos),
: /root/cac: WithholdingTaxTotal (retenciones),
: (ver detalle en [[#Class.FacturaImpuestos|Class.FacturaImpuestos]])
|-
|impuestosTotales
|Array <ImpuestosTotales>
| -
|SI
|
: Sumatoria de los impuestos/retenciones generales por tipo de impuesto/retención
: Rechazo Si el valor total del impuesto/retención indicado es diferente a la sumatoria de los reportado en el arreglo impuestosGenerales
: '''PATH''': /root/cac:TaxTotal/cbc:TaxAmount (impuestos),
: /root/cac: WithholdingTaxTotal/cbc:TaxAmount (retenciones),
: (ver detalle en [[#Class.ImpuestosTotales|Class.ImpuestosTotales]])
|-
|informacionAdicional
|Array <String>
| <nowiki>AN|...10000</nowiki>
|NO
|
: Información adicional o texto libre relativo al documento
: '''PATH''': root/cbc:Note
|-
|informacionBeneficiosComprador
|Array <InformacionBeneficiosComprador>
| -
|NO
|
: Información relacionada con beneficios del comprador
: '''PATH''': /root/cac:PaymentMeans
: (ver detalle en [[#Class.InformacionBeneficiosComprador]])
|-
|juegosLocalizados
|Array<juegosLocalizados>
| -
|NO
|
: Información referente a juegos localizados
: (ver detalle en [[#Class.juegosLocalizados]])
|-
|mediosDePago
|Array<MediosDePago>
| -
|NO
|
: '''PATH''': /root/cac:PaymentMeans
: (ver detalle en [[#Class.MediosDePago]])
|-
|moneda
|String
| <nowiki>AN|3</nowiki>
|SI
|
: Moneda o divisa del documento
: Usar códigos ISO 4217 (Ejemplo Pesos Colombianos “COP”)
: Rechazo Si el valor no corresponde a uno de los códigos ISO 4217
: '''PATH''': /root/cbc:DocumentCurrencyCode
|-
|propina
|string
| -
|NO
|
: Información relacionada a propina
|-
|ordenDeCompra
|Array <OrdenDeCompra>
| -
|NO
|
: Información relacionada a la orden de compra
: '''PATH''': /root/cac:OrderReference
: (ver detalle en [[#Class.OrdenDeCompra|Class.OrdenDeCompra]])
|-
|rangoNumeracion
|String
| <nowiki>AN|20</nowiki>
|SI
|
: Consecutivo desde el que comienza la serie para el documento a emitir, siempre debe colocarse el prefijo (con guión) independientemente de la modalidad de secuencial.
: Ejemplo: ‘PREF-1123456’
: Rechazo Si el valor del campo desde (Inicio del rango) supera el valor '''2.147.483.647'''.
: '''PATH''':
: /root/ext:UBLExtensions/ext:UBLExtension/ext:ExtensionContent/
: sts:DianExtensions/sts:InvoiceControl/sts:AuthorizedInvoices/(sts:Prefix, sts:From)
|-
|redondeoAplicado
|String
| Ent: <nowiki>N|..15</nowiki>
Dec: <nowiki>N|0..6</nowiki>
|SI
|
: Redondeo aplicado para llegar a totalMonto
: Rechazo Si redondeo es superior al mayor valor entre 500 pesos o 0,1% del valor total de la factura
: '''PATH''': /root/cac:LegalMonetaryTotal/cbc:PayableRoundingAmount
|-
|retencionesGenerales
|Array <FacturaImpuestos>
| -
|SI
|
: Información de impuestos generales o globales
: Rechazo Si los impuestos/retenciones reportados en este arreglo no corresponden con lo reportado en los detalles
: '''PATH''': /root/cac:TaxTotal (impuestos),
: /root/cac: WithholdingTaxTotal (retenciones),
: (ver detalle en [[#Class.FacturaImpuestos|Class.FacturaImpuestos]])
|-
|serviciosPublicos
|Array<ServiciosPublicos>
| -
|NO
|
: Información referente a servicios publicos
: (ver detalle en [[#Class.ServiciosPublicos]])
|-
|tasaDeCambio
|Array<TasaDeCambio>
| -
|C/C
|
: Información relacionada con la tasa de cambio de moneda extranjera a peso colombiano (COP)
: '''Obligatorio''' Si tipoDocumento es de exportación/internacional o si la divisa base es diferente a “COP”
: '''PATH''': /root/cac:PaymentExchangeRate
: (ver detalle en [[#Class.TasaDeCambio|Class.TasaDeCambio]])
|-
|tasaDeCambioAlternativa
|TasaDeCambioAlternativa
| -
|NO
|
: Información utilizada como método alternativo para informar conversiones a otras divisas
: '''PATH''': /root/cac:PaymentAlternativeExchangeRate
: (ver detalle en [[#Class.TasaDeCambioAlternativa|Class.TasaDeCambioAlternativa]])
|-
|terminosEntrega
|TerminosEntrega
| -
|C/C
|
: Información relacionada con la entrega
: '''Obligatorio''' Si tipoDocumento es de exportación/internacional
: '''PATH''': /root/cac:DeliveryTerms
: (ver detalle en [[#Class.TerminosEntrega|Class.TerminosEntrega]])
|-
|tipoDocumento
|String
| <nowiki>AN|2</nowiki>
|SI
|
: Tipo de documento
: '''PATH''': Invoice, CreditNote, DebitNote
: Rechazo 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
|String
| <nowiki>AN|..4</nowiki>
|SI
|
: Indicador del tipo de operación
: Rechazo 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
|-
|totalAnticipos
|String
| Ent: <nowiki>N|..15</nowiki>
Dec: <nowiki>N|0..6</nowiki>
|NO
|
: Suma de todos los pagos anticipados
: Rechazo Si totalAnticipos no corresponde a la suma de los atributos Anticipos.montoPagado en el arreglo anticipos
: '''PATH''': /root/LegalMonetaryTotal/cbc:PrepaidAmount
|-
|totalBaseImponible
|String
| Ent: <nowiki>N|..15</nowiki>
Dec: <nowiki>N|0..6</nowiki>
|SI
|
: Total Valor Base Imponible: Suma de Bases imponibles para el cálculo de los tributos a nivel de factura
: Rechazo Si totalBaseImponible no es igual a la suma de ocurrencias FacturaImpuestos.baseImponibleTOTALImp
: '''PATH''': /root/LegalMonetaryTotal/cbc:TaxExclusiveAmount
|-
|totalBrutoConImpuesto
|String
| Ent: <nowiki>N|..15</nowiki>
Dec: <nowiki>N|0..6</nowiki>
|SI
|
: Total del valor bruto con tributos
: Rechazo Si totalBrutoConImpuesto no es igual a la suma: totalSinImpuestos + sum(ImpuestosTotales.montoTotal)
: '''PATH''': /root/LegalMonetaryTotal/cbc:TaxInclusiveAmount
|-
|totalCargosAplicados
|String
| Ent: <nowiki>N|..15</nowiki>
Dec: <nowiki>N|0..6</nowiki>
|NO
|
: Cargo Total: Suma de todos los cargos aplicados a nivel de la factura
: Rechazo Si totalCargosAplicados no corresponde a la suma de ocurrencias CargosDescuentos.monto cuando CargosDescuentos.indicador es “true”
: '''PATH''': /root/LegalMonetaryTotal/cbc:ChargeTotalAmount
|-
|totalDescuentos
|String
| Ent: <nowiki>N|..15</nowiki>
Dec: <nowiki>N|0..6</nowiki>
|NO
|
: Descuento Total: Suma de todos los descuentos aplicados a nivel de la factura
: Rechazo Si totalDescuentos no corresponde a la suma de ocurrencias CargosDescuentos.monto cuando CargosDescuentos.indicador es “false”
: '''PATH''': /root/LegalMonetaryTotal/cbc:AllowanceTotalAmount
|-
|totalMonto
|String
| Ent: <nowiki>N|..15</nowiki>
Dec: <nowiki>N|0..6</nowiki>
|SI
|
: Valor a pagar del documento: Valor total de ítems (incluyendo cargos y descuentos a nivel de ítems) + valor de tributos + valor de cargos – valor de descuentos – valor anticipos
: Rechazo Si totalMonto no es consistente con el valor total de ítems + valor de tributos + valor de cargos – valor de descuentos – valor anticipos + redondeo aplicado
: '''PATH''': /root/LegalMonetaryTotal/cbc:PayableAmount
|-
|totalProductos
|String
| <nowiki>AN|..5</nowiki>
|SI
|
: Número o cantidad de líneas de productos (renglones) presentes en el documento
: Rechazo Si el valor de totalProductos es diferente al número de ocurrencias de rans en el arreglo detalleDeFactura
: '''PATH''': /root/cbc:LineCountNumeric
|-
|totalSinImpuestos
|String
| Ent: <nowiki>N|..15</nowiki>
Dec: <nowiki>N|0..6</nowiki>
|SI
|
: Total Valor Bruto antes de tributos: Suma de los valores brutos de las líneas de la factura
: Rechazo Si totalSinImpuestos no corresponde a la suma de los atributos precioTotalSinImpuestos en el arreglo detalleDeFactura
: '''PATH''': /root/LegalMonetaryTotal/cbc:LineExtensionAmount
|}
====Class.AcuerdosPago====
{| class="mw-collapsible mw-collapsed wikitable"
! style="background:#f2f2f2; text-align:center;"|Atributo
! style="background:#f2f2f2; text-align:center;"|Tipo Dato
! style="background:#f2f2f2; text-align:center;"|Formato
! style="background:#f2f2f2; text-align:center;"|Requerido
! style="background:#f2f2f2; text-align:center;"|Descripción
|-
|cargo debito
|string
| -
|NO
|
: Información referente al debito del acuerdo
|-
|cuotasAPagar
|String
| <nowiki>AN|10</nowiki>
|NO
|
: Numero de cuotas acordadas en el acuerdo de pago
|-
|cuotasPagadas
|String
| <nowiki>AN|10</nowiki>
|NO
|
: Cantidad de cuotas pagadas del acuerdo de pago
|-
|cuotasPactadas
|String
| <nowiki>AN|10</nowiki>
|NO
|
: Cantidad de cuotas pacttadas en el acuerdo de pago
: (ver detalle en [[#Class.CuotasPactadas|Class.CuotasPactadas]])
|-
|descuentoCredito
|String
| -
|NO
|
: descuentos especificados dentro del acuerdo de pago
|-
|descripcionProducto
|String
|<nowiki>A|..150</nowiki>
|SI
|
: Descripción del producto
|-
|nombreProducto
|String
| <nowiki>AN|15</nowiki>
|SI
|
: Nombre especifico del producto
|-
|numeroContrato
|String
|Ent: <nowiki>N|..15 </nowiki>
|SI
|
: Numero del contrato acordado
|-
|porcentajeInteres
|String
|Ent: <nowiki>N|..15 </nowiki>
|NO
|
: Porcentaje del interes dentro del acuerdo de pago
|-
|saldoAPagar
|String
|Ent: <nowiki>N|..15 </nowiki>
|NO
|
: Valor faltante a pagar dentro del acuerdo
|}

====Class.Anticipos====
{| class="mw-collapsible mw-collapsed wikitable"
! style="background:#f2f2f2; text-align:center;"|Atributo
! style="background:#f2f2f2; text-align:center;"|Tipo Dato
! style="background:#f2f2f2; text-align:center;"|Formato
! style="background:#f2f2f2; text-align:center;"|Requerido
! style="background:#f2f2f2; text-align:center;"|Descripción
|-
|extras
|Array <Extensible>
| -
|NO
|
: Campos o información opcional para el modelo de negocio del emisor
: '''PATH''': No definido
: (ver detalle en [[#Class.Extensible|Class.Extensible]])
|-
|fechaDeRecibido
|String
| <nowiki>AN|10</nowiki>
|SI
|
: Fecha en la cual el pago fue recibido, en formato: YYYY-MM-DD
: PATH: …/cbc:ReceivedDate
|-
|fechadePago
|String
| <nowiki>AN|10</nowiki>
|NO
|
: Fecha en la cual el pago fue realizado, en formato: YYYY-MM-DD
: '''PATH''': …/cbc:PaidDate
|-
|horaDePago
|String
| <nowiki>AN|8</nowiki>
|NO
|
: Hora en la cual el pago fue realizado, en formato:HH:MM:SS
: '''PATH''': …/cbc:PaidTime
|-
|id
|String
|<nowiki>A|..150</nowiki>
|SI
|
: Identificación interno del pago
: '''PATH''': …/cbc:ID
|-
|instrucciones
|String
| <nowiki>AN|15..500</nowiki>
|SI
|
: Instrucciones relativas al pago
: '''PATH''': …/cbc:InstructionID
|-
|montoPagado
|String
|Ent: <nowiki>N|..15 </nowiki>
Dec: <nowiki>N|0..6 </nowiki>
|SI
|
: Valor del pago anticipado, no puede ser superior al valor total de la factura
: Notificación Si montoPagado > totalMonto
: '''PATH''': …/cbc:PaidAmount
|}

====Class.Autorizado====
{| class="mw-collapsible mw-collapsed wikitable"
! style="background:#f2f2f2; text-align:center;"|Atributo
! style="background:#f2f2f2; text-align:center;"|Tipo Dato
! style="background:#f2f2f2; text-align:center;"|Formato
! style="background:#f2f2f2; text-align:center;"|Requerido
! style="background:#f2f2f2; text-align:center;"|Descripción
|-
|direccion
|Direccion
| -
|NO
|
: Dirección
: '''PATH''': ../cac:PhysicalLocation/cac:Address
|-
|email
|String
|<nowiki>AN|..50</nowiki>
|NO
|
: Correo Electrónico
: '''PATH''': ../cac:Contact/cbc:ElectronicMail
|-
|extras
|Array <Extensible>
| -
|NO
|
: Campos o información opcional para el modelo de negocio del emisor
: '''PATH''': No definido
: (ver detalle en [[#Class.Extensible|Class.Extensible]])
|-
|nombreComercial
|String
|<nowiki>AN|..50</nowiki>
|NO
|
: Nombre Comercial
: '''PATH''': ../cac:PartyName/cbc:Name
|-
|nombreContacto
|String
|<nowiki>AN|..50</nowiki>
|NO
|
: Nombre de Contacto
: '''PATH''': ../cac:Contact/cbc:Name
|-
|nota
|String
|<nowiki>AN|..50</nowiki>
|NO
|
: Nota
: '''PATH''': ../cac:Contact/cbc:Note
|-
|numeroDocumento
|String
|<nowiki>AN|..12</nowiki>
|SI
|
: Numero de Identificación
: '''PATH''': ../cac:PartyIdentification/cbc:ID
|-
|numeroDocumentoDV
|String
|<nowiki>AN|..2 </nowiki>
|C/C
|
: Digito Verificador
: '''Obligatorio''' Si tipoIdentificacion es “31”
: '''PATH''': ../cac:PartyIdentification/cbc:ID@schemeID
|-
|razonSocial
|String
|<nowiki>AN|..50</nowiki>
|NO
|
: Razón Social
: '''PATH''': ../cac:PartyLegalEntity/cbc:RegistrationName
|-
|telefax
|String
|<nowiki>AN|..50</nowiki>
|NO
|
: Telefax
: '''PATH''': ../cac:Contact/cbc:Telefax
|-
|telefono
|String
|<nowiki>AN|..50</nowiki>
|NO
|
: Teléfono
: '''PATH''': ../cac:Contact/cbc:Telephone
|-
|tipoIdentificacion
|String
|<nowiki>AN|..2 </nowiki>
|SI
|
: Tipo de Identificación
: '''PATH''': /cac:PartyIdentification/cbc:ID@schemeName
: 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.BoletaIngreso====
{| class="mw-collapsible mw-collapsed wikitable"
! style="background:#f2f2f2; text-align:center;"|Atributo
! style="background:#f2f2f2; text-align:center;"|Tipo Dato
! style="background:#f2f2f2; text-align:center;"|Formato
! style="background:#f2f2f2; text-align:center;"|Requerido
! style="background:#f2f2f2; text-align:center;"|Descripción
|-
|nombreProductor
|String
| -
|SI
|
: Apellidos y nombre o razón social del productor u organizador del espectáculo público
: ext:ExtensionContent/PublicShowsInformation/Producer/ProducerName
|-
|numeroIdentificacionProductor
|String
| -
|SI
|
: NIT del productor u organizador del espectáculo público
: ext:ExtensionContent/PublicShowsInformation/Producer/ProducerNIT
|-
|codigoLEP
|String
| -
|NO
|
: Código LEP de productor de espectáculos públicos de acuerdo a su categoría
: ext:ExtensionContent/PublicShowsInformation/Producer/LEPCode
|-
|nombreEvento
|String
| -
|si
|
: Nombre del evento
: ext:ExtensionContent/PublicShowsInformation/EventInformation/EventName
|-
|localidad
|String
| -
|SI
|
: Sala, escenario, puesto y/o localidad asignada
: ext:ExtensionContent/PublicShowsInformation/EventInformation/TicketLocation
|-
|codigoUnicoEvento
|String
| -
|NO
|
: Código único del evento – PULEP
: ext:ExtensionContent/PublicShowsInformation/EventInformation/PULEPCode
|-
|tipoEvento
|String
| -
|NO
|
: Tipo de venta
: ext:ExtensionContent/PublicShowsInformation/EventInformation/TicketType
|-
|etapa
|String
| -
|NO
|
: Etapa de la venta
: ext:ExtensionContent/PublicShowsInformation/EventInformation/SalePhase
|-
|categoria
|String
| -
|NO
|
: Indicar la categoría del evento
: ext:ExtensionContent/PublicShowsInformation/EventInformation/EventCategory
|-
|departamento
|String
| -
|NO
|
: Nombre del departamento donde se realizará el evento
: ext:ExtensionContent/PublicShowsInformation/EventInformation/CountrySubentity
|-
|codigoDepartamento
|String
| -
|NO
|
: Código del departamento donde se realizará el evento
: ext:ExtensionContent/PublicShowsInformation/EventInformation/CountrySubentityCode
|-
|ciudad
|String
| -
|NO
|
: Nombre de la Ciudad o Municipio donde se realizará el evento
: ext:ExtensionContent/PublicShowsInformation/EventInformation/CityName
|-
|codigoCiudad
|String
| -
|NO
|
: Código de la Ciudad o Municipio donde se realizará el evento
: ext:ExtensionContent/PublicShowsInformation/EventInformation/ID
|-
|direccion
|String
| -
|NO
|
: Nombre del sitio, dirección o ubicación donde se realizará el evento
: ext:ExtensionContent/PublicShowsInformation/EventInformation/EventLocation
|-
|fechaEvento
|String
| -
|NO
|
: Fecha del evento
: ext:ExtensionContent/PublicShowsInformation/EventInformation/DateEvent
|-
|horaEvento
|String
| -
|NO
|
: Hora del evento
: ext:ExtensionContent/PublicShowsInformation/EventInformation/TimeEvent
|}

====Class.bolsaValores====
{| class="mw-collapsible mw-collapsed wikitable"
! style="background:#f2f2f2; text-align:center;"|Atributo
! style="background:#f2f2f2; text-align:center;"|Tipo Dato
! style="background:#f2f2f2; text-align:center;"|Formato
! style="background:#f2f2f2; text-align:center;"|Requerido
! style="background:#f2f2f2; text-align:center;"|Descripción
|-
|consecutivo
|String
| -
|SI
|
: Número del consecutivo
: ext:ExtensionContent/CustomTagGeneral/Group/AdditionalCollection/Value
|-
|fechaCumplimiento
|String
| -
|SI
|
: Fecha de cumplimiento
: ext:ExtensionContent/CustomTagGeneral/Group/AdditionalCollection/Value
|-
|cantidadNominal
|String
| -
|SI
|
: Cantidad nominal
: ext:ExtensionContent/CustomTagGeneral/Group/CollectionTotal/Value
|-
|precioCesionTotal
|String
| -
|SI
|
: Precio cesion total
: ext:ExtensionContent/CustomTagGeneral/Group/CollectionTotal/Value
|-
|PrecioRegistro
|String
| -
|SI
|
: Precio de registro
: ext:ExtensionContent/CustomTagGeneral/Group/CollectionTotal/Value
|-
|montoderendimientos
|String
| -
|SI
|
: Monto de Rendimientos
: ext:ExtensionContent/CustomTagGeneral/Group/CollectionTotal/Value
|-
|valor
|String
| -
|SI
|
: Valor
: ext:ExtensionContent/CustomTagGeneral/Group/CollectionTotal/Value
|-
|porcentajeComision
|String
| -
|SI
|
: Porcentaje de la comisión
: ext:ExtensionContent/CustomTagGeneral/Group/CollectionTotal/Value
|}

====Class.CargosDescuentos====
{| class="mw-collapsible mw-collapsed wikitable"
! style="background:#f2f2f2; text-align:center;"|Atributo
! style="background:#f2f2f2; text-align:center;"|Tipo Dato
! style="background:#f2f2f2; text-align:center;"|Formato
! style="background:#f2f2f2; text-align:center;"|Requerido
! style="background:#f2f2f2; text-align:center;"|Descripción
|-
|Tipo
|String
|<nowiki>AN|2</nowiki>
|SI
|
: Grupo de campos para información relacionadas con un cargo o un descuento
: '''Obligatorio''': Si es descuento a nivel de factura (general)
: Rechazo Rechazo: Si cac:AllowanceCharge/cbc:ID/@schemeName =1, se deben informar los elementos: ID, ChargeIndicator, AllowanceChargeReason, Amount Rechazo: Si cac:AllowanceCharge/cbc:ID/@schemeName =2, se deben informar loselementos: ID, ChargeIndicator, AllowanceChargeReason, MultiplierFactorNumeric, Amount y BaseAmount
: '''PATH''': /Invoice/cac:AllowanceCharge
|-
|codigo
|String
|<nowiki>AN|2</nowiki>
|C/C
|
: Código para categorizar el descuento
: '''Obligatorio''': Si es descuento a nivel de factura (general)
: Rechazo 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
|-
|descripcion
|String
|<nowiki>AN|10..5000</nowiki>
|SI
|
: Texto libre para informar la razón del descuento
: '''PATH''': …/cbc:AllowanceChargeReason
: Notificación : Si se informa un cargo o descuento y no se informa este elemento
|-
|extras
|Array <Extensible>
| -
|NO
|
: Campos o información opcional para el modelo de negocio del emisor
: '''PATH''': No definido
: (ver detalle en [[#Class.Extensible|Class.Extensible]])
|-
|indicador
|String
|<nowiki>N|1</nowiki>
|SI
|
: Indicador de si es Cargo”1” o Descuento “0”
: Rechazo : Si este elemento contiene una información diferente de “1” o “0”
: '''PATH''': …/cbc:ChargeIndicator
|-
|monto
|String
|Ent: <nowiki>N|..15</nowiki>
Dec: <nowiki>N|0..6</nowiki>
|SI
|
: Valor total del cargo o descuento, si es descuento no puede ser superior al valor base
: Rechazo : Si es Descuento y monto > montoBase
: '''PATH''': …/cbc:Amount
|-
|montoBase
|String
|Ent: <nowiki>N|..15</nowiki>
Dec: <nowiki>N|0..6</nowiki>
|SI
|
: Valor Base para calcular el descuento o el cargo,
: Rechazo: Si es negativo el montoBase, si es descuento no puede ser superior al valor total de la factura
: Rechazo: Si montoBase > totalMonto
: '''PATH''': …/cbc:BaseAmount
|-
|porcentaje
|String
|Ent: <nowiki>N|..6</nowiki>
Dec: <nowiki>N|2</nowiki>
|SI
|
: Porcentaje del descuento
: Rechazo Si este elemento > 100
: '''PATH''': …/cbc:MultiplierFactorNumeric
|-
|secuencia
|String
|<nowiki>N|..3</nowiki>
|SI
|
: Indicador de orden de secuencia
: '''PATH''': …/cbc:ID
|}

====Class.CajaVenta====
{| class="mw-collapsible mw-collapsed wikitable"
! style="background:#f2f2f2; text-align:center;"|Atributo
! style="background:#f2f2f2; text-align:center;"|Tipo Dato
! style="background:#f2f2f2; text-align:center;"|Formato
! style="background:#f2f2f2; text-align:center;"|Requerido
! style="background:#f2f2f2; text-align:center;"|Descripción
|-
|placaCaja
|String
| -
|SI
|
: Valor de la característica que se quiere informar (Placa de inventario de la Caja)
: Corresponde a la Placa de inventario de la Caja
: ./ext:UBLExtension/ext:ExtensionContent//InformacionCajaVenta/Value
|-
|-
|ubicacionCaja
|String
| -
|SI
|
: Valor de la característica que se quiere informar (Ubicación de la caja ALMACEN)
: Corresponde a la Ubicación de la caja ALMACEN
: ./ext:UBLExtension/ext:ExtensionContent//InformacionCajaVenta/Value
|-
|cajero
|String
| -
|SI
|
: Valor de la característica que se quiere informar (nombres y apellidos del cajero o vendedor)
: Corresponde a los Nombres y apellidos del cajero o vendedor
: ./ext:UBLExtension/ext:ExtensionContent//InformacionCajaVenta/Value
|-
|tipoCaja
|String
| -
|SI
|
: Valor de la característica que se quiere informar (Tipo de Caja)
: Corresponse al Tipo de Caja
: ./ext:UBLExtension/ext:ExtensionContent//InformacionCajaVenta/Value
|-
|codigoVenta
|String
| -
|SI
|
: Valor de la característica que se quiere informar (Código de la Venta)
: Corresponde al Código de la Venta
: ./ext:UBLExtension/ext:ExtensionContent//InformacionCajaVenta/Value
|}

====Class.CreditoInstrumentoJuego====
{| class="mw-collapsible mw-collapsed wikitable"
! style="background:#f2f2f2; text-align:center;"|Atributo
! style="background:#f2f2f2; text-align:center;"|Tipo Dato
! style="background:#f2f2f2; text-align:center;"|Formato
! style="background:#f2f2f2; text-align:center;"|Requerido
! style="background:#f2f2f2; text-align:center;"|Descripción
|-
|numeroSerie
|String
| -
|SI
|
: Número del serial de la máquina o intrumento de juego con reporte diario crédito
: ext:ExtensionContent/InfoEstablishment/CreditValueOfTheMachine/GameMachineSerial
|-
|valorCredito
|String
| -
|SI
|
: Valor crédito de la máquina o instrumento de juego
: ext:ExtensionContent/InfoEstablishment/CreditValueOfTheMachine/CreditValue
|-
|moneda
|String
| -
|SI
|
: Código de modena
: ext:ExtensionContent/InfoEstablishment/CreditValueOfTheMachine/CreditValue/@currencyID
|}

====Class.Cliente====
{| class="mw-collapsible mw-collapsed wikitable"
! style="background:#f2f2f2; text-align:center;"|Atributo
! style="background:#f2f2f2; text-align:center;"|Tipo Dato
! style="background:#f2f2f2; text-align:center;"|Formato
! style="background:#f2f2f2; text-align:center;"|Requerido
! style="background:#f2f2f2; text-align:center;"|Descripción
|-
|actividadEconomicaCIIU
|String
|<nowiki>AN|…4</nowiki>
|NO
|
: Corresponde al código de actividad económica CIIU
: '''PATH''': .. /cac:Party/cbc:IndustryClassificationCode
|-
|apellido
|String
|<nowiki>AN|…50</nowiki>
|NO
|
: Apellido del adquiriente.
: '''PATH''': No definido
|-
|destinatario
|Array <Destinatario>
| -
|C/C
|
: Permite especifica el medio y los datos de la entrega electrónica del documento
: '''Obligatorio''': Si campo notificar = ‘SI’
: '''PATH''': No definido
: (ver detalle en [[#Class.Destinatario|Class.Destinatario]])
|-
|detallesTributarios
|Array <Tributos>
| -
|SI
|
: Detalles tributarios del adquirente
: Rechazo Si la clase no es informada
: '''PATH''': /cac:Party/cac:PartyTaxScheme/cac:TaxScheme
: (ver detalle en [[#Class.Tributos|Class.Tributos]])
|-
|direccionCliente
|Direccion
| -
|C/C
|
: Información donde se detalle la dirección de recepción del adquiriente
: '''Recomendado''': Esta dirección ransf es la que se pinta en la representación gráfica estándar
: '''PATH''': ../cac:Party/cac:PhysicalLocation/cac:Address
: (ver detalle en [[#Class.Direccion|Class.Direccion]])
|-
|direccionFiscal
|Direccion
| -
|C/C
|
: Dirección fiscal del adquiriente.
: '''Obligatorio''': Si el adquirente es responsable
: Notificación Si el adquirente es responsable y no fue informada esta clase
: '''PATH''': .. /cac:Party/cac:PartyTaxScheme/cac:RegistrationAddress
: (ver detalle en [[#Class.Direccion|Class.Direccion]])
|-
|email
|String
|<nowiki>AN|..50</nowiki>
|C/C
|
: Correo Electrónico del adquiriente que irá al XML/UBL fiscal
: (solo se envía un correo en este campo)
: '''PATH''': No aplica nodo
|-
|extras
|Array <Extensible>
| -
|NO
|
: Campos o información opcional para el modelo de negocio del emisor
: '''PATH''': No definido
: (ver detalle en [[#Class.Extensible|Class.Extensible]])
|-
|informacionLegalCliente
|InformacionLegalCliente
| -
|C/C
|
: Información legal del cliente
: Notificación : Si se informa tipoPersona = ‘1’ y el atributo no es reportado
: '''PATH''': ../cac:Party/cac:PartyLegalEntity
: (ver detalle en [[#Class.InformacionLegalCliente|Class.InformacionLegalCliente]])
|-
|nombreComercial
|String
|<nowiki>AN|5..450</nowiki>
|C/C
|
: Nombre Comercial del adquiriente
: '''Obligatorio''' Si en la Rep. Gráfica se mostrará el nombre comercial
: '''PATH''': /cac:Party/cac:PartyName
|-
|nombreContacto
|String
|<nowiki>AN|5..450</nowiki>
|NO
|
: Nombre de Contacto
: '''PATH''': ../cac:Party/cac:Contact/cbc:Name
|-
|nombreRazonSocial
|String
|<nowiki>AN|5..450</nowiki>
|SI
|
: Nombre o Razón Social del adquirente
: '''Recomendado''': Si la persona es natural concatenar en este campo el nombre competo (nombres + apellidos)
: '''PATH''': …/cac:Party/cac:PartyTaxScheme/cbc:RegistrationName
|-
|nota
|String
|<nowiki>AN|..450</nowiki>
|NO
|
: Nota adicional de contacto
: '''PATH''': ../cac:Party/cac:Contact/cbc:Note
|-
|notificar
|String
|<nowiki>AN|2</nowiki>
|SI
|
: Activa el envío de email al adquirente.
: Valores posibles: “SI” o “NO”
: '''PATH''': No aplica
|-
|numeroDocumento
|String
|<nowiki>AN|..12</nowiki>
|SI
|
: Número del Documento o Identificación Fiscal del adquirente
: '''Obligatorio''' Si el adquirente es responsable debe informar el NIT
: Rechazo Si tipoIdentificacion es ‘31’ y la estructura de NIT es inválida
: Rechazo : Se genera si el valor de AdditionalAccountID = “2” y este no es mencionado.
: Nota : Para identificar al consumidor final, se utiliza el siguiente documento “222222222222”
: '''PATH''': …/cac:Party/cac:PartyTaxScheme/cbc:CompanyID
|-
|numeroIdentificacionDV
|String
|<nowiki>AN|..2</nowiki>
|C/C
|
: Digito de verificación NIT del adquiriente
: '''Obligatorio''': Si tipoIndentificacion = 31, debe ser informado
: '''PATH''':
: ../cac:Party/cac:PartyTaxScheme/cbc:CompanyID/@schemeID
|-
|responsabilidadesRut
|Array <Obligaciones>
| -
|SI
|
: Obligaciones y régimen del adquiriente
: Rechazo Si la clase no es informada
: '''PATH''': ../cac:Party/cac:PartyTaxScheme/cbc:TaxLevelCode
: (ver detalle en [[#Class.Obligaciones|Class.Obligaciones]])
|-
|segundoNombre
|String
|<nowiki>AN|..50</nowiki>
|NO
|
: Segundo nombre del adquiriente.
: '''PATH''': No definido
|-
|telefax
|String
|<nowiki>N|..20</nowiki>
|NO
|
: Telefax
: '''PATH''': ../cac:Party/cac:Contact/cbc:Telefax
|-
|telefono
|String
|<nowiki>AN|..20</nowiki>
|NO
|
: Teléfono del adquiriente
: '''PATH''': …/cac:Party/cac:Contact/cbc:Telephone
|-
|tipoIdentificacion
|String
|<nowiki>N|2</nowiki>
|SI
|
: Tipo de Identificación del adquiriente
: Rechazo 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]]
: Nota: Para identificar al consumidor final se utiliza el código “13”
: '''PATH''': ./cac:Party/cac:PartyTaxScheme/cbc:CompanyID/@schemeName
|-
|tipoPersona
|String
|<nowiki>N|1</nowiki>
|SI
|
: Identificador de tipo de persona
: Rechazo 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
|}
====Class.Consumo====
{| class="mw-collapsible mw-collapsed wikitable"
! style="background:#f2f2f2; text-align:center;"|Atributo
! style="background:#f2f2f2; text-align:center;"|Tipo Dato
! style="background:#f2f2f2; text-align:center;"|Formato
! style="background:#f2f2f2; text-align:center;"|Requerido
! style="background:#f2f2f2; text-align:center;"|Descripción
|-
|unidadConsumida
|String
| <nowiki>AN|10</nowiki>
|SI
|
: (ver detalle en [[#Class.Valor|Class.Valor]])
|-
|periodoDesde
|string
| -
|NO
|
: Información referente al periodo inicial
|-
|periodoHasta
|String
| <nowiki>AN|10</nowiki>
|NO
|
: Información referente al periodo final
|-
|diasFacturados
|String
| -
|NO
|
: Información referente a los días facturados durante el periodo
|-
|diasFacturadosUnidad
|String
| -
|NO
|
: Información referente al promedio consumo dias/unidad
|-
|monto
|String
| -
|NO
|
: Información referente al monto del consumo
|}
====Class.ConsumoHistorico====
{| class="mw-collapsible mw-collapsed wikitable"
! style="background:#f2f2f2; text-align:center;"|Atributo
! style="background:#f2f2f2; text-align:center;"|Tipo Dato
! style="background:#f2f2f2; text-align:center;"|Formato
! style="background:#f2f2f2; text-align:center;"|Requerido
! style="background:#f2f2f2; text-align:center;"|Descripción
|-
|pagoAnterior
|string
| -
|NO
|
: Información referente al ultimo pago realizado anteriormente
|-
|Consumo
|String
| <nowiki>AN|10</nowiki>
|SI
|
: (ver detalle en [[#Class.Consumo|Class.Consumo]])
|-
|promedioUnidades
|String
| <nowiki>AN|10</nowiki>
|NO
|
: (ver detalle en [[#Class.Valor|Class.Valor]])
|-
|promedioDias
|String
| <nowiki>AN|10</nowiki>
|NO
|
: (ver detalle en [[#Class.Valor|Class.Valor]])
|}
====Class.CuotasPactadas====
{| class="mw-collapsible mw-collapsed wikitable"
! style="background:#f2f2f2; text-align:center;"|Atributo
! style="background:#f2f2f2; text-align:center;"|Tipo Dato
! style="background:#f2f2f2; text-align:center;"|Formato
! style="background:#f2f2f2; text-align:center;"|Requerido
! style="background:#f2f2f2; text-align:center;"|Descripción
|-
|numeroCuota
|string
| -
|NO
|
: Información referente al numero de cuotas pactadas
|-
|montoDebito
|String
| <nowiki>AN|10</nowiki>
|NO
|
: Referente al monto debitado en la transacción
|-
|montoCredito
|String
| <nowiki>AN|10</nowiki>
|NO
|
: Referente al monto credito en la transacción
|}
====Class.DatosDelTransportista====
{| class="mw-collapsible mw-collapsed wikitable"
! style="background:#f2f2f2; text-align:center;"|Atributo
! style="background:#f2f2f2; text-align:center;"|Tipo Dato
! style="background:#f2f2f2; text-align:center;"|Formato
! style="background:#f2f2f2; text-align:center;"|Requerido
! style="background:#f2f2f2; text-align:center;"|Descripción
|-
|detallesTributarios
|Tributos
| -
|NO
|
: Tipos de Impuesto
: '''PATH''': ../cac:PartyTaxScheme/cac:TaxScheme
: (ver detalle en [[#Class.Tributos|Class.Tributos]])
|-
|direccionResponsableEntrega
|Direccion
| -
|NO
|
: Información de la Dirección del Responsable de Entrega
: '''PATH''': ../cac:Address/cbc:PhysicalLocation
: (ver detalle en [[#Class.Direccion|Class.Direccion]])
|-
|email
|String
|<nowiki>AN|..50</nowiki>
|NO
|
: Correo Electrónico
: '''PATH''': ..cac:Contact/cbc:ElectronicMail
|-
|extras
|Array <Extensible>
| -
|NO
|
: Campos o información opcional para el modelo de negocio del emisor.
: '''PATH''': No definido
: (ver detalle en [[#Class.Extensible|Class.Extensible]])
|-
|indicadordeAtencion
|String
|<nowiki>AN|..50</nowiki>
|NO
|
: Indicador si es información sobre “para la atención de” (FAO)
: '''PATH''': ../cbc:MarkAttentionIndicator
|-
|indicadordeCuidado
|String
|<nowiki>AN|..50</nowiki>
|NO
|
: Indicador si es información sobre alguien responsable por los bienes
: '''PATH''': ../cbc:MarkCareIndicator
|-
|nombreContacto
|String
|<nowiki>AN|..50</nowiki>
|NO
|
: Nombre de Contacto
: '''PATH''': .. /cac:Contact/cbc:Name
|-
|nombreResponsableEntrega
|String
|<nowiki>AN|..50</nowiki>
|NO
|
: Nombre del Responsable de la Entrega
: '''PATH''': ../cac:PartyName/cbc:Name
|-
|nota
|String
| -
|NO
|
: Nota de Contacto
: '''PATH''': ../cac:Contact/cbc:Note
|-
|numeroIdentificacion
|String
|<nowiki>AN|…12</nowiki>
|NO
|
: NIT del transportista
: '''PATH''': ../cac:PartyTaxScheme/cbc:CompanyID
|-
|numeroIdentificacionDV
|String
|<nowiki>N|..2</nowiki>
|NO
|
: Digito Verificador
: '''PATH''': ../cac:PartyTaxScheme/cbc:CompanyID@schemeID
|-
|numeroMatriculaMercantil
|String
|<nowiki>AN|..20</nowiki>
|NO
|
: Número de matrícula mercantil
: '''PATH''': ../cac:PartyLegalEntity/cac:CorporateRegistrationScheme/cbc:Name
|-
|prefijoFacturacion
|String
|<nowiki>AN|..20</nowiki>
|NO
|
: Prefijo de facturación del Transportista
: '''PATH''': .. /cac:PartyLegalEntity//cac:CorporateRegistrationScheme/cbc:ID
|-
|responsabilidadesRut
|Array <Obligaciones>
| -
|NO
|
: Responsabilidad del Transportista
: '''PATH''': ../cac:PartyTaxScheme/cbc:TaxLevelCode
: (ver detalle en [[#Class.Obligaciones|Class.Obligaciones]])
|-
|telefax
|String
|<nowiki>AN|..20</nowiki>
|NO
|
: Telefax de transportista
: '''PATH''': ../cac:PartyTaxScheme/cbc:CompanyID/@schemeName
|-
|telefono
|String
|<nowiki>AN|..20</nowiki>
|NO
|
: Teléfono de transportista
: '''PATH''': ../cac:Contact/cbc:Telefax
|-
|tipoIdentificacion
|String
|<nowiki>N|2</nowiki>
|NO
|
: Tipo de Identificación del Transportista
: Rechazo 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
|-
|transportadorDireccion
|Direccion
| -
|NO
|
: Dirección fiscal del transportador
: '''PATH''': ../cac:PartyLegalEntity/cac:RegistrationAddress
: (ver detalle en [[#Class.Direccion|Class.Direccion]])
|-
|transportadorNombre
|String
|<nowiki>AN|..50</nowiki>
|NO
|
: Nombre del transportador
: '''PATH''': ../cac:PartyLegalEntity/cbc:RegistrationName
|-
|transportadorNumeroDocumento
|String
|<nowiki>AN|..12</nowiki>
|NO
|
: Numero documento del transportador
: '''PATH''': ../cac:PartyLegalEntity/cbc:CompanyID
|-
|transportadorNumeroDocumentoDV
|String
|<nowiki>AN|..2</nowiki>
|NO
|
: Digito Verificador del NIT del transportador
: '''PATH''': ../cac:PartyLegalEntity/cbc:CompanyID@schemeID
|-
|transportadorTipoIdentificacion
|String
|<nowiki>N|2</nowiki>
|NO
|
: Tipo documento del transportador
: '''PATH''': ../cac:PartyLegalEntity/cbc:CompanyID@schemeName
|}

====Class.Destinatario====
{| class="mw-collapsible mw-collapsed wikitable"
! style="background:#f2f2f2; text-align:center;"|Atributo
! style="background:#f2f2f2; text-align:center;"|Tipo Dato
! style="background:#f2f2f2; text-align:center;"|Formato
! style="background:#f2f2f2; text-align:center;"|Requerido
! style="background:#f2f2f2; text-align:center;"|Descripción
|-
|canalDeEntrega
|String
| -
|SI
|
: Medio de Entrega del Documento Electrónico
: Puede tomar los siguientes valores: 0– Email; 1– Recepción; 2– Interoperabilidad; 3– Whatsapp; 4– Telegram
: PATH: No aplica
|-
|email
|Array <String>
| -
|C/C
|
: Lista de Correos Electrónicos a los cuales se realizará la entrega del documento electrónico si el canalDeEntrega=’0’
: '''Obligatorio''' Cuando canalDeEntrega=’0’
: '''PATH''': No aplica
|-
|extras
|Array <Extensible>
| -
|NO
|
: Campos o información opcional para el modelo de negocio del emisor
: '''PATH''': No definido
: (ver detalle en [[#Class.Extensible|Class.Extensible]])
|-
|fechaProgramada
|String
|<nowiki>AN|19</nowiki>
|NO
|
: Fecha programada
: '''PATH''': No aplica
|-
|mensajeProgramado
|String
| -
|NO
|
: Mensaje
: '''PATH''': No aplica
|-
|nitProveedorReceptor
|String
|<nowiki>N|..12</nowiki>
|C/C
|
: NIT del Destinatario
: '''Obligatorio''' Cuando canalDeEntrega=’1’ ó ‘2’
: '''PATH''': No aplica
|-
|telefono
|String
|<nowiki>AN|..20</nowiki>
|C/C
|
: Teléfono del Destinatario
: '''Obligatorio''' Cuando canalDeEntrega=’3’ ó ‘4’
: '''PATH''': No aplica
|}

====Class.detalleDeFactura====
{| class="mw-collapsible mw-collapsed wikitable"
! style="background:#f2f2f2; text-align:center;"|Atributo
! style="background:#f2f2f2; text-align:center;"|Tipo Dato
! style="background:#f2f2f2; text-align:center;"|Formato
! style="background:#f2f2f2; text-align:center;"|Requerido
! style="background:#f2f2f2; text-align:center;"|Descripción
|-
|cantidadPorEmpaque
|String
| <nowiki>N|..3 </nowiki>
| NO
|
: Cantidad de unidad de este artículo por empaque.
: Por ejemplo, si el artículo son tres “six pack”, la cantidad a reportar en cantidadPorEmpaque es 6, mientras la cantidad a reportar en cantidadReal es 3, y el total de latas que se está describiendo son 18
: '''PATH''': ..cac:Item/cbc:PackSizeNumeric
|-
|cantidadReal
|String
|<nowiki>N|..6</nowiki>
|SI
|
: Cantidad real sobre la cual el precio aplica
: '''PATH''': .. /cac:Price/cbc:BaseQuantity
|-
|cantidadRealUnidadMedida
|String
|<nowiki>AN|..6</nowiki>
|SI
|
: Unidad de la cantidad sobre la cual el precio aplica
: Notificación 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)
: '''PATH''': .. /cac:Price/cbc:BaseQuantity/@unitCode
|-
|cantidadUnidades
|String
|<nowiki>N|..6</nowiki>
|SI
|
: Cantidad de unidades del producto/servicio facturado
: '''PATH''': .. /cbc:InvoicedQuantity
|-
|cargosDescuentos
|Array <CargosDescuentos>
| -
|C/C
|
: Información de cargos y descuentos
: '''Obligatorio''' Este arreglo se debe informar a nivel de ítem, si y solamente si el cargo o descuento afecta la base gravable del ítem.
: Si un cargo individual general a la factura genera IVA, debe reportarse como ítem
: '''PATH''': ../cac:AllowanceCharge
: (ver detalle en [[#Class.CargosDescuentos|Class.CargosDescuentos]])
|-
|codigoFabricante
|String
| -
|NO
|
: Código del fabricante correspondiente al artículo
: '''PATH''': .. /cac:Item/cac:
: ManufacturersItemIdentification/cbc:ID
|-
|codigoIdentificadorPais
|String
|<nowiki>A|2</nowiki>
|NO
|
: Código Identificador del país de origen del artículo o servicio
: Rechazo Si el contenido de este elemento no corresponde a un valor del estándar ISO 3166-1 alfa-2
: '''PATH''': .. /cac:Item/cac:OriginCountry/cbc:IdentificationCode
|-
|codigoProducto
|String
|<nowiki>AN|..50</nowiki>
|SI
|
: Código del vendedor correspondiente al artículo
: '''PATH''': .. /cac:Item/cac:SellersItemIdentification/cbc:ID
|-
|codigoTipoPrecio
|String
|<nowiki>AN|..3</nowiki>
|C/C
|
: Código del tipo de precio informado
: '''Obligatorio''' Para muestras comerciales (valor = 01)
: Rechazo 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
|-
|descripcion
|String
|<nowiki>AN|..300</nowiki>
|C/C
|
: Descripción del producto o servicio
: '''Para Documento Soporte en adquisiciones a No Obligados a Facturar Reportar el Servicio recibido.'''
: '''PATH''': ../Item/cbc:Description[1]
|-
|descripcion2
|String
|<nowiki>AN|..300</nowiki>
|C/C
|
: Descripción del producto o servicio
: '''Para Documento Soporte en adquisiciones a No Obligados a Facturar se Reporta la fecha de compra en un formato año-mes-día.'''
: '''PATH''': ../Item/cbc:Description[2]
|-
|descripcion3
|String
|<nowiki>AN|..300</nowiki>
|C/C
|
: '''Para Documento Soporte en adquisiciones a No Obligados a Facturar se Reporta (1) Si es por operación (2) Si es un acumulado semanal.'''
: '''PATH''': ../Item/cbc:Description[3]
|-
|descripcionTecnica
|String
|<nowiki>AN|..300</nowiki>
|NO
|
: Datos técnicos asociados al producto o servicio
: '''PATH''': .. /cac:Item/cbc:AdditionalInformation
|-
|documentosReferenciados
|Array <DocumentoReferenciado>
| -
|NO
|
: Informaciones que describen un documento referenciado
: '''Obligatorio''' En facturas tipoDocumento contingencia (AdditionalDocumentReference), en facturas que afecten una nota (BillingReference), en Notas de Crédito y Débito (DiscrepancyResponse)
: '''PATH''': /root/cac:DiscrepancyResponse,
: /root/cac:BillingReference,
: /root/cac: AdditionalDocumentReference,
: /root/cac: DespatchDocumentReference,
: /root/cac: ReceiptDocumentReference
: (ver detalle en [[#Class.DocumentoReferenciado|Class.DocumentoReferenciado]])
|-
|estandarCodigo
|String
|AN
|C/C
|
: Código del estándar (identificación del artículo o servicio de acuerdo con un estándar)
: 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]]
: '''Obligatorio''' Para documento soporte y nota de ajuste.
: Notificación Si es factura de exportación (tipoDocumento = 02), y no se informó la sub partida arancelaria
: Notificación Si el código no existe en un estándar cerrado.
: Ejemplo: UNSPSC
: Notificación Si el código no sigue la regla de formación de un código abierto, pero con valores verificables
: Ejemplo: GTIN, Ejemplo:Partidas arancelarias
: '''Nota''': En este caso puede utilizarse el código 999 (Estándar de adopción del contribuyente) para evitar reclasificar los productos
: '''PATH''': /cac:Item/cac:StandardItemIdentification/cbc:ID/@schemeID
|-
|estandarCodigoID
|String
|AN
|NO
|
: Asociado al código del estándar (identificación del artículo o servicio de acuerdo con un estándar).
: Rechazo Si estandarCodigo = 010 y estandarCodigoID es diferente a 9
: 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
|-
|estandarCodigoIdentificador
|String
|AN
|NO
|
: 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 [[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
|-
|estandarCodigoNombre
|String
|AN
|NO
|
: 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 [[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
|-
|estandarCodigoProducto
|String
|AN
|C/C
|
: Código del producto según el estándar informado en estandarCodigo
: '''Obligatorio''' Para documento soporte y nota de ajuste.
: 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
|-
|estandarOrganizacion
|String
| -
|NO
|
: Estándar de la organización
: '''PATH''': ../cac:Item/cac:StandardItemIdentification/cac:IssuerParty/cac:PartyName/cbc:Name
|-
|estandarSubCodigoProducto
|String
| -
|NO
|
: Sub código del estándar del producto
: '''PATH''': ../cac:Item/cac:StandardItemIdentification/cbc:ExtendedID
|-
|extras
|Array <Extensible>
| -
|NO
|
: Campos o información opcional para el modelo de negocio del emisor
: '''PATH''': No definido
: (ver detalle en [[#Class.Extensible|Class.Extensible]])
|-
|impuestosDetalles
|Array <FacturaImpuestos >
| -
|SI
|
: Información de impuestos
: Rechazo Si existe más de un elemento con el mismo valor en el atributo FacturaImpuestos.codigoTOTALImp
: Este grupo NO debe ser informado para ítems excluidos de acuerdo a lo establecido en el Estatuto Tributario.
: Adicionalmente, NO debe ser informado para facturas del régimen simple grupo I, ni para ítems cuyo concepto en contratos de AIU no haga parte de la base gravable.
: A nivel de ítem solo aplica para tributos que deban informarse a nivel de ítem, por ejemplo: IVA, INC, IC, Impuesto Nacional a los Combustibles, entre otros
: '''PATH''': ../cac:TaxTotal (impuestos),
: ../cac: WithholdingTaxTotal (retenciones)
: (ver detalle en [[#Class.FacturaImpuestos|Class.FacturaImpuestos]])
|-
|impuestosTotales
|Array <ImpuestosTotales>
| -
|SI
|
: Sumatoria de los impuestos por todos los tipos
: Este grupo NO debe ser informado para ítems excluidos de acuerdo a lo establecido en el Estatuto Tributario.
: Rechazo Si el valor del valor total del impuesto indicado es diferente a la sumatoria de lo reportado en FacturaImpuestos. valorTOTALImp.
: A nivel de ítem solo aplica para tributos que deban informase a nivel de ítem, por ejemplo, IVA, INC, IC, Impuesto Nacional a los Combustibles, entre otros
: '''PATH''': ../cac:TaxTotal/cbc:TaxAmount (impuestos),
: ../cac: WithholdingTaxTotal/cbc:TaxAmount (retenciones)
: (ver detalle en [[#Class.ImpuestosTotales|Class.ImpuestosTotales]])
|-
|informacionAdicional
|Array <LineaInformacionAdicional>
| -
|NO
|
: Sirve para adicionar información específica del producto que puede ser solicitada por autoridades o entidades diferentes a la DIAN
: '''PATH''': ../cac:Item/cac:AdditionalItemProperty
: (ver detalle en [[#Class.LineaInformacionAdicional|Class.LineaInformacionAdicional]])
|-
|mandatorioNumeroIdentificacion
|String
|<nowiki>N|..12</nowiki>
|C/C
|
: NIT del mandatario
: '''Obligatorio''' para facturas por mandato
: '''PATH''': ../cac:Item/cac:InformationContentProviderParty/cac:PowerOfAttorney/cac:AgentParty/cbc:ID
|-
|mandatorioNumeroIdentificacionDV
|String
|<nowiki>N|..2</nowiki>
|C/C
|
: Digito Verificador del NIT del mandatario
: '''Obligatorio''' para facturas por mandato
: '''PATH''': ../cac:Item/cac:InformationContentProviderParty/cac:PowerOfAttorney/cac:AgentParty/cbc:ID/ @schemeID
|-
|mandatorioTipoIdentificacion
|String
|<nowiki>N|2</nowiki>
|C/C
|
: Tipo de identificación del mandatario
: '''Obligatorio''' Para facturas por mandato
: Notificación 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
|-
|marca
|String
|<nowiki>AN|..100</nowiki>
|C/C
|
: Marca del artículo.
: '''Obligatorio''' Si es factura internacional
: Notificación Si tipoDocumento = “02” y este elemento no fue informado
: '''PATH''': ../Item/cbc:BrandName
|-
|modelo
|String
|<nowiki>AN|..100</nowiki>
|C/C
|
: Modelo del artículo.
: '''Obligatorio''' Si es factura internacional
: Notificación Si tipoDocumento = “02” y este elemento no fue informado
: '''PATH''': ../Item/cbc:ModelName
|-
|muestraGratis
|String
|<nowiki>N|1</nowiki>
|C/C
|
: Indicador de si el ítem es gratuito o no (sin valor comercial)
: '''Obligatorio''' Para muestras comerciales
: Valores posibles: “1” (Es muestra gratis) ó “0” (No es muestra gratis)
: '''PATH''': ../cbc:FreeOfChargeIndicator
|-
|nombreFabricante
|String
|<nowiki>AN|..100</nowiki>
|NO
|
: Nombre del fabricante del producto/servicio
: '''PATH''': ../cac:Item/cac:ManufacturersItemIdentification/cac:IssuerParty/cac:PartyName/cbc:Name
|-
|nota
|String
|<nowiki>AN|20..5000</nowiki>
|C/C
|
: Texto libre para añadir información adicional al artículo
: '''Obligatorio''' Informar para el caso de facturas por contratos de servicio tipo AIU. Para el ítem Adminsitración. En este caso la nota debe empezar por el texto: “Contrato de servicios AIU por concepto de:” El contribuyente debe incluir el objeto del contrato facturado
: '''PATH''': ../cbc:Note
|-
|precioReferencia
|String
|Ent: <nowiki>N|..15</nowiki>
Dec: <nowiki>N|0..6</nowiki>
|C/C
|
: Valor del artículo o servicio.
: Corresponde al valor del precio referencia del ítem que se da como muestra o regalo sin valor comercial
: '''Obligatorio''' Para muestras comerciales
: Rechazo Si se informa el atributo precioReferencia entonces el valor de precioTotalSinImpuestos debe ser (0.00), ya que se trata de muestra o regalo comercial
: '''PATH''': ../cac:PricingReference/cac:AlternativeConditionPrice/cbc:PriceAmount
|-
|precioTotal
|String
|Ent: <nowiki>N|..15</nowiki>
Dec: <nowiki>N|0..6</nowiki>
|C/C
|
: Precio total del producto o servicio.
: (cantidadUnidades*precioVentaUnitario +cargos-descuentos +impuestos)
: '''Obligatorio''' Para uso en las representaciones gráficas
: '''PATH''': No definido
|-
|precioTotalSinImpuestos
|String
|Ent: <nowiki>N|..15</nowiki>
Dec: <nowiki>N|0..6</nowiki>
|SI
|
: Valor total de la línea sin impuestos.
: (cantidadUnidades*precioVentaUnitario +cargos-descuentos)
: Rechazo Si se informa el atributo precioTotalSinImpuestos en 0.00 entonces el valor de precioReferencia debe ser informado ya que se trata de muestra o regalo comercial
: '''PATH''': ../cbc:LineExtensionAmount
|-
|precioVentaUnitario
|String
|Ent: <nowiki>N|..15</nowiki>
Dec: <nowiki>N|0..6</nowiki>
|SI
|
: Precio Unitario del porducto/servicio
: '''PATH''': ../Price/cbc:PriceAmount
|-
|secuencia
|String
|<nowiki>AN|..4</nowiki>
|SI
|
: Indicador de orden de secuencia (número de línea)
: Notificación Si contiene un valor ya utilizado en el atributo secuencia en otro grupo de este archivo
: Notificación Si los números utilizados en los diferentes grupos no son consecutivos, empezando en “1”
: '''PATH''': ../cbc:ID
|-
|seriales
|String
|<nowiki>AN|..500</nowiki>
|NO
|
: Seriales del producto (separador por coma), Ej: ABC123,ABC456
: '''PATH''': ../cac:Item/cac:ItemInstance/cbc:SerialID
|-
|subCodigoFabricante
|String
|<nowiki>AN|..50</nowiki>
|NO
|
: Código del fabricante correspondiente a una sub-especificación del artículo
: '''PATH''': ../cac:Item/cac:ManufacturersItemIdentification/cbc:ExtendedID
|-
|subCodigoProducto
|String
|<nowiki>AN|..50</nowiki>
|NO
|
: Código del emisor/vendedor correspondiente a una sub-especificación del artículo
: '''PATH''': ../Item/cac:SellersItemIdentification/cbc:ExtendedID
|-
|tipoAIU
|String
|<nowiki>AN|..50</nowiki>
|NO
|
: Para Clasificar el tipo de AIU
: '''PATH''': No aplica
|-
|unidadMedida
|String
|<nowiki>AN|..3</nowiki>
|SI
|
: Código de Unidad de medida del producto/servicio facturado
: Notificación 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)
: '''PATH''': ../cbc:InvoicedQuantity@unitCode
|}

====Class.Direcciones====
{| class="mw-collapsible mw-collapsed wikitable"
! style="background:#f2f2f2; text-align:center;"|Atributo
! style="background:#f2f2f2; text-align:center;"|Tipo Dato
! style="background:#f2f2f2; text-align:center;"|Formato
! style="background:#f2f2f2; text-align:center;"|Requerido
! style="background:#f2f2f2; text-align:center;"|Descripción
|-
|aCuidadoDe
|String
|<nowiki>AN|..50</nowiki>
|NO
|
: Cuidado de
: '''PATH''': ../cac:Address/cbc:MarkCare
|-
|aLaAtenciónDe
|String
|<nowiki>AN|..50</nowiki>
|NO
|
: A la atención de
: '''PATH''': ../cac:Address/cbc:MarkAttention
|-
|bloque
|String
|<nowiki>AN|..50</nowiki>
|NO
|
: Nombre del bloque
: '''PATH''': ../cac:Address/cbc:BlockName
|-
|buzon
|String
|<nowiki>AN|..50</nowiki>
|NO
|
: Buzón postal
: '''PATH''': ../cac:Address/cbc:Postbox
|-
|calle
|String
|<nowiki>AN|..50</nowiki>
|NO
|
: Nombre de la calle
: '''PATH''': ../cac:Address/cbc:StreetName
|-
|calleAdicional
|String
|<nowiki>AN|..50</nowiki>
|NO
|
: Nombre Adicional para especificar mejor el nombre de la calle
: '''PATH''': ../cac:Address/cbc:AdditionalStreetName
|-
|ciudad
|String
|<nowiki>AN|…50</nowiki>
|SI
|
: Ciudad
: Rechazo 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
|-
|codigoDepartamento
|String
|<nowiki>AN|…5</nowiki>
|SI
|
: Código del departamento
: 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
: '''PATH''': ../cac:Address/cbc:CountrySubentityCode
|-
|correccionHusoHorario
|String
|<nowiki>AN|6</nowiki>
|NO
|
: Corrección del uso horario correspondiente
: '''PATH''': ../cac:Address/cbc:TimezoneOffset
|-
|departamento
|String
|<nowiki>AN|…50</nowiki>
|SI
|
: Nombre del departamento
: Rechazo 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
|-
|departamentoOrg
|String
|<nowiki>AN|..50</nowiki>
|NO
|
: Un departamento direccionable de una organización
: '''PATH''': ../cac:Address/cbc:Department
|-
|direccion
|String
|<nowiki>AN|…100</nowiki>
|SI
|
: Dirección del cliente, sin indicar ciudad ni departamento
: '''PATH''': ../cac:Address/cac:AddressLine/cbc:Line
|-
|distrito
|String
|<nowiki>AN|..50</nowiki>
|NO
|
: Distrito
: '''PATH''': /cac:Address/cbc:District
|-
|extras
|Array <Extensible>
| -
|NO
|
: Campos o información opcional para el modelo de negocio del emisor.
: '''PATH''': No definido
: (ver detalle en [[#Class.Extensible|Class.Extensible]])
|-
|habitacion
|String
|<nowiki>AN|..50</nowiki>
|NO
|
: Habitación
: '''PATH''': ../cac:Address/cbc:Room
|-
|lenguaje
|String
|<nowiki>A|2</nowiki> ISO 639-1
|SI
|
: Identificador del lenguaje utilizado en el nombre del país
: Notificación Si el contenido de este atributo no corresponde a uno de los valores del estándar ISO 639-1
: Notificación Si este es un grupo con informaciones con respeto a la dirección del emisor de un documento electrónico, debe contener el literal “es”
: '''PATH''': /cac:Address/cac:Country/cbc:Name/@languageID
|-
|localizacion
|Array <Coordenadas>
|<nowiki>AN|..50</nowiki>
|NO
|
: Coordenadas de la dirección
: '''PATH''': ../cac:Address/cac:LocationCoordinate
: (ver detalle en [[#Class.Coordenadas|Class.Coordenadas]])
|-
|municipio
|String
|<nowiki>AN|..50</nowiki>
|SI
|
: Código del Municipio
: Notificación 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
|-
|nombreEdificio
|String
|<nowiki>AN|..50</nowiki>
|NO
|
: Nombre de un Edificio
: '''PATH''': ../cac:Address/cbc:BuildingName
|-
|numeroEdificio
|String
|<nowiki>AN|..50</nowiki>
|NO
|
: Número de una casa o edificio
: '''PATH''': ../cac:Address/cbc:BuildingNumber
|-
|numeroParcela
|String
|<nowiki>AN|..50</nowiki>
|NO
|
: Número de Parcela
: '''PATH''': ../cac:Address/cbc:PlotIdentification
|-
|pais
|String
|<nowiki>A|2</nowiki>
|SI
|
: País del cliente.
: Rechazo Si el contenido de este elemento no corresponde a un valor del estándar ISO 3166-1 alfa-2
: '''PATH''': ../cac:Address/cac:Country/cbc:IdentificationCode
|-
|piso
|String
|<nowiki>AN|..50</nowiki>
|NO
|
: Piso
: '''PATH''': ../cac:Address/cbc:Floor
|-
|region
|String
|<nowiki>AN|..50</nowiki>
|NO
|
: Región
: '''PATH''': ../cac:Address/cbc:Region
|-
|subDivision
|String
|<nowiki>AN|..40</nowiki>
|NO
|
: Subdivisión (Nombre del Barrio)
: '''PATH''': ../cac:Address/cbc:CitySubdivisionName
|-
|ubicación
|String
|<nowiki>AN|..50</nowiki>
|NO
|
: Una ubicación específica dentro de un edificio
: '''PATH''': ../cac:Address/cbc:InhouseMail
|-
|zonaPostal
|String
|<nowiki>AN|..10</nowiki>
|NO
|
: Zona Postal
: Notificación 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]]
: Notificación Si el valor del atributo codigoDepartamento es diferente a los 2 primeros dígitos del código postal.
: '''PATH''': ../cac:Address/cbc:PostalZone
|}

====Class.DocumentoReferenciado====
{| class="mw-collapsible mw-collapsed wikitable"
! style="background:#f2f2f2; text-align:center;"|Atributo
! style="background:#f2f2f2; text-align:center;"|Tipo Dato
! style="background:#f2f2f2; text-align:center;"|Formato
! style="background:#f2f2f2; text-align:center;"|Requerido
! style="background:#f2f2f2; text-align:center;"|Descripción
|-
|codigoEstatusDocumento
|String
| -
|C/C
|
: Código o motivo del Documento
: '''Obligatorio''' Cuando codigoInterno sea ‘4’
: Rechazo 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
|-
|codigoInterno
|String
|<nowiki>N|1</nowiki>
|SI
|
: Este campo decide si en que nodo XML se va a enviar la información de DocumentoReferenciado, posibles valores:
# AdditionalDocumentReference (FE de contingencia y para acciones comerciales y mercantiles)
# DespatchDocumentReference (Doc. De despacho)
# ReceiptDocumentReference (Doc. De recepción)
# DiscrepancyResponse (N.C y N.D)
# BillingReference (Facturas por corrección, N.C y N.D)
:OBLIGATORIO '''Para Documento soporte este campo debe ser 5.'''
|-
|cufeDocReferenciado
|String
|<nowiki>AN|..90</nowiki>
|C/C
|
: CUFE o CUDE del documento referenciado
: '''Obligatorio''' Cuando codigoInterno sea ‘5’
: '''Obligatorio''' En facturas, se debe diligenciar únicamente cuando la factura ransferênc se origina a partir de la corrección o ajuste que se da mediante un NC o ND
: '''Obligatorio''' En N.C y N.D, son las referencias a facturas electrónicas afectadas por la Nota.
: Solamente puede reportar facturas electrónicas de un mismo adquiriente
: Rechazo Si CUFE o CUDE no existe en la DIAN
: '''PATH''': /Invoice/cac:BillingReference/cac:CreditNoteDocumentReference/cbc:UUID
: /CreditNote/cac:BillingReference/cac:InvoiceDocumentReference/cbc:UUID
: /DebitNote/cac:BillingReference/cac:InvoiceDocumentReference/cbc:UUID
|-
|descripcion
|Array <String>
|<nowiki>AN|20..5000</nowiki>
|C/C
|
: Descripción de la naturaleza de la corrección
: '''Obligatorio''' Cuando codigoInterno sea ‘4’
: '''PATH''': ../cac:DiscrepancyResponse/cbc:Description
|-
|extras
|Array <Extensible>
| -
|NO
|
: Campos o información opcional para el modelo de negocio del emisor
: '''PATH''': No definido
: (ver detalle en [[#Class.Extensible|Class.Extensible]])
|-
|fecha
|String
|<nowiki>AN|10</nowiki>
|C/C
|
: Fecha de ransfe del documento referenciado, en formato: YYYY-MM-DD
: '''Obligatorio''' Cuando codigoInterno sea ‘1’, ‘2’, ‘3’ ó ‘5’
: Rechazo Si fecha es posterior a la del documento referenciado
: '''PATH''': /Invoice/cac:BillingReference/cac:CreditNoteDocumentReference/cbc:IssueDate
: /CreditNote/cac:BillingReference/cac:InvoiceDocumentReference/cbc:IssueDate
: /DebitNote/cac:BillingReference/cac:InvoiceDocumentReference
: /cbc:IssueDate
|-
|fechaFinValidez
|String
|<nowiki>AN|10</nowiki>
|NO
|
: Fecha de Fin de Validez
: '''PATH''': No definido
|-
|fechaInicioValidez
|String
|<nowiki>AN|10</nowiki>
|NO
|
: Fecha de Inicio de Validez
: '''PATH''': No definido
|-
|numeroDocumento
|String
|<nowiki>AN..20</nowiki>
|SI
|
: Concatenación del prefijo y el número del documento referenciado
: Rechazo Si se informa codigoInterno igual a ‘1’, ‘2’, ‘3’, ‘4’ ó ‘5’ y el ID de documento de referencia no está relacionado
: '''PATH''':
: /Invoice/cac:BillingReference/cac:CreditNoteDocumentReference/cbc:ID
: /CreditNote/cac:BillingReference/cac:InvoiceDocumentReference/cbc:ID
: /DebitNote/cac:BillingReference/cac:InvoiceDocumentReference
: /cbc:ID
|-
|tipoCUFE
|String
|<nowiki>AN|..11</nowiki>
|C/C
|
: Algoritmo del tipo de CUFE.
: “CUFE-SHA384” ó “CUDE-SHA384”
: '''Obligatorio''' Cuando codigoInterno sea ‘5’
: '''PATH''': /Invoice/cac:BillingReference/cac:CreditNoteDocumentReference/cbc:UUID/@schemeName
: /CreditNote/cac:BillingReference/cac:InvoiceDocumentReference/cbc:UUID/@schemeName
: /DebitNote/cac:BillingReference/cac: InvoiceDocumentReference/cbc:UUID/@schemeName
|-
|tipoDocumento
|String
|<nowiki>AN|..50</nowiki>
|NO
|
: Descripción del tipo de documento referenciado,
: OBLIGATORIO '''Para Documento soporte este campo debe ser 05.'''
: Ejemplo: “Factura de Venta Nacional”
: '''PATH''': No definido
|-
|tipoDocumentoCodigo
|String
|<nowiki>AN|2</nowiki>
|C/C
|
: Identificador del tipo de documento referenciado.
: '''Obligatorio''' Cuando codigoInterno sea ‘1’
: Rechazo 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’
: '''PATH''': /Invoice/cac:AdditionalDocumentReference/cbc: DocumentTypeCode
: / CreditNote /cac:AdditionalDocumentReference/cbc: DocumentTypeCode
: / DebitNote /cac:AdditionalDocumentReference/cbc: DocumentTypeCode
: '''Para Documento soporte este campo debe ser 05.'''
|}

'''@IMPORTANTE:'''
''# Para referenciar '''facturas de venta al emitir una NC o ND''', se deben enviar dos objetos de tipo DocumentosReferenciados indicando lo siguiente:
#* '''Objeto 1''': indicando los campos codigoEstatusDocumento; codigoInterno = ‘4’, numeroDocumento, ransferênc.
#* '''Objeto 2''': si el '''tipoOperacion es igual a 20 (para NC) ó 30 (para ND)''' y codigoInterno = ‘5’, se validan los campos: cufeDocReferenciado, fecha, y numeroDocumento.
# Al transmitir una '''Factura de Contingencia''', se debe enviar un arreglo de tipo DocumentosReferenciados indicando los campos: codigoInterno = ‘1’, numeroDocumento, fecha, tipoDocumentoCodigo (correspondiente a Factura de Contingencia).
# Para referenciar '''Documentos de Despacho''' (codigoInterno = ’2’) o '''Documentos de Recepción''' (codigoInterno = ‘3’) se validan los campos: numeroDocumento y fecha.''

====Class.EntregaMercancia====
{| class="mw-collapsible mw-collapsed wikitable"
! style="background:#f2f2f2; text-align:center;"|Atributo
! style="background:#f2f2f2; text-align:center;"|Tipo Dato
! style="background:#f2f2f2; text-align:center;"|Formato
! style="background:#f2f2f2; text-align:center;"|Requerido
! style="background:#f2f2f2; text-align:center;"|Descripción
|-
|datosTransportistas
|DatoTransportistas
| -
|NO
|
: Datos del Transportista
: '''PATH''': ../cac:DeliveryParty
: (ver detalle en [[#Class.DatosTransportista|Class.DatosTransportista]])
|-
|direccionDespacho
|Direccion
| -
|NO
|
: Información de Despacho
: '''PATH''': ../cac:Despatch/cac:DespatchAddress
: (ver detalle en [[#Class.Direccion|Class.Direccion]])
|-
|direccionEntrega
|Direccion
| -
|NO
|
: Información de Entrega
: '''PATH''': ../cac:DeliveryAddress
: (ver detalle en [[#Class.Direccion|Class.Direccion]])
|-
|extras
|Array <Extensible>
| -
|NO
|
: Campos o información opcional para el modelo de negocio del emisor
: '''PATH''': No definido
: (ver detalle en [[#Class.Extensible|Class.Extensible]])
|-
|fechaEfectivaSalida
|String
|<nowiki>AN|19</nowiki>
|NO
|
: Fecha y hora efectiva de salida de los bienes, en formato: YYYY-MM-DD HH:MM:SS
: Rechazo si la fecha efectiva de salida es anterior a la fecha de emisión
: '''PATH''': ../cbc:ActualDeliveryDate + ../cbc:ActualDeliveryTime
|-
|fechaEstimada
|String
|<nowiki>AN|19</nowiki>
|NO
|
: Fecha y hora estimada, en formato: YYYY-MM-DD HH:MM:SS
: Rechazo si la fecha estimada es anterior a la fecha de emisión
: '''PATH''': ../cac:Despatch/cbc:EstimatedDespatchDate y EstimatedDespatchTime
|-
|fechaReal
|String
|<nowiki>AN|19</nowiki>
|NO
|
: Fecha real, en formato: YYYY-MM-DD HH:MM:SS
: Rechazo si la fecha real es anterior a la fecha de emisión
: '''PATH''': ../cac:Despatch/cbc:ActualDespatchDate y ActualDespatchTime
|-
|fechaSolicitada
|String
|<nowiki>AN|19</nowiki>
|NO
|
: Fecha Solicitada, en formato: YYYY-MM-DD HH:MM:SS
: Rechazo si la fecha solicitada es anterior a la fecha de emisión
: '''PATH''': ../cac:Despatch/ cbc:RequestedDespatchDate y RequestedDespatchTime
|-
|identificacionTransporte
|String
|<nowiki>AN|..20</nowiki>
|NO
|
: Datos del Transporte
: '''PATH''': ../cac:Despatch/cbc:ID
|-
|matriculaTransporte
|String
|<nowiki>AN|..20</nowiki>
|NO
|
: Matricula del Transporte
: '''PATH''': ../cac:Despatch/ cbc:ID/@schemeAgencyID
|}

====Class.Extras====
{| class="mw-collapsible mw-collapsed wikitable"
! style="background:#f2f2f2; text-align:center;"|Atributo
! style="background:#f2f2f2; text-align:center;"|Tipo Dato
! style="background:#f2f2f2; text-align:center;"|Formato
! style="background:#f2f2f2; text-align:center;"|Requerido
! style="background:#f2f2f2; text-align:center;"|Descripción
|-
|controlInterno1
|String
|<nowiki>AN|100</nowiki>
|C/C
|
: Etiqueta asignada para la Representación Impresa PDF.
: '''PATH''': Variable
|-
|controlInterno2
|String
|Depende del Campo
|C/C
|
: Permite asociar dos o más campos mediante un índice (si los campos son asociables)
: '''PATH''': Variable
|-
|nombre
|String
|Depende del Campo
|SI
|
: Código del campo extensible a referenciar
: (Ver sección [[Caracteristicas adicionales - Indice Manual Integración Directa#Uso de campos extras|USO DE CAMPOS EXTRAS]])
: '''PATH''': Variable
|-
|pdf
|String
|<nowiki>N|1</nowiki>
|SI
|
: Indicación de mostrar el campo en la representación gráfica PDF
: (“0” = No mostrar / “1” = Mostrar)
: '''PATH''': Variable
|-
|valor
|String
|Depende del Campo
|SI
|
: Valor del campo a agregar
: '''PATH''': Variable
|-
|xml
|String
|<nowiki>N|1</nowiki>
|SI
|
: Indicación de mostrar el campo en el XML
: (“0” = No mostrar / “1” = Mostrar)
: '''PATH''': Variable
|}

====Class.Extensible====
{| class="mw-collapsible mw-collapsed wikitable"
! style="background:#f2f2f2; text-align:center;"|Atributo
! style="background:#f2f2f2; text-align:center;"|Tipo Dato
! style="background:#f2f2f2; text-align:center;"|Formato
! style="background:#f2f2f2; text-align:center;"|Requerido
! style="background:#f2f2f2; text-align:center;"|Descripción
|-
|controlInterno1
|String
|<nowiki>AN|100</nowiki>
|C/C
|
: Etiqueta asignada para la Representación Impresa PDF.
: '''PATH''': Variable
|-
|controlInterno2
|String
|Depende del Campo
|C/C
|
: Permite asociar dos o más campos mediante un índice (si los campos son asociables)
: '''PATH''': Variable
|-
|nombre
|String
|Depende del Campo
|SI
|
: Código del campo extensible a referenciar
: '''PATH''': Variable
|-
|valor
|String
|Depende del Campo
|SI
|
: Valor del campo a agregar
: '''PATH''': Variable
|}

====Class.FacturaImpuestos====
{| class="mw-collapsible mw-collapsed wikitable"
! style="background:#f2f2f2; text-align:center;"|Atributo
! style="background:#f2f2f2; text-align:center;"|Tipo Dato
! style="background:#f2f2f2; text-align:center;"|Formato
! style="background:#f2f2f2; text-align:center;"|Requerido
! style="background:#f2f2f2; text-align:center;"|Descripción
|-
|baseImponibleTOTALImp
|String
|Ent: <nowiki>N|..15</nowiki>
Dec: <nowiki>N|0..6</nowiki>
|SI
|
: Base Imponible sobre la que se calcula el valor del tributo
: '''PATH''': ../cac:TaxTotal/TaxSubtotal/cbc:TaxableAmount
|-
|codigoTOTALImp
|String
|<nowiki>AN|2</nowiki>
|SI
|
: Identificador del tributo
: Rechazo 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
|-
|controlInterno
|String
|<nowiki>N|1</nowiki>
|C/C
|
: Indicador de tipo de retención
: '''PATH''': No Definido
|-
|extras
|Array <Extensible>
| -
|NO
|
: Campos o información opcional para el modelo de negocio del emisor
: '''PATH''': No definido
: (ver detalle en [[#Class.Extensible|Class.Extensible]])
|-
|porcentajeTOTALImp
|String
|Ent: <nowiki>N|..2</nowiki>
Dec: <nowiki>N|2*</nowiki>
|SI
|
: Tarifa del tributo.
: En el caso de que el tributo es un porcentaje del valor tributable: informar la tarifa “porcentaje” a ser aplicada a la base imponible
: Rechazo 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
|-
|unidadMedida
|String
|<nowiki>AN|..5</nowiki>
|SI
|
: Identificación de la unidad de medida
: Rechazo 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
|-
|unidadMedidaTributo
|String
|Ent: <nowiki>N|..2</nowiki>
Dec: <nowiki>N|2</nowiki>
|C/C
|
: Unidad de medida base para el tributo
: '''Obligatorio''' En el caso de que el tributo es un valor fijo por unidad tributada, por ejemplo el impuesto de consumo a las bolsas o los impuestos a los combustibles
: Rechazo Si elemento valorTributoUnidad es informado y unidadMedidaTributo no es informado
: '''PATH''': ../cac:TaxTotal/TaxSubtotal/cbc:BaseUnitMeasure
|-
|valorTOTALImp
|String
|Ent: <nowiki>N|..15</nowiki>
Dec: <nowiki>N|0..6</nowiki>
|SI
|
: Valor del tributo. Producto del porcentaje aplicado sobre la base imponible
: Rechazo Para tributos cuya tarifa se enuncia en porcentajes, si valorTOTALImp es diferente a baseImponibleTOTALImp * porcentajeTOTALImp
: Rechazo Para tributos cuya tarifa se enuncia en valores nominales (ejempo bolsas plásticas), si valorTOTALImp es diferente a valorTributoUnidad * cantidadUnidades
: '''PATH''': ../cac:TaxTotal/TaxSubtotal/cbc:TaxAmount
|-
|valorTributoUnidad
|String
|Ent: <nowiki>N|..15</nowiki>
Dec: <nowiki>N|0..6</nowiki>
|C/C
|
: Es el valor nominal del tributo por unidad
: '''Obligatorio''' En el caso de que el tributo es un valor fijo por unidad tributada, por ejemplo el impuesto de consumo a las bolsas o los impuestos a los combustibles
: Rechazo si el elemento unidadMedidaTributo NO es informado.
: '''PATH''': ../cac:TaxTotal/TaxSubtotal/cbc:PerUnitAmount
|}

'''@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.FabricanteSoftware====
{| class="mw-collapsible mw-collapsed wikitable"
! style="background:#f2f2f2; text-align:center;"|Atributo
! style="background:#f2f2f2; text-align:center;"|Tipo Dato
! style="background:#f2f2f2; text-align:center;"|Formato
! style="background:#f2f2f2; text-align:center;"|Requerido
! style="background:#f2f2f2; text-align:center;"|Descripción
|-
|NombreApellido
|String
| -
|SI
|
: Corresponde a los nombres y apellidos del fabricante del software
: ./ext:UBLExtension/ext:ExtensionContent/InformacionDelFabricanteDelSoftware/Value
|-
|-
|RazonSocial
|String
| -
|SI
|
: Corresponse a la Razon social del fabricante del software
: ./ext:UBLExtension/ext:ExtensionContent/InformacionDelFabricanteDelSoftware/Value
|-
|nombreSoftware
|String
| -
|SI
|
: Corresponde al Nombre del Software
: ./ext:UBLExtension/ext:ExtensionContent/InformacionDelFabricanteDelSoftware/Value
|}

====Class.ImpuestosTotales====
{| class="mw-collapsible mw-collapsed wikitable"
! style="background:#f2f2f2; text-align:center;"|Atributo
! style="background:#f2f2f2; text-align:center;"|Tipo Dato
! style="background:#f2f2f2; text-align:center;"|Formato
! style="background:#f2f2f2; text-align:center;"|Requerido
! style="background:#f2f2f2; text-align:center;"|Descripción
|-
|codigoTOTALImp
|String
|<nowiki>AN|2</nowiki>
|SI
|
: Identificador del tributo
: Rechazo 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
|-
|extras
|Array <Extensible>
| -
|NO
|
: Campos o información opcional para el modelo de negocio del emisor.
: '''PATH''': No definido
: (ver detalle en [[#Class.Extensible|Class.Extensible]])
|-
|montoTotal
|String
|Ent: <nowiki>N|..15</nowiki>
Dec: <nowiki>N|0..6</nowiki>
|SI
|
: Suma de todos los atributos valorTOTALImp
: Rechazo Si montoTotal es diferente a la sumatoria de todas las ocurrencias de FacturaImpuestos.valorTOTALImp
: '''PATH''': ../cac:TaxTotal/cbc:TaxAmount
|-
|redondeoAplicado
|String
| -
|SI
|
:Redondeo agregado al total del impuesto
|}

====Class.InformacionBeneficiosComprador====
{| class="mw-collapsible mw-collapsed wikitable"
! style="background:#f2f2f2; text-align:center;"|Atributo
! style="background:#f2f2f2; text-align:center;"|Tipo Dato
! style="background:#f2f2f2; text-align:center;"|Formato
! style="background:#f2f2f2; text-align:center;"|Requerido
! style="background:#f2f2f2; text-align:center;"|Descripción
|-
|Codigo
|String
| -
|SI
|
: Corresponde al Codigo del comprador Documento identidad
: /ext:UBLExtension/ext:ExtensionContent/InformacionBeneficiosCompra dor/Value
|-
|NombresApellidos
|String
| -
|SI
|
: Corresponse a los Nombres y apellidos del comprador
: /ext:UBLExtension/ext:ExtensionContent/InformacionBeneficiosCompra dor/Value
|-
|Puntos
|String
| -
|SI
|
: Corresponde a un valor donde se informe la Cantidad de Puntos acumulados por el comprador
: /ext:UBLExtension/ext:ExtensionContent/InformacionBeneficiosCompra dor/Value
|}

====Class.informacionLegalCliente====
{| class="mw-collapsible mw-collapsed wikitable"
! style="background:#f2f2f2; text-align:center;"|Atributo
! style="background:#f2f2f2; text-align:center;"|Tipo Dato
! style="background:#f2f2f2; text-align:center;"|Formato
! style="background:#f2f2f2; text-align:center;"|Requerido
! style="background:#f2f2f2; text-align:center;"|Descripción
|-
|codigoEstablecimiento
|String
| -
|NO
|
: Código de Establecimiento
: <nowiki>PATH</nowiki>: /cac:CorporateRegistrationScheme/cbc:CorporateRegistrationTypeCode
|-
|nombreRegistroRUT
|String
|<nowiki>AN|..450</nowiki>
|SI
|
: Nombre o Razón Social del adquirente
: '''Obligatorio''' Para Documento Soporte se debe informar Nombre o Razón Social del proveedor.
: '''PATH''': ../cac:PartyLegalEntity/cbc:RegistrationName
|-
|numeroIdentificacion
|String
|<nowiki>AN|..12</nowiki>
|SI
|
: Identificador del Adquirente.
: Debe informar el NIT si es responsable
: '''PATH''': ../cac:Party/cac:PartyLegalEntity/cbc:CompanyID
|-
|numeroIdentificacionDV
|String
|<nowiki>N|..2</nowiki>
|C/C
|
: Digito Verificador
: '''Obligatorio''' Si tipoIdentificacion =31, el DV del NIT debe ser informado
: '''PATH''': ../cac:PartyLegalEntity/cbc:CompanyID@schemeID
|-
|numeroMatriculaMercantil
|String
|<nowiki>N|9</nowiki>
|NO
|
: Número de matrícula mercantil
: '''PATH''': ../cac:CorporateRegistrationScheme/cbc:Name
|-
|prefijoFacturacion
|String
| -
|NO
|
: Prefijo de facturación:
: '''PATH''': ../cac:CorporateRegistrationScheme/cbc:ID
|-
|tipoIdentificacion
|String
|<nowiki>N|2</nowiki>
|SI
|
: Tipo de identificación del cliente
: Rechazo Si el contenido de este elemento es diferente de “31”
: '''PATH''': ../cac:PartyLegalEntity/cbc:CompanyID@schemeName
|}

====Class.juegosLocalizados====
{| class="mw-collapsible mw-collapsed wikitable"
! style="background:#f2f2f2; text-align:center;"|Atributo
! style="background:#f2f2f2; text-align:center;"|Tipo Dato
! style="background:#f2f2f2; text-align:center;"|Formato
! style="background:#f2f2f2; text-align:center;"|Requerido
! style="background:#f2f2f2; text-align:center;"|Descripción
|-
|direccionEstablecimiento
|String
| -
|SI
|
: Dirección de establecimiento o dirección de internet e IP cuando es virtual
: ext:ExtensionContent/InfoEstablishment/InfoPoint/EstablishmentAddress
|-
|montoDeposito
|String
| -
|SI
|
: Valor de la base o depósito de dinero
: ext:ExtensionContent/InfoEstablishment/InfoPoint/MoneyDeposit
|-
|tipoJuego
|String
| -
|SI
|
: Tipo de juego
: ext:ExtensionContent/InfoEstablishment/GameInformation/MoneyDeposit
|-
|numeroInstrumento
|String
| -
|SI
|
: Número de instrumentos de juegos
: ext:ExtensionContent/InfoEstablishment/GameInformation/GameTypeTotal
|-
|creditoInstrumentoJuego
|List<Class.CreditoInstrumentoJuego>
| -
|SI
|
: Grupo para informar valor diario crédito de un instrumento de juego
: ext:ExtensionContent/InfoEstablishment/CreditValueOfTheMachine
: (ver detalle en [[#Class.Anticipos|Class.CreditoInstrumentoJuego]])
|}

====Class.LineaInformacionAdicional====
{| class="mw-collapsible mw-collapsed wikitable"
! style="background:#f2f2f2; text-align:center;"|Atributo
! style="background:#f2f2f2; text-align:center;"|Tipo Dato
! style="background:#f2f2f2; text-align:center;"|Formato
! style="background:#f2f2f2; text-align:center;"|Requerido
! style="background:#f2f2f2; text-align:center;"|Descripción
|-
|cantidad
|String
|<nowiki>AN|..5</nowiki>
|NO
|
: Cantidad adicional
: '''PATH''': ../cbc:ValueQuantity
|-
|codigo
|String
|<nowiki>AN|..5</nowiki>
|NO
|
: Código adicional
: '''PATH''': ../cbc:NameCode
|-
|codigoInterno1
|String
| -
|NO
|
: Opcional sin uso por ahora
: '''PATH''': No definido
|-
|codigoInterno2
|String
| -
|NO
|
: Opcional sin uso por ahora
: '''PATH''': No definido
|-
|descripcion
|String
|<nowiki>AN|..450</nowiki>
|NO
|
: Descripción adicional
: '''PATH''': ../cac:UsabilityPeriod/cbc:Description
|-
|fechaFin
|String
|<nowiki>AN|10</nowiki>
|NO
|
: Fecha final del período
: '''PATH''': ../cac:UsabilityPeriod/cbc:EndDate
|-
|fechaInicio
|String
|<nowiki>AN|10</nowiki>
|NO
|
: Fecha inicial del período
: '''PATH''': ../cac:UsabilityPeriod/cbc:StartDate
|-
|nombre
|String
|<nowiki>AN|..50</nowiki>
|NO
|
: Característica que quiere informar del ítem, por ejemplo: (Uso Vehículo)
: Rechazo Por cada nombre debe existir un valor
: '''PATH''': ../cbc:Name
: (Por definir catálogos de campos extensibles a nivel de detalle)
|-
|secuencia
|String
|<nowiki>AN|..3</nowiki>
|NO
|
: Indicador de orden de secuencia
: '''PATH''': No definido
|-
|tipo
|String
|<nowiki>N|1</nowiki>
|NO
|
: Indicador de Tipo de Valor, ejemplo Valor = ’1’
: '''PATH''': No aplica
|-
|valor
|String
|<nowiki>AN|..50</nowiki>
|NO
|
: Valor de la característica que se quiere informar, por ejemplo :(Particular)
: Rechazo Por cada valor debe existir un name
: '''PATH''': ../cbc:Value
|}

====Class.MediosDePago====
{| class="mw-collapsible mw-collapsed wikitable"
! style="background:#f2f2f2; text-align:center;"|Atributo
! style="background:#f2f2f2; text-align:center;"|Tipo Dato
! style="background:#f2f2f2; text-align:center;"|Formato
! style="background:#f2f2f2; text-align:center;"|Requerido
! style="background:#f2f2f2; text-align:center;"|Descripción
|-
|codigoBanco
|String
|<nowiki>AN|..20</nowiki>
|NO
|
: Código del Banco o Entidad Financiera
: '''PATH''': ../cac:PayeeFinancialAccount/cbc:AccountTypeCode
|-
|codigoCanalPago
|String
|<nowiki>AN|..20</nowiki>
|NO
|
: Código del canal del pago
: '''PATH''': ../cbc:PaymentChannelCode
|-
|codigoReferencia
|String
|<nowiki>AN|..20</nowiki>
|NO
|
: Opcional sin uso por ahora
: '''PATH''': No definido
|-
|extras
|Array <Extensible>
| -
|NO
|
: Campos o información opcional para el modelo de negocio del emisor.
: '''PATH''': No definido
: (ver detalle en [[#Class.Extensible|Class.Extensible]])
|-
|fechaDeVencimiento
|String
|<nowiki>AN|19</nowiki>
|C/C
|
: Fecha de Vencimiento del pago de la factura en formato: YYYY-MM-DD
: '''Obligatorio''' Si la venta es a crédito
: Rechazo: Si código del método de pago es “2” y no se envía la fecha de vencimiento
: '''PATH''': ../cbc:PaymentDueDate
|-
|medioPago
|String
|<nowiki>AN|..2</nowiki>
|SI
|
: Código correspondiente al medio de pago
: Rechazo: 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
|-
|metodoDePago
|String
|<nowiki>AN|..2</nowiki>
|SI
|
: Método de Pago
: Rechazo: 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
|-
|nombreBanco
|String
|<nowiki>AN|..50</nowiki>
|NO
|
: Nombre del Banco o Entidad Financiera
: '''PATH''': ../cac:PayeeFinancialAccount/cbc:Name
|-
|numeroDeReferencia
|String
|<nowiki>AN|..200</nowiki>
|NO
|
: Identificador o referencia interna del Pago
: PATH''':''' ../cbc:PaymentID
|-
|numeroDias
|String
|<nowiki>N|..3</nowiki>
|NO
|
: Número de días para el pago
: '''PATH''': ../cbc:InstructionNote
|-
|numeroTransferencia
|String
|<nowiki>AN|..20</nowiki>
|NO
|
: Número de ransferência o número de cheque
: '''PATH''': ../cac:PayeeFinancialAccount/cbc:ID
|}

====Class.Obligaciones====
{| class="mw-collapsible mw-collapsed wikitable"
! style="background:#f2f2f2; text-align:center;"|Atributo
! style="background:#f2f2f2; text-align:center;"|Tipo Dato
! style="background:#f2f2f2; text-align:center;"|Formato
! style="background:#f2f2f2; text-align:center;"|Requerido
! style="background:#f2f2f2; text-align:center;"|Descripción
|-
|extras
|Array <Extensible>
| -
|NO
|
: Campos o información opcional para el modelo de negocio del emisor
: '''PATH''': No definido
: (ver detalle en [[#Class.Extensible|Class.Extensible]])
|-
|obligaciones
|String
|<nowiki>AN|7</nowiki>
|SI
|
: Obligaciones del adquiriente
: Rechazo 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
|-
|regimen
|String
|<nowiki>AN|2</nowiki>
|NO
|
: Opcional, si informado indicar “No aplica”. Posibles Valores:
: 48: “Impuesto sobre las ventas - IVA”
: 49: “No responsable de IVA”
: '''PATH''': .. /cbc:TaxLevelCode/@listName
|}

====Class.OrdenDeCompra====
{| class="mw-collapsible mw-collapsed wikitable"
! style="background:#f2f2f2; text-align:center;"|Atributo
! style="background:#f2f2f2; text-align:center;"|Tipo Dato
! style="background:#f2f2f2; text-align:center;"|Formato
! style="background:#f2f2f2; text-align:center;"|Requerido
! style="background:#f2f2f2; text-align:center;"|Descripción
|-
|codigoCliente
|String
|<nowiki>AN|..20</nowiki>
|NO
|
: Código del cliente
: '''PATH''': ../cbc:CustomerReference
|-
|documentoReferencia
|DocumentoReferencia
| -
|NO
|
: Documento Referencia
: '''PATH''': ../cac:DocumentReference
: (ver detalle en [[#Class.DocumentoReferencia|Class.DocumentoReferencia]])
|-
|extras
|Array <Extensible>
| -
|NO
|
: Campos o información opcional para el modelo de negocio del emisor
: '''PATH''': No definido
: (ver detalle en [[#Class.Extensible|Class.Extensible]])
|-
|fecha
|String
|<nowiki>AN|10</nowiki>
|NO
|
: Fecha de la Orden, en formato: YYYY-MM-DD HH:MM:SS
: '''PATH''': ../cbc:IssueDate
|-
|numeroOrden
|String
|<nowiki>AN|..20</nowiki>
|SI
|
: Número de la Orden de Compra
: '''Obligatorio''' Para enviar la Orden de Compra
: '''PATH''': ../cbc:ID
|-
|numeroPedido
|String
|<nowiki>AN|..20</nowiki>
|C/C
|
: Número del Pedido
: '''Obligatorio''' Para enviar el Pedido
: '''PATH''': ../cbc:SalesOrderID
|-
|tipoCUFE
|String
|<nowiki>AN|..20</nowiki>
|NO
|
: Identificador del tipo de CUFE
: '''PATH''': ../cbc:UUID@schemeName
|-
|tipoOrden
|String
|<nowiki>AN|..20</nowiki>
|NO
|
: Tipo de Orden
: '''PATH''': ../cbc:OrderTypeCode
|-
|uuid
|String
|<nowiki>AN|..90</nowiki>
|NO
|
: UUID de algún documento referenciado
: '''PATH''': ../cbc:UUID
|}

'''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.

'''Importante''': En el caso del campo '''rangoNumeracion''', éste valor siempre debe tener el siguiente formato (Pefijo-campoDesde), es decir, dicho campo es independiente de la modalidad de secuencial configurado en el portal (manual con prefijo o manual sin prefijo).

En el caso del campo '''consecutivoDocumento''', este campo si depende de la modalidad de secuenciales configurados en el portal web.
* Si la modalidad asignada es ''“manual sin prefijo”'', los valores para los campos rangoNumeracion y consecutivoDocumento’ deben ser por ejemplo:
:: Factura #1: rangoNumeracion= "PRUE-1", consecutivoDocumento= "1"
:: Factura #2: rangoNumeracion= "PRUE-1", consecutivoDocumento= "2"
:: ...
:: Factura #1000: rangoNumeracion= "PRUE-1", consecutivoDocumento= "1000"

*Si la modalidad asignada es ''“manual con prefijo”'', los valores para los campos rangoNumeracion y consecutivoDocumento deben ser por ejemplo:
:: Factura #1: rangoNumeracion= "PRUE-1", consecutivoDocumento= "PRUE1"
:: Factura #2: rangoNumeracion= "PRUE-1", consecutivoDocumento= "PRUE2"
:: ...
:: Factura #1000: rangoNumeracion= "PRUE-1", consecutivoDocumento= "PRUE1000"

====Class.serviciosPublicos====
{| class="mw-collapsible mw-collapsed wikitable"
! style="background:#f2f2f2; text-align:center;"|Atributo
! style="background:#f2f2f2; text-align:center;"|Tipo Dato
! style="background:#f2f2f2; text-align:center;"|Formato
! style="background:#f2f2f2; text-align:center;"|Requerido
! style="background:#f2f2f2; text-align:center;"|Descripción
|-
|tipo
|String
| -
|SI
|
: Código del cliente
: ext:ExtensionContent/SERVICES_SPD o ext:ExtensionContent/OTHERCOMPANY_SPD
|-
|consecutivo
|String
| -
|SI
|
: Número de consecutive de linea
: ext:UBLExtensions/ext:UBLExtension/cbc:ID
|-
|servicio
|String
| -
|SI
|
: Servicio facturado
: ext:UBLExtensions/ext:UBLExtension/cbc:Name
|-
|nombreEmpresaEmite
|String
| -
|SI
|
: Nombre de la Empresa SPD que emite este DE
: ext:UBLExtensions/ext:UBLExtension/ext:ExtensionAgencyName
|-
|nombreEmpresaRecaudo
|String
| -
|SI
|
: Nombre de la Empresa SPD a cargo de este recaudo.
: ext:UBLExtensions/ext:UBLExtension/ext:ExtensionReason
|-
|numeroContrato
|String
| -
|NO
|
: numero del contrato SPD
: ext:ExtensionContent/SERVICES_SPD/ID
|-
|peridodoConsumo
|String
| -
|NO
|
: Periodo del consumo o Periodo o fecha de Consumo del servicio del SPD
: ext:ExtensionContent/SERVICES_SPD/IssueDate
|-
|notaServicio
|String
| -
|NO
|
: Campo utilizado para informacion adicional de texto libre
: ext:ExtensionContent/SERVICES_SPD/Note
|-
|numeroDocumento
|String
| -
|NO
|
: Campo utilizado para informacion adicional de texto libre
: ext:ExtensionContent/SERVICES_SPD/Note
|-
|tipoIdentificacion
|String
| -
|NO
|
: Tipo de Identificacion
: ext:ExtensionContent/SERVICES_SPD/SenderParty/PartyIdentification/ID/@schemeName
|-
|numeroDocumentoDV
|String
| -
| CC
|
: Digito de Verificacion
: ext:ExtensionContent/SERVICES_SPD/SenderParty/PartyIdentification/ID/@schemeID
|-
|nombreEmpresaServicio
|String
| -
|NO
|
: Nombre de la empresa prestadora del servicio
: ext:ExtensionContent/SERVICES_SPD/SenderParty/PartyName/Name
|-
|nombreSuscriptor
|String
| -
|NO
|
: Nombre del suscriptor y/o usuario
: ext:ExtensionContent/SERVICES_SPD/SubscriberParty/SubscriberConsumption/SenderParty/PartyName/Name
|-
|direccion
|String
| -
|NO
|
: Campo para informar Direccion de correspondencia del suscriptor
: ext:ExtensionContent/SERVICES_SPD/SubscriberParty/SubscriberConsumption/SubscriberParty/PostalAddress/StreetName
|-
|direccionAdicional
|String
| -
|NO
|
: Campo para informar una dirección adicional de entrega del suscriptor
: ext:ExtensionContent/SERVICES_SPD/SubscriberParty/SubscriberParty/PostalAddress/AdditionalStreetName
|-
|ciudad
|String
| -
|NO
|
: Nombre de la ciudad del suscriptor
: ext:ExtensionContent/SERVICES_SPD/SubscriberParty/SubscriberConsumption/SubscriberParty/PostalAddress/CityName
|-
|departamento
|String
| -
|NO
|
: Nombre del Departamento del suscriptor
: ext:ExtensionContent/SERVICES_SPD/SubscriberParty/SubscriberConsumption/SubscriberParty/PostalAddress/CountrySubentity
|-
|estrato
|String
| -
|NO
|
: Campo para información sobre el estrato o tipo de plan
: ext:ExtensionContent/SERVICES_SPD/SubscriberParty/SubscriberConsumption/SubscriberParty/PostalAddress/ResidentialStratum
|-
|email
|String
| -
|NO
|
: Correo electrónico de contacto
: ext:ExtensionContent/SERVICES_SPD/SubscriberParty/SubscriberConsumption/SubscriberParty/ElectronicMail
|-
|cicloFacturacion
|String
| -
|NO
|
: Campo para informar el ciclo de facturación
: ext:ExtensionContent/SERVICES_SPD/SubscriberParty/SubscriberConsumption/DurationOfTheBillingCycle
|-
|periodicidad
|String
| -
|NO
|
: Corresponde al ciclo de faturacion de cada empresa de servicios públicos
: ext:ExtensionContent/SERVICES_SPD/SubscriberParty/SubscriberConsumption/DurationOfTheBillingCycle/@unitOfTime
|-
|notaDocumento
|String
| -
|NO
|
: Información adicional: Texto libre, relativo al documento
: ext:ExtensionContent/SERVICES_SPD/SubscriberParty/SubscriberConsumption/Note
|-
|cantidadUnidadTotal
|String
| -
|NO
|
: Cantidad medida total, elemento utlizado para informar la cantidad de unidades consumidas en el periodo.
: ext:ExtensionContent/SERVICES_SPD/SubscriberParty/SubscriberConsumption/ConsumptionSection/SPDDebitsForPartialConsumption/SPDDebitForPartialConsumption/TotalMeteredQuantity
|-
|unidadmedida
|String
| -
|NO
|
: Valida la Unidad de Medida de la cantidad del servicio solicitado
: ext:ExtensionContent/SERVICES_SPD/SubscriberParty/SubscriberConsumption/ConsumptionSection/SPDDebitsForPartialConsumption/SPDDebitForPartialConsumption/TotalMeteredQuantity/@unitCode
|}

====Class.TasaDeCambio====
{| class="mw-collapsible mw-collapsed wikitable"
! style="background:#f2f2f2; text-align:center;"|Atributo
! style="background:#f2f2f2; text-align:center;"|Tipo Dato
! style="background:#f2f2f2; text-align:center;"|Formato
! style="background:#f2f2f2; text-align:center;"|Requerido
! style="background:#f2f2f2; text-align:center;"|Descripción
|-
|baseMonedaDestino
|String
|Ent: <nowiki>N|..15</nowiki>
Dec: <nowiki>N|0..6</nowiki>
|SI
|
: Base monetaria para la conversión.
: Debe ser 1.00
: Rechazo Si trae valor diferente a 1.00
: '''PATH''': ../cbc:TargetCurrencyBaseRate
|-
|baseMonedaOrigen
|String
|Ent: <nowiki>N|..15</nowiki>
Dec: <nowiki>N|0..6</nowiki>
|SI
|
: Base monetaria de la divisa extranjera para el cambio.
: Debe ser 1.00
: Rechazo Si trae valor diferente a 1.00
: '''PATH''': ../cbc:SourceCurrencyBaseRate
|-
|extras
|Array <Extensible>
| -
|NO
|
: Campos o información opcional para el modelo de negocio del emisor
: '''PATH''': No definido
: (ver detalle en [[#Class.Extensible|Class.Extensible]])
|-
|fechaDeTasaDeCambio
|String
|<nowiki>AN|10</nowiki>
|SI
|
: Fecha en la que se fijó la tasa de cambio, en formato: YYYY-MM-DD
: '''PATH''': ../cbc:Date
|-
|indicadorDeTasa
|String
| -
|NO
|
: Indicador de Tasa de Cambio
: '''PATH''': ../cbc:ExchangeMarketID
|-
|monedaDestino
|String
|<nowiki>AN|3</nowiki>
|SI
|
: Código de moneda destino del documento.
: Rechazo Si el contenido de este elemento no es ‘COP’
: '''PATH''': ../cbc:TargetCurrencyCode
|-
|monedaOrigen
|String
|<nowiki>AN|3</nowiki>
|SI
|
: Código de moneda base del documento
: Rechazo Si el contenido de este elemento no corresponde al estándar ISO-4217
'''PATH''': ../cbc:SourceCurrencyCode
|-
|operadorCalculo
|String
| -
|NO
|
: Operador de Calculo
: '''PATH''': ../cbc: MathematicOperatorCode
|-
|tasaDeCambio
|String
|Ent: <nowiki>N|..15</nowiki>
Dec: <nowiki>N|0..6</nowiki>
|SI
|
: Valor de la tasa de cambio entre las divisas. Se debe diligenciar con el valor de la tasa de cambio.
: Por ejemplo para USD-COP puede ser el valor de la TRM o tasa acordada entre las partes (Valor reportado * Valor de tasa de cambio = Valor reportado en divisa informado en monedaDestino)
: '''PATH''': ../cbc:CalculationRate
|}

====Class.TasaDeCambioAlternativa====
{| class="mw-collapsible mw-collapsed wikitable"
! style="background:#f2f2f2; text-align:center;"|Atributo
! style="background:#f2f2f2; text-align:center;"|Tipo Dato
! style="background:#f2f2f2; text-align:center;"|Formato
! style="background:#f2f2f2; text-align:center;"|Requerido
! style="background:#f2f2f2; text-align:center;"|Descripción
|-
|baseMonedaDestino
|String
|Ent: <nowiki>N|..15</nowiki>
Dec: <nowiki>N|0..6</nowiki>
|SI
|
: Base monetaria para la conversión.
: Debe ser 1.00
: Rechazo Si trae valor diferente a 1.00
: '''PATH''': ../cbc:TargetCurrencyBaseRate
|-
|baseMonedaOrigen
|String
|Ent: <nowiki>N|..15</nowiki>
Dec: <nowiki>N|0..6</nowiki>
|SI
|
: Base monetaria de la divisa extranjera para el cambio.
: Debe ser 1.00
: Rechazo Si trae valor diferente a 1.00
: '''PATH''': ../cbc:SourceCurrencyBaseRate
|-
|extras
|Array <Extensible>
| -
|NO
|
: Campos o información opcional para el modelo de negocio del emisor
: '''PATH''': No definido
: (ver detalle en [[#Class.Extensible|Class.Extensible]])
|-
|fechaDeTasaDeCambio
|String
|<nowiki>AN|10</nowiki>
|SI
|
: Fecha en la que se fijó la tasa de cambio, en formato: YYYY-MM-DD
: '''PATH''': ../cbc:Date
|-
|indicadorDeTasa
|String
| -
|NO
|
: Indicador de Tasa de Cambio
: '''PATH''': ../cbc:ExchangeMarketID
|-
|monedaDestino
|String
|<nowiki>AN|3</nowiki>
|SI
|
: Código de moneda destino del documento.
: Rechazo Si el contenido de este elemento no es ‘COP’
: '''PATH''': ../cbc:TargetCurrencyCode
|-
|monedaOrigen
|String
|<nowiki>AN|3</nowiki>
|SI
|
: Código de moneda base del documento
: Rechazo Si el contenido de este elemento no corresponde al estándar ISO-4217
: '''PATH''': ../cbc:SourceCurrencyCode
|-
|operadorCalculo
|String
| -
|NO
|
: Operador de Calculo
: '''PATH''': ../cbc: MathematicOperatorCode
|-
|tasaDeCambio
|String
|Ent: <nowiki>N|..15</nowiki>
Dec: <nowiki>N|0..6</nowiki>
|SI
|
: Valor de la tasa de cambio entre las divisas. Se debe diligenciar con el valor de la tasa de cambio.
: Por ejemplo para USD-COP puede ser el valor de la TRM o tasa acordada entre las partes (Valor reportado * Valor de tasa de cambio = Valor reportado en divisa informado en monedaDestino)
: '''PATH''': ../cbc:CalculationRate
|}

====Class.TerminosEntrega====
{| class="mw-collapsible mw-collapsed wikitable"
! style="background:#f2f2f2; text-align:center;"|Atributo
! style="background:#f2f2f2; text-align:center;"|Tipo Dato
! style="background:#f2f2f2; text-align:center;"|Formato
! style="background:#f2f2f2; text-align:center;"|Requerido
! style="background:#f2f2f2; text-align:center;"|Descripción
|-
|cargosDescuentos
|Array <CargosDescuentos>
| -
|NO
|
: Informaciones relacionadas con un cargo o un descuento
: '''PATH''': ../cac:AllowanceCharge
: (ver detalle en [[#Class.CargosDescuentos|Class.CargosDescuentos]])
|-
|codigoCondicionEntrega
|String
|<nowiki>AN|3</nowiki>
|C/C
|
: Código de Condiciones de Entrega
: '''Obligatorio''' Se es factura de exportación/internacional
: Rechazo: 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
|-
|costoTransporte
|String
|Por Definir
|NO
|
: Método de pago del transporte: Se utiliza para indicar como se pagan los costes del transporte, por ejemplo: http://www.unece.org/
: '''PATH''': ../cbc: SpecialTerms
|-
|direccionEntrega
|Class.Direccion
| -
|NO
|
: Información donde se detalle la dirección de entrega
: '''PATH''': ../cac:DeliveryLocation
: (ver detalle en [[#Class.Direccion|Class.Direccion]])
|-
|extras
|Array <Extensible>
| -
|NO
|
: Campos o información opcional para el modelo de negocio del emisor.
: '''PATH''': No definido
: (ver detalle en [[#Class.Extensible|Class.Extensible]])
|-
|identificacion
|String
|<nowiki>AN|..12</nowiki>
|NO
|
: Numero Identificación
: '''PATH''': ../cbc:ID
|-
|monto
|String
|Ent: <nowiki>N|..15</nowiki>
Dec: <nowiki>N|0..6</nowiki>
|NO
|
: Monto
: '''PATH''': ../cbc:Amount
|-
|responsableEntrega
|String
|<nowiki>AN|..50</nowiki>
|NO
|
: Descripción de quien asume la responsabilidad en caso de que la mercancía se pierda
: '''PATH''': ../cbc:LossRisk
|}
====Class.Valor====
{| class="mw-collapsible mw-collapsed wikitable"
! style="background:#f2f2f2; text-align:center;"|Atributo
! style="background:#f2f2f2; text-align:center;"|Tipo Dato
! style="background:#f2f2f2; text-align:center;"|Formato
! style="background:#f2f2f2; text-align:center;"|Requerido
! style="background:#f2f2f2; text-align:center;"|Descripción
|-
|numero
|String
| -
|NO
|
: Referente al numero que indica el valor correspondiente
|-
|unidad
|string
| -
|NO
|
: Referente a la unidad que indican en la valor
|}
====Class.Residuos====
{| class="mw-collapsible mw-collapsed wikitable"
! style="background:#f2f2f2; text-align:center;"|Atributo
! style="background:#f2f2f2; text-align:center;"|Tipo Dato
! style="background:#f2f2f2; text-align:center;"|Formato
! style="background:#f2f2f2; text-align:center;"|Requerido
! style="background:#f2f2f2; text-align:center;"|Descripción
|-
|residuosHistorico
|Array
| -
|NO
|
: (ver detalle en [[#Class.residuosHistorico|Class.residuosHistorico]])
|-
|totalNoAprovechable
|array
| -
|NO
|
: (ver detalle en [[#Class.Valor|ClassValor]])
|-
|totalLimpiezaBarrido
|array
| -
|NO
|
: (ver detalle en [[#Class.Valor|ClassValor]])
|-
|totalLimpiezaUrbana
|array
| -
|NO
|
: (ver detalle en [[#Class.Valor|ClassValor]])
|-
|totalResiduosInutiles
|array
| -
|NO
|
: (ver detalle en [[#Class.Valor|ClassValor]])
|}
====Class.ResiduosHistorico====
{| class="mw-collapsible mw-collapsed wikitable"
! style="background:#f2f2f2; text-align:center;"|Atributo
! style="background:#f2f2f2; text-align:center;"|Tipo Dato
! style="background:#f2f2f2; text-align:center;"|Formato
! style="background:#f2f2f2; text-align:center;"|Requerido
! style="background:#f2f2f2; text-align:center;"|Descripción
|-
|valor
|Array
| -
|NO
|
: (ver detalle en [[#Class.Valor|Class.Valor]])
|-
|usable
|string
| -
|NO
|
: Referente al material aprovechable de los residuos
|-
|periodoDesde
|string
| -
|NO
|
: Referencia a el periodo inicial
|-
|periodoHasta
|string
| -
|NO
|
: Referencia a el periodo final
|}
====Class.Tributos====
{| class="mw-collapsible mw-collapsed wikitable"
! style="background:#f2f2f2; text-align:center;"|Atributo
! style="background:#f2f2f2; text-align:center;"|Tipo Dato
! style="background:#f2f2f2; text-align:center;"|Formato
! style="background:#f2f2f2; text-align:center;"|Requerido
! style="background:#f2f2f2; text-align:center;"|Descripción
|-
|codigoImpuesto
|String
|<nowiki>AN|2</nowiki>
|SI
|
: Identificador del tributo
: Rechazo 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
|-
|extras
|Array <Extensible>
| -
|NO
|
: Campos o información opcional para el modelo de negocio del emisor.
: '''PATH''': No definido (ver detalle en [[#Class.Extensible|Class.Extensible]])
|}

; RESPONSE: Parámetros a Recibir
{| class="mw-collapsible mw-collapsed wikitable"
! style="background:#f2f2f2; text-align:center;"|Tipo
! style="background:#f2f2f2; text-align:center;"|Identificación
! style="background:#f2f2f2; text-align:center;"|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.
{{clear}}

===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
{| class="mw-collapsible mw-collapsed wikitable"
! style="background:#f2f2f2; text-align:center;"|Tipo
! style="background:#f2f2f2; text-align:center;"|Identificador
! style="background:#f2f2f2; text-align:center;"|Descripción
|- valign="center"
|-
|rowspan="3"|String
|tokenEmpresa
|rowspan="2"|Suministrado por The Factory HKA Colombia
|-
|tokenPassword
|-
|Documento
|Prefijo y Consecutivo del Documento electrónico concatenado sin separadores. Ejemplo “PRUE980338212
|}
; RESPONSE: Parámetros a Recibir
{| class="mw-collapsible mw-collapsed wikitable"
! style="background:#f2f2f2; text-align:center;"|Tipo
! style="background:#f2f2f2; text-align:center;"|Identificador
! style="background:#f2f2f2; text-align:center;"|Descripción
|- valign="center"
|-
|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 (Documento equivalente) 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
|nombre
|Este mensaje está asociado al nombre
|-
|String
|resultado
|Resultado del consumo del método:
: “Procesado” ó “Error”
|-
|String
|tipoCufe
|correspondiente al documento consultado
|}
{{clear}}

===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 (Documento equivalente) y todos los eventos (ApplicationResponse) generados hasta la fecha.
; REQUEST: Parámetros a Enviar
{| class="mw-collapsible mw-collapsed wikitable"
! style="background:#f2f2f2; text-align:center;"|Tipo
! style="background:#f2f2f2; text-align:center;"|Identificador
! style="background:#f2f2f2; text-align:center;"|Descripción
|- valign="center"
|-
|rowspan="3"|String
|tokenEmpresa
|rowspan="2"|Suministrado por The Factory HKA Colombia
|-
|tokenPassword
|-
|Documento
|Prefijo y Consecutivo del Documento electrónico concatenado sin separadores. Ejemplo “PRUE980338212
|}
; RESPONSE: Parámetros a Recibir
{| class="mw-collapsible mw-collapsed wikitable"
! style="background:#f2f2f2; text-align:center;"|Tipo
! style="background:#f2f2f2; text-align:center;"|Identificador
! style="background:#f2f2f2; text-align:center;"|Descripción
|- valign="center"
|-
|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
|Nombre
|Este mensaje está asociado al nombre.
|-
|String
|Resultado
|Resultado del consumo del método:
: “Procesado” ó “Error”
|}
{{clear}}

:Para mayor información pude visitar la siguiente sección:
'''[[Tips Urls de Emisión| Tips Urls de Emisión]]'''
{{clear}}
===Método EnvioCorreo===
Permite reenviar a una o varias direcciones de correos el documento indicado.
; REQUEST: Parámetros a Enviar
{| class="mw-collapsible mw-collapsed wikitable"
! style="background:#f2f2f2; text-align:center;"|Tipo
! style="background:#f2f2f2; text-align:center;"|Identificador
! style="background:#f2f2f2; text-align:center;"|Descripción
|- valign="center"
|-
|rowspan="5"|String
|tokenEmpresa
|rowspan="2"|Suministrado por The Factory HKA Colombia
|-
|tokenPassword
|-
|Documento
|Prefijo y consecutivo del Documento Electrónico concatenado sin separadores. Ejemplo “PRUE980338212”. Permite enviar múltiples destinatarios (máximo 5) separados por coma el carácter coma ‘,’
|-
|correo
|Correo electrónico al que se enviará el documento. Ejemplo nombre@empresa.com
|-
|adjuntos
|
: “0”: Realiza el reenvio del correo sin adjuntos
: “1”: Realiza el reenvio del correo con los adjuntos almacenados durante la emisión del documento.
|}
; RESPONSE: Parámetros a Recibir
{| class="mw-collapsible mw-collapsed wikitable"
! style="background:#f2f2f2; text-align:center;"|Tipo
! style="background:#f2f2f2; text-align:center;"|Identificador
! style="background:#f2f2f2; text-align:center;"|Descripción
|- valign="center"
|-
|int
|codigo
|Indica el Estado de la operación retornado por el servicio
|-
|rowspan="2"|String
|mensaje
|Este mensaje está asociado al código, útil para identificación de errores
|-
|resultado
|Resultado del consumo del método:
: “Procesado” ó “Error”
|}
'''@Importante:''' Si durante la emisión del documento (método '''Enviar''') el parámetro '''adjuntos''' se asignó en “10” u “11”, la plataforma The Factory HKA - DFACTURE no generará representación gráfica (PDF) estándar, por lo tanto solo será reenviado a los destinatarios los documentos alojados en la plataforma (AttachedDocument). Para realizar un reenvío de correo (con el AttachedDocument y adjuntos) a una dirección de email diferente a la utilizada durante la emisión se puede consumir nuevamente el método '''CargarAdjuntos''' del Servicio Adjuntos Web SOAP.
{{clear}}

===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
{| class="mw-collapsible mw-collapsed wikitable"
! style="background:#f2f2f2; text-align:center;"|Tipo
! style="background:#f2f2f2; text-align:center;"|Identificador
! style="background:#f2f2f2; text-align:center;"|Descripción
|- valign="center"
|-
|rowspan="3"|String
|tokenEmpresa
|rowspan="2"|Suministrado por The Factory HKA Colombia
|-
|tokenPassword
|-
|Documento
|Prefijo y Consecutivo del Documento electrónico concatenado sin separadores. Ejemplo “PRUE980338212
|}
; RESPONSE: Parámetros a Recibir
{| class="mw-collapsible mw-collapsed wikitable"
! style="background:#f2f2f2; text-align:center;"|Tipo
! style="background:#f2f2f2; text-align:center;"|Identificador
! style="background:#f2f2f2; text-align:center;"|Descripción
|- valign="center"
|-
|Bool
|aceptacionFisica
|Indica si el documento posee aceptación física (entregado físicamente): “true” o “false”
|-
|String
|acuseComentario
|Comentario informado por el adquiriente al realizar el acuse
|-
|String
|acuseEstatus
|0: Acuse no realizado ; 1: Acuse realizado
|-
|String
|acuseResponsable
|Email del responsable de realizar el acuse
|-
|String
|acuseRespuesta
|0: Respuesta no enviada ; 1: Respuesta enviada
|-
|String
|ambiente
|Tipo de ambiente de generación del documento:
:: “1: ambienteDeProducción”
:: “2: ambienteDePruebas”
|-
|String
|cadenaCodigoQR
|Concatenación cadena del código QR (elemento de control)
|-
|String
|cadenaCufe
|Concatenación cadena del código CUFE previo al cálculo por el algoritmo correspondiente del servicio
|-
|int
|Codigo
|Indica el estado de la operación retornado por el servicio
|-
|String
|consecutivo
|Consecutivo del Documento TFHKA/DIAN
|-
|String
|cufe
|“Código Único de Factura Electrónica” correspondiente al documento consultado, calculado por el algoritmo correspondiente del servicio
|-
|String
|descripcionDocumento
|Identificador del tipo de documento de referencia,
: Ejemplo: “Factura de Venta Nacional”
|-
|String
|descripcionEstatusDocumento
|Descripción correspondiente al estatusDocumento ante la DIAN: “Procesado Correctamente”
|-
|String
|entregaMetodoDIAN
|Indica el método de Entrega a la DIAN
: (Síncrono ó Asyncrono), (Individual ó Lote)
|-
|Bool
|esValidoDIAN
|
: “true” Si es válido
: “false” Si no es válido
|-
|String
|estatusDocumento
|Código obtenido en la respuesta correspondiente al estado del documento ante la DIAN (Por definir catálogo)
|-
|Array <Evento>
|eventos
|Lista de eventos del Documento Electrónico
|-
|String
|fechaAceptacionDIAN
|Día y Hora en la que la DIAN aceptó el documento electrónico, en formato AAAA-MM-DD HH:MM:SS
|-
|String
|fechaDocumento
|Fecha en la que se generó el documento, en formato: AAAA-MM-DD
|-
|Array <HistorialDeEntregas>
|historialDeEntregas
|Histórico de las entregas del documento
|-
|String
|mensaje
|Este mensaje está asociado al codigo, útil para identificación de errores
|-
|String
|mensajeDocumento
|Entrega una descripción del error de cada una de las validaciones iniciales. Si no hay errores no entrega descripción
|-
|Bool
|poseeAdjuntos
|Indica si el documento posee adjuntos:
: “true” o “false”
|-
|Bool
|poseeRepresentacionGrafica
|Indica si el documento posee representación gráfica:
: “true” o “false”
|-
|Array <String>
|reglasValidacionDIAN
|Mensajes de validación por parte de la DIAN
|-
|String
|resultado
|Resultado del consumo del método:
: “Procesado” ó “Error”
|-
|String
|tipoCufe
|Algoritmo utilizado para calcular CUFE:
: SHA-256, SHA-384, SHA-512
|-
|String
|tipoDocumento
|Identificador del tipo de documento de referencia
: Ver [[Tablas de códigos de propiedades para emisión de documentos - Indice Manual Integración Directa#Tabla 1|Tabla 1]]
|-
|String
|trackID
|Este elemento corresponde al TrackId del documento procesado
|}
===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
{| class="mw-collapsible mw-collapsed wikitable"
! style="background:#f2f2f2; text-align:center;"|Tipo
! style="background:#f2f2f2; text-align:center;"|Identificador
! style="background:#f2f2f2; text-align:center;"|Descripción
|- valign="center"
|-
|rowspan="3"|String
|tokenEmpresa
|rowspan="2"|Suministrado por The Factory HKA Colombia
|-
|tokenPassword
|-
|documento
|Prefijo y consecutivo del Documento Electrónico concatenado sin separadores. Ejemplo “PRUE980338212”
|}
; RESPONSE: Parámetros a Recibir
{| class="mw-collapsible mw-collapsed wikitable"
! style="background:#f2f2f2; text-align:center;"|Tipo
! style="background:#f2f2f2; text-align:center;"|Identificador
! style="background:#f2f2f2; text-align:center;"|Descripción
|- valign="center"
|-
|int
|codigo
|Indica el Estado de la operación retornado por el servicio
|-
|String
|tipocufe
|correspondiente al documento consultado.
|-
|String
|cufe
|“Código Único de Factura Electrónica” correspondiente al documento consultado.
|-
|String
|documento
|Documento PDF codificado en Base64
|-
|String
|hash
|Código de detección de errores
|-
|String
|mensaje
|Este mensaje está asociado al codigo, útil para identificación de errores
|-
|String
|resultado
|Resultado del consumo del método:
: “Procesado” ó “Error”
|}
'''@Importante:''' Si durante la emisión del documento (método '''Enviar''') el parámetro '''adjuntos''' se asignó en “10” u “11”, la plataforma The Factory HKA - DFACTURE no generará representación gráfica (PDF) estándar, por lo tanto no se puede consumir éste método ya que el servicio arrojará un error indicando que NO existe PDF asociado, ya que se asume que la representación gráfica ha sido generada de manera local por el software de facturación (ERP).
{{clear}}

Métodos Servicio Emisión Web TFHKA - Indice del Manual Integración Directa HKA Documentos Equivalentes Electrónicos

2026-03-26T21:38:05Z

Dmrodriguez2: /* Método EnviarRequest */

====Class.FacturaGeneral====
{| class="mw-collapsible mw-collapsed wikitable"
! style="background:#f2f2f2; text-align:center;"|Atributo
! style="background:#f2f2f2; text-align:center;"|Tipo Dato
! style="background:#f2f2f2; text-align:center;"|Formato
! style="background:#f2f2f2; text-align:center;"|Requerido
! style="background:#f2f2f2; text-align:center;"|Descripción
|-
|anticipos
|Array <Anticipos>
| -
|NO
|
: Informaciones relacionadas con anticipos
: '''PATH''': /root/cac:PrepaidPayment
: (ver detalle en [[#Class.Anticipos|Class.Anticipos]])
|-
|autorizado
|Autorizado
| -
|NO
|
: Informaciones de la persona autorizada para descargar documentos
: '''PATH''': /root/cac:TaxRepresentativeParty
: (ver detalle en [[#Class.Autorizado|Class.Autorizado]])
|-
|boletaIngreso
|Array<BoletaIngreso>
| -
|NO
|
: Información referente a boleta de ingreso
: (ver detalle en [[#Class.BoletaIngreso]])
|-
|bolsaValores
|Array<BolsaValores>
| -
|NO
|
: Información referente a bolsa de valores
: (ver detalle en [[#Class.BolsaValores]])
|-
|cajaVenta
|Array<CajaVenta>
| -
|NO
|
: Información referente a caja de venta
: (ver detalle en [[#Class.CajaVenta]])
|-
|cantidadDecimales
|String
| <nowiki>N|1</nowiki>
|SI
|
: Se envía la cantidad de decimales a utilizar (mínimo 0, máximo 6)
: Rechazo Si se reciben más decimales en los montos a los indicados en este campo
: '''PATH''': No aplica
|-
|cargosDescuentos
|Array <CargosDescuentos>
| -
|NO
|
: Informaciones relacionadas con un cargo o un descuento a escala de factura que no afecte a la base gravable
: '''PATH''': /root/cac:AllowanceCharge
: (ver detalle en [[#Class.CargosDescuentos|Class.CargosDescuentos]])
|-
|cliente
|Cliente
| -
|SI
|
: Información del adquiriente
: Para Documento Soporte en adquisiciones a No Obligados a Facturar se debe utiliza para registrar los datos del proveedor o del no obligado
: '''PATH''':/root/cac:AccountingCustomerParty
: (ver detalle en [[#Class.Cliente|Class.Cliente]])
|-
|codigoCosto
|String
| -
|NO
|
: Código de para centro de costos

: '''PATH''': ../cbc:
|-
|consecutivoDocumento
|String
| AN..14
|SI
|
: Correlativo/consecutivo del documento electrónico
: Concatenación del prefijo (<nowiki>AN|..4</nowiki>) + el consecutivo DIAN,
: según la configuración en portal web:
:: Manual con prefijo: prefijo requerido (Sin guion). Ejemplo: “PREF2147483647”
:: Manual sin prefijo: prefijo no requerido. Ejemplo: “2147483647”
: Rechazo No se permiten caracteres adicionales como espacios o guiones
: Rechazo Número de consecutivo debe ser igual o superior al valor inicial del rango de numeración otorgado por la DIAN
: Rechazo Número de consecutivo debe ser igual o inferior al valor final del rango de numeración otorgado por la DIAN
: '''PATH''': /root/cbc:ID
|-
|detalleDeFactura
|Array <FacturaDetalle>
| -
|SI
|
: Información de detalles o productos
: '''PATH''': /root/cac:InvoiceLine
: (ver detalle en [[#Class.FacturaDetalle|Class.FacturaDetalle]])
|-
|DocumentosAdjuntos
|String
| -
|SI
|
Posibles valores:
: “0” No se admiten adjuntos. Se genera XML y representación Gráfica estándar por The Factory HKA
: “2” Admite archivos adjuntos. Se genera XML y representación Gráfica estándar por The Factory HKA
|documentosReferenciados
|Array <DocumentoReferenciado>
| -
|C/C
|
: Informaciones que describen un documento referenciado
: '''Obligatorio''' en facturas tipoDocumento contingencia (AdditionalDocumentReference), en facturas que afecten una nota (BillingReference), en Notas de Crédito y Débito (DiscrepancyResponse y BillingReference)
: '''PATH''': /root/cac:DiscrepancyResponse,
:: /root/cac:BillingReference,
:: /root/cac: AdditionalDocumentReference,
:: /root/cac: DespatchDocumentReference,
:: /root/cac: ReceiptDocumentReference
:(ver detalle en [[#Class.DocumentoReferenciado|Class.DocumentoReferenciado]])
|-
|entregaMercancia
|Entrega
| -
|NO
|
: Información de entrega (Delivery) de bienes
: '''PATH''': /root/cac:Delivery
: (ver detalle en [[#Class.Entrega|Class.Entrega]])
|-
|extras
|Array <Extras>
| -
|NO
|
: Campos o información opcional para el modelo de negocio del emisor
: '''PATH''': No definido
: (ver detalle en [[#Class.Extras|Class.Extras]])
|-
|fabricantesoftware
|Array<FabricanteSoftware>
| -
|SI
|
: Código de para centro de costos
: (ver detalle en [[#Class.fabricanteSoftware]])
|-
|fechaEmision
|String
| <nowiki>AN|19</nowiki>
|SI
|
: Fecha y hora de emisión del documento, en formato: YYYY-MM-DD HH:MM:SS
: Notificación Si la fecha de emisión es anterior a cinco (5) días de la fecha calendario
: Rechazo Si la fecha de emisión es posterior a diez días calendario
: '''PATH''': /root/cbc:IssueDate, root/cbc:IssueTime
|-
|fechaFinPeriodoFacturacion
|String
| <nowiki>AN|19</nowiki>
|NO
|
: Fecha/Hora de fin del periodo de facturación (Intervalo de fechas a las que referencia la factura por ejemplo en servicios públicos), en formato: YYYY-MM-DD HH:MM:SS
: '''PATH''': /root/cac:InvoicePeriod/cbc:EndDate, /root/cac:InvoicePeriod/cbc:EndTime
|-
|fechaInicioPeriodoFacturacion
|String
| <nowiki>AN|19</nowiki>
|NO
|
: Fecha/Hora de inicio del periodo de facturación, en formato: YYYY-MM-DD HH:MM:SS
: '''PATH''':
: /root/cac:InvoicePeriod/cbc:StartDate, /root/cac:InvoicePeriod/cbc:StartTime
|-
|fechaPagoImpuestos
|String
| <nowiki>AN|19</nowiki>
|NO
|
: Fecha de pago de impuestos, en formato: YYYY-MM-DD HH:MM:SS
: '''PATH''': root/cbc:TaxPointDate
|-
|fechaVencimiento
|String
| <nowiki>AN|10</nowiki>
|NO
|
: Fecha vencimiento de la factura, en formato: YYYY-MM-DD
: '''PATH''': /root/cbc:DueDate
|-
|impuestosGenerales
|Array <FacturaImpuestos>
| -
|SI
|
: Información de impuestos generales o globales
: Rechazo Si los impuestos/retenciones reportados en este arreglo no corresponden con lo reportado en los detalles
: '''PATH''': /root/cac:TaxTotal (impuestos),
: /root/cac: WithholdingTaxTotal (retenciones),
: (ver detalle en [[#Class.FacturaImpuestos|Class.FacturaImpuestos]])
|-
|impuestosTotales
|Array <ImpuestosTotales>
| -
|SI
|
: Sumatoria de los impuestos/retenciones generales por tipo de impuesto/retención
: Rechazo Si el valor total del impuesto/retención indicado es diferente a la sumatoria de los reportado en el arreglo impuestosGenerales
: '''PATH''': /root/cac:TaxTotal/cbc:TaxAmount (impuestos),
: /root/cac: WithholdingTaxTotal/cbc:TaxAmount (retenciones),
: (ver detalle en [[#Class.ImpuestosTotales|Class.ImpuestosTotales]])
|-
|informacionAdicional
|Array <String>
| <nowiki>AN|...10000</nowiki>
|NO
|
: Información adicional o texto libre relativo al documento
: '''PATH''': root/cbc:Note
|-
|informacionBeneficiosComprador
|Array <InformacionBeneficiosComprador>
| -
|NO
|
: Información relacionada con beneficios del comprador
: '''PATH''': /root/cac:PaymentMeans
: (ver detalle en [[#Class.InformacionBeneficiosComprador]])
|-
|juegosLocalizados
|Array<juegosLocalizados>
| -
|NO
|
: Información referente a juegos localizados
: (ver detalle en [[#Class.juegosLocalizados]])
|-
|mediosDePago
|Array<MediosDePago>
| -
|NO
|
: '''PATH''': /root/cac:PaymentMeans
: (ver detalle en [[#Class.MediosDePago]])
|-
|moneda
|String
| <nowiki>AN|3</nowiki>
|SI
|
: Moneda o divisa del documento
: Usar códigos ISO 4217 (Ejemplo Pesos Colombianos “COP”)
: Rechazo Si el valor no corresponde a uno de los códigos ISO 4217
: '''PATH''': /root/cbc:DocumentCurrencyCode
|-
|propina
|string
| -
|NO
|
: Información relacionada a propina
|-
|ordenDeCompra
|Array <OrdenDeCompra>
| -
|NO
|
: Información relacionada a la orden de compra
: '''PATH''': /root/cac:OrderReference
: (ver detalle en [[#Class.OrdenDeCompra|Class.OrdenDeCompra]])
|-
|rangoNumeracion
|String
| <nowiki>AN|20</nowiki>
|SI
|
: Consecutivo desde el que comienza la serie para el documento a emitir, siempre debe colocarse el prefijo (con guión) independientemente de la modalidad de secuencial.
: Ejemplo: ‘PREF-1123456’
: Rechazo Si el valor del campo desde (Inicio del rango) supera el valor '''2.147.483.647'''.
: '''PATH''':
: /root/ext:UBLExtensions/ext:UBLExtension/ext:ExtensionContent/
: sts:DianExtensions/sts:InvoiceControl/sts:AuthorizedInvoices/(sts:Prefix, sts:From)
|-
|redondeoAplicado
|String
| Ent: <nowiki>N|..15</nowiki>
Dec: <nowiki>N|0..6</nowiki>
|SI
|
: Redondeo aplicado para llegar a totalMonto
: Rechazo Si redondeo es superior al mayor valor entre 500 pesos o 0,1% del valor total de la factura
: '''PATH''': /root/cac:LegalMonetaryTotal/cbc:PayableRoundingAmount
|-
|retencionesGenerales
|Array <FacturaImpuestos>
| -
|SI
|
: Información de impuestos generales o globales
: Rechazo Si los impuestos/retenciones reportados en este arreglo no corresponden con lo reportado en los detalles
: '''PATH''': /root/cac:TaxTotal (impuestos),
: /root/cac: WithholdingTaxTotal (retenciones),
: (ver detalle en [[#Class.FacturaImpuestos|Class.FacturaImpuestos]])
|-
|serviciosPublicos
|Array<ServiciosPublicos>
| -
|NO
|
: Información referente a servicios publicos
: (ver detalle en [[#Class.ServiciosPublicos]])
|-
|tasaDeCambio
|Array<TasaDeCambio>
| -
|C/C
|
: Información relacionada con la tasa de cambio de moneda extranjera a peso colombiano (COP)
: '''Obligatorio''' Si tipoDocumento es de exportación/internacional o si la divisa base es diferente a “COP”
: '''PATH''': /root/cac:PaymentExchangeRate
: (ver detalle en [[#Class.TasaDeCambio|Class.TasaDeCambio]])
|-
|tasaDeCambioAlternativa
|TasaDeCambioAlternativa
| -
|NO
|
: Información utilizada como método alternativo para informar conversiones a otras divisas
: '''PATH''': /root/cac:PaymentAlternativeExchangeRate
: (ver detalle en [[#Class.TasaDeCambioAlternativa|Class.TasaDeCambioAlternativa]])
|-
|terminosEntrega
|TerminosEntrega
| -
|C/C
|
: Información relacionada con la entrega
: '''Obligatorio''' Si tipoDocumento es de exportación/internacional
: '''PATH''': /root/cac:DeliveryTerms
: (ver detalle en [[#Class.TerminosEntrega|Class.TerminosEntrega]])
|-
|tipoDocumento
|String
| <nowiki>AN|2</nowiki>
|SI
|
: Tipo de documento
: '''PATH''': Invoice, CreditNote, DebitNote
: Rechazo 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
|String
| <nowiki>AN|..4</nowiki>
|SI
|
: Indicador del tipo de operación
: Rechazo 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
|-
|totalAnticipos
|String
| Ent: <nowiki>N|..15</nowiki>
Dec: <nowiki>N|0..6</nowiki>
|NO
|
: Suma de todos los pagos anticipados
: Rechazo Si totalAnticipos no corresponde a la suma de los atributos Anticipos.montoPagado en el arreglo anticipos
: '''PATH''': /root/LegalMonetaryTotal/cbc:PrepaidAmount
|-
|totalBaseImponible
|String
| Ent: <nowiki>N|..15</nowiki>
Dec: <nowiki>N|0..6</nowiki>
|SI
|
: Total Valor Base Imponible: Suma de Bases imponibles para el cálculo de los tributos a nivel de factura
: Rechazo Si totalBaseImponible no es igual a la suma de ocurrencias FacturaImpuestos.baseImponibleTOTALImp
: '''PATH''': /root/LegalMonetaryTotal/cbc:TaxExclusiveAmount
|-
|totalBrutoConImpuesto
|String
| Ent: <nowiki>N|..15</nowiki>
Dec: <nowiki>N|0..6</nowiki>
|SI
|
: Total del valor bruto con tributos
: Rechazo Si totalBrutoConImpuesto no es igual a la suma: totalSinImpuestos + sum(ImpuestosTotales.montoTotal)
: '''PATH''': /root/LegalMonetaryTotal/cbc:TaxInclusiveAmount
|-
|totalCargosAplicados
|String
| Ent: <nowiki>N|..15</nowiki>
Dec: <nowiki>N|0..6</nowiki>
|NO
|
: Cargo Total: Suma de todos los cargos aplicados a nivel de la factura
: Rechazo Si totalCargosAplicados no corresponde a la suma de ocurrencias CargosDescuentos.monto cuando CargosDescuentos.indicador es “true”
: '''PATH''': /root/LegalMonetaryTotal/cbc:ChargeTotalAmount
|-
|totalDescuentos
|String
| Ent: <nowiki>N|..15</nowiki>
Dec: <nowiki>N|0..6</nowiki>
|NO
|
: Descuento Total: Suma de todos los descuentos aplicados a nivel de la factura
: Rechazo Si totalDescuentos no corresponde a la suma de ocurrencias CargosDescuentos.monto cuando CargosDescuentos.indicador es “false”
: '''PATH''': /root/LegalMonetaryTotal/cbc:AllowanceTotalAmount
|-
|totalMonto
|String
| Ent: <nowiki>N|..15</nowiki>
Dec: <nowiki>N|0..6</nowiki>
|SI
|
: Valor a pagar del documento: Valor total de ítems (incluyendo cargos y descuentos a nivel de ítems) + valor de tributos + valor de cargos – valor de descuentos – valor anticipos
: Rechazo Si totalMonto no es consistente con el valor total de ítems + valor de tributos + valor de cargos – valor de descuentos – valor anticipos + redondeo aplicado
: '''PATH''': /root/LegalMonetaryTotal/cbc:PayableAmount
|-
|totalProductos
|String
| <nowiki>AN|..5</nowiki>
|SI
|
: Número o cantidad de líneas de productos (renglones) presentes en el documento
: Rechazo Si el valor de totalProductos es diferente al número de ocurrencias de rans en el arreglo detalleDeFactura
: '''PATH''': /root/cbc:LineCountNumeric
|-
|totalSinImpuestos
|String
| Ent: <nowiki>N|..15</nowiki>
Dec: <nowiki>N|0..6</nowiki>
|SI
|
: Total Valor Bruto antes de tributos: Suma de los valores brutos de las líneas de la factura
: Rechazo Si totalSinImpuestos no corresponde a la suma de los atributos precioTotalSinImpuestos en el arreglo detalleDeFactura
: '''PATH''': /root/LegalMonetaryTotal/cbc:LineExtensionAmount
|}

API AgendarReporte

2026-03-24T14:24:06Z

Dmrodriguez2:

La API '''AgendarReporte''' es un desarrollo elaborado por el equipo de The Factory HKA el cual brinda la posibilidad al contribuyente de agendar un Reporte Programado el cual el sistema se encargara de agendarlo para ser descargado en un lapso de tiempo no mayor a 24 horas. Luego se podrá descargar el reporte de los documentos emitidos en un formato csv/archivo plano para convertirlo en formato Excel. El reporte programado le permitirá traer todos los registros hechos en el periodo seleccionado. El periodo máximo por reporte es de 35 días, para obtener reportes de distintos meses pueden realizar la solicitud por mes, es decir un reporte a la vez. Esta funcionalidad se puede utilizar en el ambiente demo y en ambiente de producción o al realizar el consumo del servicio a través de la Api AgendarReporte.
 
 
'''@IMPORTANTE:''' La API AgendarReporte está construida en método POST. Para el consumo de este servicio se han establecido dos url especificas en ambiente DEMO y ambiente PRODUCCION las cuales las podrá encontrar a continuación:

'''Para mayor información pude consultas las URL en la siguiente sección:'''
'''[[Tips_Urls_de_Emisión #AgendarReporteProgramado|AgendarReporteProgramado]]'''

A continuación se documenta la estructura que se debe contemplar en la construcción del Request y el Response del servicio AgendarReporte y de esta forma garantizar la implementación de este nuevo método:

; REQUEST: Parámetros a Enviar
{| class="mw-collapsible wikitable"
! style="background:#f2f2f2; text-align:center;"|Tipo
! style="background:#f2f2f2; text-align:center;"|Identificador
! style="background:#f2f2f2; text-align:center;"|Descripción
|- valign="center"
|-
|String
|Nit
|Número de documento del contribuyente emisor.
|-
|rowspan="2"|String
|TokenEmpresa
|rowspan="2"|Suministrado por The Factory HKA Colombia según el ambiente a consultar
|-
|TokenClave
|-
|String
|ClaveSecreta
|Definida por el contribuyente emisor desde el usuario root a través del portal HKA Factura Electrónica en ambiente demo y en ambiente de producción.
|-
|Array <Reporte>
|Reporte
|Parámetros que conforman la cabecera del reporte a agendar
|-
|String
|CantidadDecimales
|Se envía la cantidad de decimales a utilizar (mínimo 0, máximo 6)
|-
|String
|Correo
|Debe identificar el correo al que desea llegue el reporte
|-
|String
|EstadoLegal
|Se muestra el estado legal de los documentos este solamente es visible cuando el codigo de reporte es igual a 2
|-
|String
|EstadoLegal
|Se muestra el estado legal de los documentos este solamente es visible cuando el codigo de reporte es igual a 2
|-
|Array <Filtro>
|Filtros
|Parametros que identifican las caracteristicas del reporte.
|}
 

Donde Class.Filtros contiene la siguiente información:

; RESPONSE: Parámetros a Recibir Array Numeraciones
{| class="mw-collapsible wikitable"
! style="background:#f2f2f2; text-align:center;"|Tipo
! style="background:#f2f2f2; text-align:center;"|Identificador
! style="background:#f2f2f2; text-align:center;"|Descripción
|- valign="center"
|-
|String
|CodigoReporte
| 2= Reporte General Programado Facturación
|-
|String
|FechaInicio
|Describe la fecha inicial desde en que desea agendar el reporte "AA-MM-DD HH-MM-SS".
|-
|String
|FechaHasta
|Describe la fecha hasta la que deseaa agendar el reporte "AA-MM-DD HH-MM-SS".
|-
|String
|TipoIdentificacionAdquiriente
|Describe el Tipo de Identificación del adquiriente
: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]]
|-
|String
|NumeroIdentificacionAdquiriente
|Describe Número del Documento o Identificación Fiscal del adquirente
|-
|String
|EstatusDian
|null
|-
|String
|EstatusAcuseRecibo
|null
|-
|String
|EstatusCorreoElectronico
|null
|-
|String
|EstatusHka
|Se debe indicar el codigo de respuesta del servicio de TFHKA
: 200= Documento Exitoso
: 208= Documento de contingencia recibido, se enviará más tarde a la DIAN
: 99= Documento fue rechazado por la DIAN
|-
|String
|TipoDocumento
|Se debe indicar el codigo de respuesta del servicio de TFHKA
: 01= Factura Electronica de Venta
: 91= Nota Credito
: 92= Nota Debito
: 03= Nota Contingencia
|-
|String
|RangoMontoInicial
|Valores iniciales en los que desea se agende el reporte, se requiere punto(.) como separadores de miles
|-
|String
|RangoMontoFinal
|Valores finales en los que desea se agende el reporte, se requiere punto(.) como separadores de miles
|-
|String
|OrigenFacturacion
|Define el servicio por el cual se genero la emision de los documentos electronicos. Existen las siguientes opciones:
: 1= Portal
: 2= Servicio de Integración
: 3= App Móvil
: 4= Masivo
: 5= App Tili
|-
|String
|Prefijo
|Corresponde al prefijo de la numeracion con la que se genero la emision de los documentos electronicos.
|-
|String
|NumeracionFacturaInicial
|Corresponde corresponde al rango inicial de la numeracion a consultar con la que se genero la emision de los documentos electronicos.
|-
|String
|NumeracionFacturaFinal
|Corresponde corresponde al rango final de la numeracion a consultar con la que se genero la emision de los documentos electronicos.
|-
|String
|CodigoSucursal
|Corresponde al codigo del estableciiento al que corresponde la numeración.
|-
|String
|Ambiente
|Corresponde al ambiente en el que se realizo la emision de los documentos electroncos. '''Este campo debe enviarse null'''
|}
 

; RESPONSE: Parámetros a Recibir al consumir la Api AgendarReporte
{| class="mw-collapsible wikitable"
! style="background:#f2f2f2; text-align:center;"|Tipo
! style="background:#f2f2f2; text-align:center;"|Identificador
! style="background:#f2f2f2; text-align:center;"|Descripción
|- valign="center"
|-
|int
|Código
|Indica el estado de la operación retornado por el servicio
|-
|String
|Mensaje
|El Reporte Programado ha sido agendado satisfactoriamente
|-
|String
|Resultado
|Resultado del consumo del método:
: “Procesado” ó “Error”
|-
|String
|IdReporte
|Codigo identificador del Reporte agendado
|-
|String
|EstadoLegal
|Codigo indica si el reporte agendado viene con estado Legal
|-
|String
|Errores
|Indica la descripcion de los posibles errores al momento de agendar el reporte.
|}
{{clear}}

API AgendarReporte

2026-03-24T14:21:48Z

Dmrodriguez2:

La API '''AgendarReporte''' es un desarrollo elaborado por el equipo de The Factory HKA el cual brinda la posibilidad al contribuyente de agendar un Reporte Programado el cual el sistema se encargara de agendarlo para ser descargado en un lapso de tiempo no mayor a 24 horas. Luego se podrá descargar el reporte de los documentos emitidos en un formato csv/archivo plano para convertirlo en formato Excel. El reporte programado le permitirá traer todos los registros hechos en el periodo seleccionado. El periodo máximo por reporte es de 35 días, para obtener reportes de distintos meses pueden realizar la solicitud por mes, es decir un reporte a la vez. Esta funcionalidad se puede utilizar en el ambiente demo y en ambiente de producción o al realizar el consumo del servicio a través de la Api AgendarReporte.
 
 
'''@IMPORTANTE:''' La API AgendarReporte está construida en método POST. Para el consumo de este servicio se han establecido dos url especificas en ambiente DEMO y ambiente PRODUCCION las cuales las podrá encontrar a continuación:

'''Para mayor información pude consultas las URL en la siguiente sección:'''
'''[[Tips_Urls_de_Emisión #AgendarReporteProgramado|AgendarReporteProgramado]]'''

A continuación se documenta la estructura que se debe contemplar en la construcción del Request y el Response del servicio AgendarReporte y de esta forma garantizar la implementación de este nuevo método:

; REQUEST: Parámetros a Enviar
{| class="mw-collapsible wikitable"
! style="background:#f2f2f2; text-align:center;"|Tipo
! style="background:#f2f2f2; text-align:center;"|Identificador
! style="background:#f2f2f2; text-align:center;"|Descripción
|- valign="center"
|-
|String
|Nit
|Número de documento del contribuyente emisor.
|-
|rowspan="2"|String
|TokenEmpresa
|rowspan="2"|Suministrado por The Factory HKA Colombia según el ambiente a consultar
|-
|TokenClave
|-
|String
|ClaveSecreta
|Definida por el contribuyente emisor desde el usuario root a través del portal HKA Factura Electrónica en ambiente demo y en ambiente de producción.
|-
|Array <Reporte>
|Reporte
|Parámetros que conforman la cabecera del reporte a agendar
|-
|String
|CantidadDecimales
|Se envía la cantidad de decimales a utilizar (mínimo 0, máximo 6)
|-
|String
|Correo
|Debe identificar el correo al que desea llegue el reporte
|-
|String
|EstadoLegal
|Se muestra el estado legal de los documentos este solamente es visible cuando el codigo de reporte es igual a 2
|-
|String
|EstadoLegal
|Se muestra el estado legal de los documentos este solamente es visible cuando el codigo de reporte es igual a 2
|-
|Array <Filtro>
|Filtros
|Parametros que identifican las caracteristicas del reporte.
|}
 

Donde Class.Filtros contiene la siguiente información:

; RESPONSE: Parámetros a Recibir Array Numeraciones
{| class="mw-collapsible wikitable"
! style="background:#f2f2f2; text-align:center;"|Tipo
! style="background:#f2f2f2; text-align:center;"|Identificador
! style="background:#f2f2f2; text-align:center;"|Descripción
|- valign="center"
|-
|String
|CodigoReporte
| 2= Reporte General Programado Facturación
|-
|String
|FechaInicio
|Describe la fecha inicial desde en que desea agendar el reporte.
|-
|String
|FechaHasta
|Describe la fecha hasta la que deseaa agendar el reporte.
|-
|String
|TipoIdentificacionAdquiriente
|Describe el Tipo de Identificación del adquiriente
: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]]
|-
|String
|NumeroIdentificacionAdquiriente
|Describe Número del Documento o Identificación Fiscal del adquirente
|-
|String
|EstatusDian
|null
|-
|String
|EstatusAcuseRecibo
|null
|-
|String
|EstatusCorreoElectronico
|null
|-
|String
|EstatusHka
|Se debe indicar el codigo de respuesta del servicio de TFHKA
: 200= Documento Exitoso
: 208= Documento de contingencia recibido, se enviará más tarde a la DIAN
: 99= Documento fue rechazado por la DIAN
|-
|String
|TipoDocumento
|Se debe indicar el codigo de respuesta del servicio de TFHKA
: 01= Factura Electronica de Venta
: 91= Nota Credito
: 92= Nota Debito
: 03= Nota Contingencia
|-
|String
|RangoMontoInicial
|Valores iniciales en los que desea se agende el reporte, se requiere punto(.) como separadores de miles
|-
|String
|RangoMontoFinal
|Valores finales en los que desea se agende el reporte, se requiere punto(.) como separadores de miles
|-
|String
|OrigenFacturacion
|Define el servicio por el cual se genero la emision de los documentos electronicos. Existen las siguientes opciones:
: 1= Portal
: 2= Servicio de Integración
: 3= App Móvil
: 4= Masivo
: 5= App Tili
|-
|String
|Prefijo
|Corresponde al prefijo de la numeracion con la que se genero la emision de los documentos electronicos.
|-
|String
|NumeracionFacturaInicial
|Corresponde corresponde al rango inicial de la numeracion a consultar con la que se genero la emision de los documentos electronicos.
|-
|String
|NumeracionFacturaFinal
|Corresponde corresponde al rango final de la numeracion a consultar con la que se genero la emision de los documentos electronicos.
|-
|String
|CodigoSucursal
|Corresponde al codigo del estableciiento al que corresponde la numeración.
|-
|String
|Ambiente
|Corresponde al ambiente en el que se realizo la emision de los documentos electroncos. '''Este campo debe enviarse null'''
|}
 

; RESPONSE: Parámetros a Recibir al consumir la Api AgendarReporte
{| class="mw-collapsible wikitable"
! style="background:#f2f2f2; text-align:center;"|Tipo
! style="background:#f2f2f2; text-align:center;"|Identificador
! style="background:#f2f2f2; text-align:center;"|Descripción
|- valign="center"
|-
|int
|Código
|Indica el estado de la operación retornado por el servicio
|-
|String
|Mensaje
|El Reporte Programado ha sido agendado satisfactoriamente
|-
|String
|Resultado
|Resultado del consumo del método:
: “Procesado” ó “Error”
|-
|String
|IdReporte
|Codigo identificador del Reporte agendado
|-
|String
|EstadoLegal
|Codigo indica si el reporte agendado viene con estado Legal
|-
|String
|Errores
|Indica la descripcion de los posibles errores al momento de agendar el reporte.
|}
{{clear}}

Manual DLL hkafact21 - Emisión V4

2025-12-29T15:55:55Z

Dmrodriguez2: /* Respuesta método EstadoDocumento */

<includeonly>=</includeonly>== Objetivo ==<includeonly>=</includeonly>
 
El presente manual tiene como propósito dar a conocer los detalles de los cambios a nivel del consumo de la librería HKAFACT21 para validación previa respecto a la versión del modelo de facturación de validación posterior (HKAFACT).

<includeonly>=</includeonly>== Alcance ==<includeonly>=</includeonly>
 
<DIV ALIGN=justify>El presente documento abarca desde la instalación de la API hasta las funciones utilizables para el consumo del Servicio Web de Integración para el modelo de facturación de validación previa. La librería hkafact21 es compatible con cualquier desarrollo cuya base sea plataformas WIN32</DIV>

'''Nota:''' En el mismo se describen cada uno de los strings que constituyen el objeto factura. Para obtener mayor información sobre la obligatoriedad de los campos (requeridos/opcionales) ver '''MANUAL DE INTEGRACION DIRECTA (EMISIÓN - VAL. PREVIA)'''

<includeonly>=</includeonly>== Definiciones y Términos ==<includeonly>=</includeonly>
 
*'''C++:''' lenguaje de programación diseñado para extender al lenguaje de programación C con mecanismos que permiten la manipulación de objetos. En ese sentido, desde el punto de vista de los lenguajes orientados a objetos, el C++ es un lenguaje híbrido, con la particularidad de poder redefinir los operadores, y de crear nuevos tipos que se comporten como tipos fundamentales.
*'''DLL:''' Biblioteca de enlace dinámico o más comúnmente DLL (sigla en inglés de dynamic-link library) es el término con el que se refiere a los archivos con código ejecutable que se cargan bajo demanda de un programa por parte del sistema operativo.
*'''SDK:''' Un kit de desarrollo de software es un conjunto de herramientas de desarrollo de software que le permite al programador o desarrollador de software crear una aplicación informática para un sistema concreto.
*'''Servicio Web de Integración:''' Servicio Web de The Factory HKA Colombia SAS puesto a disposición a propietarios de software administrativos o de gestión para la generación de factura electrónica.

<includeonly>=</includeonly>== Procedimiento ==<includeonly>=</includeonly>
 
<DIV ALIGN=justify>Instalación: En el SDK descargado, se encontrará con tres herramientas; la librería de integración (hkafact21.dll), el presente manual y un demo funcional de código. Antes de comenzar a hacer uso de la librería en el desarrollo, lo primero que se debe hacer es registrar y referenciar la librería en nuestro proyecto. Esto se consigue siguiendo los siguientes pasos: </DIV>
#Creamos una nueva carpeta.
# Descomprimimos el contenido del SDK en la capeta previamente creada.
# Copiamos la librería hkafact21.dll.
# Pegamos la librería en la carpeta System32 de Windows.
# Finalmente, declaramos las distintas funciones a utilizar de la librería.
 
'''@IMPORTANTE:'''
 
#En el caso de que al final de la cadena (Identificador), el campo se encuentre vacío se debe agregar un pipe “|” al final.
#Si el identificador no es obligatorio, este pueden enviarse con el identificador seguido de un pipe (Ejemplo: ID02A = "02A|").
#Si los identificadores son repetibles puede concatenarse con el separador “% “seguido del identificador con los campos correspondientes a la cadena que desea repetir.
 
<includeonly>=</includeonly>== MÉTODO ENVIAR==<includeonly>=</includeonly>
 
Función que permite generar el documento electrónico.
 
=== Declaración ===
<center>
<pre> INT Enviar (string URL, string tokenEmpresa, string tokenPassword, string DatosCliente, string FacturaGlobal, string AnticAutCargDesc, string CpDr, string EntMerc, string ImpuestosFactura, string MpOcTe, string TcTcaIa, string Extras, string DetalleDeFactura, string Adjuntos, string SectorSalud, bool debugMode)</pre></center>

=== String URL ===
*URL del servicio de emisión.

=== String tokenEmpresa ===
*Token asignado por la plataforma de TFHKA.

=== String tokenPassword ===
*Token asignado por la plataforma de TFHKA.

=== String datosCliente ===
*Datos que componen la información del adquiriente.

===== Cliente_DatosGenerales =====
(20 Campos, 19 pipes “|”):
<center>
<pre>ID01=01|nombreRazonSocial|tipoPersona|segundoNombre|apellido|numeroDocumento|tipoIdentificacion
|email|telefono|notificar|actividadEconomicaCIIU|nombreComercial|nombreContacto
|nota|numeroIdentificacionDV
|telefax|Extensible1.controlInterno1|
Extensible1.controlInterno2|Extensible1.nombre|Extensible1.valor
</pre>
</center>
'''Nota:''' Si Extensible1.valor se debe enviar un pipe (|) al final de la cadena
 

==== Cliente_Destinatario ====
(11 Campos, 9 pipes “|”):
<center>
<pre>ID01A=01A|CanalDeEntrega|email|fechaProgramada|mensajePersonalizado|nitProveedorReceptor
|telefono|Extensible1.controlInterno1|Extensible1.controlInterno2
|Extensible1.nombre|Extensible1.valor
</pre>
</center>
'''Nota:''' Si Extensible1.valor se debe enviar un pipe (|) al final de la cadena
 

==== Cliente_DetallesTributarios ====
(6 Campos, 5 pipes “|”):
<center>
<pre>ID01B=01B|codigoImpuesto|Extensible1.controlInterno1|Extensible1.controlInterno2
|Extensible1.nombre|Extensible1.valor
</pre>
</center>
'''Nota:''' Si Extensible1.valor se debe enviar un pipe (|) al final de la cadena
 

==== Cliente_InformacionLegal ====
(8 Campos, 7 pipes “|”):
<center>
<pre>ID01E=01E|codigoEstablecimiento|nombreRegistroRUT|numeroIdentificacion|numeroIdentificacionDV|
numeroMatriculaMercantil|prefijoFacturacion|tipoIdentificacion
</pre>
</center>
 

==== Cliente_ResponsabilidadesRut ====
(7 Campos, 6 pipes “|”):
<center>
<pre>ID01F=01F|obligaciones|regimen|Extensible1.controlInterno1|Extensible1.controlInterno2
|Extensible1.nombre|Extensible1.valor
</pre>
</center>
'''Nota:''' Si Extensible1.valor se debe enviar un pipe (|) al final de la cadena
 

==== DireccionCliente ====
(30 Campos, 29 pipes “|”):
<center>
<pre>ID01C=01C|aCuidadoDe|aLaAtenciónDe|bloque|buzon|calle|calleAdicional|ciudad|codigoDepartamento|
correccionHusoHorario|departamento|departamentoOrg|direccion|distrito|habitacion|lenguaje
|municipio|nombreEdificio|numeroEdificio|numeroParcela|pais|piso|region|subDivision|ubicación
|zonaPostal|Extensible1.controlInterno1|Extensible1.controlInterno2|
Extensible1.nombre|Extensible1.valor
</pre>
</center>
'''Nota:''' Si Extensible1.valor se debe enviar un pipe (|) al final de la cadena
 

==== DireccionFiscalCliente ====
(30 Campos, 29 pipes “|”):
<center>
<pre>ID01D=01D|aCuidadoDe|aLaAtenciónDe|bloque|buzon|calle|calleAdicional|ciudad|codigoDepartamento
|correccionHusoHorario|departamento|departamentoOrg|direccion|distrito|habitacion|lenguaje
|municipio|nombreEdificio|numeroEdificio|numeroParcela|pais|piso|region|subDivision|ubicación
|zonaPostal|Extensible1.controlInterno1|Extensible1.controlInterno2
|Extensible1.nombre|Extensible1.valor
</pre>
</center>
'''Nota:''' Si Extensible1.valor se debe enviar un pipe (|) al final de la cadena
 
<center>'''datos_Cliente=''' ID01 %ID01A%ID01B%ID01E%ID01F%%ID01C %%ID01D</center>

'''Observaciones:'''
* Los identificadores 01A, 01B, 01F son repetibles
 

=== String FacturaGlobalL ===
Datos generales del objeto factura.

==== FacturaGlobal ====
(23 Campos, 22 pipes “|”):
<center>
<pre>datos_factura=02|tipoDocumento|consecutivoDocumento|rangoNumeracion|fechaEmision|fechaVencimiento|moneda
|propina|totalDescuentos|totalSinImpuestos|totalMonto|cantidadDecimales|fechaFinPeriodoFacturacion
|fechaInicioPeriodoFacturacion|fechaPagoImpuestos|redondeoAplicado|tipoOperacion|
totalAnticipos|totalBaseImponible|totalBrutoConImpuesto|totalCargosAplicados
|totalProductos|tipoSector
</pre>
</center>
 

=== String AnticAutCargDesc ===
Anticipos, autorizaciones, Cargos y descuentos aplicados en el comprobante.

==== Anticipos ====
(11 Campos, 10 pipes “|”):
<center>
<pre>ID02A=02A|fechaDeRecibido|fechadePago|horaDePago|id|instrucciones|montoPagado|
Extensible1.controlInterno1
|Extensible1.controlInterno2|Extensible1.nombre|Extensible1.valor
</pre>
</center>
'''Nota:''' Si Extensible1.valor se debe enviar un pipe (|) al final de la cadena
 

==== Autorizado ====
(15 Campos, 14 pipes “|”):
<center>
<pre>ID02B=02B|email|nombreComercial|nombreContacto|nota|numeroDocumento|numeroDocumentoDV
|razonSocial|telefax|telefono|tipoIdentificacion|Extensible1.controlInterno1
|Extensible1.controlInterno2|Extensible1.nombre|Extensible1.valor
</pre>
</center>
'''Nota:''' Si Extensible1.valor se debe enviar un pipe (|) al final de la cadena
 

==== cargosDescuentos ====
(12 Campos, 11 pipes “|”):
<center>
<pre>ID02C=02C|codigo|descripcion|indicador|monto|montoBase|porcentaje|secuencia|Extensible1.controlInterno1
|Extensible1.controlInterno2|Extensible1.nombre|Extensible1.valor
</pre>
</center>
'''Nota:''' Si Extensible1.valor se debe enviar un pipe (|) al final de la cadena
 
<center>'''AnticAutCargDesc =''' ID02A %%ID02B %%ID02C%%</center>

'''Observaciones:'''
* Los identificadores 02A, 02B son repetibles
 

=== String CpDr ===
Condiciones de pago y documentos referenciados para el comprobante.

==== CondicionPago ====
(20 Campos, 19 pipes “|”):
<center>
<pre>ID02D=02D|codigoEvento|comentario|duracionPeriodo|duracionPeriodoMedida|fechaVencimiento|identificador
|medioPagoAsociado|monto|montoMulta|montoPenalidad|periodoDesde|periodoHasta|porcentajeDescuento
|porcentajePago|referenciaAnticipo|Extensible1.controlInterno1|
Extensible1.controlInterno2|Extensible1.nombre|Extensible1.valor
</pre>
</center>
'''Nota:''' Si Extensible1.valor se debe enviar un pipe (|) al final de la cadena
 

==== DocumentosReferenciados ====
(18 Campos, 17 pipes “|”): Puedo no enviarse 02E1
<center>
<pre>ID02E=02E|codigoEstatusDocumento|codigoInterno|cufeDocReferenciado|fecha|fechaFinValidez|fechaInicioValidez
|numeroDocumento|tipoCUFE|tipoDocumento|tipoDocumentoCodigo|Extensible1.controlInterno1|
Extensible1.controlInterno2|Extensible1.nombre|Extensible1.valor|conceptoRecaudo|
monto|numeroIdentificacion ¬02E1|descripción
</pre>
</center>
'''Nota:''' Si Extensible1.valor se debe enviar un pipe (|) al final de la cadena
 
<center>'''CpDr =''' ID02D%%ID02E </center>

'''Observaciones:'''
* Los identificadores 02D, 02E son repetibles
 

=== String EntMerc (Este indientificador no es obligatorio) ===
Datos referentes a la entrega de la mercancía.Anticipos, autorizaciones, Cargos y descuentos aplicados en el comprobante.

==== entregaMercancia ====
<center>
<pre>ID02F=02F|fechaEfectivaSalida|fechaEstimada|fechaReal|fechaSolicitada|identificacionTransporte|
matriculaTransporte|Extensible1.controlInterno1|Extensible1.controlInterno2|
Extensible1.nombre|Extensible1.valor
</pre>
</center>
'''Nota:''' Si Extensible1.valor se debe enviar un pipe (|) al final de la cadena
 

==== datosTransportista ====
<center>
<pre>ID02F1=02F1|email|indicadordeAtencion|indicadordeCuidado|nombreContacto|nombreResponsableEntrega
|nota|numeroIdentificacion|numeroIdentificacionDV|numeroMatriculaMercantil|prefijoFacturacion
|telefax|telefono|tipoIdentificacion|transportadorNombre|transportadorNumeroDocumento
|transportadorNumeroDocumentoDV|transportadorTipoIdentificacion|Extensible1.controlInterno1
|Extensible1.controlInterno2|Extensible1.nombre|Extensible1.valor
</pre>
</center>
'''Nota:''' Si Extensible1.valor se debe enviar un pipe (|) al final de la cadena
 

==== detallesTributariosTransportista ====
<center>
<pre>ID02F1A=02F1A|codigoImpuesto|Extensible1.controlInterno1|Extensible1.controlInterno2|Extensible1.nombre
|Extensible1.valor
</pre>
</center>
'''Nota:''' Si Extensible1.valor se debe enviar un pipe (|) al final de la cadena
 

==== direccionTransportista ====
<center>
<pre>ID02F1B=02F1B|aCuidadoDe|aLaAtenciónDe|bloque|buzon|calle|calleAdicional|ciudad|codigoDepartamento
|correccionHusoHorario|departamento|departamentoOrg|direccion|distrito|habitacion
|lenguaje|municipio|nombreEdificio|numeroEdificio|numeroParcela|pais|piso|region
|subDivision|ubicación|zonaPostal|Extensible1.controlInterno1|Extensible1.controlInterno2
|Extensible1.nombre|Extensible1.valor
</pre>
</center>
'''Nota:''' Si Extensible1.valor se debe enviar un pipe (|) al final de la cadena
 

==== responsabilidadRUT ====
<center>
<pre>ID02F1C=02F1C|obligaciones|regimen|Extensible1.controlInterno1|Extensible1.controlInterno2
|Extensible1.nombre|Extensible1.valor
</pre>
</center>
'''Nota:''' Si Extensible1.valor se debe enviar un pipe (|) al final de la cadena
 

==== transportadorDireccion ====
<center>
<pre>ID02F1D=02F1D|aCuidadoDe|aLaAtenciónDe|bloque|buzon|calle|calleAdicional|ciudad
|codigoDepartamento|correccionHusoHorario|departamento|departamentoOrg
|direccion|distrito|habitacion|lenguaje|municipio|nombreEdificio|numeroEdificio
|numeroParcela|pais|piso|region|subDivision|ubicación|zonaPostal|Extensible1.controlInterno1
|Extensible1.controlInterno2|Extensible1.nombre|Extensible1.valor
</pre>
</center>
'''Nota:''' Si Extensible1.valor se debe enviar un pipe (|) al final de la cadena
 

==== direccionDespacho ====
<center>
<pre>ID02F2=02F2|aCuidadoDe|aLaAtenciónDe|bloque|buzon|calle|calleAdicional|ciudad
|codigoDepartamento|correccionHusoHorario|departamento|departamentoOrg
|direccion|distrito|habitacion|lenguaje|municipio|nombreEdificio|numeroEdificio
|numeroParcela|pais|piso|region|subDivision|ubicación|zonaPostal|
Extensible1.controlInterno1|Extensible1.controlInterno2|Extensible1.nombre|Extensible1.valor
</pre>
</center>
'''Nota:''' Si Extensible1.valor se debe enviar un pipe (|) al final de la cadena
 

==== direccionEntrega ====
<center>
<pre>ID02F3=02F3aCuidadoDe|aLaAtenciónDe|bloque|buzon|calle|calleAdicional|ciudad|codigoDepartamento
|correccionHusoHorario|departamento|departamentoOrg|direccion|distrito|habitacion
|lenguaje|municipio|nombreEdificio|numeroEdificio|numeroParcela|pais|piso
|region|subDivision|ubicación|zonaPostal|Extensible1.controlInterno1|
Extensible1.controlInterno2|Extensible1.nombre|Extensible1.valor
</pre>
</center>
'''Nota:''' Si Extensible1.valor se debe enviar un pipe (|) al final de la cadena
 
Si se envía:
'''EntMerc =''' ID02F%%ID02F1%%
 
 
Si no se desea envía:
'''EntMerc =''' ""
 
 
'''Observaciones:'''
*Los identificadores ID02F1A, 02F1B1, 02F1C, 02F1D1, 02F2A, 02F3A son repetibles
 

=== String ImpuestosFactura ===
Esta cadena contiene la información referente a los impuestos aplicados en el documento.
 

==== ImpuestosGenerales ====
(13 Campos, 12 pipes “|”):
<center>
<pre>ID02G=02G|baseImponibleTOTALImp|codigoTOTALImp|controlInterno|porcentajeTOTALImp
|unidadMedida|unidadMedidaTributo|valorTOTALImp|valorTributoUnidad|Extensible1.controlInterno1
|Extensible1.controlInterno2|Extensible1.nombre|Extensible1.valor
</pre>
</center>
'''Nota:''' Si Extensible1.valor se debe enviar un pipe (|) al final de la cadena
 

==== ImpuestosTotales ====
(8 Campos, 7 pipes “|”):
<center>
<pre>ID02H=02H|codigoTOTALImp|montoTotal|Extensible1.controlInterno1|Extensible1.controlInterno2
|Extensible1.nombre|Extensible1.valor|redondeoAplicado
</pre>
 
<center>'''ImpuestosFactura =''' ID02G%%ID02H</center>
</center>
'''Nota:''' En caso de enviar el campo redondeoAplicado vacío se tomará por defecto 0.00

'''Nota:''' Si el campo redondeoAplicado se encuentra vacío debe enviar un pipe (|) al final de la cadena.
 
Obsercaciones:
*Los identificadores ID02G, ID02H son repetibles
 
=== String MpOcTe ===
Esta cadena contiene la información referente a Medios de pagos, Orden de compra y términos de entrega.
 

==== MediosPago ====
(15 Campos, 14 pipes “|”):
<center>
<pre>ID02J=02J|codigoBanco|codigoCanalPago|codigoReferencia|fechaDeVencimiento|medioPago|metodoDePago
|nombreBanco|numeroDeReferencia|numeroDias|numeroTransferencia|Extensible1.controlInterno1
|Extensible1.controlInterno2|Extensible1.nombre|Extensible1.valor
</pre>
</center>
'''Nota:''' Si Extensible1.valor se debe enviar un pipe (|) al final de la cadena
 

==== Orden_Compra ====
(12 Campos, 11 pipes “|”):
<center>
<pre>ID02K=02K|codigoCliente|fecha|numeroOrden|numeroPedido|tipoCUFE|tipoOrden
|uuid|Extensible1.controlInterno1|Extensible1.controlInterno2|Extensible1.nombre|Extensible1.valor
</pre>
</center>
'''Nota:''' Si Extensible1.valor se debe enviar un pipe (|) al final de la cadena
 

==== Terminos_Entrega ====
(10 Campos, 9 pipes “|”):
<center>
<pre>ID02N=02N|codigoCondicionEntrega|costoTransporte|identificacion|monto
|responsableEntrega|Extensible1.controlInterno1|Extensible1.controlInterno2|Extensible1.nombre|Extensible1.valor
</pre>
</center>
'''Nota:''' Si Extensible1.valor se debe enviar un pipe (|) al final de la cadena
 
<center>'''MpOcTe =''' ID02J%%ID02K%%ID02N</center>
 
'''Observaciones:'''
*Los identificadores ID02J, ID02K son repetibles
 

=== String TcTcaIa ===
Esta cadena contiene la información referente a la tasa de cambio, tasa de cambio alternativa e información adicional.
 

==== TasaCambio ====
(13 Campos, 12 pipes “|”):
<center>
<pre>ID02L=02L|baseMonedaDestino|baseMonedaOrigen|fechaDeTasaDeCambio|indicadorDeTasa
|monedaDestino|monedaOrigen|operadorCalculo|tasaDeCambio|Extensible1.controlInterno1
|Extensible1.controlInterno2|Extensible1.nombre|Extensible1.valor
</pre>
</center>
'''Nota:''' Si Extensible1.valor se debe enviar un pipe (|) al final de la cadena
 

==== TasaCambioAlternativa ====
(13 Campos, 12 pipes “|”):
<center>
<pre>ID02M=02M|baseMonedaDestino|baseMonedaOrigen|fechaDeTasaDeCambio|indicadorDeTasa
|monedaDestino|monedaOrigen|operadorCalculo|tasaDeCambio|Extensible1.controlInterno1
|Extensible1.controlInterno2|Extensible1.nombre|Extensible1.valor
</pre>
</center>
'''Nota:''' Si Extensible1.valor se debe enviar un pipe (|) al final de la cadena
 

==== InformacionAdicional ====
(2 Campos, 1 pipes “|”):
<center>
<pre>ID02I=02I|Texto
</pre>
</center>
 
<center>'''TcTcaIa=''' ID02L%%ID02M%%ID02I</center>
 
'''Observaciones:'''
*Los identificadores ID02I son repetibles
 

=== String DetalleDeFactura ===
Esta cadena contiene la información referente a los items
 

==== DetalleDeFactura ====
(43 Campos, 42 pipes “|”):
<center>
<pre>ID03=03|cantidaPorEmpaque|CantidadReal|CantidadRealUnidadMedida|cantidadUnidades
|codigoFabricante|codigoIdentificacionPais|codigoProducto|codigoTipoPrecio|descripcion
|descripcionTecnica|estandarCodigo|estandarCodigoID|estandarCodigoIdentificador|estandarCodigoProducto
|estandarOrganizacion|estandarSubcodigoProducto|mandatorioNumeroIdentificacion|mandatorioNumeroIdentificacionDV
|mandatorioTipoIdentificacion|marca|modelo|muestraGratis|NombreFabricante|nota|precioReferencia
|precioTotal|precioTotalSinImpuestos|PrecioVentaUnitario|secuencia|seriales|subCodigoFabricante
|subcodigoProducto|tipoAIU|unidadMedida|informacionAdicional|Extensible1.controlInterno1
|Extensible1.controlInterno2|Extensible1.nombre|Extensible1.valor|descripcion2|descripcion3| idEsquema
</pre>
</center>
'''Nota:''' Si envía vacío el campo idEsquema se debe enviar un pipe (|) al final de la cadena
 

==== DF_CargosDescuentos ====
(12 Campos, 11 pipes “|”):
<center>
<pre>ID03A=03A|codigo|descripcion|indicador|monto|montoBase|porcentaje|secuencia
|Extensible1.controlInterno1|Extensible1.controlInterno2|Extensible1.nombre|Extensible1.valor
</pre>
</center>
'''Nota:''' Si Extensible1.valor se debe enviar un pipe (|) al final de la cadena
 

==== DF_ImpDet ====
(13 Campos, 12 pipes “|”):
<center>
<pre>ID03C=03C|baseImponibleTOTALImp|codigoTOTALImp|controlInterno|porcentajeTOTALImp
|unidadMedida|unidadMedidaTributo|valorTOTALImp|valorTributoUnidad|Extensible1.controlInterno1
|Extensible1.controlInterno2|Extensible1.nombre|Extensible1.valor
</pre>
</center>
'''Nota:''' Si Extensible1.valor se debe enviar un pipe (|) al final de la cadena
 

==== DF_ImpTot ====
(8 Campos, 7 pipes “|”):
<center>
<pre>ID03D=03D|codigoTOTALImp|montoTotal|Extensible1.controlInterno1|Extensible1.controlInterno2
|Extensible1.nombre|Extensible1.valor|redondeoAplicado
</pre>
</center>
'''Nota:''' En caso de enviar el campo redondeoAplicado vacio se tomara por defecto 0.00

'''Nota:''' Si el campo redondeoAplicado se encuentra vacío debe enviar un pipe (|) al final de la cadena 
 
 
'''Observaciones:'''
*Separación entre campos del ítem: $$
 

==== DF_InformacionAdicional ====
(7 Campos, 6 pipes “|”):
<center>
<pre>ID03E=03E|nombre|valor|código|cantidad|secuencia|unidadMedidaTransporte
</pre>
</center>
 
'''Nota:'''Si el campo unidadMedidaTransporte se encuentra vacío debe enviar un pipe (|) al final de la cadena

'''Observaciones:'''
*Separación entre ítems: ¬(Ejemplo: item1¬item2)

<center>'''DetalleDeFactura ='''ID03$$ID03A$$ID03C$$ID03D$$ID03E (Si se envía descuento) </center>
 
<center>'''DetalleDeFactura ='''ID03$$ID03C$$ID03D$$ID03E $$ID03E (Si NO se envía descuento) </center>
 
<center>'''DetalleDeFactura ='''ID03$$ID03C$$ID03D (Si NO se envía descuento ni información Adicional) </center>
 

=== String Extras ===
Esta cadena contiene los campos extras que se deseen agregar al objeto factura.
 
<center>'''Extras = '''04|controlInterno1|controlInterno2|nombre|pdf|valor|xml</center>
'''Observaciones:'''
*El string Extras es repetible.
 

=== String SectorSalud ===
Esta cadena contiene la información referente al sector salud:
 

==== sectorSalud ====
(4 Campos, 3 pipes “|”):
<center>
<pre>ID06=06|TipoIdentificacion|IdPersonalizacion|TipoEscenario
</pre>
</center>
 

==== DireccionResidencia ====
(30 Campos, 29 pipes “|”):
<center>
<pre>ID06A=06A|aCuidadoDe|aLaAtenciónDe|bloque|buzon|calle|calleAdicional|ciudad
|codigoDepartamento|correccionHusoHorario|departamento|departamentoOrg|direccion
|distrito|habitacion|lenguaje|municipio|nombreEdificio|numeroEdificio|numeroParcela
|pais|piso|region|subDivision|ubicación|zonaPostal|Extensible1.controlInterno1
|Extensible1.controlInterno2|Extensible1.nombre|Extensible1.valor
</pre>
</center>
 

==== CamposGenerales ====
(3 Campos, 2 pipes “|”):

Esta cadena contiene la información referente a los Pacientes.
<center>
<pre>ID06B=06B|Nombre|Valor
</pre>
</center>
 
'''Nota:'''Los camposGenerales se encuentran numerados según el orden establecido en la resolución. Para los campos que se envian vacios se debe finalizar la cadena con pipe (|) adicional.
*El string CamposGenerales es repetible.
<center>'''Separación entre Pacientes:''' “¬” (Ejemplo: Paciente1¬Paciente2)
</center>
 

==== Sextras ====
(7 Campos, 6 pipes “|”):
<center>
<pre>ID06C=06C|controlInterno1|controlInterno2|nombre|pdf|valor|xml
</pre>
</center>
*El string Extras es repetible.
<center>'''SectorSalud= ''' ID06 +“%” + ID06A + “%%” + ID06B + “%%”+ ID06C
</center>
 

=== String Adjunto ===
Caracter que establece si el documento que se emite contendrá o no adjuntos. Valores posibles:
 
* “0” No se admiten adjuntos. Se genera XML y representación Gráfica estándar por The Factory HKA.
* “1” Admite archivos adjuntos. Se genera XML y representación Gráfica estándar por The Factory HKA.
* “10” No se admiten adjuntos. Se genera solo XML sin representación Gráfica estándar por The Factory HKA.
* “11” Admite archivos adjuntos. Se genera solo XML sin representación gráfica estándar por The Factory HKA.

=== String debugMode ===
Flag para indicar a la dll que registre el log de debug en pruebas.
 

=== Respuesta de método Enviar ===
Las respuestas se darán en un archivo de texto plano con nombre hkafact21fresult.txt con la siguiente estructura:

:01|codigo|consecutivoDocumento|cufe|fechaRespuesta|hash|mensaje|resultado|tipoCufe|esValidoDian|nombre|fechaAceptacionDIAN

:esValidoDian =1 True (Documento Aceptado) - esValidoDian = 0 False (Documento no Aceptado)

:01A|mensajeValidacion

:01B|reglasValidacionDIAN
 
'''Nota:'''El string del QR se escribe en un archivo de texto llamado string_QR.txt

'''Nota:'''La dll también dispone del método EnviarCustom, similar al anterior con la diferencia de que este método permite generar el archivo plano de resultado con un nombre diferente y en un directorio distinto al local mediante el parámetro NombreArchivo. Para más detalles ver código ejemplo suministrado en el SDK.
 
 
<includeonly>=</includeonly>== Método EnviarArchivo ==<includeonly>=</includeonly>
 
Función que permite adjuntar o enviar archivos (anexos) por email durante la emisión del documento electrónico. Este método se ejecuta después de consumir el método Enviar con el parámetro adjuntos en “1” o en “11”.
 

<big>''' Declaración '''</big>
<center>
<pre> INT EnviarArchivo (string URLAdj, string tokenEmpresa, string tokenPassword, string ndocumento, string enviar, string formato, string nombre, string tipo, string email, string ruta, bool debugMode).</pre></center>

<big>''' String URLAdj'''</big>
 
*URL del servicio de carga de Adjuntos (Sin ?wsdl).
 

<big>''' String tokenEmpresa ''' </big>
 
*Token asignado por la plataforma de TFHKA.
 

<big>'''String tokenPassword'''</big>
 
*Token asignado por la plataforma de TFHKA.
 

<big>'''String ndocumento '''</big>
 
Prefijo y consecutivo del Documento electrónico concatenado sin separadores (Documento al cual se adjuntará el archivo).
 

<big>''' String enviar '''</big>
 
Parámetro que indica la finalización de la carga de adjuntos. Posee dos valores:
* “0” Adjunta el archivo y lo asocia al documento electrónico sin enviar el email al Adquiriente.
* “1” Adjunta el archivo y lo asocia al documento electrónico y envía el email al Adquiriente.

<big>'''String formato '''</big>
 
Extension del archivo adjunto, formatos permitidos: png, bmp, jpg, pdf, doc, docx, xsl, xlsx, ppt, pptx.
 

<big>'''String nombre '''</big>
 
Nombre que tomará el archive adjunto.
 

<big>'''String tipo '''</big>
 
“1” Declaramos en la Clase Adjunto (Class.Adjunto) en Tipo "1" cuando queremos generar la representación gráfica obtenida por el ERP. 
“2” Declaramos en la Clase Adjunto (Class.Adjunto) en Tipo "2" Cuando se van a enviar otros documentos adicionales a la factura, es decir, que estos documentos van a quedar en una cola sin que se haga ningún tipo de envío sin antes indicárselo a la plataforma. Para esto, el parámetro <enviar> se debe declarar en cero '0', para indicarle a nuestra plataforma que sincronice el adjunto pero sin enviarlo. Finalmente cuando se declare el último adjunto se debe declarar el parámetro <enviar> en "1", así nuestra plataforma entiende que es el último adjunto, por tanto envía este último documento más los anteriores que se encontraban en la cola.

 

<big>'''String email'''</big>
 
Correo al cual se dese enviar el XML (AttachedDocument), la Representación Gráfica y los anexos o adjuntos.
 

<big>''' String ruta '''</big>
 
Cadena de caracteres con la ubicación del archivo que será enviado a través del servicio.
 

<big>'''String debugMode'''</big>
 
Flag para indicar a la dll que registre el log de debug en pruebas.
 

'''@IMPORTANTE:'''

Al emitir un documento electrónico con el parámetro Adjunto en “1” u “11” el email no se enviará al adquiriente hasta no consumir el método '''EnviarArchivo.'''
 

=== Respuesta de método EnviarArchivo===
Las respuestas se darán en un archivo de texto plano con nombre hkafact21fresult.txt con la siguiente estructura:

:01|codigo| mensaje|resultado
 
<includeonly>=</includeonly>== Método EstadoDocumento ==<includeonly>=</includeonly>
 
Función que permite consultar el estado de un documento emitido previamente.
 

<big>''' Declaración '''</big>
<center>
<pre> INT EstadoDocumento (string URL, string tokenEmpresa, string tokenPassword, string documento, bool debugMode)</pre></center>

<big>''' String URLAdj'''</big>
 
*URL del servicio de carga de Adjuntos (Sin ?wsdl).
 

<big>''' String tokenEmpresa ''' </big>
 
*Token asignado por la plataforma de TFHKA.
 

<big>'''String tokenPassword'''</big>
 
*Token asignado por la plataforma de TFHKA.
 

<big>'''String ndocumento '''</big>
 
Prefijo y consecutivo del Documento electrónico concatenado sin separadores (Documento al cual se adjuntará el archivo).
 

<big>'''String debugMode'''</big>
 
Flag para indicar a la dll que registre el log de debug en pruebas.
 

=== Respuesta método EstadoDocumento===
Las respuestas se darán en un archivo de texto plano con nombre hkafact21fresult con la siguiente estructura:Las respuestas se darán en un archivo de texto plano con nombre hkafact21fresult.txt con la siguiente estructura:

:01|codigo|estatusDocumento|ambiente|cadenaCufe|consecutivo|cufe|descripcionDocumento|descripcionEstatusDocumento|entregaMetodoDIAN
:|esValidoDIAN|estatusDocumento|fechaDocumento|mensaje|mensajeDocumento|poseeAdjuntos|poseeRepresentacionGrafica|resultado
:|tipoCufe|tipoDocumento|trackID|fechaAceptacionDIAN

:esValidoDian =1 True (Documento Aceptado) - esValidoDian = 0 False (Documento no Aceptado)

:01B|canalDeEntrega|email|entregaEstatus|entregaEstatusDescripcion|entregaFecha|fechaProgramada|mensajePersonalizado
:|nitProveedorReceptor|recepcionEmailComentario|recepcionEmailEstatus|recepcionEmailFecha|recepcionEmailIPAddress|telefono

:01C|reglasValidacionDIAN

 
'''Nota:'''El string del QR se escribe en un archivo de texto llamado string_QR.txt

'''Nota:'''La dll también dispone del método EstadoDocumentoCustom, similar al anterior con la diferencia de que este método permite generar el archivo plano de resultado con un nombre diferente y en un directorio distinto al local mediante el parámetro NombreArchivo. Para más detalles ver código ejemplo suministrado en el SDK.
 
 
<includeonly>=</includeonly>== Método FoliosRestantes ==<includeonly>=</includeonly>
 
Función que permite consultar la cantidad de folios disponibles
 

<big>''' Declaración '''</big>
<center>
<pre> INT FoliosRestantes (string URL, string tokenEmpresa, string tokenPassword, string otro, bool debugMode)</pre></center>

<big>''' String URLAdj'''</big>
 
*URL del servicio de carga de Adjuntos (Sin ?wsdl).
 

<big>''' String tokenEmpresa ''' </big>
 
*Token asignado por la plataforma de TFHKA.
 

<big>'''String tokenPassword'''</big>
 
*Token asignado por la plataforma de TFHKA.
 

<bi>''' String otro '''</big>
 
Actualmente en desuso, campo reservado para futuras versiones.
 

<big>'''String debugMode'''</big>
 
Flag para indicar a la dll que registre el log de debug en pruebas.
 

=== Respuesta método FoliosRestantes:===
Las respuestas se darán en un archivo de texto plano con nombre hkafact21fresult con la siguiente estructura:

:código|foliosRestantes|mensaje|resultados.
 
 
<includeonly>=</includeonly>== Método EnvioCorreoAdjuntos ==<includeonly>=</includeonly>
 
Función que permite reenviar el correo de notificación que se emite cuando se genera un documento electrónico con adjuntos
 

<big>''' Declaración '''</big>
<center>
<pre> INT EnvioCorreoAdjuntos (string URL, string tokenEmpresa, string tokenPassword, string documento,
string correo, string adjunto, bool debugMode)</pre></center>

<big>''' String URLAdj'''</big>
 
*URL del servicio de carga de Adjuntos (Sin ?wsdl).
 

<big>''' String tokenEmpresa ''' </big>
 
*Token asignado por la plataforma de TFHKA.
 

<big>'''String tokenPassword'''</big>
 
*Token asignado por la plataforma de TFHKA.
 

<big>''' String documento '''</big>
 
Prefijo y consecutivo del Documento electrónico concatenado sin separadores (Documento que se quiere reenviar).
 

<big>''' String correo'''</big>
 
Correo al cual se dese enviar el XML (AttachedDocument) y la Representación Gráfica Estándar si aplica.
 

<big>''' String adjunto'''</big>
 
Carácter que establece si el documento será reenviado con adjuntos. Valores posibles:
* “0” Realiza el reenvió del correo sin adjuntos
* “1” Realiza el reenvió del correo con los adjuntos almacenados durante la emisión del documento.

<big>'''String debugMode'''</big>
 
Flag para indicar a la dll que registre el log de debug en pruebas.
 

=== Respuesta método EnvioCorreoAdjuntos===
Las respuestas se darán en un archivo de texto plano con nombre hkafact21fresult con la siguiente estructura:

:código|mensaje|resultados.
 
'''Nota:''La dll también dispone del método EnvioCorreo, similar al anterior con la diferencia de que este no contiene el parámetro adjunto.
 
 
<includeonly>=</includeonly>== Método DescargarXML ==<includeonly>=</includeonly>
 
Función que permite descargar el XML Fiscal de un documento emitido previamente (solo el documento electrónico Invoice, CreditNote y DebitNote). El archivo XML es creado en el directorio local de la aplicación.
 

<big>''' Declaración '''</big>
<center>
<pre> INT DescargarXML (string URL, string tokenEmpresa, string tokenPassword, string documento, bool debugMode))</pre></center>

<big>''' String URLAdj'''</big>
 
*URL del servicio de carga de Adjuntos (Sin ?wsdl).
 

<big>''' String tokenEmpresa ''' </big>
 
*Token asignado por la plataforma de TFHKA.
 

<big>'''String tokenPassword'''</big>
 
*Token asignado por la plataforma de TFHKA.
 

<big>''' String documento '''</big>
 
Prefijo y consecutivo del Documento electrónico concatenado sin separadores (Documento que se quiere consultar).
 

<big>'''String debugMode'''</big>
 
Flag para indicar a la dll que registre el log de debug en pruebas.
 

=== Respuesta método DescargarXML ===
Las respuestas se darán en un archivo de texto plano con nombre hkafact21fresult con la siguiente estructura:

código|mensaje|resultados.
 
 
<includeonly>=</includeonly>== Método DescargarPDF ==<includeonly>=</includeonly>
 
Función que permite descargar la Representación Gráfica Estándar de un documento emitido previamente. El archivo PDF es creado en el directorio local de la aplicación.
 

<big>''' Declaración '''</big>
<center>
<pre>INT DescargarPDF (string URL, string tokenEmpresa, string tokenPassword, string documento, bool debugMode)</pre></center>

<big>''' String URLAdj'''</big>
 
*URL del servicio de carga de Adjuntos (Sin ?wsdl).
 

<big>''' String tokenEmpresa ''' </big>
 
*Token asignado por la plataforma de TFHKA.
 

<big>'''String tokenPassword'''</big>
 
*Token asignado por la plataforma de TFHKA.
 

<big>''' String documento '''</big>
 
Prefijo y consecutivo del Documento electrónico concatenado sin separadores (Documento que se quiere consultar).
 

<big>'''String debugMode'''</big>
 
Flag para indicar a la dll que registre el log de debug en pruebas.
 

=== Respuesta método DescargarPDF ===
Las respuestas se darán en un archivo de texto plano con nombre hkafact21fresult con la siguiente estructura:

código|mensaje|resultados.
 

'''@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).
 
 
<includeonly>=</includeonly>== Método GenerarContenedor ==<includeonly>=</includeonly>
 
Función que permite descargar el XML AttachedDocument de un documento emitido previamente (Este archivo contiene el XML de un documento electrónico (Invoice, CreditNote ó DebitNote) y todos los eventos (ApplicationResponse) generados hasta la fecha). El archivo XML es creado en el directorio local de la aplicación.
 

<big>''' Declaración '''</big>
<center>
<pre>INT GenerarContenedor (string URL, string tokenEmpresa, string tokenPassword, string documento, bool debugMode)</pre></center>

<big>''' String URLAdj'''</big>
 
*URL del servicio de carga de Adjuntos (Sin ?wsdl).
 

<big>''' String tokenEmpresa ''' </big>
 
*Token asignado por la plataforma de TFHKA.
 

<big>'''String tokenPassword'''</big>
 
*Token asignado por la plataforma de TFHKA.
 

<big>''' String documento '''</big>
 
Prefijo y consecutivo del Documento electrónico concatenado sin separadores (Documento que se quiere consultar).
 

<big>'''String debugMode'''</big>
 
Flag para indicar a la dll que registre el log de debug en pruebas.
 

=== Respuesta método GenerarContenedor ===
Las respuestas se darán en un archivo de texto plano con nombre hkafact21fresult con la siguiente estructura:

código|mensaje|Fecha|Hash|resultados.
 
 
<includeonly>=</includeonly>== Ejemplo Strings Método Enviar ==<includeonly>=</includeonly>
 
<center>
<pre>
* Url= http://demoemision21.thefactoryhka.com.co/ws/v1.0/Service.svc '
* TokenEmp='xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
* TokenPas='xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
</pre>
</center>
 
<big>'''GESTION DE STRINGS PARA PARAMETRO: datos_Cliente'''</big>
 
 
* ID01="01|Cristche|1|Evardho|ParedesMarquina|746260|31|email@gmail.com|3185853106|SI|0812|CHEV DEV|Cristche Paredes|cliente importante|0|123123123|||||"
* ID01A = "01A|0|email1@thefactoryhka.com;email2@gmail.com|2019-07-31 13:01:01|Mensaje programadito||1235467|||||"
* ID01B = "01B|01|||||"
* ID01E = "01E|1|Cristche Paredes|746260|0|456456|FE1|31"
* ID01F = "01F|O-13|04|||||"
* ID01C = "01C|Fulano|Sutano|1|POXBOX01|Principal|Los Chaimas|Bogotá, D.C.|11|-66.01|Bogotá|Soporte|Kr #71D 76-15|Los :Andes|Principal|es|11001|Chaima|16a|78|CO|2|sur|parcela||111061|||||"
* ID01D = "01D|Fulano|Sutano|1|POXBOX01|Principal|Los Chaimas|Bogotá, D.C.|11|-66.01|Bogotá|Soporte|Kr #71D 76-15|Los :Andes|Principal|es|11001|Chaima|16a|78|CO|2|sur|parcela||111061|||||"
:datos_Cliente = ID01 + "%" + ID01A + "%" + ID01B + "%" + ID01E + "%" + ID01F + "%%" + ID01C + "%%" + ID01D
 

<big>'''GESTION DE STRINGS PARA PARAMETRO: datos_factura'''</big>
 
 
* datos_factura= " 02|01|CONSECUTIVO|RANGO-CAMPODESDE|2019-11-29 00:00:00|2019-10-29|COP|0.00|0.00|5980.00|7116.20|2||||0.00|10|0.00|5980.00|7116.20|0.00|1|"
* **datos_factura ="02|01|CONSECUTIVO|RANGO-CAMPODESDE|2019-11-29 00:00:00|2019-10-29|COP|0.00|0.00|5980.00|7116.20|2||||0.00|10|0.00|5980.00|7116.20|0.00|1|2" (Con el campo tipoSector)
 

<big>'''GESTION DE STRINGS PARA PARAMETRO: anticAutorizado_CargDesc''''</big>
 
 
* ID02A = "02A|2019-07-21|2019-07-21|12:12:12|1|instruccion|||||" (No es obligatorio)
* ID02A = "02A|"
* ID02B = "02B|" (No es obligatorio para nada)
* ID02B = "02B|"
* ID02C = "02C|11|descripcion del descuento|0|100.00|1980.00|5.00|1|||||" (No es obligatorio)
* ID02C = "02C|"
* anticAutorizado_CargDesc = ID02A + "%%" + ID02B + "%%" + ID02C
 

<big>'''GESTION DE STRINGS PARA PARAMETRO: CP_DR''''</big>
 
 
* ID02D = "02D||nota en codicion de pago|10|1|2019-07-31|1|1|100.00|50.00|150.00|2019-07-21|2019-07-31|10.00|90.00|111222333" (No es obligatorio)
* ID02D = "02D|"
* ID02E="02E|6|4|4191110db1f3c8060a4ce34e40c6ec6541ac1bd248264624bfe1b60fdf02aea7e15c5a49969cc08f498b938a9e3cd954|2019-07-29|2019-07-29|2019-07-29|PRUE21|CUFE-SHA384|Factura de Ventas|01|||||| || ¬02E1|descipcion documento referenciado" (Condicionado)
* ID02E="02E|5|4|4191110db1f3c8060a4ce34e40c6ec6541ac1bd248264624bfe1b60fdf02aea7e15c5a49969cc08f498b938a9e3cd954|2019-07-29|2019-07-29|2019-07-29|PRUE21|CUFE-SHA384|Factura de Ventas|01|||||Copago|100.00|900895784 (con los campos conceptoRecaudo,monto,numeroIdentificacion)
* ID02E = "02E|"
* CP_DR = ID02D + "%%" + ID02E
 

<big>'''GESTION DE STRINGS PARA PARAMETRO: EntMerc'''</big>
 
 
* ID02F = "02F|2019-06-27 11:32:30|2019-06-29 11:32:30|2019-07-01 11:32:30|2019-07-01 11:32:30|1|ABCD123|||||"
* ID02F1 = "02F1|mail@gmail.com|1|1|Fulanito Gonzales|Pedrito Perez|Mercancia delicada|800123456|2|QWERT|PRUE|123456789|3451269|31|Juan Lopez|40012365|1|13|||||"
* ID02F1A = "02F1A|01|||||"
* ID02F1B = "02F1B|ResponsableEntrega|Sutano|1|POXBOX01|Principal|Los Chaimas|BOGOTÁ, D.C.|11|-66.01|Bogotá|Soporte|Kr #71D 76-15|Los Andes|Principal|es|11001|Chaima|16a|78|CO|2|sur|parcela||111061|||||"
* ID02F1C = "02F1C|O-12|04|||||"
* ID02F1D = "02F1D|TransportadorDireccion|Sutano|1|POXBOX01|Principal|Los Chaimas|BOGOTÁ, D.C.|11|-66.01|Bogotá|Soporte|Kr #71D 76-15|Los Andes|Principal|es|11001|Chaima|16a|78|CO|2|sur|parcela||111061|||||"
* ID02F2 = "02F2|direccionDespacho|Sutano|1|POXBOX01|Principal|Los Chaimas|BOGOTÁ, D.C.|11|-66.01|Bogotá|Soporte|Kr #71D 76-15|Los Andes|Principal|es|11001|Chaima|16a|78|CO|2|sur|parcela||111061|||||"
* ID02F3 = "02F3|direccionEntrega|Sutano|1|POXBOX01|Principal|Los Chaimas|BOGOTÁ, D.C.|11|-66.01|Bogotá|Soporte|Kr #71D 76-15|Los Andes|Principal|es|11001|Chaima|16a|78|CO|2|sur|parcela||111061|||||%02F3A|4|74|41|4|N|O|"
* EntMerc = ID02F + "%%" + ID02F1 + "%%" + ID02F1A + "%%" + ID02F1B + "%%" + ID02F1C + "%%" + ID02F1D + "%%" + ID02F2 + "%%" + ID02F3
 

<big>'''GESTION DE STRINGS PARA PARAMETRO: ImpuestosFactura'''</big>
 
 
* ID02G = "02G|1980|01||19.00|KGM|94|376.20|0.00|||||"
* ID02H ="02H|01|1136.20|||||0.00"
* **ID02H ="02H|01|1136.20||||||" (sin el campo redondeoAplicado)
* ImpuestosFactura = ID02G + "%%" + ID02H
 

<big>'''GESTION DE STRINGS PARA PARAMETRO: MPOCTE'''</big>
 
 
* ID02J = "02J|3356|0312|123QBCV|2019-01-01|10|1|Bancolombia|Referencia de pago 1|22|982467|||||"
* ID02K = "02K|987654|2019-04-29 00:00:00|1233456|321456|CUFE-SHA384|1|85b5cfa4-16af-48a0-9388-501e519ed659|||||" (No es obligatorio)
* ID02K = "02K|"
* ID02N = "02N|CFR|100.00|200311301|100.00|cliente|||||" (Condicionado)
* ID02N = "02N|"
* MPOCTE = ID02J + "%%" + ID02K + "%%" + ID02N
 

<big>'''GESTION DE STRINGS PARA PARAMETRO: TC_TCA_IA'''</big>
 
 
* ID02L = "02L|0000001.00|0000001.00|2019-01-01|123456|USD|COP|Division|000000.50|||||" (Condicionado)
* ID02L = "02L|"
* 'ID02M = "02M|0000001.00|0000001.00|2019-01-01|123456|USD|COP|Division|000000.50|||||" (No es obligatorio)
* ID02M = "02M|"
* 'ID02I = "02I|Informacion Adicional de Pruebita" (No es obligatorio)
* ID02I = "02I|"
* TC_TCA_IA = ID02L + "%%" + ID02M + "%%" + ID02I
 

<big>'''GESTION DE STRINGS PARA PARAMETRO: Extras'''</big>
 
 
* Extras = "04|||443|1|pedro picapiedra|1"
 

<big>'''GESTION DE STRINGS PARA PARAMETRO: DetalleDeFactura'''</big>
 
 
* ID03 = "03|1|1|94|1|||ABC123||Productico de prueba 1|primer producto para enviar al web service|999|||123||||||||0||nota en el producto01||2356.20|1980.00|1980.00|1|||||94||||||descripcion2|descripcion3||" (sin el campo idEsquema)
* ID03 = "03|1|1|94|1|||ABC123||Productico de prueba 1|primer producto para enviar al web service|999|||123||||||||0||nota en el producto01||2356.20|1980.00|1980.00|1|||||94||||||descripcion2|descripcion3|1" (con el campo idEsquema)
* 'ID03A = "03A|00|descuento comercial 123456789|0|0.00|0.00|0.00|1|||||"(Descuento en el detalle)
* ID03C = "03C|1980.00|01||19.00|KGM|94|376.20||||||"
* ID03D = "03D|01|376.20|||||0.00"
* ID03E = "03E|03|24350| |2500000|1|WSD "
* 'DetalleDeFactura = ID03 + "$$" + ID03A + "$$" + ID03C + "$$" + ID03D + "$$" + ID03E (con Descuento Detalle)
* DetalleDeFactura = ID03 + "$$" + ID03C + "$$" + ID03D + "$$" + ID03E
 

<big>'''GESTION DE STRINGS PARA PARAMETRO: SectorSalud'''</big>
 
 
* ID06= "06|01|SS-CUFE|2"
* ID06A= "06A|Fulano|Sutano|1|POXBOX01|Principal|Los Chaimas|Bogotá, D.C.|11|-66.01|Bogotá|Soporte|Kr #71D 76-15|Los Andes|Principal|es|11001|Chaima|16a|78|CO|2|sur|parcela||111061|||||"
 

<big><center>**Los camposGenerales se encuentran numerados según el orden establecido en la resolución 2275.</center></big>
 
<pre>ID06B = "06B|1|CODIGO_PRESTADOR"+ "%" + "06B|2||" + "%" + "06B|3||" + "%" + "06B|4||" + "%" + "06B|5||"+ "%" + "06B|6||" + "%" + "06B|7||" + "%" + "06B|8||" + "%" + "06B|9|MODALIDAD_PAGO" + "%" + "06B|10|COBERTURA_PLAN_BENEFICIOS" + "%" + "06B|11||" + "%" + "06B|12||" + "%" + "06B|13||" + "%" + "06B|14|NUMERO_CONTRATO" + "%" + "06B|15|NUMERO_POLIZA" + "%" + "06B|16|COPAGO" + "%" + "06B|17|CUOTA_MODERADORA" + "%" + "06B|18||" + "%" + "06B|19|PAGOS_COMPARTIDOS"</pre>
 

<big><center>*** Varios pacientes:</center></big>
 
<pre>ID06B = "06B|1|CODIGO_PRESTADOR"+ "%" + "06B|2||" + "%" + "06B|3||" + "%" + "06B|4||" + "%" + "06B|5||"+ "%" + "06B|6||" + "%" + "06B|7||" + "%" + "06B|8||" + "%" + "06B|9|MODALIDAD_PAGO" + "%" + "06B|10|COBERTURA_PLAN_BENEFICIOS" + "%" + "06B|11||" + "%" + "06B|12||" + "%" + "06B|13||" + "%" + "06B|14|NUMERO_CONTRATO" + "%" + "06B|15|NUMERO_POLIZA" + "%" + "06B|16|COPAGO" + "%" + "06B|17|CUOTA_MODERADORA" + "%" + "06B|18||" + "%" + "06B|19|PAGOS_COMPARTIDOS"</pre>
 
<pre>ID06B1 = "06B|1|CODIGO_PRESTADOR"+ "%" + "06B|2||" + "%" + "06B|3||" + "%" + "06B|4||" + "%" + "06B|5||"+ "%" + "06B|6||" + "%" + "06B|7||" + "%" + "06B|8||" + "%" + "06B|9|MODALIDAD_PAGO" + "%" + "06B|10|COBERTURA_PLAN_BENEFICIOS" + "%" + "06B|11||" + "%" + "06B|12||" + "%" + "06B|13||" + "%" + "06B|14|NUMERO_CONTRATO" + "%" + "06B|15|NUMERO_POLIZA" + "%" + "06B|16|COPAGO" + "%" + "06B|17|CUOTA_MODERADORA" + "%" + "06B|18||" + "%" + "06B|19|PAGOS_COMPARTIDOS"</pre>
 

<big><center>Pacientes= Concatenacion de todos los Pacientes separados por el caracter "¬"= ID06B + "¬" + ID06B1</center></big>
 
<pre>Pacientes= ID06B + "¬" + ID06B1
ID06C = "06C|||5170000|1|100.50|1"
SectorSalud= ID06 + "%" + ID06A + "%%" + Pacientes
</pre>
 
Adjuntos= "0"
 
'''Enviar (url, tokenEmp, tokenPas, datos_Cliente, Factura_Global, Antic_Autorizado_CargDesc, CondPago_DocReferencia, Entrega_Mercancia, Impuestos_Factura, MedPago_OC_TermEntrega, TasaCamb_TasaCambAlt_InfAdic, Extras, Detalle_De_Factura, Adjuntos, SectorSalud, debugMode)'''
 
 
<includeonly>=</includeonly>== Ejemplo Strings Método EnviarArchivo==<includeonly>=</includeonly>
 
<center>
<pre>
* Url= 'http://demoemision21.thefactoryhka.com.co/ws/adjuntos/Service.svc'
* TokenEmp='xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
* TokenPas='xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
</pre>
</center>
* Ndocumento = “PRUE1”
* Enviar = “1”
* Formato =”pdf”
* Nombre = “Adjunto”
* Tipo = “2”
* Email = “integracion_fel_co@thefactoryhka.com”
* Ruta = “C:\Adjunto.PDF”
 

<includeonly>=</includeonly>== Personalización del Correo ==<includeonly>=</includeonly>
 
El arreglo “extras” también permite manejar algunas funcionalidades especiales de la plataforma, como la de correo electrónico personalizado mediante el uso de los campos extensibles 11, 13 y 14. Para obtener más detalles, referirse al '''[https://felcowiki.thefactoryhka.com.co/index.php/Caracteristicas_adicionales_-_Indice_Manual_Integraci%C3%B3n_Directa#Correo_electr.C3.B3nico_personalizado MANUAL DE INTEGRACION DIRECTA (EMISIÓN - VAL. PREVIA)]''' sección ''PERSONALIZACIÓN DEL CORREO''
 
 
<includeonly>=</includeonly>== Generación De Notas Con Y Sin Referencia a Documentos ==<includeonly>=</includeonly>
 
En el anexo técnico V1.8 se plantea la emisión de notas de crédito y débito bajo los siguientes escenarios:
 

* Emisión de notas de Val. previa con referencia a facturas de Val. Previa
* Emisión de notas de Val. previa con referencia a facturas de Val. Posterior
* Emisión de notas de Val. previa sin referencia

Para ello se debe tener en cuenta la estructura de la clase documentosReferenciados y el campo tipoOperación para cada escenarios. Para obtener más detalles, referirse al '''[https://felcowiki.thefactoryhka.com.co/index.php/Caracteristicas_adicionales_-_Indice_Manual_Integraci%C3%B3n_Directa#GENERACI.C3.93N_DE_NOTAS_CON_Y_SIN_REFERENCIA_A_DOCUMENTO MANUAL DE INTEGRACION DIRECTA (EMISIÓN - VAL. PREVIA)]]''' sección ''GENERACIÓN DE NOTAS CON Y SIN REFERENCIA A DOCUMENTOS'' donde se ejemplifica cada uno de estos casos.
 
 
<includeonly>=</includeonly>== Transmisión De Documentos De Contingencia Tipo 03 ==<includeonly>=</includeonly>
 
La transmisión de documentos de contingencia está sujeta a la estructura de la clase documentosReferenciados y el campo tipoDocumento. Este escenario junto con las condiciones en las cuales aplica y la respuesta obtenida por parte de la DIAN se especifican en el '''[https://felcowiki.thefactoryhka.com.co/index.php/Caracteristicas_adicionales_-_Indice_Manual_Integraci%C3%B3n_Directa#TRANSMISI.C3.93N_DE_DOCUMENTOS_DE_CONTINGENCIA_TIPO_03_.28ATRIBUIBLE_AL_EMISOR.29 MANUAL DE INTEGRACION DIRECTA (EMISIÓN - VAL. PREVIA)]''' sección ''TRANSMISIÓN DE DOCUMENTOS DE CONTINGENCIA TIPO 03 (ATRIBUIBLE AL EMISOR)''.
 
 
<includeonly>=</includeonly>== Radicar Documentos Electrónicos En Plataformas De Recepción ==<includeonly>=</includeonly>
 
El XML que se debe radicar en las plataformas de recepción es el que envía nuestro servicio en la notificación de correo llamado '''AttachedDocument''' (Contenedor de Documentos), la estructura de este documento tiene por objetivo contener en un único archivo XML un documento electrónico (Invoice, CreditNote ó DebitNote) y todos los eventos (ApplicationResponse) registrados hasta la fecha, este XML también puede ser descargado a través del método '''GenerarContenedor'''.
 
La estructura de este archivo se ejemplifica en en el '''[https://felcowiki.thefactoryhka.com.co/index.php/Caracteristicas_adicionales_-_Indice_Manual_Integraci%C3%B3n_Directa#Radicar_documentos_electr.C3.B3nicos_en_plataformas_de_recepci.C3.B3n MANUAL DE INTEGRACION DIRECTA (EMISIÓN - VAL PREVIA)]''' sección ''RADICAR DOCUMENTOS ELECTRÓNICOS EN PLATAFORMAS DE RECEPCIÓN''
 
 
<includeonly>=</includeonly>== Ambiente De Habilitación ==<includeonly>=</includeonly>
 
El ambiente de pruebas liberado (ambiente demo) corresponde a un entorno de pruebas propio del proveedor tecnológico ('''The Factory HKA''') con el objetivo de que los desarrolladores y Casas de Software puedan realizar pruebas de los ajustes realizados a los ERP bajo el modelo de facturación con validación previa. Las pruebas realizadas en este ambiente NO serán enviadas al web service de habilitación de la DIAN.

 
 
 
 

<center>'''<big>[[Archivo:Copyright.png|100px|sinmarco|centro|Copyright]]THE FACTORY HKA COLOMBIA</big>
 Copyright © 2016 The Factory HKA. Todos los derechos reservados.</center>

 

{{clear}}

RIPS:Carga Masiva

2025-12-23T19:07:05Z

Dmrodriguez2:

__NOTOC__

{| style="width:35%; float:right; margin-left:1em; border:1.5px solid #7B68EE; border-radius:10px; background:#E6E6FA; padding:10px; font-size:95%;"
! style="background:#894DFA; color:white; text-align:center; border-radius:8px;" | 🧭 Navegación por esta página
|-
|
1. Use el menú a su derecha para ir directamente a la sección deseada. 
2. En cada sección encontrará una ⬆️ que lo regresa al menú de esta página. 
3. Al final de la página encontrará una 🏠, que también lo lleva al menú de esta página. 
4. El botón

← Regresar
 lo llevará al menú principal de RIPS.
|}


{| style="width:25%; margin:left; border:2px solid #4A90E2; border-radius:10px; background:#f0f8ff; padding:10px; font-size:95%;"
|-
|
📘 Menú de Carga Masiva 

🟢 1- [[#Descripcion|Descripción de la funcionalidad: “Carga Masiva”]] 
📥 2- [[#Descarga|Descarga de la plantilla para Carga Masiva]] 
⚙️ 3- [[#Macros|Habilitar Macros de Plantilla]] 
📂 4- [[#PlantillaRIPS|Plantilla para la carga masiva de RIPS (TFHKA)]] 
     🗂 4.1- [[#Plantilla|Estructura de la plantilla]] 
     💡 4.2- [[#Recomendaciones|Recomendaciones]] 
     ℹ️ 4.3- [[#InfoGeneral|Información General]] 
         📊 4.3.1- [[#Transaccion|Pestaña “TRANSACCIÓN”]] 
         👤 4.3.2- [[#Usuarios|Pestaña “USUARIOS”]] 
         🏥 4.3.3- [[#Consultas|Pestaña “CONSULTAS”]] 
         ⚕️ 4.3.4- [[#Consultas|Pestaña “PROCEDIMIENTOS”]] 
     ℹ️ 4.4- [[#FlujoCargaRIPS|Explicación del flujo de la plantilla de carga masiva de RIPS]] 
📂 5- [[#CargaArchivoRIPS|Carga del archivo RIPS]] 
|}

== 📦 Carga Masiva [[#MenuCargaMasiva|⬆️]]==


<div style="background-color:#f4faff; border:1px solid #c0dffb; padding:15px; border-radius:8px;">

 ✨ Gestión de RIPS de forma fácil 
📌 Hemos incorporado en nuestro portal la nueva funcionalidad "Cargas Masivas".
 
<table class="tabla-rips" style="width:100%; border-collapse:collapse; border:none; background:none;">
<tr>
<td style="width:35%; vertical-align:top; text-align:center; padding:10px; border:none; background:none;">
<div style="display:inline-block; border: 1px solid #c0dffb; border-radius: 8px; padding:10px; background-color:#f4faff; box-shadow: 2px 2px 8px rgba(0,0,0,0.1);">
[[Archivo:rips68.png|300px|center|alt=Acceso a carga masiva en el menú RIPS]]
</div>
</td>
<td style="width:65%; vertical-align:top; padding:10px; font-size:14px; line-height:1.5; color:#333; border:none; background:none;">
 
¿Qué es la carga masiva? Este proceso permite enviar de una sola vez la información de uno o varios RIPS, incluyendo datos de pacientes y servicios prestados, a través de un archivo en el formato establecido. 

Beneficios principales: ✅ Ahorro de tiempo al evitar el ingreso manual de cada registro. ✅ Reducción de errores en la digitación de datos. ✅ Mayor eficiencia en el cumplimiento de los reportes exigidos por el Ministerio de Salud. Usos comunes: 🔹 Reportar RIPS con factura, relacionando los datos que están dentro de la Factura Electrónica según el escenario correspondiente. 🔹 Reportar RIPS sin factura, vinculando la información con el número de nota. 🔹 Facilitar el envío de grandes volúmenes de información de forma organizada y segura. 
En la parte izquierda del menú, se encuentra la sección RIPS. Desplegamos esta sección y debajo de ella se ven las distintas subsecciones; dentro de ellas está Carga Masiva, la cual se indica en la imagen de la izquierda ←
</td>
</tr>
</table>


= 📂 Descarga de la plantilla para Cargas Masivas [[#MenuCargaMasiva|⬆️]] =


Al ingresar al módulo Cargas Masivas, se visualizará una tarjeta como la mostrada en la imagen:

<div style="text-align:center;">
<div style="display:inline-block; border: 1px solid #c0dffb; border-radius: 8px; padding:10px; background-color:#f4faff; box-shadow: 2px 2px 8px rgba(0,0,0,0.1);">
[[Archivo:rips69.png|600px]]
</div>
</div>

*📌 En el lado izquierdo se encuentra el ícono de descarga y, en el lado derecho, el botón “Descargar Plantilla”.

*📥 Al seleccionar este botón, se descargara la plantilla oficial en formato .xlsm (libro de Excel habilitado para macros).

*✅ Esta plantilla ya incluye la columna obligatoria <code>ripsId</code>, lo que facilita la consolidación correcta de la información de los RIPS antes de su envío.

 
<div style="display: flex; flex-wrap: wrap; justify-content: center; align-items: center; gap: 20px; padding: 20px; max-width: 1200px; margin: 0 auto;">
<div style="display: flex; justify-content: center; align-items: center; width: 100%; max-width: 430px; min-width: 280px; height: 320px; border: 1px solid #c0dffb; border-radius: 8px; padding: 8px; background-color: #f4faff; box-shadow: 2px 2px 8px rgba(0,0,0,0.1); box-sizing: border-box;">
[[Archivo:rips71.png|400px|center|alt=Descripción imagen 1]]
</div>
<div style="display: flex; justify-content: center; align-items: center; width: 100%; max-width: 430px; min-width: 280px; height: 320px; border: 1px solid #c0dffb; border-radius: 8px; padding: 8px; background-color: #f4faff; box-shadow: 2px 2px 8px rgba(0,0,0,0.1); box-sizing: border-box;">
[[Archivo:rips70.png|400px|center|alt=Descripción imagen 2]]
</div>
</div>

📍 Ubicación del archivo descargado: 
De forma predeterminada, el archivo se almacena en la carpeta Descargas del equipo.
En caso de que el navegador solicite una ubicación, podrá elegirse cualquier carpeta de preferencia.

<div style="background-color:#E6F7FF; border:1px dashed #7AA0FF; border-radius:6px; padding:10px; margin-top:10px; font-size:13px; color:#333;">
ℹ️ Nota sobre el formato .xlsm:
Este formato corresponde a un archivo de Microsoft Excel que, además de hojas y fórmulas, puede contener macros 🛠️ (pequeños programas o automatizaciones que agilizan tareas repetitivas).
Este tipo de archivo resulta útil para validar datos, aplicar formatos predefinidos y asegurar que la información cumpla con la estructura requerida antes de su carga al sistema.
</div>

<div style="margin:1.5em 0;"></div>

<div style="border:2px solid #7AA0FF; border-radius:8px; padding:15px; background-color:#F4FAFF; font-family:Arial, sans-serif; font-size:14px; line-height:1.5;">

= 📂 Abrir la plantilla y habilitar macros [[#MenuCargaMasiva|⬆️]] =


<table style="width:100%; border-collapse:collapse; border:none; background:none;">
<tr>

<td style="width:50%; vertical-align:top; padding-right:20px;">


1️⃣ Abrir el archivo: 
- Localice el archivo descargado .xlsm en su carpeta Descargas (o en la ubicación que haya elegido). 
- Puede abrirlo haciendo doble clic sobre el archivo o con clic derecho → Abrir. 

2️⃣ Habilitar macros para su uso: 
Al abrirlo, Excel puede mostrar una franja amarilla en la parte superior con el mensaje “Habilitar contenido”. 
➡️ Haga clic en Habilitar contenido para activar las macros y permitir que la plantilla funcione correctamente. 

💡 Nota: Si no aparece la franja amarilla, puede habilitar las macros manualmente: 
1. Vaya a Archivo → Opciones. 
2. Seleccione Centro de confianza → Configuración del Centro de confianza. 
3. Abra Configuración de macros y elija Deshabilitar con notificación o Habilitar todas las macros. 
</td>

<td style="width:50%; text-align:center; vertical-align:middle;">
<div style="overflow-x: auto; margin: 20px 0;">
<div style="display: flex; justify-content: center; align-items: center; width: 100%; padding: 10px; min-width: 820px;">
<div style="display: inline-flex; justify-content: center; align-items: center; border: 1px solid #c0dffb; border-radius: 8px; padding: 8px; background-color: #ffffff; box-shadow: 2px 2px 8px rgba(0,0,0,0.1);">
[[Archivo:rips72.png|800px|center|alt=Abrir plantilla y habilitar macros]]
</div>
</div>
</div>
</td>
</tr>
</table>


<div style="border:1px solid #FF9999; border-radius:6px; background-color:#FFF5F5; padding:8px; color:#B22222; margin-top:10px;">
⚠️ Advertencia de seguridad: Solo habilite macros en archivos provenientes de fuentes confiables. Las macros pueden ejecutar código que modifique o dañe su equipo.
</div>

</div>

<div style="margin:2.5em 0;"></div>



= 🏥 Plantilla para la carga masiva de RIPS (TFHKA) [[#MenuCargaMasiva|⬆️]] =

La '''Plantilla TFHKA''' es un archivo de Excel con macros habilitadas (''.xlsm'') diseñado de acuerdo con la '''Resolución 2275 de 2023''' del Ministerio de Salud y Protección Social.

📌 Esta plantilla funciona como '''herramienta de apoyo para la carga masiva de RIPS''':
en lugar de registrar uno por uno en el portal, permite consolidar la información en un solo archivo y cargarla de forma más rápida y ordenada.
 
{{{!}} style="background:#e8f6ef; border:1px solid #00897b; border-radius:8px; width:100%;"
|-
! ⚠️ Importante
| Por '''cada factura de venta''' se debe diligenciar un archivo de la plantilla.
En ese archivo se relacionan todos los '''RIPS''' asociados a la factura.
{{!}}}


=== 📑 Estructura de la plantilla ===

La plantilla contiene '''9 pestañas''', cada una dedicada a un tipo específico de información:

• 📄 Transacción: Se registran los datos generales de la factura: NIT de la entidad, número de factura y, si aplica, el tipo y número de nota (crédito, débito o ajuste).

• 🧑‍🤝‍🧑 Usuarios: Aquí va la información de los pacientes: tipo y número de identificación, fecha de nacimiento, sexo y condición del usuario.

• 👩‍⚕️ Consultas: Se detallan las atenciones médicas, odontológicas, de enfermería y de otros profesionales de la salud.

• 🚑 Urgencias: Aquí se registran las atenciones de urgencia que implicaron observación del paciente.

• 🔬 Procedimientos: Se incluyen los procedimientos diagnósticos, terapéuticos, quirúrgicos, no quirúrgicos y la aplicación de vacunas.

• 🏥 Hospitalización: Registra los datos sobre la estancia del usuario en servicios de hospitalización.

• 👶 Recién Nacidos: Se diligencia cuando se atienden partos o cesáreas, registrando la información del recién nacido vinculada a la factura de la madre.

• 💊 Medicamentos: Aquí se reportan los medicamentos administrados o dispensados, indicando código, cantidad y valor.

• 🛠️ Otros Servicios: Se registran los servicios complementarios facturados: dispositivos médicos, insumos, honorarios profesionales, estancias adicionales y traslados.

<div style="text-align:center; margin:20px 0;">
<div style="display:inline-block; border:1px solid #c0dffb; border-radius:8px; padding:10px; background-color:#f4faff; box-shadow:2px 2px 8px rgba(0,0,0,0.1);">
[[Archivo:rips73.png|thumb|800px]]
</div>
</div>

<div style="border:1px solid #7e57c2; background:#f3e5f5; padding:12px; border-radius:8px; font-size:95%;">
✨ Con esta plantilla, la información de los RIPS queda organizada de forma estandarizada, reduciendo errores y agilizando la validación frente a la normatividad vigente.
</div>


<div style="margin:2em 0;"></div>


== 📝 Recomendaciones [[#MenuCargaMasiva|⬆️]] ==

{| style="width:100%; border-collapse:separate; border-spacing:15px;"

| style="background:#FFF7E6; border:2px solid #FFD966; border-radius:12px; padding:18px; box-shadow:2px 2px 6px #ccc; text-align:justify; width:45%;" |
📂 '''Archivo a cargar''' 
• Formato obligatorio: '''XLSM''' (Excel con macros). 
• Tamaño máximo permitido: '''3 MB'''.

| style="background:#FFF0E6; border:2px solid #FFB366; border-radius:12px; padding:18px; box-shadow:2px 2px 6px #ccc; text-align:justify; width:45%;" |
🔑 '''Campo <code>ripsId</code>''' 
• Es una columna adicional que conecta ''Transacción'', ''Usuarios'' y ''Servicios''. 
• '''Crear RIPS nuevos:''' use números consecutivos (1, 2, 3…). 
👉 Cada transacción debe tener al menos un usuario, y cada usuario y servicio debe estar vinculado con el mismo <code>ripsId</code>.

|-
| style="background:#E6F5FF; border:2px solid #A3D9FF; border-radius:12px; padding:18px; box-shadow:2px 2px 6px #ccc; text-align:justify; width:45%;" |
⚙️ '''Diligenciamiento paso a paso''' 
1️⃣ Inicie en la pestaña '''Transacción''' (factura asociada). 
2️⃣ Complete la pestaña '''Usuarios''' (datos del paciente). 
3️⃣ Diligencie las pestañas de '''Servicios''' (consultas, urgencias, medicamentos, hospitalización, etc.).

| style="background:#F2FAE6; border:2px solid #B6E6A1; border-radius:12px; padding:18px; box-shadow:2px 2px 6px #ccc; text-align:justify; width:45%;" |
🗂️ '''Orden sugerido''' 
• Seleccionar <code>consecutivoUsuario</code>. 
• Diligenciar los demás campos.

|}

<div style="font-size: 14px; line-height: 1.6em;">

<div style="margin:2em 0;"></div>


= Información General [[#MenuCargaMasiva|⬆️]] =
ℹ️ En las secciones siguientes se presenta la explicación de las tres primeras pestañas de la plantilla —Transacciones, Usuarios y Consultas— junto con cuatro campos de la pestaña de Procedimientos que difieren de los de Consultas.

A continuación, se detallan los campos de estas pestañas, con ejemplos que facilitan su comprensión y diligenciamiento.

Las demás pestañas conservan la misma dinámica de registro, por lo que su uso resulta sencillo e intuitivo siempre que se cuente con la información necesaria.

<div style="margin:1em 0;"></div>

La plantilla que se utiliza corresponde a la definida por el Ministerio de Salud ([https://fevrips.sispro.gov.co/SPConvertidorJSON plantilla_fev-rips_v 1_0]), con algunas columnas adicionales que hemos incluido para facilitar la identificación de los datos al momento de realizar la carga en el portal.

<div style="margin:1em 0;"></div>

Toda la información registrada se basa en el Anexo Técnico de RIPS:
''[https://www.minsalud.gov.co/sites/rid/Lists/BibliotecaDigital/RIDE/DE/DIJ/resolucion-2275-de-2023.pdf Resolución 2275 del 28 de diciembre de 2023]'' – ''[https://www.minsalud.gov.co/sites/rid/Lists/BibliotecaDigital/RIDE/DE/DIJ/resolucion-1884-de-2024.pdf Resolución 1884 del 30 de septiembre de 2024]'', conforme al lineamiento oficial más reciente – [https://www.minsalud.gov.co/sites/rid/Lists/BibliotecaDigital/RIDE/DE/OT/lineamientos-generacion-validacion-rips-factura-electronica-fev-doc-electronicos.pdf versión 3.2].

<div style="margin:1.5em 0;"></div>

<div style="border:2px solid #dcd6f7; background:#fcfbff; border-radius:12px; padding:12px; box-shadow:0 1px 4px rgba(0,0,0,0.08);">

<div style="font-size:16px; font-weight:bold; color:#20C997; margin:0.5em 0;">📑 '''TRANSACCIÓN'''</div>

<div style="text-align:center; margin:1em 0;">
<div style="display:inline-block; border:2px solid #20C997; background:#f9fdfb; padding:6px; border-radius:10px; box-shadow:0 2px 6px rgba(0,0,0,0.1);">
[[Archivo:Rips74.png|600px]]
</div>
</div>
<div style="margin:2em 0;"></div>
{| class="mw-collapsible mw-collapsed" style="margin:auto; width:95%; border:1.5px solid #4A90E2; border-radius:8px; background:#f9fbff;"
! style="background:#4A90E2; color:white; text-align:center; border-top-left-radius:8px; border-top-right-radius:8px;" | Campos de la pestaña Transacciones
|-
| style="padding:5px;" |

* 🟢 → Campo: <code style="color:#B266FF;">'''numDocumentoIdObligado'''</code> 
Número de identificación del prestador de servicios de salud. Permite asociar correctamente todas las transacciones con la entidad que reporta.

* 🟢 → Campo: <code style="color:#B266FF;">'''numFactura'''</code> 
Número de la factura cuando el RIPS está asociado a una Factura Electrónica de Venta (FEV). Ejemplo: `FEV123`. Si no hay factura, no se diligencia.

* 🟢 → Campo: <code style="color:#B266FF;">'''tipoNota'''</code> 
Se diligencia cuando el RIPS corresponde a un registro sin factura. Opciones disponibles:

{| class="mw-collapsible mw-collapsed" style="margin:auto; text-align:center; width:28%; font-size:85%; border:1.5px solid #2B6CB0; border-radius:6px; background:#fdfefe; border-spacing:0;"
! style="background:#2B6CB0; color:white; padding:3px; width:30%; border-top-left-radius:6px;" | Código
! style="background:#2B6CB0; color:white; padding:3px; width:70%; border-top-right-radius:6px;" | Descripción
|-
| '''NA''' || Nota de Ajuste
|-
| '''NC''' || Nota Crédito
|-
| '''ND''' || Nota Débito
|-
| '''RS''' || RIPS sin factura
|}

* 🟢 → Campo: <code style="color:#B266FF;">'''numNota'''</code> 
Número consecutivo (1,2,3,…) cuando se envían RIPS sin factura electrónica. Aplica en casos de EOSD o Profesionales Independientes que no están obligados a facturar.

* 🟢 → Campo: <code style="color:#B266FF;">'''ripsId'''</code> 
Identificador que enlaza las pestañas "Transacciones", "Usuarios" y "Servicios". Cada número consecutivo asegura correcta relación entre registros.
|}

</div>
<div style="margin:1.5em 0;"></div>
<div style="border:2px solid #dcd6f7; background:#fcfbff; border-radius:12px; padding:12px; box-shadow:0 1px 4px rgba(0,0,0,0.08);">

<div style="font-size:16px; font-weight:bold; color:#20C997; margin:0.5em 0;">👤 '''USUARIOS'''</div>

<div style="text-align:center; margin:1em 0;">
<div style="display:inline-block; border:2px solid #20C997; background:#f9fdfb; padding:6px; border-radius:10px; box-shadow:0 2px 6px rgba(0,0,0,0.1);">
[[Archivo:Rips78.png|1000px]]
</div>
</div>

<div style="margin:2em 0;"></div>

En esta pestaña se guardan los datos básicos del usuario: identificación, información personal y administrativa que permiten reconocerlo dentro de los RIPS. Si se llena bien, cada atención quedará vinculada al paciente correcto.

<div style="margin:2em 0;"></div>

<div style="border:1.5px solid #E6A400; background:#FFF8E5; padding:8px; border-radius:8px; width:60%; margin:auto; text-align:center; font-size:90%;">
⚠️ Nota: Verifique que la fecha de nacimiento coincida con el tipo de documento según la edad del usuario.
</div>

<div style="margin:1.5em 0;"></div>

{| class="mw-collapsible mw-collapsed" style="margin:auto; width:95%; border:1.5px solid #4A90E2; border-radius:8px; background:#f9fbff;"
! style="background:#4A90E2; color:white; text-align:center; border-top-left-radius:8px; border-top-right-radius:8px;" | Campos de la pestaña Usuarios
|-
| style="padding:5px;" |

* 🟢 → Campo: <code style="color:#B266FF;">'''TipoDocumentoIdentificacion'''</code> 
Seleccione el tipo de documento del usuario desde la lista desplegable. Para elegir correctamente, consulte la tabla con cada código y su significado.

{| class="mw-collapsible mw-collapsed" style="margin:auto; text-align:left; width:30%; font-size:80%; border:1.5px solid #4A90E2; border-radius:8px; background:#f9fbff; border-spacing:0;"
! colspan="2" style="background:#4A90E2; color:white; text-align:center; border-top-left-radius:8px; border-top-right-radius:8px; border:none;" | Tipos de Documento
|-
| style="border:none; padding:3px;" | '''AS''' || style="border:none; padding:3px;" | Adulto sin identificación
|-
| style="border:none; padding:3px;" | '''CC''' || style="border:none; padding:3px;" | Cédula de Ciudadanía
|-
| style="border:none; padding:3px;" | '''CD''' || style="border:none; padding:3px;" | Carnet Diplomático
|-
| style="border:none; padding:3px;" | '''CE''' || style="border:none; padding:3px;" | Cédula de Extranjería
|-
| style="border:none; padding:3px;" | '''CN''' || style="border:none; padding:3px;" | Certificado de nacido vivo
|-
| style="border:none; padding:3px;" | '''DE''' || style="border:none; padding:3px;" | Documento extranjero
|-
| style="border:none; padding:3px;" | '''MS''' || style="border:none; padding:3px;" | Menor sin identificación
|-
| style="border:none; padding:3px;" | '''NI''' || style="border:none; padding:3px;" | Número de Identificación Tributario (NIT)
|-
| style="border:none; padding:3px;" | '''NV''' || style="border:none; padding:3px;" | Certificado nacido vivo
|-
| style="border:none; padding:3px;" | '''PA''' || style="border:none; padding:3px;" | Pasaporte
|}

* 🟢 → Campo: <code style="color:#B266FF;">'''numDocumentoIdentificacion'''</code> 
Número de identificación del usuario, según el tipo de documento seleccionado.

* 🟢 → Campo: <code style="color:#B266FF;">'''NumDocumentoIdObligado'''</code> 
Este campo replica la información registrada en <code>numDocumentoIdObligado</code> de la pestaña ''TRANSACCIÓN''.

* 🟢 → Campo: <code style="color:#B266FF;">'''tipoUsuario'''</code> 
Seleccione de la lista desplegable el tipo de usuario correspondiente. Las opciones disponibles se encuentran en la tabla siguiente:

{| class="mw-collapsible mw-collapsed" style="margin:auto; text-align:left; width:30%; font-size:80%; border:1.5px solid #4A90E2; border-radius:8px; background:#f9fbff; border-spacing:0;"
! colspan="2" style="background:#4A90E2; color:white; text-align:center; border-top-left-radius:8px; border-top-right-radius:8px; border:none;" | Tipos de Usuario
|-
| style="border:none; padding:3px; width:20%;" | '''01''' || style="border:none; padding:3px;" | Contributivo cotizante
|-
| style="border:none; padding:3px;" | '''02''' || style="border:none; padding:3px;" | Contributivo beneficiario
|-
| style="border:none; padding:3px;" | '''03''' || style="border:none; padding:3px;" | Contributivo adicional
|-
| style="border:none; padding:3px;" | '''04''' || style="border:none; padding:3px;" | Subsidiado
|-
| style="border:none; padding:3px;" | '''05''' || style="border:none; padding:3px;" | No afiliado
|-
| style="border:none; padding:3px;" | '''06''' || style="border:none; padding:3px;" | Especial o Excepción cotizante
|-
| style="border:none; padding:3px;" | '''07''' || style="border:none; padding:3px;" | Especial o Excepción beneficiario
|-
| style="border:none; padding:3px;" | '''08''' || style="border:none; padding:3px;" | Personas privadas de la libertad a cargo del Fondo Nacional de Salud
|-
| style="border:none; padding:3px;" | '''09''' || style="border:none; padding:3px;" | Tomador / Amparado ARL
|-
| style="border:none; padding:3px;" | '''10''' || style="border:none; padding:3px;" | Tomador / Amparado SOAT
|-
| style="border:none; padding:3px;" | '''11''' || style="border:none; padding:3px;" | Tomador / Amparado Planes voluntarios de salud
|-
| style="border:none; padding:3px;" | '''12''' || style="border:none; padding:3px;" | Particular
|-
| style="border:none; padding:3px;" | '''13''' || style="border:none; padding:3px;" | Especial o Excepción no cotizante Ley 352 de 1997
|}

* 🟢 → Campo: <code style="color:#B266FF;">'''fechaNacimiento'''</code> 
Ingrese la fecha en el formato '''AAAA-MM-DD'''. Ejemplo: <code>2002-07-11</code>.

* 🟢 → Campo: <code style="color:#B266FF;">'''codSexo'''</code> 
Seleccione el sexo de la persona: '''M''' = Masculino · '''F''' = Femenino · '''I''' = Indeterminado / Intersexual

* 🟢 → Campo: <code style="color:#B266FF;">CodPaisResidencia</code> 
Corresponde al código del país de residencia habitual. Por defecto se puede seleccionar el código '''170 (Colombia)'''. Más info: '''[[Media:Pais.xlsx|País]]''' o '''[https://web.sispro.gov.co/WebPublico/Consultas/ConsultarDetalleReferenciaBasica.aspx?Code=Pais SISPRO: País]'''.

* 🟢 → Campo: <code style="color:#B266FF;">'''codMunicipioResidencia'''</code> 
Registre el código del municipio donde la persona ha residido la mayor parte del último año. Referencia: '''[[Media:municipio.xlsx|Municipios]]''' o portal SISPRO: [https://web.sispro.gov.co/WebPublico/Consultas/ConsultarDetalleReferenciaBasica.aspx?Code=Municipio Municipio].

* 🟢 → Campo: <code style="color:#B266FF;">'''codZonaTerritorialResidencia'''</code> 
Indica la zona de residencia según el DANE. Opciones en tabla:

{| class="mw-collapsible mw-collapsed" style="margin:auto; text-align:left; width:30%; font-size:80%; border:1.5px solid #4A90E2; border-radius:8px; background:#f9fbff; border-spacing:0;"
! colspan="2" style="background:#4A90E2; color:white; text-align:center; border-top-left-radius:8px; border-top-right-radius:8px; border:none;" | Zona Territorial
|-
| style="border:none; padding:3px;" | '''01''' || style="border:none; padding:3px;" | Rural
|-
| style="border:none; padding:3px;" | '''02''' || style="border:none; padding:3px;" | Urbano
|}

* 🟢 → Campo: <code style="color:#B266FF;">'''Incapacidad'''</code> 
Seleccione ''SI'' o ''NO''. Dato soportado en el RIPS.

* 🟢 → Campo: <code style="color:#B266FF;">'''codPaisOrigen'''</code> 
Código del país de nacimiento, por ejemplo ''170'' = Colombia.

* 🟢 → Campo: <code style="color:#B266FF;">'''consecutivo'''</code> 
Número que identifica cada registro, inicia en 1 y aumenta de uno en uno.

* 🟢 → Campo: <code style="color:#B266FF;">'''nombre'''</code> 
Nombre del usuario según documento, sin abreviaturas ni caracteres especiales.

* 🟢 → Campo: <code style="color:#B266FF;">'''apellido'''</code> 
Apellido según documento.

* 🟢 → Campo: <code style="color:#B266FF;">'''ripsId'''</code> 
Identificador que enlaza las pestañas "Transacción", "Usuarios" y "Servicios". Cada número consecutivo asegura correcta relación entre registros.
|}
</div>
<div style="margin:1.5em 0;"></div>
<div style="border:2px solid #dcd6f7; background:#fcfbff; border-radius:12px; padding:12px; box-shadow:0 1px 4px rgba(0,0,0,0.08);">

<div style="font-size:16px; font-weight:bold; color:#20C997; margin:0.5em 0;">🩺 '''CONSULTAS'''</div>

<div style="margin:2em 0;"></div>

{| class="mw-collapsible mw-collapsed" style="margin:auto; width:95%; border:1.5px solid #4A90E2; border-radius:8px; background:#f9fbff;"
! style="background:#4A90E2; color:white; text-align:center; border-top-left-radius:8px; border-top-right-radius:8px;" | Campos de la pestaña Consultas
|-
| style="padding:5px;" |

* 🟢 → Campo: <code style="color:#B266FF;">'''num_DocumentoIdObligado'''</code> 
Este valor se completa con el número de identificación del prestador, traído desde la pestaña '''Transacción'''.

* 🟢 → Campo: <code style="color:#B266FF;">'''consecutivoUsuario'''</code> 
Digite aquí el consecutivo asignado en la pestaña '''Usuarios'''.
Al ingresarlo, automáticamente se relaciona con '''num_DocumentoIdObligado''', enlazando ambas pestañas.

* 🟢 → Campo: <code style="color:#B266FF;">'''CodPrestador'''</code> 
Ingrese el código que el Ministerio de Salud y Protección Social asignó al prestador de servicios de salud o al responsable de reportar.
Este código se vincula automáticamente con '''numDocumentoIdObligado''', asegurando la relación correcta entre la información del prestador y los datos del obligado.

* 📅 → Campo: <code style="color:#B266FF;">'''FechaInicioAtencion'''</code> 
Digite la fecha y hora en que se realizó la consulta o atención.
Esta fecha no puede ser posterior al momento de validación de los RIPS, ni anterior a la fecha de nacimiento del usuario, y debe estar dentro del periodo de facturación registrado en la factura electrónica.
Formato: '''aaaa-mm-dd hh:mm''' (ejemplo: 2025-07-19 00:00).

* 🟢 → Campo: <code style="color:#B266FF;">'''numAutorizacion'''</code> 
Ingrese el número que la entidad responsable de pago asignó para autorizar la prestación del servicio o la provisión de la tecnología de salud.
Si el servicio no requiere autorización, registre '''NA''' (no aplica).

* 📄 → Campo: <code style="color:#B266FF;">'''codConsulta'''</code> 
Digite el código de la consulta según la Clasificación Única de Procedimientos en Salud ⇒ CUPS. Puede consultar la tabla oficial en SISPRO: '''[https://web.sispro.gov.co/WebPublico/Consultas/ConsultarDetalleReferenciaBasica.aspx?Code=CUPSRips CUPSRips]''' O descargarla directamente del archivo: '''[[Media:CUPSRips.xlsx|CUPSRips]]'''

* 🟢 → Campo: <code style="color:#B266FF;">'''modalidadGrupoServicioTecSalud'''</code> 
Digite el código que indica la forma en que se presta el servicio de salud dentro de un grupo de servicios. Puede guiarse con la tabla oficial:
{| class="mw-collapsible mw-collapsed" style="margin:auto; text-align:left; width:30%; font-size:80%; border:1.5px solid #4A90E2; border-radius:8px; background:#f9fbff; border-spacing:0;"
! colspan="2" style="background:#4A90E2; color:white; text-align:center; border-top-left-radius:8px; border-top-right-radius:8px;" | Modalidad de Servicio
|-
| style="border:none; padding:5px 10px;" | '''01''' || style="border:none; padding:3px;" | Intramural
|-
| style="border:none; padding:5px 10px;" | '''02''' || style="border:none; padding:3px;" | Extramural unidad móvil
|-
| style="border:none; padding:5px 10px;" | '''03''' || style="border:none; padding:3px;" | Extramural domiciliaria
|-
| style="border:none; padding:5px 10px;" | '''04''' || style="border:none; padding:3px;" | Extramural jornada de salud
|-
| style="border:none; padding:5px 10px;" | '''06''' || style="border:none; padding:3px;" | Telemedicina interactiva
|-
| style="border:none; padding:5px 10px;" | '''07''' || style="border:none; padding:3px;" | Telemedicina no interactiva
|-
| style="border:none; padding:5px 10px;" | '''08''' || style="border:none; padding:3px;" | Telemedicina telexperticia
|-
| style="border:none; padding:5px 10px;" | '''09''' || style="border:none; padding:3px;" | Telemedicina telemonitoreo
|}

* 🟢 → Campo: <code style="color:#B266FF;">'''grupoServicios'''</code> 
Digite el código que identifica un conjunto de servicios relacionados entre sí, que comparten similitudes en la forma de prestación y cumplen los mismos estándares.
Puede guiarse con la tabla:
{| class="mw-collapsible mw-collapsed" style="margin:auto; text-align:left; width:30%; font-size:80%; border:1.5px solid #4A90E2; border-radius:8px; background:#f9fbff; border-spacing:0;"
! colspan="2" style="background:#4A90E2; color:white; text-align:center; border-top-left-radius:8px; border-top-right-radius:8px;" | Grupo de Servicios
|-
| style="border:none; padding:5px 10px;" | '''01''' || style="border:none; padding:3px;" | Consulta externa
|-
| style="border:none; padding:5px 10px;" | '''02''' || style="border:none; padding:3px;" | Apoyo diagnóstico y complementación terapéutica
|-
| style="border:none; padding:5px 10px;" | '''03''' || style="border:none; padding:3px;" | Internación
|-
| style="border:none; padding:5px 10px;" | '''04''' || style="border:none; padding:3px;" | Quirúrgico
|-
| style="border:none; padding:5px 10px;" | '''05''' || style="border:none; padding:3px;" | Atención inmediata
|}
<div style="margin:1.5em 0;"></div>

* 🟢 → Campo: <code style="color:#B266FF;">'''codServicio'''</code> 
Digite el código que identifica la unidad básica de atención autorizada, incluyendo procesos, actividades, personal, infraestructura y tecnología, todo orientado a garantizar la seguridad del paciente. Puede guiarse con la tabla: '''[[Media:codServicio.xlsx|codServicio]]''' O consultar el registro oficial en SISPRO: '''[https://web.sispro.gov.co/WebPublico/Consultas/ConsultarDetalleReferenciaBasica.aspx?Code=Servicios Servicios]'''

* 🟢 → Campo: <code style="color:#B266FF;">'''finalidadTecnologiaSalud'''</code> 
Digite el código que indica la finalidad con la que se realiza la consulta o prestación de la tecnología en salud. Puede guiarse con la tabla: '''[[Media:FinalidadConsulta.xlsx|FinalidadConsulta]]''' O consultar el registro oficial en SISPRO: '''[https://web.sispro.gov.co/WebPublico/Consultas/ConsultarDetalleReferenciaBasica.aspx?Code=RIPSFinalidadConsultaVersion2 FinalidadConsulta]'''

* 🟢 → Campo: <code style="color:#B266FF;">'''causaMotivoAtencion'''</code> 
Digite el código que indica la causa o motivo que originó la consulta o prestación del servicio de salud. Puede guiarse con la tabla: '''[[Media:causaMotivoAtencion.xlsx|causaMotivoAtencion]]''' O consultar el registro oficial en SISPRO: '''[https://web.sispro.gov.co/WebPublico/Consultas/ConsultarDetalleReferenciaBasica.aspx?Code=RIPSCausaExternaVersion2 Causa Motivo Atencion]'''

* 📄 → Campo: <code style="color:#B266FF;">'''codDiagnosticoPrincipal'''</code> 
Digite el código CIE del diagnóstico principal del paciente, ya sea confirmado o sospechado. Puede guiarse con la tabla: '''[[Media:CIE10.xlsx|CIE10]]''' O consultar el registro oficial en SISPRO: '''[https://web.sispro.gov.co/WebPublico/Consultas/ConsultarDetalleReferenciaBasica.aspx?Code=CIE10 CIE10]'''

* 📄 → Campo: <code style="color:#B266FF;">'''codDiagnosticoRelacionado 1,2,3'''</code> 
Digite los códigos CIE de los diagnósticos relacionados con el principal. Pueden estar confirmados o sólo sospechados, y su diligenciamiento no siempre es obligatorio.

* 🟢 → Campo: <code style="color:#B266FF;">'''tipoDiagnosticoPrincipal'''</code> 
Seleccione el identificador que indica si el diagnóstico principal es confirmado o presuntivo. Puede guiarse con la siguiente tabla:
{| class="mw-collapsible mw-collapsed" style="margin:auto; text-align:left; width:30%; font-size:80%; border:1.5px solid #4A90E2; border-radius:8px; background:#f9fbff; border-spacing:0;"
! colspan="2" style="background:#4A90E2; color:white; text-align:center; border-top-left-radius:8px; border-top-right-radius:8px;" | Tipo de Diagnóstico
|-
| style="border:none; padding:5px 10px;" | '''01''' || style="border:none; padding:3px;" | Impresión diagnóstica
|-
| style="border:none; padding:5px 10px;" | '''02''' || style="border:none; padding:3px;" | Confirmado nuevo
|-
| style="border:none; padding:5px 10px;" | '''03''' || style="border:none; padding:3px;" | Confirmado repetido
|}
<div style="margin:1.5em 0;"></div>

* 🟢 → Campo: <code style="color:#B266FF;">'''tipoDocumentoIdentificacion'''</code> 
Indique el tipo de documento de identificación de la persona que realizó la consulta. Seleccione la opción que mejor coincida con su registro, para que la información quede correcta y completa. Puede guiarse con la tabla:
{| class="mw-collapsible mw-collapsed" style="margin:auto; text-align:left; width:30%; font-size:80%; border:1.5px solid #4A90E2; border-radius:8px; background:#f9fbff; border-spacing:0;"
! colspan="2" style="background:#4A90E2; color:white; text-align:center; border-top-left-radius:8px; border-top-right-radius:8px;" | Tipo de Documento
|-
| style="border:none; padding:5px 10px;" | '''AS''' || style="border:none; padding:3px;" | Adulto sin identificación
|-
| style="border:none; padding:5px 10px;" | '''CC''' || style="border:none; padding:3px;" | Cédula de Ciudadanía
|-
| style="border:none; padding:5px 10px;" | '''CD''' || style="border:none; padding:3px;" | Carnet Diplomático
|-
| style="border:none; padding:5px 10px;" | '''CE''' || style="border:none; padding:3px;" | Cédula de Extranjería
|-
| style="border:none; padding:5px 10px;" | '''CN''' || style="border:none; padding:3px;" | Certificado nacido vivo
|-
| style="border:none; padding:5px 10px;" | '''DE''' || style="border:none; padding:3px;" | Documento extranjero
|-
| style="border:none; padding:5px 10px;" | '''MS''' || style="border:none; padding:3px;" | Menor sin identificación
|-
| style="border:none; padding:5px 10px;" | '''NI''' || style="border:none; padding:3px;" | Número de identificación tributario NIT
|-
| style="border:none; padding:5px 10px;" | '''NV''' || style="border:none; padding:3px;" | Certificado nacido vivo
|-
| style="border:none; padding:5px 10px;" | '''PA''' || style="border:none; padding:3px;" | Pasaporte
|-
| style="border:none; padding:5px 10px;" | '''PE''' || style="border:none; padding:3px;" | Permiso Especial de Permanencia
|-
| style="border:none; padding:5px 10px;" | '''PT''' || style="border:none; padding:3px;" | Permiso por protección temporal
|-
| style="border:none; padding:5px 10px;" | '''RC''' || style="border:none; padding:3px;" | Registro civil
|-
| style="border:none; padding:5px 10px;" | '''SC''' || style="border:none; padding:3px;" | Salvoconducto
|-
| style="border:none; padding:5px 10px;" | '''SI''' || style="border:none; padding:3px;" | Sin identificación
|-
| style="border:none; padding:5px 10px;" | '''TI''' || style="border:none; padding:3px;" | Tarjeta de Identidad
|}
<div style="margin:1.5em 0;"></div>

* 🟢 → Campo: <code style="color:#B266FF;">'''numDocumentoIdentificacion'''</code> 
Digite el número del documento de identificación de la persona que realizó la consulta, asegurándose de que coincida con el tipo de documento seleccionado.

* 💰 → Campo: <code style="color:#B266FF;">'''vrServicio'''</code> 
Ingrese el valor de la consulta, de acuerdo con el manual tarifario vigente o la tarifa acordada entre las partes.

* 📄 → Campo: <code style="color:#B266FF;">'''conceptoRecaudo'''</code> 
Seleccione el tipo de pago moderador correspondiente, según el plan de beneficios o la póliza adquirida. Puede guiarse con la siguiente tabla:
{| class="mw-collapsible mw-collapsed" style="margin:auto; text-align:left; width:30%; font-size:80%; border:1.5px solid #4A90E2; border-radius:8px; background:#f9fbff; border-spacing:0;"
! colspan="2" style="background:#4A90E2; color:white; text-align:center; border-top-left-radius:8px; border-top-right-radius:8px;" | Concepto de Recaudo
|-
| style="border:none; padding:5px 10px;" | '''01''' || style="border:none; padding:3px;" | Copago
|-
| style="border:none; padding:5px 10px;" | '''02''' || style="border:none; padding:3px;" | Cuota moderadora
|-
| style="border:none; padding:5px 10px;" | '''03''' || style="border:none; padding:3px;" | Pagos compartidos en planes voluntarios de salud
|-
| style="border:none; padding:5px 10px;" | '''05''' || style="border:none; padding:3px;" | No aplica
|}
<div style="margin:1.5em 0;"></div>

* 💰 → Campo: <code style="color:#B266FF;">'''valorPagoModerador'''</code> 
Ingrese el valor del pago moderador correspondiente. Si no aplica pago moderador, registre '''0'''.

* 🟢 → Campo: <code style="color:#B266FF;">'''numFEVPagoModerador'''</code> 
Digite el número de la factura electrónica de venta emitida al usuario que respalda el valor registrado en '''valorPagoModerador''', o la información proporcionada por la entidad responsable de pago.

* 🟢 → Campo: <code style="color:#B266FF;">'''consecutivo'''</code> 
Digite el número consecutivo que identifica este registro, asegurando el orden correcto de la información.

* 🟢 → Campo: <code style="color:#B266FF;">'''ripsId'''</code> 
Ingrese el identificador que permite relacionar la información de esta consulta con las pestañas de '''Usuarios''' y '''Transacción'''.
|}
</div>
<div style="margin:1.5em 0;"></div>
<div style="border:2px solid #dcd6f7; background:#fcfbff; border-radius:12px; padding:12px; box-shadow:0 1px 4px rgba(0,0,0,0.08);">

<div style="font-size:16px; font-weight:bold; color:#20C997; margin:0.5em 0;">
⚕️ '''PROCEDIMIENTOS'''

</div>

{| class="mw-collapsible mw-collapsed" style="margin:auto; width:95%; border:1.5px solid #4A90E2; border-radius:8px; background:#f9fbff;"
! style="background:#4A90E2; color:white; text-align:center; border-top-left-radius:8px; border-top-right-radius:8px;" | Campos de la pestaña Procedimientos
|-
| style="padding:5px;" |

* 🟢 → Campo: <code style="color:#B266FF;">'''IdMIPRES'''</code> 
Código asignado por la herramienta MIPRES cuando el procedimiento fue autorizado allí.
Si no aplica, se deja vacío. Para más información consulta la página web:[https://www.sispro.gov.co/central-prestadores-de-servicios/Pages/MIPRES.aspx MIPRES]

Nota: Aplica para entidades que prestan servicios no POS.

* 🟢 → Campo: <code style="color:#B266FF;">'''CodProcedimiento'''</code> 
Es el código CUPS que identifica el procedimiento realizado en salud. Puede guiarse en la siguiente tabla: [[Media:CUPSRips.xlsx|CUPSRips]] o consultarla directamente en la página oficial de SISPRO: [https://web.sispro.gov.co/WebPublico/Consultas/ConsultarDetalleReferenciaBasica.aspx?Code=CUPSRips CUPSRips]

* 🟢 → Campo: <code style="color:#B266FF;">'''ViaIngresoServicioSalud'''</code> 
Indica de dónde viene el paciente (por ejemplo, si llegó por su cuenta o fue remitido). Puede guiarse en el siguiente enlace: [https://web.sispro.gov.co/WebPublico/Consultas/ConsultarDetalleReferenciaBasica.aspx?Code=ViaIngresoUsuario ViaIngresoUsuario] o consultar la tabla aquí:

{| class="mw-collapsible mw-collapsed" style="margin:auto; text-align:center; width:55%; font-size:85%; border:1.5px solid #2B6CB0; border-radius:6px; background:#fdfefe; border-spacing:0;"
! colspan="2" style="background:#2B6CB0; color:white; padding:4px; border-top-left-radius:6px; border-top-right-radius:6px; font-weight:bold;" | Vía Ingreso Usuario
|-
! style="background:#2B6CB0; color:white; padding:3px; width:20%;" | Código
! style="background:#2B6CB0; color:white; padding:3px; width:80%;" | Nombre
|-
| '''01''' || DEMANDA ESPONTÁNEA
|-
| '''02''' || DERIVADO DE CONSULTA EXTERNA
|-
| '''03''' || DERIVADO DE URGENCIAS
|-
| '''04''' || DERIVADO DE HOSPITALIZACIÓN
|-
| '''05''' || DERIVADO DE SALA DE CIRUGÍA
|-
| '''06''' || DERIVADO DE SALA DE PARTOS
|-
| '''07''' || RECIÉN NACIDO EN LA INSTITUCIÓN
|-
| '''08''' || RECIÉN NACIDO EN OTRA INSTITUCIÓN
|-
| '''09''' || DERIVADO O REFERIDO DE HOSPITALIZACIÓN DOMICILIARIA
|-
| '''10''' || DERIVADO DE ATENCIÓN DOMICILIARIA
|-
| '''11''' || DERIVADO DE TELEMEDICINA
|-
| '''12''' || DERIVADO DE JORNADA DE SALUD
|-
| '''13''' || REFERIDO DE OTRA INSTITUCIÓN
|-
| '''14''' || CONTRARREFERIDO DE OTRA INSTITUCIÓN
|}

* 🟢 → Campo: <code style="color:#B266FF;">'''CodComplicacion'''</code> 
Código del diagnóstico confirmado o presuntivo, según la versión vigente de la Clasificación Internacional de Enfermedades – CIE.

|}
</div>

<div style="margin:1.5em 0;"></div>

<div style="border: 2px solid #BFCFFF; border-radius: 10px; padding: 20px; background-color: #fdf9ff;">


= Explicación del flujo de la plantilla de carga masiva de RIPS [[#MenuCargaMasiva|⬆️]] =

<div style="margin:1.5em 0;"></div>

<div style="text-align:center; margin: 20px 0; overflow-x: auto;">
[[Archivo:rips88.png|1000px|center|Flujo de la plantilla de carga masiva de RIPS]]
</div>

<div style="font-size: 1em; line-height: 1.6; color:#333; text-align:justify; margin-bottom:20px;">
El diagrama muestra cómo funciona el recorrido de la información dentro de la plantilla de carga masiva de RIPS:
</div>

<div style="display: flex; flex-wrap: wrap; gap: 15px; justify-content: center; max-width: 100%;">

<div style="flex: 1 1 220px; border: 1px solid #BFCFFF; border-radius: 8px; background-color: #ffffff; padding: 15px; box-shadow: 1px 1px 6px rgba(0,0,0,0.05); text-align:justify;">
1. Transacción 
<div style="margin-bottom:6px;">◦ Todo comienza con una transacción. Este es el punto de partida que conecta la información que se va a registrar.</div>
</div>

<div style="flex: 1 1 220px; border: 1px solid #BFCFFF; border-radius: 8px; background-color: #ffffff; padding: 15px; box-shadow: 1px 1px 6px rgba(0,0,0,0.05); text-align:justify;">
2. Usuarios 
<div style="margin-bottom:6px;">◦ A partir de la transacción se relacionan los usuarios, que son las personas a quienes se les prestan los servicios de salud.</div>
<div style="margin-bottom:6px;">◦ En la plantilla cada usuario aparece identificado con un consecutivo (por ejemplo: "Consecutivo 1", "Consecutivo 2", etc.).</div>
</div>

<div style="flex: 1 1 220px; border: 1px solid #BFCFFF; border-radius: 8px; background-color: #ffffff; padding: 15px; box-shadow: 1px 1px 6px rgba(0,0,0,0.05); text-align:left;">
3. Servicios 
<div style="margin-bottom:6px;">◦ Luego, cada usuario puede tener uno o varios servicios asociados.</div>
<div style="margin-bottom:6px;">◦ Los servicios pueden ser: consultas, procedimientos, medicamentos, hospitalizaciones, urgencias, entre otros.</div>
<div style="margin-bottom:6px;">◦ Es decir, un mismo usuario puede aparecer varias veces en la plantilla, porque pudo recibir diferentes tipos de servicios.</div>
</div>

<div style="flex: 1 1 220px; border: 1px solid #BFCFFF; border-radius: 8px; background-color: #ffffff; padding: 15px; box-shadow: 1px 1px 6px rgba(0,0,0,0.05); text-align:justify;">
4. ripsId 
<div style="margin-bottom:6px;">◦ Finalmente, todos esos servicios terminan relacionados en un mismo ripsId, que actúa como un identificador único en el sistema.</div>
<div style="margin-bottom:6px;">◦ El ripsId permite organizar y consolidar la información para enviarla correctamente.</div>
</div>
</div>
</div>


== 5. 📂 Carga del archivo RIPS [[#MenuCargaMasiva|⬆️]] ==

Después de diligenciar la '''plantilla de carga masiva de RIPS''', el siguiente paso es '''subir el archivo al portal''' y generar los RIPS para enviarlos al '''Ministerio de Salud'''.

<div style="border-left: 5px solid #02509f; background-color: #f0f4fa; padding: 12px 15px; margin: 15px 0; font-family: 'Segoe UI', 'Arial', sans-serif; font-size: 15px; line-height: 1.5; color: #222;">
ℹ️ Nota: A continuación se explica el proceso de forma clara y detallada para que el usuario pueda seguirlo sin inconvenientes.
</div>

=== 1️⃣ Paso 1 — 📤 Subir documento ===

En el módulo '''Carga Masiva''', en la opción '''Subir Archivo XLSM''', haga clic en '''Subir documento'''.
Se abrirá el explorador de archivos de su equipo: seleccione el archivo de carga masiva que preparó.

<div style="text-align:center; margin:1.5em auto; padding:0.5em; border:1px solid #a2c6df; border-radius:10px; box-shadow:0 2px 6px rgba(0,0,0,0.05); width:fit-content; background-color:#f8fbff;">
[[Archivo:Rips90.png|800px]]
</div>

Al seleccionar el archivo, el portal validará el formato.
Si el formato es correcto, el sistema procesará el archivo y mostrará un '''ID de carga''' asignado automáticamente.

<div style="text-align:center; margin:1.5em auto; padding:0.5em; border:1px solid #a2c6df; border-radius:10px; box-shadow:0 2px 6px rgba(0,0,0,0.05); width:fit-content; background-color:#f8fbff;">
[[Archivo:Rips93.png|800px]]
</div>

=== 2️⃣ Paso 2 — 📑 Ir a "Listado de carga masiva" ===

Una vez completada la subida, diríjase a la sección '''Listado de carga masiva''', ubicada en la parte inferior de la pantalla.

Allí aparecerán las cargas recientes con su '''ID, fecha y estado''' (campos visibles: '''Archivo, Estado, Fecha de creación, Transacciones, Errores y Acciones''').

<div style="text-align:center; margin:1.5em auto; padding:0.5em; border:1px solid #a2c6df; border-radius:10px; box-shadow:0 2px 6px rgba(0,0,0,0.05); width:fit-content; background-color:#f8fbff;">
[[Archivo:Rips91.png|800px]]
</div>

=== 3️⃣ Paso 3 — 🔎 Ver detalle ===

Haga clic en Ver detalle junto a la carga que desea revisar.

En esta vista encontrará el desglose completo:
* Número de registros procesados
* Advertencias y errores detectados
* Acciones disponibles para continuar el flujo

<div style="text-align:center; margin:1.5em auto; padding:0.5em; border:1px solid #a2c6df; border-radius:10px; box-shadow:0 2px 6px rgba(0,0,0,0.05); width:fit-content; background-color:#f8fbff;">
[[Archivo:Rips94.png|800px]]
</div>

<div style="border-left: 5px solid #02509f; background-color: #f0f4fa; padding: 12px 15px; margin: 15px 0; font-family: 'Segoe UI', 'Arial', sans-serif; font-size: 15px; line-height: 1.5; color: #222;">
💡 Consejo: Revise siempre los errores y advertencias antes de continuar, para evitar inconsistencias en los RIPS.
</div>

=== 4️⃣ Paso 4 — 📂 Acceder a "Rips Guardados" ===

En la columna '''RIPS ID''' del detalle existe un enlace directo.

Haga clic en RIPS ID para entrar al módulo '''Rips Guardados''', donde estarán organizadas todas las secciones importadas del archivo.

<div style="text-align:center; margin:1.5em auto; padding:0.5em; border:1px solid #a2c6df; border-radius:10px; box-shadow:0 2px 6px rgba(0,0,0,0.05); width:fit-content; background-color:#f8fbff;">
[[Archivo:Rips95.png|900px]]
</div>

<div style="border-left: 5px solid #02509f; background-color: #f0f4fa; padding: 12px 15px; margin: 15px 0; font-family: 'Segoe UI', 'Arial', sans-serif; font-size: 15px; line-height: 1.5; color: #222;">
ℹ️ Nota: Desde este módulo podrá visualizar y gestionar cada sección cargada de manera independiente.
</div>

=== 5️⃣ Paso 5 — ✅ Revisar, validar y generar RIPS ===

Dentro de '''Rips Guardados''' revise cada sección (pacientes, servicios, procedimientos, medicamentos, hospitalización, entre otros) para confirmar que los datos coincidan con la plantilla.
Si encuentra inconsistencias, puede corregir la información directamente en el RIPS generado a partir de la carga masiva.

Cuando toda la información esté correcta, haga clic en Generar RIPS.

El sistema enviará la información al '''Ministerio de Salud''' para su validación y registrará el envío en la plataforma.

<div style="border-left: 5px solid #c00; background-color: #fdecea; padding: 12px 15px; margin: 15px 0; font-family: 'Segoe UI', 'Arial', sans-serif; font-size: 15px; line-height: 1.5; color: #222;">
⚠️ Nota importante: Siga las instrucciones de la plantilla (nombres exactos de columnas, tipos de datos y campos obligatorios).
Los errores más comunes son: columnas vacías, formatos de fecha inconsistentes, uso de separador decimal diferente o inclusión de hojas adicionales en el archivo.
Si el portal devuelve un rechazo, revise el mensaje de error, realice los ajustes y cargue nuevamente el archivo.
</div>

</div>
</div>
</div>

{| style="width:100%; border:none;"
| style="text-align:right; border:none;" |


[[#MenuCargaMasiva|🏠]]


'''[[Índice del Manual de Usuario HKA Fácil RIPS|← Regresar]]'''


|}

Sección para clientes de Integración

2025-12-12T14:05:22Z

Dmrodriguez2:

{| style="width:100%; border:1px solid #d0d7e1; border-radius:10px; background-color:#ffffff; box-shadow:0 1px 3px rgba(0,0,0,0.08);"
|-
| style="vertical-align:top; padding:20px;" |

<div style="font-size:1.9em; font-weight:bold; color:#003366;">
Integración – The Factory HKA Colombia
</div>

<div style="font-size:1.05em; color:#444; line-height:1.6; margin-bottom:15px;">
Bienvenido a Integración de The Factory HKA Colombia, el espacio diseñado para brindar una experiencia técnica clara, eficiente y centralizada para nuestros clientes y aliados.
 
Aquí encontrará la documentación completa para la integración de los servicios de Factura Electrónica, Nómina Electrónica, Recepción Electrónica y Documentos Equivalentes, incluyendo manuales, APIs, herramientas y recomendaciones para el cumplimiento de las resoluciones DIAN vigentes.
</div>

<div style="background:linear-gradient(90deg, #0073e6 0%, #0099ff 100%); color:#fff; padding:12px 18px; border-radius:6px; font-weight:bold; font-size:1.05em;">
Acceso rápido: Consulte las secciones de pasos de integración, canales de comunicación y ejemplos de APIs según su tipo de documento electrónico.
</div>

| style="width:140px; text-align:center; vertical-align:middle; background-color:#f7f9fc; border-left:1px solid #e0e6ef; padding:15px;" |
[[Archivo:Tfhka-co.png|140px|center|sinmarco]]
|}

{| style="width:100%; border:none; background-color:#ffffff; padding:2px;"
|-
| style="vertical-align:top; padding:18px 5px;" |

<div style="font-size:1.7em; font-weight:bold; color:#003366; margin-bottom:8px;">
¿Qué hacemos?
</div>

<div style="font-size:1.05em; color:#444; line-height:1.6; margin-bottom:15px;">
En The Factory HKA Colombia ofrecemos soluciones tecnológicas que optimizan la emisión, recepción y gestión de documentos electrónicos requeridos por la DIAN.
Nuestros servicios web (APIs) están orientados a empresas, desarrolladores y casas de software que buscan integraciones seguras, escalables y de alta disponibilidad.
</div>

<div style="background-color:#f4f9fc; border-left:6px solid #0073e6; border-radius:4px; padding:12px; color:#003366; font-size:1.05em; margin-bottom:15px;">
Servicios principales: 
• Facturación Electrónica con validación previa ante la DIAN. 
• Nómina Electrónica con soporte para documentos individuales y masivos. 
• Recepción de Documentos Electrónicos con trazabilidad y respuesta. 
• Emisión de Documentos Equivalentes conforme a la Resolución 000165 del 2023.
</div>
<div style="font-size:1.7em; font-weight:bold; color:#003366; margin-top:25px; margin-bottom:10px;">
¿Cómo contactarnos?
</div>

<div style="font-size:1.05em; color:#444; line-height:1.6; margin-bottom:15px;">
Si necesita soporte técnico o acompañamiento durante su proceso de integración, puede comunicarse a través de los siguientes canales:
</div>

<table style="width:100%; border-collapse:collapse; font-size:1.02em; color:#333;">
<tr style="background-color:#eef4fb; text-align:left;">
<th style="padding:8px; border:1px solid #cfd7e0; width:25%;">Canal</th>
<th style="padding:8px; border:1px solid #cfd7e0;">Información de contacto</th>
</tr>
<tr>
<td style="padding:8px; border:1px solid #cfd7e0;">
[[File:icono-correo-electronico.png|20px]] Correo electrónico
</td>
<td style="padding:8px; border:1px solid #cfd7e0;">integracion_fel_co@thefactoryhka.com</td>
</tr>
<tr style="background-color:#f8fafd;">
<td style="padding:8px; border:1px solid #cfd7e0;">
[[File:icono-telefono.png|20px]] Teléfonos
</td>
<td style="padding:8px; border:1px solid #cfd7e0;">Opción 5, luego Opción 1 
+57 317 668 7663 | +57 (601) 390 95 39 </td>
</tr>
<tr>
<td style="padding:8px; border:1px solid #cfd7e0;">
[[File:icono-whatsapp.png|20px]] WhatsApp
</td>
<td style="padding:8px; border:1px solid #cfd7e0;">Escríbanos al canal de soporte técnico https://wa.me/573163192251</td>
</tr>
<tr style="background-color:#f8fafd;">
<td style="padding:8px; border:1px solid #cfd7e0;">
[[File:icono-sesiones-grupales.png|20px]] Sesiones grupales de integración
</td>
<td style="padding:8px; border:1px solid #cfd7e0;">Martes y jueves de 08:30 a.m. a 10:00 a.m. (hora Colombia). https://meet.google.com/fzo-xmyc-duk</td>
</tr>
</table>

<div style="font-size:1.7em; font-weight:bold; color:#003366; margin-top:25px; margin-bottom:10px;">
Principales métodos o APIs por producto
</div>

<div style="font-size:1.02em; color:#444; line-height:1.6; margin-bottom:10px;">
La siguiente tabla presenta los métodos principales de integración por producto.
Cada servicio dispone de endpoints para emisión, validación, consulta, descarga y gestión de documentos conforme a los estándares DIAN.
</div>

<div style="font-size:1.5em; font-weight:bold; color:#003366; margin-top:25px; margin-bottom:15px;">
Factura Electrónica - SOAP
</div>

{| class="wikitable" style="width:100%; border-collapse:collapse; font-size:0.95em; color:#333;"
|-
! style="background-color:#003366; color:#fff; text-align:left; padding:8px;" | Producto
! style="background-color:#003366; color:#fff; text-align:left; padding:8px;" | Servicio
! style="background-color:#003366; color:#fff; text-align:left; padding:8px;" | Descripción
|-
| style="padding:8px; border:1px solid #b8c6db;" | FEL
| SOAP
|
'''FacturaElectronica - Enviar''' 
Servicio dedicado al envío y validación de facturas electrónicas ante la DIAN, garantizando el cumplimiento normativo mediante la verificación integral de todos los requisitos técnicos y legales exigidos por la autoridad tributaria colombiana. 
'''Entornos:''' Demo / Producción
|-
| style="background-color:#f8fafd; padding:8px; border:1px solid #b8c6db;" | FEL
| SOAP
|
'''FacturaElectronica - EstadoDocumento''' 
Consulta del estado de tramitación de documentos ante la DIAN, proporcionando información en tiempo real sobre la validación y aceptación definitiva.
|-
| style="padding:8px; border:1px solid #b8c6db;" | FEL
| SOAP
|
'''FacturaElectronica - DescargaPDF''' 
Generación automática de la representación gráfica en PDF según especificaciones DIAN, lista para distribución comercial conforme a los estándares requeridos.
|-
| style="background-color:#f8fafd; padding:8px; border:1px solid #b8c6db;" | FEL
| SOAP
|
'''FacturaElectronica - EnvioCorreo''' 
Envío automatizado de facturas electrónicas a los destinatarios con PDF y XML técnico, asegurando entrega completa y trazable.
|}

<div style="font-size:1.5em; font-weight:bold; color:#003366; margin-top:25px; margin-bottom:15px;">
Factura Electrónica - REST
</div>

{| class="wikitable" style="width:100%; border-collapse:collapse; font-size:0.95em; color:#333;"
|-
! style="background-color:#003366; color:#fff; text-align:left; padding:8px;" | Producto
! style="background-color:#003366; color:#fff; text-align:left; padding:8px;" | Servicio
! style="background-color:#003366; color:#fff; text-align:left; padding:8px;" | Descripción
! style="background-color:#003366; color:#fff; text-align:left; padding:8px;" | Método
|-
| style="padding:8px; border:1px solid #b8c6db;" | FEL
| REST
|
'''Api/documentos/enviar''' 
Servicio dedicado al envío y validación de facturas electrónicas ante la DIAN, con verificación completa de los requisitos técnicos y legales. 
'''Entornos:''' Demo / Producción
| POST
|-
| style="background-color:#f8fafd; padding:8px; border:1px solid #b8c6db;" | FEL
| REST
|
'''Api/documentos/EstadoDocumento''' 
Consulta en tiempo real del estado del documento y validación ante la DIAN, mostrando incidencias o aceptación definitiva.
| GET
|-
| style="padding:8px; border:1px solid #b8c6db;" | FEL
| REST
|
'''Api/documentos/DescargaPDF''' 
Generación automática del PDF representativo del documento, conforme a los estándares de presentación exigidos.
| GET
|-
| style="background-color:#f8fafd; padding:8px; border:1px solid #b8c6db;" | FEL
| REST
|
'''FacturaElectronica - EnvioCorreo''' 
Distribución electrónica automatizada de facturas a clientes, incluyendo PDF y XML técnico.
| POST
|}

<div style="font-size:1.5em; font-weight:bold; color:#003366; margin-top:25px; margin-bottom:15px;">
Nómina Electrónica - SOAP
</div>

{| class="wikitable" style="width:100%; border-collapse:collapse; font-size:0.95em; color:#333;"
|-
! style="background-color:#003366; color:#fff; text-align:left; padding:8px;" | Producto
! style="background-color:#003366; color:#fff; text-align:left; padding:8px;" | Servicio
! style="background-color:#003366; color:#fff; text-align:left; padding:8px;" | Descripción
|-
| style="padding:8px; border:1px solid #b8c6db;" | Nomina
| SOAP
|
'''NominaElectronica - Enviar''' 
Procesamiento de nóminas electrónicas individuales o masivas conforme a requisitos DIAN. 
'''Entornos:''' Demo / Producción
|-
| style="background-color:#f8fafd; padding:8px; border:1px solid #b8c6db;" | Nomina
| SOAP
|
'''NominaElectronica - ConsultarDocumento''' 
Consulta del estado de tramitación y validación de nóminas electrónicas.
|-
| style="padding:8px; border:1px solid #b8c6db;" | Nomina
| SOAP
|
'''NominaElectronica - EnviarCorreo''' 
Envío automatizado de nóminas electrónicas a los colaboradores con sus representaciones gráficas.
|-
| style="background-color:#f8fafd; padding:8px; border:1px solid #b8c6db;" | Nomina
| SOAP
|
'''NominaElectronica - ConsultarFolios''' 
Consulta y gestión de numeración autorizada por la DIAN para emisión de nóminas.
|}

<div style="font-size:1.5em; font-weight:bold; color:#003366; margin-top:25px; margin-bottom:15px;">
Nómina Electrónica - REST
</div>

{| class="wikitable" style="width:100%; border-collapse:collapse; font-size:0.95em; color:#333;"
|-
! style="background-color:#003366; color:#fff; text-align:left; padding:8px;" | Producto
! style="background-color:#003366; color:#fff; text-align:left; padding:8px;" | Servicio
! style="background-color:#003366; color:#fff; text-align:left; padding:8px;" | Descripción
! style="background-color:#003366; color:#fff; text-align:left; padding:8px;" | Método
|-
| style="padding:8px; border:1px solid #b8c6db;" | Nomina
| REST
|
'''Api/documentos/Enviar''' 
Procesamiento de nóminas electrónicas individuales o masivas conforme a requisitos DIAN. 
'''Entornos:''' Demo / Producción
| POST
|-
| style="background-color:#f8fafd; padding:8px; border:1px solid #b8c6db;" | Nomina
| REST
|
'''Api/documentos/ConsultarDocumento''' 
Consulta del estado de tramitación y validación de nóminas electrónicas.
| GET
|-
| style="padding:8px; border:1px solid #b8c6db;" | Nomina
| REST
|
'''Api/documentos/EnviarCorreo''' 
Envío automatizado de nóminas electrónicas a los colaboradores con sus representaciones gráficas.
| POST
|-
| style="background-color:#f8fafd; padding:8px; border:1px solid #b8c6db;" | Nomina
| REST
|
'''Api/documentos/ConsultarFolios''' 
Consulta y gestión de numeración autorizada por la DIAN para emisión de nóminas.
| GET
|}

<div style="font-size:1.5em; font-weight:bold; color:#003366; margin-top:25px; margin-bottom:15px;">
Recepción Electrónica
</div>

{| class="wikitable" style="width:100%; border-collapse:collapse; font-size:0.95em; color:#333;"
|-
! style="background-color:#003366; color:#fff; text-align:left; padding:8px;" | Producto
! style="background-color:#003366; color:#fff; text-align:left; padding:8px;" | Servicio
! style="background-color:#003366; color:#fff; text-align:left; padding:8px;" | Descripción
|-
| style="padding:8px; border:1px solid #b8c6db;" | Recepcion
| SOAP
|
'''Recepcion - ReporteStatus''' 
Procesa documentos recibidos de proveedores, validando autenticidad e integridad para integración contable. 
'''Entornos:''' Demo / Producción
|-
| style="background-color:#f8fafd; padding:8px; border:1px solid #b8c6db;" | Recepcion
| SOAP
|
'''Recepcion - EstadoDocumento''' 
Consulta del estado y trazabilidad de documentos recibidos ante la DIAN.
|-
| style="padding:8px; border:1px solid #b8c6db;" | Recepcion
| SOAP
|
'''Recepcion - Respuesta''' 
Gestión formal de aceptación o rechazo de documentos recibidos, registrando eventos ante la DIAN.
|-
| style="background-color:#f8fafd; padding:8px; border:1px solid #b8c6db;" | Recepcion
| SOAP
|
'''Recepcion - RepresentacionGrafica''' 
Descarga y generación de PDFs de documentos recibidos conforme a los estándares DIAN.
|}

<div style="font-size:1.5em; font-weight:bold; color:#003366; margin-top:25px; margin-bottom:15px;">
Documentos Equivalentes
</div>

{| class="wikitable" style="width:100%; border-collapse:collapse; font-size:0.95em; color:#333;"
|-
! style="background-color:#003366; color:#fff; text-align:left; padding:8px;" | Producto
! style="background-color:#003366; color:#fff; text-align:left; padding:8px;" | Servicio
! style="background-color:#003366; color:#fff; text-align:left; padding:8px;" | Descripción
! style="background-color:#003366; color:#fff; text-align:left; padding:8px;" | Método
|-
| style="padding:8px; border:1px solid #b8c6db;" | Doc Equivalente
| REST
|
'''Equivalente - EnviarRequest''' 
Envío de documentos equivalentes electrónicos a la DIAN, cumpliendo con las validaciones oficiales. 
'''Entornos:''' Demo / Producción
| POST
|-
| style="background-color:#f8fafd; padding:8px; border:1px solid #b8c6db;" | Doc Equivalente
| REST
|
'''Equivalente - GenerarContenedor''' 
Genera contenedores de información estructurados según los requisitos técnicos de la DIAN.
| GET
|-
| style="padding:8px; border:1px solid #b8c6db;" | Doc Equivalente
| REST
|
'''Equivalente - DescargaPDF''' 
Generación de representaciones gráficas PDF para documentos equivalentes conforme a la normativa vigente.
| POST
|-
| style="background-color:#f8fafd; padding:8px; border:1px solid #b8c6db;" | Doc Equivalente
| REST
|
'''Equivalente - EstadoDocumento''' 
Consulta del estado de validación y trazabilidad de documentos equivalentes ante la DIAN.
| POST
|}

|}
 
[[File:HKAFactura 3.png|200px]]
 

* [[Índice del Manual de Integración Directa]]

* [[Direct Integration Manual Index - Electronic Invoice]]
* '''[[Facturación Electrónica bajo Resoluciones DIAN]]'''
* [[Herramientas Alternativas de Integración Facturación]]
* '''[[Servicio Gestión Contribuyentes]]'''
* [[Representaciones Gráficas en el proceso de Emisión]]
* [[Reglas de Rechazo DIAN - Integración]]
* [[Preguntas Frecuentes de Integración con servicio Web (Val. Previa)]]
* [[Tips Urls de Emisión]]

 
[[File:HKANomina 3.png|200px]]
 

* [[Índice del Manual de Integración Nómina Electrónica]]
* [[Portal Web Nómina Electrónica]]
* [[Habilitación Nómina Electrónica]]
* '''[[Herramientas Alternativas de Integración Nómina]]'''
* [[Nómina Electrónica según Concepto Unificado DIAN 0106 – 19 agosto 2022 ]]
* [[Preguntas Frecuentes de Integración Nómina Electrónica]]
* [[Tips Urls de Emisión Nómina Electrónica]]

 
[[File:HKARecepcion 3.png|260px]]
 

* [[Índice del Manual de Integración Directa HKA Recepción]]
* [[HKA Reception Direct Integration Manual Index]]
* [[Preguntas Frecuentes de Integración Recepción Electrónica]]
* [[Tips Urls de Recepción Integración]]

 
[[File:HKAEquivalente1.png|260px]]
 
* [[Indice del Manual Integración Directa HKA Documentos Equivalentes Electrónicos]]
* [[Requisitos minimos de las Representaciones grafica para documento equivalente]]
* [[Preguntas Frecuentes de Integración Documento Equivalente Electrónico]]
* [[Tips Urls de documento equivalente Integración]]
 
 
 

 
[[File:ArticulosInteresIntegracion.png|260px]]
 
* [[HKA TIPS]]
* [[Consideraciones Url Versión 4]]
* [[Recomendaciones para integraciones ante escenarios de intermitencia o Timeouts DIAN]]
* [[Manejo de SoapUI para pruebas en Demo]]
* [[Manejo de Postman para pruebas en Demo]]
* [[Campo extra para informar el Fabricante de Software]]
* [[Recomendaciones en la implementación de la factura electronica]]
* [[Politicas de seguridad de la información para aliados de The Factory HKA]]
* [[Actualización de Seguridad Requerida Migración a TLS 1.2 o superior en nuestros servicios web]]
 

<center>'''<big>[[Archivo:Copyright.png|100px|sinmarco|centro|Copyright]]THE FACTORY HKA COLOMBIA</big>
 Copyright © 2016 The Factory HKA. Todos los derechos reservados.</center>

 
{{clear}}

Generalidades - Índice Manual Integración Recepción Electrónica

2025-12-10T22:05:16Z

Dmrodriguez2:

<includeonly>=</includeonly>==Historial de versiones==<includeonly>=</includeonly>
{| class="wikitable" style="margin: auto;"
|-
! style="background:#e9e9e9; text-align:center;"|Versión
! style="background:#e9e9e9; text-align:center;"|Fecha lanzamiento
! style="background:#e9e9e9; text-align:center;"|Descripción
|- valign="center"
| 0
| 12/01/22
|versión inicial
|}

<includeonly>=</includeonly>==Cómo obtener soporte==<includeonly>=</includeonly>
*Soporte de 1er nivel:
::Soporte telefónico / email / chat o tele-conferencias en horario 5x8 para atención de consultas y fallas de usuario.
*Soporte de 2do nivel:
::Soporte resolución remota de incidencias en el sistema en horario 5x8
::::Escriba a [mailto:soporte@thefactoryhka.com.co soporte@thefactoryhka.com.co]

Para consultas referente a configuraciones y errores en el Portal:
* soporte_fel_co@thefactoryhka.com

Para consultas referente a configuraciones de ERP, casa de software e integración:
* integracion_fel_co@thefactoryhka.com

'''Lineas de atención telefónica:'''
* '''MASTER''' +57 (1) 746.08.12
* +57 (1) 508.8990
* +57 (1) 517.6795
* +57 (1) 517.6796
* +57 (1) 311.3063
** '''Soporte Técnico''' → Opción 2
** '''Integración ''' → Opción 5 Luego Opción 1

<includeonly>=</includeonly>===Para Sesiones:===<includeonly>=</includeonly>

<includeonly>=</includeonly>====Sesiones Soporte====<includeonly>=</includeonly>
Manejo de métodos en soap.
'''Dirigido a:''' Agencias Comerciales – Casas de Software Aliadas - Clientes Finales

'''Horario:''' Martes y Jueves a partir de las 8:30 AM

[https://meet.google.com/yyg-pujr-yqv Enlace Sesiones de Soporte]

<includeonly>=</includeonly>====Sesiones Área Integración<includeonly>=</includeonly>====
Solución Casos de Integración

'''Dirigido a:''' Clientes que realicen desarrollos de Software para integrarse con TFHKA, Casas de Software Aliadas

'''Horario:''' Martes y Jueves a partir de las 8:30 AM

[http://meet.google.com/fzo-xmyc-duk Enlace Sesiones Integración]
{{clear}}

<includeonly>=</includeonly>==Descripción general==<includeonly>=</includeonly>
El presente documento es una guía para la integración de servicios y funcionalidades de HKA Recepción, la plataforma de The Factory HKA para la gestión de eventos a Documentos Electrónicos.

Se detallan los servicios del Web Service SOAP disponibles para los receptores, cubriendo el listado, descarga, cambio de estatus y remisión de archivos (XML, representación gráfica y anexos), especificando los requisitos mandatorios en la recepción de documentos para la validez de facturas a crédito como soporte de costos y títulos valor (Resolución 000012).

===¿Qué es The Factory HKA-Recepción?===
Es una plataforma de recepción electrónica, diseñada para dar cumplimiento a la legislación vigente en Colombia y ofrecer valores agregados mediante servicios complementarios.

===¿Qué es HKA Integración?===
Es un producto dirigido al integrador y está conformado por los siguientes componentes:
*Manuales de integración.
*Bolsa de horas de soporte vía email y/o tele-conferencias.
*Credenciales para ambiente de pruebas (DEMO) y productivo.
{{clear}}

===Funcionalidades===
La plataforma The Factory HKA DRECEPCION permite el envío de archivos anexos, representación
gráficas y archivos de XML correspondiente de documento de facturación electrónica generadas
por el usuario emisor, así como recepción y descarga de los siguientes documentos en formato
XML y/o su correspondiente representación gráfica en PDF:

* Acuse Recibo
* Cambio de Estatus
* ConsultarDocumentoMetadata
* Descargar Acuse Aceptación XML
* Descargar Acuse Recibido XML
* Descargar Anexo
* Descargar Rep. Gráfica
* Descargar XML
* Eliminar Anexo
* Eliminar Rep. Gráfica
* Enviar Anexo
* EnviarMetadata
* Enviar Rep. Gráfica
* Enviar XML
* Estado Documento
* Lista Anexo
* Reporte
* Reporte Status

===La integración directa===
La integración es una actividad esencial para la puesta en marcha de la recepción electrónica en un Sistema de Facturación o Software Administrativo (ERP) y se realizará sólo una vez. Esta actividad consiste en enlazar dos plataformas con tecnologías distintas con el objetivo de transmitir los datos necesarios para la construcción de los documentos y el seguimiento exitoso del ciclo de vida.

En el caso de la integración directa, la comunicación se conecta directamente al Web Service, lo cual tiene como ventaja el control total del ciclo de vida del documento electrónico, desde el origen de los datos, pasando por el proceso de transmisión hasta su entrega, acuse de recibo y validación. Esta forma de integración permite reaccionar de un modo más rápido y eficiente ante errores o inconsistencias que se presenten en el proceso.

La integración directa es un proceso exclusivo entre el software integrado y la plataforma The Factory HKA Recepcion.

'''@Importante:''' No es necesario implementar integración adicional ante la DIAN, ya que se cuenta con la funcionalidad completa de seguimiento del estatus del documento.
{{clear}}

===Requerimientos técnicos para la integración directa===
The Factory HKA Recepcion es una plataforma tipo SaaS (Software as a Service): Los servicios, la
información, el procesamiento, los insumos y resultados están alojados en nuestros servidores
(como proveedor tecnológico), y nos ocupamos del mantenimiento, la operación, los cambios
normativos y el soporte de la solución.
Por normativa de la DIAN, el proveedor tecnológico tiene la obligación de conservar los
documentos y garantizar la integridad y seguridad de los datos bajo el estándar ISO 27001. Por
tanto, no es necesario una extensa planificación de infraestructura de procesamiento y
almacenamiento para implementar la facturación electrónica.
Los parámetros necesarios para la construcción de cada transacción son expuestos
independientemente al momento de consumir los servicios, y el resultado es entregado
enteramente al final de la operación. Eso significa que The Factory HKA no requiere manejar bases
de datos de clientes o productos/servicios.
Como proveedor tecnológico, The Factory HKA Colombia cuenta con recurso humano dedicado a
hacer seguimiento y analizar los cambios normativos que progresivamente emite la DIAN. De
generarse un cambio significativo que impacte del lado de la integración, se indicarán las
instrucciones para aplicar los correctivos de la forma más sencilla posible.
La plataforma The Factory HKA Recepcion pone a disposición de la integración un Web Service,
como solución para interoperación con terceros. El WS está desarrollado en SOAP (Simple Object
Access Protocol). Por tanto, como únicos requerimientos para la integración serán los siguientes:

* Capacidad de consumo de WS SOAP del software a utilizar.
* Capacidad de captación y validación de los datos de entrada.
* Opcional: Capacidad para almacenar copia del XML/PDF/ ADJUNTOS por transacción.
* Capacidad para el despliegue del estado del ciclo de vida del documento electrónico.

{{clear}}
 

===Esquema de integración directa para Factura Electrónica SOAP URL===
Contamos con un web service SOAP para pruebas en el cual se hacen validaciones iniciales frent ala DIAN, esto permite que puedan ir validando la estructura del objeto Factura y origen de datos propuesto por TFHKA. 
 

'''URL Ambiente DEMO (ambiente de pruebas en el cual las emisiones no son transmitidas a la DIAN)''':
 

[http://demorecepcion21.thefactoryhka.com.co/ReceptorWS.svc?wsdl
] --> DEMO (HTTP)
 
 
'''URL Ambiente Productivo (ambiente en el cual se realizan las emisiones correspondientes al set de habilitación y posteriormente la emisión de documentos en operación):'''
 

[https://recepcion21.thefactoryhka.com.co/ReceptorWS.svc?wsdl
] --> PRODUCCIÓN (HTTPS)
 
<center>
 
@IMPORTANTE:La url del servicio SOAP en producción solo esta funcional bajo el protocolo https.</center>
 
 
'''NOTA:''' Si no pueden acceder a dicha configuración en el interfaz del sistema, por favor, comunicarse con su casa de software o desarrollador del ERP con el fin de que puedan validar lo anteriormente descrito. De no solventarse el inconveniente con lo mencionado, por favor, enviar un correo al área de integración [mailto:integracion_fel_co@thefactoryhka.com integracion_fel_co@thefactoryhka.com] con la siguiente información:

* Request enviado al Web Service.
* Captura de la configuración realizada en el sistema donde se visualice la información de las URL y tokens indicada.
{{clear}}

<includeonly>=</includeonly>==Esquema de operación de la recepción electrónica==<includeonly>=</includeonly>
===¿Qué es la Recepción Electrónica?===

Quienes adquieran bienes y/o servicios y sean facturadores electrónicos están en la obligación de recibir las facturas electrónicas a través de correo electrónico. La recepción de facturas electrónicas recibe el documento mediante el cual un proveedor acredita que nos ha proporcionado un producto o servicio con un precio determinado, de forma digitalizada.

===¿Quiénes están obligados a implementar Recepción Electrónica?===

Los contribuyentes que deseen el producto Drecepción, un medio para la recepción y control de sus documentos electrónicos. La recepción directa desde el portal está diseñada para personas con un bajo y alto volumen de operaciones, como pequeñas, medianas y grandes empresas o profesionales independientes. El portal es la herramienta de configuración de todos los medios que interactúen con la plataforma Drecepción (Aplicación Móvil o ERP).

===Ventajas de la Recepción Electrónica===

• HKA Recepción permite optimizar la gestión de los documentos electrónicos con la identificación automática de los proveedores.
 
• Permite establecer reglas de negocio que faciliten la gestión de los
documentos
 
• También el sistema permite categorizar el tipo de proveedor de forma manual, para agrupar a los proveedores y mejorar los filtros de búsqueda en el manejo de los documentos.
 
• Permite la gestión de documentos agrupando los documentos y dándole posibilidad al usuario de visualizar la representación gráfica, la descarga del XML, manejar estatus personalizados y estatus DIAN.
 
• También permite incorporar el flujo de trabajo de la empresa en el sistema para gestionar los documentos.
 
• Garantiza el envío de eventos DIAN y la obtención de respuesta de los mismos.
 
• Facilita la búsqueda de un documento o varios de ellos en el sistema porque cuenta con los siguientes filtros de búsqueda: por estatus, por proveedor, por tipo de proveedor, por infodatos y por fechas.

===El proceso de la Recepción de la Facturación Electrónica===
Se enumerará el proceso una vez se ha emitido la factura electrónica:

1. El Adquiriente recibe el XML y el PDF (vía email, vía portal web, o cualquier medio
acordado con TFHKA).

2. El ERP consulta si existe un nuevo documento radicado en la plataforma para descargarlo
e iniciar el proceso de verificación y aceptación/rechazo correspondiente.

3. Se lleva a cabo la descarga de los adjuntos si los hubiere.

4. Se realiza el workflow de verificación-verificación en el proveedor-aceptación/rechazo enconjunto con el proveedor de la factura.

<includelonly

Generalidades - Índice Manual Integración Recepción Electrónica

2025-12-10T21:18:08Z

Dmrodriguez2: /* Requisitos para la recepción de documentos */

Generalidades - Índice Manual Integración Recepción Electrónica

2025-12-10T21:01:13Z

Dmrodriguez2: /* La integración directa */

<includeonly>=</includeonly>==Historial de versiones==<includeonly>=</includeonly>
{| class="wikitable" style="margin: auto;"
|-
! style="background:#e9e9e9; text-align:center;"|Versión
! style="background:#e9e9e9; text-align:center;"|Fecha lanzamiento
! style="background:#e9e9e9; text-align:center;"|Descripción
|- valign="center"
| 0
| 12/01/22
|versión inicial
|}

<includeonly>=</includeonly>==Cómo obtener soporte==<includeonly>=</includeonly>
*Soporte de 1er nivel:
::Soporte telefónico / email / chat o tele-conferencias en horario 5x8 para atención de consultas y fallas de usuario.
*Soporte de 2do nivel:
::Soporte resolución remota de incidencias en el sistema en horario 5x8
::::Escriba a [mailto:soporte@thefactoryhka.com.co soporte@thefactoryhka.com.co]

Para consultas referente a configuraciones y errores en el Portal:
* soporte_fel_co@thefactoryhka.com

Para consultas referente a configuraciones de ERP, casa de software e integración:
* integracion_fel_co@thefactoryhka.com

'''Lineas de atención telefónica:'''
* '''MASTER''' +57 (1) 746.08.12
* +57 (1) 508.8990
* +57 (1) 517.6795
* +57 (1) 517.6796
* +57 (1) 311.3063
** '''Soporte Técnico''' → Opción 2
** '''Integración ''' → Opción 5 Luego Opción 1

<includeonly>=</includeonly>===Para Sesiones:===<includeonly>=</includeonly>

<includeonly>=</includeonly>====Sesiones Soporte====<includeonly>=</includeonly>
Manejo de métodos en soap.
'''Dirigido a:''' Agencias Comerciales – Casas de Software Aliadas - Clientes Finales

'''Horario:''' Martes y Jueves a partir de las 8:30 AM

[https://meet.google.com/yyg-pujr-yqv Enlace Sesiones de Soporte]

<includeonly>=</includeonly>====Sesiones Área Integración<includeonly>=</includeonly>====
Solución Casos de Integración

'''Dirigido a:''' Clientes que realicen desarrollos de Software para integrarse con TFHKA, Casas de Software Aliadas

'''Horario:''' Martes y Jueves a partir de las 8:30 AM

[http://meet.google.com/fzo-xmyc-duk Enlace Sesiones Integración]
{{clear}}

<includeonly>=</includeonly>==Descripción general==<includeonly>=</includeonly>
El presente documento es una guía para la integración de servicios y funcionalidades de HKA Recepción, la plataforma de The Factory HKA para la gestión de eventos a Documentos Electrónicos.

Se detallan los servicios del Web Service SOAP disponibles para los receptores, cubriendo el listado, descarga, cambio de estatus y remisión de archivos (XML, representación gráfica y anexos), especificando los requisitos mandatorios en la recepción de documentos para la validez de facturas a crédito como soporte de costos y títulos valor (Resolución 000012).

===¿Qué es The Factory HKA-Recepción?===
Es una plataforma de recepción electrónica, diseñada para dar cumplimiento a la legislación vigente en Colombia y ofrecer valores agregados mediante servicios complementarios.

===¿Qué es HKA Integración?===
Es un producto dirigido al integrador y está conformado por los siguientes componentes:
*Manuales de integración.
*Bolsa de horas de soporte vía email y/o tele-conferencias.
*Credenciales para ambiente de pruebas (DEMO) y productivo.
{{clear}}

===Funcionalidades===
La plataforma The Factory HKA DRECEPCION permite el envío de archivos anexos, representación
gráficas y archivos de XML correspondiente de documento de facturación electrónica generadas
por el usuario emisor, así como recepción y descarga de los siguientes documentos en formato
XML y/o su correspondiente representación gráfica en PDF:

* Acuse Recibo
* Cambio de Estatus
* ConsultarDocumentoMetadata
* Descargar Acuse Aceptación XML
* Descargar Acuse Recibido XML
* Descargar Anexo
* Descargar Rep. Gráfica
* Descargar XML
* Eliminar Anexo
* Eliminar Rep. Gráfica
* Enviar Anexo
* EnviarMetadata
* Enviar Rep. Gráfica
* Enviar XML
* Estado Documento
* Lista Anexo
* Reporte
* Reporte Status

===La integración directa===
La integración es una actividad esencial para la puesta en marcha de la recepción electrónica en un Sistema de Facturación o Software Administrativo (ERP) y se realizará sólo una vez. Esta actividad consiste en enlazar dos plataformas con tecnologías distintas con el objetivo de transmitir los datos necesarios para la construcción de los documentos y el seguimiento exitoso del ciclo de vida.

En el caso de la integración directa, la comunicación se conecta directamente al Web Service, lo cual tiene como ventaja el control total del ciclo de vida del documento electrónico, desde el origen de los datos, pasando por el proceso de transmisión hasta su entrega, acuse de recibo y validación. Esta forma de integración permite reaccionar de un modo más rápido y eficiente ante errores o inconsistencias que se presenten en el proceso.

La integración directa es un proceso exclusivo entre el software integrado y la plataforma The Factory HKA Recepcion.

'''@Importante:''' No es necesario implementar integración adicional ante la DIAN, ya que se cuenta con la funcionalidad completa de seguimiento del estatus del documento.
{{clear}}

===Requisitos para la recepción de documentos===
The Factory HKA Recepcion es una plataforma tipo SaaS (Software as a Service): Los servicios, la
información, el procesamiento, los insumos y resultados están alojados en nuestros servidores
(como proveedor tecnológico), y nos ocupamos del mantenimiento, la operación, los cambios
normativos y el soporte de la solución.
Por normativa de la DIAN, el proveedor tecnológico tiene la obligación de conservar los
documentos y garantizar la integridad y seguridad de los datos bajo el estándar ISO 27001. Por
tanto, no es necesario una extensa planificación de infraestructura de procesamiento y
almacenamiento para implementar la facturación electrónica.
Los parámetros necesarios para la construcción de cada transacción son expuestos
independientemente al momento de consumir los servicios, y el resultado es entregado
enteramente al final de la operación. Eso significa que The Factory HKA no requiere manejar bases
de datos de clientes o productos/servicios.
Como proveedor tecnológico, The Factory HKA Colombia cuenta con recurso humano dedicado a
hacer seguimiento y analizar los cambios normativos que progresivamente emite la DIAN. De
generarse un cambio significativo que impacte del lado de la integración, se indicarán las
instrucciones para aplicar los correctivos de la forma más sencilla posible.
La plataforma The Factory HKA Recepcion pone a disposición de la integración un Web Service,
como solución para interoperación con terceros. El WS está desarrollado en SOAP (Simple Object
Access Protocol). Por tanto, como únicos requerimientos para la integración serán los siguientes:
● Capacidad de consumo de WS SOAP del software a utilizar.
● Capacidad de captación y validación de los datos de entrada.
● Opcional: Capacidad para almacenar copia del XML/PDF/ ADJUNTOS por
transacción.
● Capacidad para el despliegue del estado del ciclo de vida del documento electrónico.

{{clear}}
 
<includeonly>=</includeonly>====Estructura del correo electrónico:====<includeonly>=</includeonly>
Según el comunicado oficial de la Cámara Colombiana de Comercio Electrónico del 28 de agosto de 2020 en la disposición de adjuntos se indica que por cada documento electrónico se debe enviar un correo electrónico con un único archivo adjunto en .zip el cual debe contener de manera obligatoria el archivo xml AttachedDocument correspondiente y de manera opcional el archivo .pdf.

[https://www.ccce.org.co/wp-content/uploads/2017/06/CCCE-ConsensoInteroperabilidad-V-001-20200629.pdf Comunicado oficial de la Cámara Colombiana de Comercio Electrónico]

'''Alternativa para carga de documentos urgentes:'''
El proveedor puede acceder a su [[Usuario Proveedor (UP) - Portal DRecepción Validación Previa#Ingreso al Sistema para Usuario Proveedor|usuario Proveedor]] y realizar la carga manual de su documento en la opción Documentos -> [[Usuario Proveedor (UP) - Portal DRecepción Validación Previa#Ingreso al Sistema para Usuario Proveedor|Subir documentos]].
{{clear}}

 
<includeonly>=</includeonly>====Tipo de documento del adquiriente:====<includeonly>=</includeonly>
Para la recepción de documentos es requerido validar que el tipo de documento del adquiriente o receptor corresponda a NIT, lo anterior basándose en el anexo técnico 1.8, de lo contrario el documento electrónico puede ser rechazado por la regla FAJ48.

[https://www.dian.gov.co/impuestos/factura-electronica/Documents/Anexo-Tecnico-Resolucion-000012-09022021.pdf Anexo tecnico 1.8]
{{clear}}

 
<includeonly>=</includeonly>====Nit del receptor no debe contener el DV:====<includeonly>=</includeonly>
Según el anexo técnico 1.8 el NIT del adquiriente o receptor de los documentos electrónicos debe ser reportado en un campo diferente al DV, al no cumplirse con esta regla el documento puede ser rechazado por las reglas FAK63 y FAK64.

[https://www.dian.gov.co/impuestos/factura-electronica/Documents/Anexo-Tecnico-Resolucion-000012-09022021.pdf Anexo tecnico 1.8]
{{clear}}

 
<includeonly>=</includeonly>====Validez de la firma digital:====<includeonly>=</includeonly>
En la Resolución 000012 punto 8. Suplemento A: Política de firma se especifica los detalles con respecto a la validez de la firma del documento electrónico, para la recepción de los documentos electrónicos es requerido que estos cuenten con una firma válida según lo indicado en la resolución 000012.

[https://www.dian.gov.co/normatividad/Normatividad/Resoluci%C3%B3n%20000012%20de%2009-02-2021.pdf Resolución 000012]
 
{{clear}}

===Esquema de integración directa para Factura Electrónica SOAP URL===
Contamos con un web service SOAP para pruebas en el cual se hacen validaciones iniciales frent ala DIAN, esto permite que puedan ir validando la estructura del objeto Factura y origen de datos propuesto por TFHKA. 
 

'''URL Ambiente DEMO (ambiente de pruebas en el cual las emisiones no son transmitidas a la DIAN)''':
 

[http://demorecepcion21.thefactoryhka.com.co/ReceptorWS.svc?wsdl
] --> DEMO (HTTP)
 
 
'''URL Ambiente Productivo (ambiente en el cual se realizan las emisiones correspondientes al set de habilitación y posteriormente la emisión de documentos en operación):'''
 

[https://recepcion21.thefactoryhka.com.co/ReceptorWS.svc?wsdl
] --> PRODUCCIÓN (HTTPS)
 
<center>
 
@IMPORTANTE:La url del servicio SOAP en producción solo esta funcional bajo el protocolo https.</center>
 
 
'''NOTA:''' Si no pueden acceder a dicha configuración en el interfaz del sistema, por favor, comunicarse con su casa de software o desarrollador del ERP con el fin de que puedan validar lo anteriormente descrito. De no solventarse el inconveniente con lo mencionado, por favor, enviar un correo al área de integración [mailto:integracion_fel_co@thefactoryhka.com integracion_fel_co@thefactoryhka.com] con la siguiente información:

* Request enviado al Web Service.
* Captura de la configuración realizada en el sistema donde se visualice la información de las URL y tokens indicada.
{{clear}}

===¿Qué es la Recepción Electrónica?===

Quienes adquieran bienes y/o servicios y sean facturadores electrónicos están en la obligación de recibir las facturas electrónicas a través de correo electrónico. La recepción de facturas electrónicas recibe el documento mediante el cual un proveedor acredita que nos ha proporcionado un producto o servicio con un precio determinado, de forma digitalizada.

===¿Quiénes están obligados a implementar Recepción Electrónica?===

Los contribuyentes que deseen el producto Drecepción, un medio para la recepción y control de sus documentos electrónicos. La recepción directa desde el portal está diseñada para personas con un bajo y alto volumen de operaciones, como pequeñas, medianas y grandes empresas o profesionales independientes. El portal es la herramienta de configuración de todos los medios que interactúen con la plataforma Drecepción (Aplicación Móvil o ERP).

===Ventajas de la Recepción Electrónica===

• HKARecepción permite optimizar la gestión de los documentos electrónicos con la identificación automática de los proveedores.
 
• Permite establecer reglas de negocio que faciliten la gestión de los
documentos
 
• También el sistema permite categorizar el tipo de proveedor de forma manual, para agrupar a los proveedores y mejorar los filtros de búsqueda en el manejo de los documentos.
 
• Permite la gestión de documentos agrupando los documentos y dándole posibilidad al usuario de visualizar la representación gráfica, la descarga del XML, manejar estatus personalizados y estatus DIAN.
 
• También permite incorporar el flujo de trabajo de la empresa en el sistema para gestionar los documentos.
 
• Garantiza el envío de eventos DIAN y la obtención de respuesta de los mismos.
 
• Facilita la búsqueda de un documento o varios de ellos en el sistema porque cuenta con los siguientes filtros de búsqueda: por estatus, por proveedor, por tipo de proveedor, por infodatos y por fechas.

Generalidades - Índice Manual Integración Recepción Electrónica

2025-12-10T20:52:54Z

Dmrodriguez2:

<includeonly>=</includeonly>==Historial de versiones==<includeonly>=</includeonly>
{| class="wikitable" style="margin: auto;"
|-
! style="background:#e9e9e9; text-align:center;"|Versión
! style="background:#e9e9e9; text-align:center;"|Fecha lanzamiento
! style="background:#e9e9e9; text-align:center;"|Descripción
|- valign="center"
| 0
| 12/01/22
|versión inicial
|}

<includeonly>=</includeonly>==Cómo obtener soporte==<includeonly>=</includeonly>
*Soporte de 1er nivel:
::Soporte telefónico / email / chat o tele-conferencias en horario 5x8 para atención de consultas y fallas de usuario.
*Soporte de 2do nivel:
::Soporte resolución remota de incidencias en el sistema en horario 5x8
::::Escriba a [mailto:soporte@thefactoryhka.com.co soporte@thefactoryhka.com.co]

Para consultas referente a configuraciones y errores en el Portal:
* soporte_fel_co@thefactoryhka.com

Para consultas referente a configuraciones de ERP, casa de software e integración:
* integracion_fel_co@thefactoryhka.com

'''Lineas de atención telefónica:'''
* '''MASTER''' +57 (1) 746.08.12
* +57 (1) 508.8990
* +57 (1) 517.6795
* +57 (1) 517.6796
* +57 (1) 311.3063
** '''Soporte Técnico''' → Opción 2
** '''Integración ''' → Opción 5 Luego Opción 1

<includeonly>=</includeonly>===Para Sesiones:===<includeonly>=</includeonly>

<includeonly>=</includeonly>====Sesiones Soporte====<includeonly>=</includeonly>
Manejo de métodos en soap.
'''Dirigido a:''' Agencias Comerciales – Casas de Software Aliadas - Clientes Finales

'''Horario:''' Martes y Jueves a partir de las 8:30 AM

[https://meet.google.com/yyg-pujr-yqv Enlace Sesiones de Soporte]

<includeonly>=</includeonly>====Sesiones Área Integración<includeonly>=</includeonly>====
Solución Casos de Integración

'''Dirigido a:''' Clientes que realicen desarrollos de Software para integrarse con TFHKA, Casas de Software Aliadas

'''Horario:''' Martes y Jueves a partir de las 8:30 AM

[http://meet.google.com/fzo-xmyc-duk Enlace Sesiones Integración]
{{clear}}

<includeonly>=</includeonly>==Descripción general==<includeonly>=</includeonly>
El presente documento es una guía para la integración de servicios y funcionalidades de HKA Recepción, la plataforma de The Factory HKA para la gestión de eventos a Documentos Electrónicos.

Se detallan los servicios del Web Service SOAP disponibles para los receptores, cubriendo el listado, descarga, cambio de estatus y remisión de archivos (XML, representación gráfica y anexos), especificando los requisitos mandatorios en la recepción de documentos para la validez de facturas a crédito como soporte de costos y títulos valor (Resolución 000012).

===¿Qué es The Factory HKA-Recepción?===
Es una plataforma de recepción electrónica, diseñada para dar cumplimiento a la legislación vigente en Colombia y ofrecer valores agregados mediante servicios complementarios.

===¿Qué es HKA Integración?===
Es un producto dirigido al integrador y está conformado por los siguientes componentes:
*Manuales de integración.
*Bolsa de horas de soporte vía email y/o tele-conferencias.
*Credenciales para ambiente de pruebas (DEMO) y productivo.
{{clear}}

===Funcionalidades===
La plataforma The Factory HKA DRECEPCION permite el envío de archivos anexos, representación
gráficas y archivos de XML correspondiente de documento de facturación electrónica generadas
por el usuario emisor, así como recepción y descarga de los siguientes documentos en formato
XML y/o su correspondiente representación gráfica en PDF:

* Acuse Recibo
* Cambio de Estatus
* ConsultarDocumentoMetadata
* Descargar Acuse Aceptación XML
* Descargar Acuse Recibido XML
* Descargar Anexo
* Descargar Rep. Gráfica
* Descargar XML
* Eliminar Anexo
* Eliminar Rep. Gráfica
* Enviar Anexo
* EnviarMetadata
* Enviar Rep. Gráfica
* Enviar XML
* Estado Documento
* Lista Anexo
* Reporte
* Reporte Status

===La integración directa===
La integración es una actividad esencial para la puesta en marcha de la recepción electrónica en un Sistema de Facturación o Software Administrativo (ERP) y se realizará sólo una vez. Esta actividad consiste en enlazar dos plataformas con tecnologías distintas con el objetivo de transmitir los datos necesarios para la construcción de los documentos y el seguimiento exitoso del ciclo de vida.

En el caso de la integración directa, la comunicación se conecta directamente al Web Service, lo cual tiene como ventaja el control total del ciclo de vida del documento electrónico, desde el origen de los datos, pasando por el proceso de transmisión hasta su entrega, acuse de recibo y validación. Esta forma de integración permite reaccionar de un modo más rápido y eficiente ante errores o inconsistencias que se presenten en el proceso.

La integración directa es un proceso exclusivo entre el software integrado y la plataforma The Factory HKA-RECEPCIÓN.

'''@Importante:''' No es necesario implementar integración adicional ante la DIAN, ya que se cuenta con la funcionalidad completa de seguimiento del estatus del documento.
{{clear}}

<includeonly>=</includeonly>==Requisitos para la recepción de documentos==<includeonly>=</includeonly>
{{clear}}
 
<includeonly>=</includeonly>====Estructura del correo electrónico:====<includeonly>=</includeonly>
Según el comunicado oficial de la Cámara Colombiana de Comercio Electrónico del 28 de agosto de 2020 en la disposición de adjuntos se indica que por cada documento electrónico se debe enviar un correo electrónico con un único archivo adjunto en .zip el cual debe contener de manera obligatoria el archivo xml AttachedDocument correspondiente y de manera opcional el archivo .pdf.

[https://www.ccce.org.co/wp-content/uploads/2017/06/CCCE-ConsensoInteroperabilidad-V-001-20200629.pdf Comunicado oficial de la Cámara Colombiana de Comercio Electrónico]

'''Alternativa para carga de documentos urgentes:'''
El proveedor puede acceder a su [[Usuario Proveedor (UP) - Portal DRecepción Validación Previa#Ingreso al Sistema para Usuario Proveedor|usuario Proveedor]] y realizar la carga manual de su documento en la opción Documentos -> [[Usuario Proveedor (UP) - Portal DRecepción Validación Previa#Ingreso al Sistema para Usuario Proveedor|Subir documentos]].
{{clear}}

 
<includeonly>=</includeonly>====Tipo de documento del adquiriente:====<includeonly>=</includeonly>
Para la recepción de documentos es requerido validar que el tipo de documento del adquiriente o receptor corresponda a NIT, lo anterior basándose en el anexo técnico 1.8, de lo contrario el documento electrónico puede ser rechazado por la regla FAJ48.

[https://www.dian.gov.co/impuestos/factura-electronica/Documents/Anexo-Tecnico-Resolucion-000012-09022021.pdf Anexo tecnico 1.8]
{{clear}}

 
<includeonly>=</includeonly>====Nit del receptor no debe contener el DV:====<includeonly>=</includeonly>
Según el anexo técnico 1.8 el NIT del adquiriente o receptor de los documentos electrónicos debe ser reportado en un campo diferente al DV, al no cumplirse con esta regla el documento puede ser rechazado por las reglas FAK63 y FAK64.

[https://www.dian.gov.co/impuestos/factura-electronica/Documents/Anexo-Tecnico-Resolucion-000012-09022021.pdf Anexo tecnico 1.8]
{{clear}}

 
<includeonly>=</includeonly>====Validez de la firma digital:====<includeonly>=</includeonly>
En la Resolución 000012 punto 8. Suplemento A: Política de firma se especifica los detalles con respecto a la validez de la firma del documento electrónico, para la recepción de los documentos electrónicos es requerido que estos cuenten con una firma válida según lo indicado en la resolución 000012.

[https://www.dian.gov.co/normatividad/Normatividad/Resoluci%C3%B3n%20000012%20de%2009-02-2021.pdf Resolución 000012]
 
{{clear}}

===Esquema de integración directa para Factura Electrónica SOAP URL===
Contamos con un web service SOAP para pruebas en el cual se hacen validaciones iniciales frent ala DIAN, esto permite que puedan ir validando la estructura del objeto Factura y origen de datos propuesto por TFHKA. 
 

'''URL Ambiente DEMO (ambiente de pruebas en el cual las emisiones no son transmitidas a la DIAN)''':
 

[http://demorecepcion21.thefactoryhka.com.co/ReceptorWS.svc?wsdl
] --> DEMO (HTTP)
 
 
'''URL Ambiente Productivo (ambiente en el cual se realizan las emisiones correspondientes al set de habilitación y posteriormente la emisión de documentos en operación):'''
 

[https://recepcion21.thefactoryhka.com.co/ReceptorWS.svc?wsdl
] --> PRODUCCIÓN (HTTPS)
 
<center>
 
@IMPORTANTE:La url del servicio SOAP en producción solo esta funcional bajo el protocolo https.</center>
 
 
'''NOTA:''' Si no pueden acceder a dicha configuración en el interfaz del sistema, por favor, comunicarse con su casa de software o desarrollador del ERP con el fin de que puedan validar lo anteriormente descrito. De no solventarse el inconveniente con lo mencionado, por favor, enviar un correo al área de integración [mailto:integracion_fel_co@thefactoryhka.com integracion_fel_co@thefactoryhka.com] con la siguiente información:

* Request enviado al Web Service.
* Captura de la configuración realizada en el sistema donde se visualice la información de las URL y tokens indicada.
{{clear}}

===¿Qué es la Recepción Electrónica?===

Quienes adquieran bienes y/o servicios y sean facturadores electrónicos están en la obligación de recibir las facturas electrónicas a través de correo electrónico. La recepción de facturas electrónicas recibe el documento mediante el cual un proveedor acredita que nos ha proporcionado un producto o servicio con un precio determinado, de forma digitalizada.

===¿Quiénes están obligados a implementar Recepción Electrónica?===

Los contribuyentes que deseen el producto Drecepción, un medio para la recepción y control de sus documentos electrónicos. La recepción directa desde el portal está diseñada para personas con un bajo y alto volumen de operaciones, como pequeñas, medianas y grandes empresas o profesionales independientes. El portal es la herramienta de configuración de todos los medios que interactúen con la plataforma Drecepción (Aplicación Móvil o ERP).

===Ventajas de la Recepción Electrónica===

• HKARecepción permite optimizar la gestión de los documentos electrónicos con la identificación automática de los proveedores.
 
• Permite establecer reglas de negocio que faciliten la gestión de los
documentos
 
• También el sistema permite categorizar el tipo de proveedor de forma manual, para agrupar a los proveedores y mejorar los filtros de búsqueda en el manejo de los documentos.
 
• Permite la gestión de documentos agrupando los documentos y dándole posibilidad al usuario de visualizar la representación gráfica, la descarga del XML, manejar estatus personalizados y estatus DIAN.
 
• También permite incorporar el flujo de trabajo de la empresa en el sistema para gestionar los documentos.
 
• Garantiza el envío de eventos DIAN y la obtención de respuesta de los mismos.
 
• Facilita la búsqueda de un documento o varios de ellos en el sistema porque cuenta con los siguientes filtros de búsqueda: por estatus, por proveedor, por tipo de proveedor, por infodatos y por fechas.

Índice del Manual de Integración Directa HKA Recepción

2025-12-10T20:37:37Z

Dmrodriguez2:

[[Category:Manuales|I]]
__NOTOC__
[[File:HKARecepcion 3.png|500px|center|HKAReepcion]]

<includeonly>=</includeonly>==[[Generalidades - Índice Manual Integración Recepción Electrónica|Generalidades]]==<includeonly>=</includeonly>
# [[Generalidades - Índice Manual Integración Recepción Electrónica#Historial de versiones|Historial de versiones]]
# [[Generalidades - Índice Manual Integración Recepción Electrónica#Cómo obtener soporte|Cómo obtener soporte]]
# [[Generalidades - Índice Manual Integración Recepción Electrónica#Descripción general|Descripción general]]
## [[Generalidades - Índice Manual Integración Recepción Electrónica#¿Qué es The Factory HKA-RECEPCIÓN?|¿Qué es The Factory HKA-RECEPCIÓN?]]
## [[Generalidades - Índice Manual Integración Recepción Electrónica#¿Qué es HKA Integración?|¿Qué es HKA Integración?]]
## [[Generalidades - Índice Manual Integración Recepción Electrónica#Funcionalidades|Funcionalidades]]
## [[Generalidades - Índice Manual Integración Recepción Electrónica#La integración directa|La integración directa]]
## [[Generalidades - Índice Manual Integración Recepción Electrónica#Requerimientos técnicos para la integración directa|Requerimientos técnicos para la integración directa]]
# [[Generalidades - Índice Manual Integración Recepción Electrónica#Esquema de operación de Recepción Electrónica|Esquema de operación de Recepción Electrónica]]
## [[Generalidades - Índice Manual Integración Recepción Electrónica#¿Qué es la Recepción Electrónica?|¿Qué es la Recepción Electrónica?]]
## [[Generalidades - Índice Manual Integración Recepción Electrónica#¿Quiénes están obligados a implementar Recepción Electrónica?|¿Quiénes están obligados a implementar Recepción Electrónica?]]
## [[Generalidades - Índice Manual Integración Recepción Electrónica#Ventajas de la Recepción Electrónica|Ventajas de la Recepción Electrónica]]

<includeonly>=</includeonly>==[[Funcionalidades - Índice Manual Integración Recepción Electrónica|Funcionalidades]]==<includeonly>=</includeonly>

# [[Funcionalidades - Índice Manual Integración Recepción Electrónica#Servicios de Recepción de XML, PDF y Anexos para Integradores|Servicios de Recepción de XML, PDF y Anexos para Integradores]]
# [[Índice Manual Integración Recepción Electrónica#Flujograma|Flujograma]]

<includeonly>=</includeonly>==[[Servicios de Manejo de Documentos Electrónicos para Receptor - Índice Manual Integración Recepción Electrónica|Servicios de Manejo de Documentos Electrónicos para Receptor]]==<includeonly>=</includeonly>
# [[Servicios de Manejo de Documentos Electrónicos para Receptor - Índice Manual Integración Recepción Electrónica#Método de Reporte con Estatus (ReporteStatus)|Método de Reporte con Estatus (ReporteStatus)]]
# [[Servicios de Manejo de Documentos Electrónicos para Receptor - Índice Manual Integración Recepción Electrónica#Método Reporte|Método Reporte]]
# [[Servicios de Manejo de Documentos Electrónicos para Receptor - Índice Manual Integración Recepción Electrónica#Método de Descarga XML|Método de Descarga XML]]
# [[Servicios de Manejo de Documentos Electrónicos para Receptor - Índice Manual Integración Recepción Electrónica#Método de Descarga RepresentacionGrafica|Método de Descarga RepresentacionGrafica]]
# [[Servicios de Manejo de Documentos Electrónicos para Receptor - Índice Manual Integración Recepción Electrónica#Método de Descarga de Adjuntos/Anexos|Método de Descarga de Adjuntos/Anexos]]
# [[Servicios de Manejo de Documentos Electrónicos para Receptor - Índice Manual Integración Recepción Electrónica#Método Consulta de Estado Documento|Método Consulta de Estado Documento]]
# [[Servicios de Manejo de Documentos Electrónicos para Receptor - Índice Manual Integración Recepción Electrónica#Método Cambio de Status|Método Cambio de Status]]
# [[Servicios de Manejo de Documentos Electrónicos para Receptor - Índice Manual Integración Recepción Electrónica#Método Consulta de Metadata (a los documentos) ConsultaDocumentosMetadata|Método Consulta de Metadata (a los documentos) ConsultaDocumentosMetadata]]
# [[Servicios de Manejo de Documentos Electrónicos para Receptor - Índice Manual Integración Recepción Electrónica#Método ListaAnexo|Método ListaAnexo]]
# [[Servicios de Manejo de Documentos Electrónicos para Receptor - Índice Manual Integración Recepción Electrónica#Método DecargaAnexo|Método DescargaAnexo]]
# [[Servicios de Manejo de Documentos Electrónicos para Receptor - Índice Manual Integración Recepción Electrónica#Método Envío de XML Método de “EnviarXML”|Método Envío de XML Método de “EnviarXML”]]
# [[Servicios de Manejo de Documentos Electrónicos para Receptor - Índice Manual Integración Recepción Electrónica#Método Envío de Representación Gráfica (EnviarRepGrafica)|Método Envío de Representación Gráfica (EnviarRepGrafica)]]
# [[Servicios de Manejo de Documentos Electrónicos para Receptor - Índice Manual Integración Recepción Electrónica#Método Envío de Anexo (EnvioAnexo)|Método Envío de Anexo (EnvioAnexo)]]

<includeonly>=</includeonly>==[[Tablas de códigos de propiedades para recepción de documentos - Índice Manual Integración Recepción Electrónica|Tablas de códigos de propiedades para recepción de documentos]]==<includeonly>=</includeonly>
# [[Tablas de códigos de propiedades para recepción de documentos - Índice Manual Integración Recepción Electrónica#Tabla 1|Tabla 1]]
# [[Tablas de códigos de propiedades para recepción de documentos - Índice Manual Integración Recepción Electrónica#Tabla 2|Tabla 2]]
# [[Tablas de códigos de propiedades para recepción de documentos - Índice Manual Integración Recepción Electrónica#Tabla 3|Tabla 3]]
# [[Tablas de códigos de propiedades para recepción de documentos - Índice Manual Integración Recepción Electrónica#Tabla 4|Tabla 4]]
# [[Tablas de códigos de propiedades para recepción de documentos - Índice Manual Integración Recepción Electrónica#Tabla 5|Tabla 5]]
# [[Tablas de códigos de propiedades para recepción de documentos - Índice Manual Integración Recepción Electrónica#Tabla 6|Tabla 6]]

Generalidades - Índice Manual Integración Recepción Electrónica

2025-12-10T18:09:58Z

Dmrodriguez2: /* ¿Qué es The Factory HKA-RECEPCIÓN? */

<includeonly>=</includeonly>==Historial de versiones==<includeonly>=</includeonly>
{| class="wikitable" style="margin: auto;"
|-
! style="background:#e9e9e9; text-align:center;"|Versión
! style="background:#e9e9e9; text-align:center;"|Fecha lanzamiento
! style="background:#e9e9e9; text-align:center;"|Descripción
|- valign="center"
| 0
| 12/01/22
|versión inicial
|}

<includeonly>=</includeonly>==Cómo obtener soporte==<includeonly>=</includeonly>
*Soporte de 1er nivel:
::Soporte telefónico / email / chat o tele-conferencias en horario 5x8 para atención de consultas y fallas de usuario.
*Soporte de 2do nivel:
::Soporte resolución remota de incidencias en el sistema en horario 5x8
::::Escriba a [mailto:soporte@thefactoryhka.com.co soporte@thefactoryhka.com.co]

Para consultas referente a configuraciones y errores en el Portal:
* soporte_fel_co@thefactoryhka.com

Para consultas referente a configuraciones de ERP, casa de software e integración:
* integracion_fel_co@thefactoryhka.com

'''Lineas de atención telefónica:'''
* '''MASTER''' +57 (1) 746.08.12
* +57 (1) 508.8990
* +57 (1) 517.6795
* +57 (1) 517.6796
* +57 (1) 311.3063
** '''Soporte Técnico''' → Opción 2
** '''Integración ''' → Opción 5 Luego Opción 1

<includeonly>=</includeonly>===Para Sesiones:===<includeonly>=</includeonly>

<includeonly>=</includeonly>====Sesiones Soporte====<includeonly>=</includeonly>
Manejo de métodos en soap.
'''Dirigido a:''' Agencias Comerciales – Casas de Software Aliadas - Clientes Finales

'''Horario:''' Martes y Jueves a partir de las 8:30 AM

[https://meet.google.com/yyg-pujr-yqv Enlace Sesiones de Soporte]

<includeonly>=</includeonly>====Sesiones Área Integración<includeonly>=</includeonly>====
Solución Casos de Integración

'''Dirigido a:''' Clientes que realicen desarrollos de Software para integrarse con TFHKA, Casas de Software Aliadas

'''Horario:''' Martes y Jueves a partir de las 8:30 AM

[http://meet.google.com/fzo-xmyc-duk Enlace Sesiones Integración]
{{clear}}

<includeonly>=</includeonly>==Descripción general==<includeonly>=</includeonly>
El presente documento es una guía para la integración de servicios y funcionalidades de HKA Recepción, la plataforma de The Factory HKA para la gestión de eventos a Documentos Electrónicos.

Se detallan los servicios del Web Service SOAP disponibles para los receptores, cubriendo el listado, descarga, cambio de estatus y remisión de archivos (XML, representación gráfica y anexos), especificando los requisitos mandatorios en la recepción de documentos para la validez de facturas a crédito como soporte de costos y títulos valor (Resolución 000012).

===¿Qué es The Factory HKA-Recepción?===
Es una plataforma de recepción electrónica, diseñada para dar cumplimiento a la legislación vigente en Colombia y ofrecer valores agregados mediante servicios complementarios.

===¿Qué es HKA Integración?===
Es un producto dirigido al integrador y está conformado por los siguientes componentes:
*Manuales de integración.
*Bolsa de horas de soporte vía email y/o tele-conferencias.
*Credenciales para ambiente de pruebas (DEMO) y productivo.
{{clear}}

===La integración directa===
La integración es una actividad esencial para la puesta en marcha de la recepción electrónica en un Sistema de Facturación o Software Administrativo (ERP) y se realizará sólo una vez. Esta actividad consiste en enlazar dos plataformas con tecnologías distintas con el objetivo de transmitir los datos necesarios para la construcción de los documentos y el seguimiento exitoso del ciclo de vida.

En el caso de la integración directa, la comunicación se conecta directamente al Web Service, lo cual tiene como ventaja el control total del ciclo de vida del documento electrónico, desde el origen de los datos, pasando por el proceso de transmisión hasta su entrega, acuse de recibo y validación. Esta forma de integración permite reaccionar de un modo más rápido y eficiente ante errores o inconsistencias que se presenten en el proceso.

La integración directa es un proceso exclusivo entre el software integrado y la plataforma The Factory HKA-RECEPCIÓN.

'''@Importante:''' No es necesario implementar integración adicional ante la DIAN, ya que se cuenta con la funcionalidad completa de seguimiento del estatus del documento.
{{clear}}

<includeonly>=</includeonly>==Requisitos para la recepción de documentos==<includeonly>=</includeonly>
{{clear}}
 
<includeonly>=</includeonly>====Estructura del correo electrónico:====<includeonly>=</includeonly>
Según el comunicado oficial de la Cámara Colombiana de Comercio Electrónico del 28 de agosto de 2020 en la disposición de adjuntos se indica que por cada documento electrónico se debe enviar un correo electrónico con un único archivo adjunto en .zip el cual debe contener de manera obligatoria el archivo xml AttachedDocument correspondiente y de manera opcional el archivo .pdf.

[https://www.ccce.org.co/wp-content/uploads/2017/06/CCCE-ConsensoInteroperabilidad-V-001-20200629.pdf Comunicado oficial de la Cámara Colombiana de Comercio Electrónico]

'''Alternativa para carga de documentos urgentes:'''
El proveedor puede acceder a su [[Usuario Proveedor (UP) - Portal DRecepción Validación Previa#Ingreso al Sistema para Usuario Proveedor|usuario Proveedor]] y realizar la carga manual de su documento en la opción Documentos -> [[Usuario Proveedor (UP) - Portal DRecepción Validación Previa#Ingreso al Sistema para Usuario Proveedor|Subir documentos]].
{{clear}}

 
<includeonly>=</includeonly>====Tipo de documento del adquiriente:====<includeonly>=</includeonly>
Para la recepción de documentos es requerido validar que el tipo de documento del adquiriente o receptor corresponda a NIT, lo anterior basándose en el anexo técnico 1.8, de lo contrario el documento electrónico puede ser rechazado por la regla FAJ48.

[https://www.dian.gov.co/impuestos/factura-electronica/Documents/Anexo-Tecnico-Resolucion-000012-09022021.pdf Anexo tecnico 1.8]
{{clear}}

 
<includeonly>=</includeonly>====Nit del receptor no debe contener el DV:====<includeonly>=</includeonly>
Según el anexo técnico 1.8 el NIT del adquiriente o receptor de los documentos electrónicos debe ser reportado en un campo diferente al DV, al no cumplirse con esta regla el documento puede ser rechazado por las reglas FAK63 y FAK64.

[https://www.dian.gov.co/impuestos/factura-electronica/Documents/Anexo-Tecnico-Resolucion-000012-09022021.pdf Anexo tecnico 1.8]
{{clear}}

 
<includeonly>=</includeonly>====Validez de la firma digital:====<includeonly>=</includeonly>
En la Resolución 000012 punto 8. Suplemento A: Política de firma se especifica los detalles con respecto a la validez de la firma del documento electrónico, para la recepción de los documentos electrónicos es requerido que estos cuenten con una firma válida según lo indicado en la resolución 000012.

[https://www.dian.gov.co/normatividad/Normatividad/Resoluci%C3%B3n%20000012%20de%2009-02-2021.pdf Resolución 000012]
 
{{clear}}

===Esquema de integración directa para Factura Electrónica SOAP URL===
Contamos con un web service SOAP para pruebas en el cual se hacen validaciones iniciales frent ala DIAN, esto permite que puedan ir validando la estructura del objeto Factura y origen de datos propuesto por TFHKA. 
 

'''URL Ambiente DEMO (ambiente de pruebas en el cual las emisiones no son transmitidas a la DIAN)''':
 

[http://demorecepcion21.thefactoryhka.com.co/ReceptorWS.svc?wsdl
] --> DEMO (HTTP)
 
 
'''URL Ambiente Productivo (ambiente en el cual se realizan las emisiones correspondientes al set de habilitación y posteriormente la emisión de documentos en operación):'''
 

[https://recepcion21.thefactoryhka.com.co/ReceptorWS.svc?wsdl
] --> PRODUCCIÓN (HTTPS)
 
<center>
 
@IMPORTANTE:La url del servicio SOAP en producción solo esta funcional bajo el protocolo https.</center>
 
 
'''NOTA:''' Si no pueden acceder a dicha configuración en el interfaz del sistema, por favor, comunicarse con su casa de software o desarrollador del ERP con el fin de que puedan validar lo anteriormente descrito. De no solventarse el inconveniente con lo mencionado, por favor, enviar un correo al área de integración [mailto:integracion_fel_co@thefactoryhka.com integracion_fel_co@thefactoryhka.com] con la siguiente información:

* Request enviado al Web Service.
* Captura de la configuración realizada en el sistema donde se visualice la información de las URL y tokens indicada.
{{clear}}

===¿Qué es la Recepción Electrónica?===

Quienes adquieran bienes y/o servicios y sean facturadores electrónicos están en la obligación de recibir las facturas electrónicas a través de correo electrónico. La recepción de facturas electrónicas recibe el documento mediante el cual un proveedor acredita que nos ha proporcionado un producto o servicio con un precio determinado, de forma digitalizada.

===¿Quiénes están obligados a implementar Recepción Electrónica?===

Los contribuyentes que deseen el producto Drecepción, un medio para la recepción y control de sus documentos electrónicos. La recepción directa desde el portal está diseñada para personas con un bajo y alto volumen de operaciones, como pequeñas, medianas y grandes empresas o profesionales independientes. El portal es la herramienta de configuración de todos los medios que interactúen con la plataforma Drecepción (Aplicación Móvil o ERP).

===Ventajas de la Recepción Electrónica===

• HKARecepción permite optimizar la gestión de los documentos electrónicos con la identificación automática de los proveedores.
 
• Permite establecer reglas de negocio que faciliten la gestión de los
documentos
 
• También el sistema permite categorizar el tipo de proveedor de forma manual, para agrupar a los proveedores y mejorar los filtros de búsqueda en el manejo de los documentos.
 
• Permite la gestión de documentos agrupando los documentos y dándole posibilidad al usuario de visualizar la representación gráfica, la descarga del XML, manejar estatus personalizados y estatus DIAN.
 
• También permite incorporar el flujo de trabajo de la empresa en el sistema para gestionar los documentos.
 
• Garantiza el envío de eventos DIAN y la obtención de respuesta de los mismos.
 
• Facilita la búsqueda de un documento o varios de ellos en el sistema porque cuenta con los siguientes filtros de búsqueda: por estatus, por proveedor, por tipo de proveedor, por infodatos y por fechas.

Generalidades - Índice Manual Integración Recepción Electrónica

2025-12-10T17:55:51Z

Dmrodriguez2:

<includeonly>=</includeonly>==Historial de versiones==<includeonly>=</includeonly>
{| class="wikitable" style="margin: auto;"
|-
! style="background:#e9e9e9; text-align:center;"|Versión
! style="background:#e9e9e9; text-align:center;"|Fecha lanzamiento
! style="background:#e9e9e9; text-align:center;"|Descripción
|- valign="center"
| 0
| 12/01/22
|versión inicial
|}

<includeonly>=</includeonly>==Cómo obtener soporte==<includeonly>=</includeonly>
*Soporte de 1er nivel:
::Soporte telefónico / email / chat o tele-conferencias en horario 5x8 para atención de consultas y fallas de usuario.
*Soporte de 2do nivel:
::Soporte resolución remota de incidencias en el sistema en horario 5x8
::::Escriba a [mailto:soporte@thefactoryhka.com.co soporte@thefactoryhka.com.co]

Para consultas referente a configuraciones y errores en el Portal:
* soporte_fel_co@thefactoryhka.com

Para consultas referente a configuraciones de ERP, casa de software e integración:
* integracion_fel_co@thefactoryhka.com

'''Lineas de atención telefónica:'''
* '''MASTER''' +57 (1) 746.08.12
* +57 (1) 508.8990
* +57 (1) 517.6795
* +57 (1) 517.6796
* +57 (1) 311.3063
** '''Soporte Técnico''' → Opción 2
** '''Integración ''' → Opción 5 Luego Opción 1

<includeonly>=</includeonly>===Para Sesiones:===<includeonly>=</includeonly>

<includeonly>=</includeonly>====Sesiones Soporte====<includeonly>=</includeonly>
Manejo de métodos en soap.
'''Dirigido a:''' Agencias Comerciales – Casas de Software Aliadas - Clientes Finales

'''Horario:''' Martes y Jueves a partir de las 8:30 AM

[https://meet.google.com/yyg-pujr-yqv Enlace Sesiones de Soporte]

<includeonly>=</includeonly>====Sesiones Área Integración<includeonly>=</includeonly>====
Solución Casos de Integración

'''Dirigido a:''' Clientes que realicen desarrollos de Software para integrarse con TFHKA, Casas de Software Aliadas

'''Horario:''' Martes y Jueves a partir de las 8:30 AM

[http://meet.google.com/fzo-xmyc-duk Enlace Sesiones Integración]
{{clear}}

<includeonly>=</includeonly>==Descripción general==<includeonly>=</includeonly>
El presente documento es una guía para la integración de servicios y funcionalidades de HKA Recepción, la plataforma de The Factory HKA para la gestión de eventos a Documentos Electrónicos.

Se detallan los servicios del Web Service SOAP disponibles para los receptores, cubriendo el listado, descarga, cambio de estatus y remisión de archivos (XML, representación gráfica y anexos), especificando los requisitos mandatorios en la recepción de documentos para la validez de facturas a crédito como soporte de costos y títulos valor (Resolución 000012).

===¿Qué es The Factory HKA-RECEPCIÓN?===
Es una plataforma de recepción electrónica, diseñada para dar cumplimiento a la legislación vigente en Colombia y ofrecer valores agregados mediante servicios complementarios.

===¿Qué es Dintegración?===
Es un producto dirigido al integrador y está conformado por los siguientes componentes:
*Manuales de integración.
*Bolsa de horas de soporte vía email y/o tele-conferencias.
*Credenciales para ambiente de pruebas (DEMO) y productivo.
{{clear}}

===La integración directa===
La integración es una actividad esencial para la puesta en marcha de la recepción electrónica en un Sistema de Facturación o Software Administrativo (ERP) y se realizará sólo una vez. Esta actividad consiste en enlazar dos plataformas con tecnologías distintas con el objetivo de transmitir los datos necesarios para la construcción de los documentos y el seguimiento exitoso del ciclo de vida.

En el caso de la integración directa, la comunicación se conecta directamente al Web Service, lo cual tiene como ventaja el control total del ciclo de vida del documento electrónico, desde el origen de los datos, pasando por el proceso de transmisión hasta su entrega, acuse de recibo y validación. Esta forma de integración permite reaccionar de un modo más rápido y eficiente ante errores o inconsistencias que se presenten en el proceso.

La integración directa es un proceso exclusivo entre el software integrado y la plataforma The Factory HKA-RECEPCIÓN.

'''@Importante:''' No es necesario implementar integración adicional ante la DIAN, ya que se cuenta con la funcionalidad completa de seguimiento del estatus del documento.
{{clear}}

<includeonly>=</includeonly>==Requisitos para la recepción de documentos==<includeonly>=</includeonly>
{{clear}}
 
<includeonly>=</includeonly>====Estructura del correo electrónico:====<includeonly>=</includeonly>
Según el comunicado oficial de la Cámara Colombiana de Comercio Electrónico del 28 de agosto de 2020 en la disposición de adjuntos se indica que por cada documento electrónico se debe enviar un correo electrónico con un único archivo adjunto en .zip el cual debe contener de manera obligatoria el archivo xml AttachedDocument correspondiente y de manera opcional el archivo .pdf.

[https://www.ccce.org.co/wp-content/uploads/2017/06/CCCE-ConsensoInteroperabilidad-V-001-20200629.pdf Comunicado oficial de la Cámara Colombiana de Comercio Electrónico]

'''Alternativa para carga de documentos urgentes:'''
El proveedor puede acceder a su [[Usuario Proveedor (UP) - Portal DRecepción Validación Previa#Ingreso al Sistema para Usuario Proveedor|usuario Proveedor]] y realizar la carga manual de su documento en la opción Documentos -> [[Usuario Proveedor (UP) - Portal DRecepción Validación Previa#Ingreso al Sistema para Usuario Proveedor|Subir documentos]].
{{clear}}

 
<includeonly>=</includeonly>====Tipo de documento del adquiriente:====<includeonly>=</includeonly>
Para la recepción de documentos es requerido validar que el tipo de documento del adquiriente o receptor corresponda a NIT, lo anterior basándose en el anexo técnico 1.8, de lo contrario el documento electrónico puede ser rechazado por la regla FAJ48.

[https://www.dian.gov.co/impuestos/factura-electronica/Documents/Anexo-Tecnico-Resolucion-000012-09022021.pdf Anexo tecnico 1.8]
{{clear}}

 
<includeonly>=</includeonly>====Nit del receptor no debe contener el DV:====<includeonly>=</includeonly>
Según el anexo técnico 1.8 el NIT del adquiriente o receptor de los documentos electrónicos debe ser reportado en un campo diferente al DV, al no cumplirse con esta regla el documento puede ser rechazado por las reglas FAK63 y FAK64.

[https://www.dian.gov.co/impuestos/factura-electronica/Documents/Anexo-Tecnico-Resolucion-000012-09022021.pdf Anexo tecnico 1.8]
{{clear}}

 
<includeonly>=</includeonly>====Validez de la firma digital:====<includeonly>=</includeonly>
En la Resolución 000012 punto 8. Suplemento A: Política de firma se especifica los detalles con respecto a la validez de la firma del documento electrónico, para la recepción de los documentos electrónicos es requerido que estos cuenten con una firma válida según lo indicado en la resolución 000012.

[https://www.dian.gov.co/normatividad/Normatividad/Resoluci%C3%B3n%20000012%20de%2009-02-2021.pdf Resolución 000012]
 
{{clear}}

===Esquema de integración directa para Factura Electrónica SOAP URL===
Contamos con un web service SOAP para pruebas en el cual se hacen validaciones iniciales frent ala DIAN, esto permite que puedan ir validando la estructura del objeto Factura y origen de datos propuesto por TFHKA. 
 

'''URL Ambiente DEMO (ambiente de pruebas en el cual las emisiones no son transmitidas a la DIAN)''':
 

[http://demorecepcion21.thefactoryhka.com.co/ReceptorWS.svc?wsdl
] --> DEMO (HTTP)
 
 
'''URL Ambiente Productivo (ambiente en el cual se realizan las emisiones correspondientes al set de habilitación y posteriormente la emisión de documentos en operación):'''
 

[https://recepcion21.thefactoryhka.com.co/ReceptorWS.svc?wsdl
] --> PRODUCCIÓN (HTTPS)
 
<center>
 
@IMPORTANTE:La url del servicio SOAP en producción solo esta funcional bajo el protocolo https.</center>
 
 
'''NOTA:''' Si no pueden acceder a dicha configuración en el interfaz del sistema, por favor, comunicarse con su casa de software o desarrollador del ERP con el fin de que puedan validar lo anteriormente descrito. De no solventarse el inconveniente con lo mencionado, por favor, enviar un correo al área de integración [mailto:integracion_fel_co@thefactoryhka.com integracion_fel_co@thefactoryhka.com] con la siguiente información:

* Request enviado al Web Service.
* Captura de la configuración realizada en el sistema donde se visualice la información de las URL y tokens indicada.
{{clear}}

===¿Qué es la Recepción Electrónica?===

Quienes adquieran bienes y/o servicios y sean facturadores electrónicos están en la obligación de recibir las facturas electrónicas a través de correo electrónico. La recepción de facturas electrónicas recibe el documento mediante el cual un proveedor acredita que nos ha proporcionado un producto o servicio con un precio determinado, de forma digitalizada.

===¿Quiénes están obligados a implementar Recepción Electrónica?===

Los contribuyentes que deseen el producto Drecepción, un medio para la recepción y control de sus documentos electrónicos. La recepción directa desde el portal está diseñada para personas con un bajo y alto volumen de operaciones, como pequeñas, medianas y grandes empresas o profesionales independientes. El portal es la herramienta de configuración de todos los medios que interactúen con la plataforma Drecepción (Aplicación Móvil o ERP).

===Ventajas de la Recepción Electrónica===

• HKARecepción permite optimizar la gestión de los documentos electrónicos con la identificación automática de los proveedores.
 
• Permite establecer reglas de negocio que faciliten la gestión de los
documentos
 
• También el sistema permite categorizar el tipo de proveedor de forma manual, para agrupar a los proveedores y mejorar los filtros de búsqueda en el manejo de los documentos.
 
• Permite la gestión de documentos agrupando los documentos y dándole posibilidad al usuario de visualizar la representación gráfica, la descarga del XML, manejar estatus personalizados y estatus DIAN.
 
• También permite incorporar el flujo de trabajo de la empresa en el sistema para gestionar los documentos.
 
• Garantiza el envío de eventos DIAN y la obtención de respuesta de los mismos.
 
• Facilita la búsqueda de un documento o varios de ellos en el sistema porque cuenta con los siguientes filtros de búsqueda: por estatus, por proveedor, por tipo de proveedor, por infodatos y por fechas.

Generalidades - Indice Manual Integración Nómina Electrónica

2025-11-04T17:39:26Z

Dmrodriguez2:

<includeonly>=</includeonly>==¿Cómo obtener soporte y ayuda?==<includeonly>=</includeonly>


<includeonly>=</includeonly>===Canales de Soporte===<includeonly>=</includeonly>
<includeonly>=</includeonly>===Correo Electrónico:===<includeonly>=</includeonly>
:Para consultas referente a configuraciones y errores en el Portal:
::* soporte_fel_co@thefactoryhka.com

:Para consultas referente a configuraciones de ERP, casa de software e integración:
::* integracion_fel_co@thefactoryhka.com

<includeonly>=</includeonly>===Lineas de atención telefónica:===<includeonly>=</includeonly>
* '''MASTER''' +57 (601) 746.08.12
* '''MASTER''' +57 (601) 508.48.68

** '''Soporte Técnico''' → Opción 2
** '''Integración y Representaciones Gráficas''' → Opción 5
 
<includeonly>=</includeonly>===Para Sesiones de Nómina Electrónica:===<includeonly>=</includeonly>
 
<includeonly>=</includeonly>====Sesiones Soporte Nómina Electrónica====<includeonly>=</includeonly>
Registro para Nómina Electrónica, Configuración de Rangos de Numeración, Configuración Datos Fiscales, Proceso y Pruebas de Habilitación, Configuración ambiente Producción, manejo y uso del Portal de Nómina electrónica de TFHKA

'''Dirigido a:''' Agencias Comerciales – Casas de Software Aliadas - Clientes Finales

'''Horario:''' Martes y Jueves a partir de las 8:30 AM

[https://meet.google.com/kpm-npie-hhf Enlace Sesiones de Soporte]

<includeonly>=</includeonly>====Sesiones de Integración Nómina Electrónica<includeonly>=</includeonly>====
Manejo de consultas referentes al uso de del Web Service, esquemas de integración, Procesos de Habilitación, Procesos y casos de uso en Producción

'''Dirigido a:''' Clientes que realicen desarrollos de Software para integrarse con TFHKA, Casas de Software Aliadas

'''Horario:''' Martes y Jueves a partir de las 8:30 AM

[https://meet.google.com/fzo-xmyc-duk Enlace Sesiones Integración]

<includeonly>=</includeonly>==Descripción general==<includeonly>=</includeonly>
En el presente documento se describe el proceso de integración entre el modelo de nómina electrónica de acuerdo a las actualizaciones normativas y técnicas proveniente de la DIAN y/o controles propios en nuestro modelo de integración.

Para el desarrollo de éste documento, se tomó como referencia los '''Resolución Número 000013 (11 FEB 2021 )'''.

{{clear}}

===¿Qué es The Factory HKA?===
Es una plataforma de facturación electrónica, diseñada para dar cumplimiento a la legislación vigente en Colombia y ofrecer valores agregados mediante servicios complementarios.
===¿Qué es The Factory HKA NÓMINA?===
Es un portal con capacidad de emitir documentos bajo el esquema de nómina electrónica, administrada desde el portal web y dirigido a empleadores que tengan la obligación de expedir nómina electrónica por resolución de la DIAN.
===¿Qué es Dintegración?===
Es un producto dirigido al integrador y está conformado por los siguientes componentes:
*Manuales de integración.
*Bolsa de horas de soporte vía email y/o tele-conferencias.
*Credenciales para ambiente de pruebas (DEMO) y productivo.
*Templates configurables para representación gráfica.
{{clear}}
===Funcionalidades===
La plataforma The Factory HKA permite la emisión y descarga de los siguientes documentos en formato XML y/o su correspondiente representación gráfica en PDF:
*Documento Soporte de Pago de Nómina Electrónica Individual
*Nota de Ajuste del documento de Pago Nómina Electrónica.
Adicionalmente, la plataforma permite consultar el estatus del Acuse de Recibo por parte del adquirente, estatus del documento por parte de la DIAN, consultar la cantidad de timbres/folios disponibles y enviar comprobantes a través de correo electrónico.

'''@Importante:''' Solo es posible visualizar en nuestro portal web o descargar representaciones graficas (PDF de documentos electrónicos) generados por nuestra plataforma.
{{clear}}

===La integración directa===
La integración es una actividad esencial para la puesta en marcha de la nómina electrónica en un Sistema de Facturación o Software Administrativo (ERP) y se realizará sólo una vez. Esta actividad consiste en enlazar dos plataformas con tecnologías distintas con el objetivo de transmitir los datos necesarios para la construcción de los documentos y el seguimiento exitoso del ciclo de vida.

En el caso de la integración directa, la comunicación se conecta directamente al Web Service, lo cual tiene como ventaja el control total del ciclo de vida del documento electrónico, desde el origen de los datos, pasando por el proceso de transmisión hasta su entrega, acuse de recibo y validación. Esta forma de integración permite reaccionar de un modo más rápido y eficiente ante errores o inconsistencias que se presenten en el proceso.

La integración directa es un proceso exclusivo entre el software integrado y la plataforma The Factory HKA.

'''@Importante:''' No es necesario implementar integración adicional ante la DIAN, ya que se cuenta con la funcionalidad completa de seguimiento del estatus del documento.
{{clear}}
===Requerimientos técnicos para la integración directa===
The Factory HKA es una plataforma tipo SaaS (Software as a Service): Los servicios, la información, el procesamiento, los insumos y resultados están alojados en nuestros servidores (como proveedor tecnológico), y nos ocupamos del mantenimiento, la operación, los cambios normativos y el soporte de la solución.

Por normativa de la DIAN, el proveedor tecnológico tiene la obligación de conservar los documentos y garantizar la integridad y seguridad de los datos bajo el estándar ISO 27001. Por tanto, no es necesario una extensa planificación de infraestructura de procesamiento y almacenamiento para implementar la facturación electrónica y nómina electrónica.

Los parámetros necesarios para la construcción de cada transacción son expuestos independientemente al momento de consumir los servicios, y el resultado es entregado enteramente al final de la operación. Eso significa que The Factory HKA no requiere manejar bases de datos de clientes o productos/servicios.
Como proveedor tecnológico, The Factory HKA Colombia cuenta con recurso humano dedicado a hacer seguimiento y analizar los cambios normativos que progresivamente emite la DIAN. De generarse un cambio significativo que impacte del lado de la integración como, se proveerá de las herramientas necesarias y de instrucciones para aplicar los correctivos de la forma más sencilla posible.

La plataforma The Factory HKA pone a disposición de la integración un Web Service como solución para interoperación con terceros. '''El Web Service está desarrollado en SOAP (Simple Object Access Protocol)'''. Por tanto, como únicos requerimientos para la integración serán los siguientes:
*Capacidad de consumo de WS SOAP del software (ambiente de desarrollo) a utilizar.
*Capacidad de captación y validación de los datos de entrada.
*Opcional: Capacidad para almacenar copia del XML/PDF por transacción.
*Capacidad para el despliegue del estado del ciclo de vida del documento electrónico.
{{clear}}

<includeonly>=</includeonly>==Esquema de operación de Nómina Electrónica==<includeonly>=</includeonly>
===¿Qué es la Nómina Electrónica?===
El documento Soporte de Pago de Nomina Electrónica es aquel que constituye el soporte de los costos y deducciones en el impuesto sobre la renta y complementarios e impuestos descontables del IVA – Cuando aplique – y el cual es derivado de los pagos o abonos en cuenta relacionados con la nómina que se desprenden de una relación laboral, o legal y reglamentaria, y está compuesto por los valores devengados de nómina, los valores deducidos de nómina, y el valor total de la diferencia de los mismos. éste documento se debe generar y transmitir para la validación de la DIAN de manera independiente por cada para cada uno de los beneficiarios de los pagos realizados por parte del sujeto obligado. El sujeto obligado es aquel que requiera este documento como soporte de costos, gastos y deducciones.”

'''En el modelo de Nómina Electrónica se utilizarán 2 tipos de documentos:'''

El Documento Soporte de Pago de Nómina Electrónica y la Nota de Ajuste del Documento Soporte de Pago de Nómina Electrónica, para que sean documentos soporte de
costos y deducciones en el impuesto sobre la renta y complementarios, de conformidad con lo dispuesto en el parágrafo 6 del artículo 616‐1.
El formato No pertenece al Estandar Universal Business Language – UBL. La generación del Documento Soporte de Pago de la Nómina Electrónica y la Nota de Ajuste del
Documento Soporte de Pago de Nómina Electrónica poseen las siguientes características:

*Documento Soporte de Pago de Nómina Electrónica (NominaIndividual):
Debe existir al menos 1 documento de este tipo por cada empleado que tenga la empresa por mes, el cual corresponde al Comprobante de Nómina de dicho trabajador.

* Nota de Ajuste del Documento Soporte de Pago de Nómina Electrónica (NominaIndividualDeAjuste):
Debe existir 1 documento de este tipo por cada Documento Soporte de Pago de Nómina Electrónica de cada empleado que tenga la empresa el cual se deba ajustar o reemplazar por errores aritméticos contables o de contenido y que el sujeto obligado deberá ajustar o corregir. Este documento electrónico podrá hacerse tantas veces como correcciones se requieran realizar sobre un mismo Documento Soporte de Pago de Nómina Electrónica, siendo la última nota de ajuste del documento soporte de pago de nómina electrónica validada, la que sirva como soporte.
Este documento también permite eliminar un Documento Soporte de Pago de Nómina Electrónica
o una Nota de Ajuste del Documento Soporte de Pago de Nómina Electrónica que el sujeto
obligado deba eliminar por errores contables o de procedimiento
{{clear}}
===¿Quiénes están obligados a implementar Nómina Electrónica?===
'''Empresas como la tuya que generan empleo y responden a una relación empleador – empleado debidamente legalizada por un contrato laboral que se encuentre bajo las instancias del Código Sustantivo del Trabajo en donde se requieran soportar costos o deducciones con afectación directa al impuesto sobre la renta. 
{{clear}}

===Ventajas de la Nómina Electrónica===
A continuación, te presentamos los 3 principales beneficios que tendrás al emitir nómina electrónica:
*Tendrás como descuentos tributarios los pagos que realices a tus empleados.
*Información en tiempo real de tus empleados, lo que te permitirá ahorrar tiempo revisando miles de reportes e informes.
*Mayor panorama en la toma de decisiones importantes referentes a tu equipo de trabajo.
{clear}}
<includeonly>=</includeonly>==Esquema de integración directa para Nómina Electrónica==<includeonly>=</includeonly>
Contamos con un web service para pruebas en el cual se hacen validaciones iniciales ya pueden ir validando la estructura del objeto Nomina y origen de datos propuesto por TFHKA.

A la fecha la DIAN no ha liberado el ambiente de pruebas, por lo cual, se irán liberando todas las validaciones progresivamente conforme la DIAN libere.

Se cuenta con tres esquemas de integración directos los cuales se expondrán a continuación:

===Integración directa por Servicio REST===

URL DEMO Servicio REST:
[http://demo-nomina-rest.thefactoryhka.com.co http://demo-nomina-rest.thefactoryhka.com.co]
 
URL Producción Servicio REST:
[https://nomina-rest.thefactoryhka.com.co https://nomina-rest.thefactoryhka.com.co]
 
<DIV ALIGN=justify>@IMPORTANTE:La url del servicio rest en producción solo esta funcional bajo el protocolo https.

*Documentación y Ejemplos:
:[https://drive.google.com/open?id=1qwOz9P1nA0QQEmGrJ-L9NaeBgekolqoN&authuser=jserrano%40thefactoryhka.com&usp=drive_fs Enlace Drive]

Para pruebas con este escenario de Integración podrás utilizar la herramienta '''POSTMAN'''
::[https://www.postman.com/downloads/ Descarga aquí Postman]

===Integración directa por Servicio SOAP===

URL DEMO Servicio SOAP:
[http://demo-nomina-temp-soap.thefactoryhka.com.co/Service.svc?wsdl http://demo-nomina-temp-soap.thefactoryhka.com.co/Service.svc?wsdl]
 
URL Producción Servicio SOAP:
[https://nomina-soap.thefactoryhka.com.co/Service.svc?wsdl https://nomina-soap.thefactoryhka.com.co/Service.svc?wsdl]
 
<DIV ALIGN=justify>@IMPORTANTE:La url del servicio SOAP en producción solo esta funcional bajo el protocolo https.

*Documentación y Ejemplos:
:[https://drive.google.com/open?id=1qz5jKJhil9lQQmn7-E_Sm9zXWsZp3i6G&authuser=jserrano%40thefactoryhka.com&usp=drive_fs Enlace Drive]

Para pruebas con este escenario de Integración podrás utilizar la herramienta '''SOAP UI'''
::[https://www.soapui.org/downloads/soapui/?v=1/ Descarga aquí SOAP UI]

===Integración directa por Archivos Planos, usando Api de Console===

Ya se cuenta con el desarrollo del api de consola IntTfhkaNomina.exe para ser utilizado desde ambientes de desarrollo de mediano o bajo nivel, donde existe limitaciones para consumir de manera directa servicios web.

::Documentación y ejemplos Api_Console - IntTfhkaNomina:
:::[https://drive.google.com/drive/folders/1r5CzIOxbVg8sswULSyn62NXOkII98CNn Enlace Drive]

<includeonly>=</includeonly>==Seguridad de la información: recomendaciones en la implementación de la Nómina Electrónica dentro de la red y sistemas del emisor==<includeonly>=</includeonly>
En este apartado se brindan recomendaciones en la implementación e integración de nómina electrónica en su organización y en la configuración de sus Sistemas y redes para mitigar riesgos de acceso indebido a datos por externos a su organización.

===En General:===
# Contar con antivirus en su empresa.
# Tener políticas y procedimientos de backup frecuentes, realizados en un período de ejecución que sea acorde con la criticidad del negocio. Para ello tener en cuenta los siguientes aspectos:
#* Deben realizarse pruebas de restauración.
#* Deben estar en una infraestructura distinta a la operativa (ante un ransomware toda la infraestructura accedida estará comprometida)
# De ser posible, buscar asesores y especialistas en seguridad y hacer auditorias ISO 27001:2013 que evalúen la calidad de las decisiones tomadas en la implantación de nómina electrónica en su empresa.
# Evitar uso de usuarios genéricos y/o Administradores en la organización y aplicar a cada usuario el control de acceso, permisología y roles que le corresponde según su función.
===Particulares con The Factory HKA Colombia SAS:===
# Sólo permitir acceso a los puertos TCP/UDP 80 y 443 a los dominios indicados a continuación :
#* *.thefactoryhka.com.co
# No se recomienda acceso abierto a estos puertos TCP/UDP a toda la internet.
# En el modelo de factura electrónica con The Factory HKA Colombia SAS las peticiones surgen del cliente solamente por lo que pueden establecer reglas desde intentos de conexión externos. (La comunicación siempre será iniciada por el software cliente).
# Si se hace uso de herramientas de software clientes de The Factory HKA Colombia SAS como lo son:
#* Herramientas de Integración
#: Y los mismos se visualizan como un riesgo por el sistema de antivirus o protección del cliente, debe generarse una excepción en firewall, antivirus, y cualquier otro sistema de protección única y exclusivamente para ellos.
# Los TOKEN Empresa y TOKEN Password de producción para la Plataforma de Nómina Electrónica de The Factory HKA Colombia SAS deben ser guardados de forma confidencial y únicamente ser accesibles por personal de confianza.
# Para el caso en que el emisor contrate un servicio de representación gráfica con la casa de software, o desarrollador, encargado de realizar los ajustes correspondientes en el software contable o ERP para la emisión de documentos electrónicos, se deben tener en cuenta los siguientes aspectos:
#* The Factory HKA es responsable de la generación del UBL y su transmisión a la DIAN.
#* Una vez se compruebe la correcta validación y generación del UBL la casa de software puede proceder a generar una representación gráfica que debe cumplir con:
#:: Los elementos de ley exigidos por la DIAN: inclusión del código QR y de la cadena del CUNE en los documentos, según corresponda.
#:: Los elementos de ley exigidos por cualquier entidad supervisora al emisor de los documentos.
#:: Los elementos visuales y de representación de marca exigidos por el propio cliente: logos, información bancaria, leyendas referentes a las responsabilidades tributarias del emisor, etc.
#* La Casa de Software, en este escenario, asume la responsabilidad junto con el propio contribuyente de cualquier incidente de fraude por evasión, malinterpretación, error u omisión de información relevante y obligatoria por parte de la normativa.
#:TFHKA no resguarda esta representación en sus sistemas y deja claro que su participación como proveedor tecnológico se limita a la generación del UBL y su validación ante la DIAN.
{{clear}}

Habilitación Nómina Electrónica

2025-11-04T17:38:03Z

Dmrodriguez2:

<includeonly>=</includeonly>== Habilitación Nómina Electrónica ==<includeonly>=</includeonly>
 

La habilitación es el procedimiento que requiere ser realizado previo a la fecha máxima para iniciar a generar y trasmitir el documento soporte de pago de Nómina electrónica y sus notas de ajuste, es donde realizamos las pruebas de habilitación de la DIAN, las cuales son necesarias para que la DIAN los autorice a ser transmisores de Nómina electrónica.

<DIV ALIGN=justify>Fecha de inicio de habilitación en el sistema de facturación electrónica dentro del cual se encuentra la funcionalidad del documento soporte de pago de Nómina electrónica y de las notas de ajuste del documento. (DD/MM/AAAA): Indica el plazo dentro del cual el sujeto que genera y transmite el documento soporte de pago de Nómina electrónica y las notas de ajuste al citado documento, debe iniciar el proceso de habilitación y señalar el software con el cual se encuentra la funcionalidad del documento soporte de pago de Nómina electrónica, dispuesto en la pagina WEB de la Unidad Administrativa Especial Direccion de Impuestos y Aduanas Nacionales -DIAN y que corresponde al software con el cual generara y transmitirá el documento soporte de pago de Nómina electrónica y las notas de ajuste al citado documento; así como las demás condiciones del procedimiento de habilitación de que trata el articulo 9 de la resolución DIAN 000037, '''el cual deberá concluir antes de la fecha máxima para iniciar con la generación y transmisión del documento soporte de pago de Nómina electrónica y las notas de ajuste al citado documento que se establece para cada uno de los calendarios conforme se indica en los numerales 1.2 y 3 del presente articulo.'''</DIV>

<includeonly>=</includeonly>==Actualización de fecha de adopción de Anexo Técnico Documento Soporte de Pago de Nómina Electrónica - Versión 1.0 ==<includeonly>=</includeonly>
 
<DIV ALIGN=justify>De acuerdo con la Resolución 000063 DIAN del 30-07-2021 la fecha de inicio del proceso de habilitación para Nómina Electrónica será a partir del dieciocho (18) de agosto de 2021, las fechas máximas para iniciar la generación y transmisión del documento soporte de Nómina electrónica se mantienen.
El primer grupo que corresponde con las empresas de más de 250 empleados, inician a partir del 01-09-2021, el rango de fechas de la primera transmisión de Nómina Electrónica para este primer grupo será desde el 1 hasta el 29 de octubre de 2021</DIV>
 

<center>'''Fechas de Habilitación Nómina Electrónica '''</center>
[[Archivo:NuevaHabilitacion.png|800px|sinmarco|centro|NuevaHabilitacion]]

<includeonly>=</includeonly>== Grupos ==<includeonly>=</includeonly>
 

;El Grupo 1 inicia habilitación el 18 de Agosto del 2021 y debe estar habilitado antes del 1 Septiembre del 2021.
:<center>Si el 18 de agosto del 2021 el sujeto obligado tiene mas de 250 empleados, pertenece al Grupo 1.</center>
;El Grupo 2 inicia habilitación el 18 de Agosto del 2021 y debe estar habilitado antes del 1 Octubre del 2021.
:<center>Si el 18 de agosto del 2021 el sujeto obligado tiene desde 101 hasta 250 empleados, pertenece al Grupo 2.</center>
;El Grupo 3 inicia habilitación el 18 de Agosto del 2021 y debe estar habilitado antes del 1 Noviembre del 2021.
:<center>Si el 18 de agosto del 2021 el sujeto obligado tiene desde 11 hasta 100 empleados, pertenece al Grupo 3.</center>
;El Grupo 4 inicia habilitación el 18 de Agosto del 2021 y debe estar habilitado antes del 1 Diciembre del 2021.
:<center>Si el 18 de agosto del 2021 el sujeto obligado tiene desde 1 hasta 10 empleados, pertenece al Grupo 4.</center>

<includeonly>=</includeonly>== Fechas Salida en Productivo Nómina Electrónica ==<includeonly>=</includeonly>
 
*<DIV ALIGN=justify>La primera transmisión de los documentos soporte de pago de Nómina Electrónica que deben realizar se deberá efectuar dentro de los diez (10) primeros días del mes siguiente de la fecha máxima de implementación del calendario del documento soporte de Nómina Electrónica y de las notas de ajuste del documento soporte de pago de Nómina Electrónica de que trata el; lo descrito anteriormente no aplica para los sujetos que realicen una implementación anticipada</DIV>

<center>'''Salida en Productivo Nómina Electrónica '''</center>
[[Archivo:SalidaFinal.png|800px|sinmarco|centro|SalidaFinal]]

<includeonly>=</includeonly>== Implementación Anticipada de Nómina Electrónica ==<includeonly>=</includeonly>
 
<DIV ALIGN=justify>'''De acuerdo con el Parágrafo 2 del artículo 8 de la Resolución 000013 del 11 de febrero de 2021:'''
 
La primera transmisión de los documentos soporte de pago de Nómina Electrónica que deben realizar los sujetos de que trata el artículo 4 de esta resolución, '''se deberá efectuar dentro de los diez (10) primeros días del mes siguiente de la fecha máxima de implementación''' del calendario del documento soporte de pago de Nómina Electrónica y de las notas de ajuste del documento soporte de pago de Nómina Electrónica de que trata el artículo 6 de esta resolución.

'''Nota: Lo anterior no aplica para los sujetos obligados que realicen una implementación anticipada, en cuyo caso la primera transmisión corresponderá al mes siguiente en que se lleva a cabo la habilitación de que trata el artículo 9 de la presente resolución.'''</DIV>
 
 
[[Archivo:SujetosAnticipada.png|800px|sinmarco|centro|Sujeto Implementación Anticipada]]

<includeonly>=</includeonly>== Proceso de Habilitación ==<includeonly>=</includeonly>

<includeonly>=</includeonly>=== Ingresar al Portal de la DIAN ===<includeonly>=</includeonly>
*Inicialmente se debe ingresar a la página de la DIAN [http://www.dian.gov.co www.dian.gov.co] y dar clic en el botón de HABILITACIÓN.
 
 
[[Archivo:Habilitacion.png|800px|sinmarco|centro|Habilitacion]]

<includeonly>=</includeonly>=== Ingresar a la plataforma de registro de Validación ===<includeonly>=</includeonly>
*Debe ingresar por la opción Empresa y luego elegir la opción llamada '''Representante Legal'''
 
 
[[Archivo:IngresoDian.png|900px|sinmarco|centro|IngresoDian]]

*Seleccionar el tipo de documento, el número de documento y el NIT de la empresa
 
 
[[Archivo:OpcionAcceso.png|900px|sinmarco|centro|OpcionAcceso]]

*<DIV ALIGN=justify>Una vez validada la información digitada por el usuario y se verifique que existe una cédula de ciudadanía o extranjería con el número de documento de identidad ingresado, además de comprobar que no se es un robot, el sistema enviará un mensaje al correo electrónico del representante legal de la empresa con un enlace para poder ingresar al portal web.</DIV>
 
 
[[Archivo:IngresoToken.png|1000px|sinmarco|centro|IngresoToken]]

<includeonly>=</includeonly>=== Plataforma Habilitación ===<includeonly>=</includeonly>
*<DIV ALIGN=justify>En el menú de la plataforma debe ubicar la sección Registro y Habilitación e ingresar a la opción Documentos Electrónicos
'''Nota:''' Debe ser facturador electrónico para que se habilite en el menú de Registro y Habilitación la opción de Documentos Electrónicos.</DIV>
 
 
[[Archivo:ElectronicosDocumentos.png|1020px|sinmarco|centro|Documentos Electronicos]]

*Debe Ingresar por la opción de Nómina Electrónica
 
 
[[Archivo:DocumentosENomina.png|1000px|sinmarco|centro|Documento Nomina Electrónica]]

*Debe Ingresar por la opción de Nómina Electrónica y Nómina de Ajuste
 
 
[[Archivo:NominaNominaA.png|1000px|sinmarco|centro|Nomina Electrónica y Nómina de Ajuste]]

*El sistema le pregunta si desea iniciar con el proceso de habilitación para Nómina Electrónica debe ACEPTAR
 
 
[[Archivo:AceptarNominaNominaA.png|900px|sinmarco|centro|Aceptar Nomina Electrónica y Nómina de Ajuste]]

*Luego se visualizan dos opciones para el inicio debe elegir la opción '''Emisor''' Otros documentos electrónicos 
 
 
[[Archivo:EmisosODE.png|1000px|sinmarco|centro|Emisor]]

*El sistema le pregunta si desea iniciar el proceso como Emisor de otros documentos electrónicos nuevamente debe ACEPTAR
 
 
[[Archivo:AceptarEmisor.png|900px|sinmarco|centro|Iniciar Proceso]]

*Al elegir realizar el proceso como emisor puede seleccionar el modo de operación como software propio o de un proveedor tecnológico la opción que debe elegir es: Software de un proveedor tecnológico
*Luego seleccione los datos de la empresa proveedora: '''THE FACTORY HKA COLOMBIA S.A.S ''' y el nombre del software:'''TFHKA_CO_NOMINA''' luego debe dar clic en Asociar
 
'''Nombres Requeridos:'''
*Nombre Empresa Proveedora: '''THE FACTORY HKA COLOMBIA S.A.S '''
*Nombre Software: '''TFHKA_CO_NOMINA'''
 
 
[[Archivo:AmodoOperacion.png|1000px|sinmarco|centro|Asociar Modo Operación]]

*La Dian le genera el SetTestId que es el identificador para poder realizar las transmisión del set de pruebas solicitadas para poder habilitarse como emisor de Nómina Electrónica
 
 
[[Archivo:SETPruebas.png|1000px|sinmarco|centro|set]]
 

<includeonly>=</includeonly>== ¿Como Habilitarse? ==<includeonly>=</includeonly>
 
<DIV ALIGN=justify>The Factory como proveedor del servicio de Nómina Electrónica, le brinda la posibilidad, que realice su proceso de habilitación ante la Dian de forma fácil y efectiva cumpliendo con el set de pruebas requerido a través de 3 modalidades diferentes que se exponen a continuación:</DIV>
 
'''Set Requerido 8 Documentos:'''
 
*4 Nóminas Individuales
*2 Nóminas Eliminar
*2 Nóminas Reemplazar
 
<DIV ALIGN=justify>@IMPORTANTE:Previamente a este proceso usted ya ha tenido que Crear su Secuencial de Habilitación en el Portal de Nómina Electrónica https://demo-nomina.thefactoryhka.com.co/ donde el Tipo Ambiente sea igual a '''Habilitación''' y de esa forma poder realizar un set de pruebas exitoso </DIV>
 
[[Archivo:SecuencialHabilitacion.png|800px|sinmarco|centro|Secuencial Habilitación]]
 

Si no ha creado los secuenciales diríjase a la sección:
* [[Portal Web Nómina Electrónica- Indice Manual Integración Nómina Electrónica#Secuenciales Ambiente Habilitación|'''Secuenciales Ambiente Habilitación''']]

<includeonly>=</includeonly>=== Modalidad 1- Habilitación Por El Portal Demo Nomina Electrónica ===<includeonly>=</includeonly>
 
<DIV ALIGN=justify>En el menú del Portal de Nómina Electrónica debe ubicar la opción ->Configuración e ingresar a la opción ->Ambiente
'''Nota:'''Debe activar la opción de habilitación para que encienda la comunicación con la DIAN a través de el método de habilitación.</DIV>
 
[[Archivo:Activado.png|800px|sinmarco|centro|Activado]]
 
@IMPORTANTE:Una ves realizado todo el set de pruebas el portal le informara que ha cumplido con la transmisión de los documentos y debe desactivar el ambiente en la opción ->Configuración e ingresar a la opción ->Ambiente.

<DIV ALIGN=justify>Luego podrá ir al menú de ->Emisión Nómina e ingresar a la opción ->Generar Nomina. En este momento podrá iniciar su set de pruebas apuntando al método de Habilitación DIAN.
 
[[Archivo:NóminaHabilitación.png|800px|sinmarco|centro|Generar Comprobante]]
 

<includeonly>=</includeonly>=== Modalidad 2- Habilitación Por Web Service ===<includeonly>=</includeonly>
 
<DIV ALIGN=justify>En el menú del Portal de Nómina Electrónica debe ubicar la opción ->Configuración e ingresar a la opción ->Ambiente
'''Nota:''' Debe activar la opción de habilitación para que encienda la comunicación con la DIAN a través de el método de habilitación.</DIV>
 
[[Archivo:Activado.png|800px|sinmarco|centro|Activado]]
 
<DIV ALIGN=justify>Para poder realizar el proceso de habilitación en la web service deberá setear el secuencial creado para habilitación donde previamente registro el SetTestId otorgado por la DIAN.

Si no ha creado los secuenciales diríjase a la sección:
* [[Portal Web Nómina Electrónica- Indice Manual Integración Nómina Electrónica#Secuenciales Ambiente Habilitación|'''Secuenciales Ambiente Habilitación''']]
 
 
[[Archivo:rangoNumeracionNom.png|800px|sinmarco|centro|rangoNumeracionNom]]

<includeonly>=</includeonly>=== Modalidad 3- Habilitación Por medio De Tool de Habilitación ===<includeonly>=</includeonly>
 
<DIV ALIGN=justify>The Factory ha desarrollado un tool de habilitación el cual le brinda la posibilidad de superar el set de pruebas para el proceso de habilitación de forma automática, este permitirá enviar una cantidad de N documentos al método de habilitación de la DIAN hasta que sea superado este escenario y de esta forma garantizar que se cumpla de una forma exitosa el envió de los documentos requeridos para que su set no sea bloqueado. Para hacer uso de esta opción por favor envié un correo a [mailto:integracion_fel_co@thefactoryhka.com integracion_fel_co@thefactoryhka.com], con los datos requeridos que se informan a continuación: .</DIV>
 
'''Datos Requeridos para Uso del Tool:'''
 
*Razón Social Empleador
*Nit Empleador
*DV Empleador
*SetTestId

[[Archivo:ToolHKANomina.png|800px|sinmarco|centro|Tool HKA Nomina]]

*Al realizar y superar el proceso de habilitación el tool le entregara una respuesta en la cual se evidenciara que este fue aprobado y se encuentra Habilitado como emisor de Nómina Electrónica ante la DIAN.
 
 
[[Archivo:ResultadoTool.png|800px|sinmarco|centro|ResultadoTool]]

<includeonly>=</includeonly>== Habilitación Satisfactoria==<includeonly>=</includeonly>
 
<DIV ALIGN=justify>Una vez sea realizado el envió de su set de pruebas por cualquiera de las alternativas propuestas anteriormente, podrá realizar la consulta de los documentos enviados al ingresar a la página de la DIAN [http://www.dian.gov.co www.dian.gov.co], en la sección Detalle de Set de Pruebas.</DIV>
 
[[Archivo:ResumenSet.png|800px|sinmarco|centro|Resumen Set de Pruebas]]

<includeonly>=</includeonly>== Sincronizar a Producción ==<includeonly>=</includeonly>
 
<big><center>Informamos que a partir del 20/10/2021 ya se encuentra disponible el ambiente de producción para generar Nóminas Electrónicas.</center></big>
 
A continuación listaremos una serie de pasos que cada uno de los Empleadores deberá tener en cuenta antes de emitir su primer documento de soporte de pago de Nómina Electrónica o Nómina de ajuste a través de The Factory KHA Colombia en ambiente de '''PRODUCCIÓN:'''.
 
 
1. Ingresar al portal de habilitación DIAN [http://www.dian.gov.co www.dian.gov.co] en la opción "Habilitación".
 
2. Ingresar datos de inicio de sesión seleccionando el tipo de usuario, así:
*Empresa: si eres persona jurídica, ingresa la cédula del representante legal y el NIT de la compañía.
*Persona: si eres persona natural, elige el tipo de documento e ingresa el número de identificación.
3. Recibirá en su correo electrónico (registrado en el RUT) el token de acceso a la plataforma, para ingresar haz clic en “Acceder”.
 
4. Hacer clic en el botón “Participantes” y luego en la opción “Otros documentos”.
 
5. Selecciona la opción “Nómina Electrónica y Nómina de Ajuste”.
 
6. Hacer clic en el botón “Aceptar” en la ventana emergente para continuar.
 
7. Seleccionar la opción “Emisor” en la ventana de “Participantes”.
 
8. Hacer clic en el botón “Set de pruebas” del listado de modos de operación asociados
 
9. Finalmente, haz clic en el botón '''Sincronizar a Producción'''.
 
 

[[Archivo:ProduccionSincronizada.png|800px|sinmarco|centro|Sincronizar a Producción]]
 

* Una vez de clic en el botón en la ventana emergente el sistema le preguntará si desea sincronizar este contribuyente a producción para lo cual debe dar clic en '''ACEPTAR'''.
 

[[Archivo:SincronizacionAceptadaExito.png|800px|sinmarco|centro|Aceptar Sincronización Contribuyente]]
 

* Al aceptar la sincronización del contribuyente el sistema genera un aviso indicando que se envió a activar a producción con '''Éxito'''.
 

[[Archivo:CargadoAmbienteProduccionExito.png|800px|sinmarco|centro|Aviso Exitoso]]
 

<includeonly>=</includeonly>==Pasos a tener en cuenta después de Sincronizar a Producción==<includeonly>=</includeonly>
 
Una vez que haya realizado el proceso '''Sincronizar a Producción''' en el portal de habilitación de Nómina Electrónica de la DIAN, ahora podrá utilizar el ambiente productivo de The Factory HKA Colombia para esto debe tener en cuenta lo siguiente:
 
 
'''PORTAL WEB NÓMINA ELECTRONICA PRODUCCION'''
 
 
1. Para acceder al portal web debe utilizar la siguiente Url: [https://nomina.thefactoryhka.com.co/ https://nomina.thefactoryhka.com.co/]
 
2. Debe acceder al portal web de Nómina Electrónica en Producción con el mismo usuario y contraseña del portal de producción de Factura Electrónica.
 
3. El portal de producción para Nómina Electrónica permitirá gestionar los secuenciales Tipo Producción los cuales son mandatorios para el uso del servicio y la transmisión del documento soporte de pago de Nómina Electrónica y Nómina de Ajuste.
 
4. También podrá emitir documentos soporte de pago de Nómina Electrónica y Nómina de Ajuste, a través de la opción Emisión Nómina -> Generar Comprobante.
 
 
<DIV ALIGN=justify>'''@IMPORTANTE:''' Si ya cuentan con servicio de facturación electrónica con The Factory HKA puede ingresar al portal de nómina en producción con el mismo usuario y contraseña del portal de producción de factura electrónica, si solo tiene servicio de nómina con The Factory HKA debe diligenciar el siguiente documento para realizar el paso a producción: </DIV>

:[https://docs.google.com/forms/d/e/1FAIpQLSdQX5-sYxs2IS_7T4Mn_tzW-G6oB_2Rwy2uUtZhcUrTWTRs6g/viewform Formulario Solicitud Pase a Producción]
 

'''INTEGRACIÓN DIRECTA'''
 
 
1. Para acceder al portal web debe utilizar la siguiente Url: [https://nomina.thefactoryhka.com.co/ https://nomina.thefactoryhka.com.co/].
 
2. Debe acceder al portal web de Nómina Electrónica en Producción con el mismo usuario y contraseña del portal de producción de Factura Electrónica.
 
3. El portal de producción para Nómina Electrónica permitirá gestionar los secuenciales Tipo Producción los cuales son mandatorios para el uso del servicio y la transmisión del documento soporte de pago de Nómina Electrónica y Nómina de Ajuste.
 
4. En la integración debe configurar su modulo de Nómina para que éste apunte a las URL's de producción:
* [https://nomina-rest.thefactoryhka.com.co https://nomina-rest.thefactoryhka.com.co] (SERVICIO REST)
* [https://nomina-soap.thefactoryhka.com.co/Service.svc?wsdl https://nomina-soap.thefactoryhka.com.co/Service.svc?wsdl] (SERVICIO SOAP)
5. para el correcto uso del servicio, debe configurar en la integración los token de producción que tiene asignados este empleador para el servicio de Factura Electrónica en Producción estos los podrá conocer a través del siguiente enlace [https://factura21.thefactoryhka.com.co/ https://factura21.thefactoryhka.com.co/].
 
 
<DIV ALIGN=justify>'''@IMPORTANTE:''' Si ya cuentan con servicio de facturación electrónica con The Factory HKA puede ingresar al portal de nómina en producción con el mismo usuario y contraseña del portal de producción de factura electrónica, si solo tiene servicio de nómina con The Factory HKA debe diligenciar el siguiente documento para realizar el paso a producción: </DIV>

:[https://docs.google.com/forms/d/e/1FAIpQLSdQX5-sYxs2IS_7T4Mn_tzW-G6oB_2Rwy2uUtZhcUrTWTRs6g/viewform Formulario Solicitud Pase a Producción]
 

'''@IMPORTANTE:''' En caso que presente inconvenientes:
 
Ingrese a las Sesiones Área Integración
 
Solución a Casos de Integración
 
Dirigido a: Clientes que realicen desarrollos de Software para integrarse con TFHKA, Casas de Software Aliadas.
 
Fechas: Martes a las 8:30 AM, Jueves a las 8:30 AM, URL: [https://meet.google.com/fzo-xmyc-duk https://meet.google.com/fzo-xmyc-duk]
 
Solicitudes al correo: integracion_fel_co@thefactoryhka.com

 
 
 
 

<center>'''<big>[[Archivo:Copyright.png|100px|sinmarco|centro|Copyright]]THE FACTORY HKA COLOMBIA</big>
 Copyright © 2016 The Factory HKA. Todos los derechos reservados.</center>

 

{{clear}}

Sector Salud Resolución 2275 de 28 de Diciembre 2023

2025-10-20T17:59:07Z

Dmrodriguez2:

<includeonly>==</includeonly>== Resolución 2275==<includeonly>==</includeonly>
El anexo técnico, que hace parte integral de la presente resolución, deberá ser adoptado obligatoriamente por los facturadores electrónicos del sector salud a partir del 1 de abril de 2024, disponiendo estas entidades hasta esta fecha para realizar la adecuación de sus sistemas de información al cumplimiento de lo previsto en la presente resolución.

Define y particulariza los contenidos de los campos de datos adicionales del sector salud que se utilizarán para las facturas electrónicas de venta.
 
 
[[Archivo:Resolucion2275.png|700px|sinmarco|centro|Resolucion 2275]]
 

<includeonly>==</includeonly>== Derogación resolución 2275 por la resolución 00001884==<includeonly>==</includeonly>
La presente resolución modifica el artículo 21 de la Resolución 2275 de 2023, modificado por el artículo 1 de la Resolución 558 de 2024, por lo que su implementación para todos los obligados se segmenta de la siguiente forma:
 

[[Archivo:Resolucion1884.png|700px|sinmarco|centro|Resolucion 1884]]
 

Para la implementación del RIPS como soporte de la FEV en salud y el inicio de la operación de la plataforma del mecanismo único de validación, las
entidades de que trata el artículo 2 de la presente resolución y este Ministerio seguirán las siguientes actividades y cronograma:
 

{| class="wikitable" style =" margin: 0 auto; width: 60%;"
! style ="color:white; background-color:#337ab7; font-size: 110%;" colspan="1"|FASE/PROCESO
! style ="color:white; background-color:#337ab7; font-size: 110%;" colspan="3"|PLAZO DE EJECUCIÓN
|- valign="center"
|-
|style ="text-align:center"; rowspan="2"|'''Mecanismo de autenticación para PSS y PTS'''
|<center>'''Grupo 1'''</center>
|<center>'''Grupo 2'''</center>
|<center>'''Grupo 3'''</center>
|-
|<center>1 de Febrero 2025</center>
|<center>1 de Abril de 2025</center>
|<center>1 de Junio de 2025</center>
|-
|style ="text-align:center"; rowspan="2"|'''Asistencia técnica , pruebas y pilotos '''
|<center>1 de octubre a 30 noviembre de 2024</center>
|<center>1 de diciembre de 2024 a 31 de enero de 2025</center>
|<center>Del 1 de febrero al 31 de marzo de 20:25 </center>
|}
 

'''Grupo 1:''' PSS con servicios de '''Alta Complejidad''', habilitados y activos en REPS al 2 de septiembre de 2024 según el listado dispuesto por el Ministerio en el micrositio de FEV-RIPS

'''Grupo 2:''' PSS con servicios de '''Mediana Complejidad''', habilitados y activos en REPS al 2 de septiembre de 2024 según el listado dispuesto por el Ministerio

'''Grupo 3:''' PSS con servicios de '''Baja Complejidad''', profesionales independientes no obligados a FEV en salud y entidades con objeto social diferente habilitados y activos en REPS al 2 de septiembre de 2024 según el listado dispuesto por el Ministerio y PTS inscritos ante el mecanismo al 2 de septiembre de 2024 según el listado dispuesto por el Ministerio en el micrositio de FEV-RIPS
 

<includeonly>==</includeonly>== Actores que intervienen ==<includeonly>==</includeonly>
Es importante conocer los diferentes actores que intervienen para que exista el escenario de facturación electrónica sector salud:
 
[[Archivo:actores.png|700px|sinmarco|centro|actores]]
 

<includeonly>==</includeonly>== Ámbito de aplicación ==<includeonly>==</includeonly>
 

{| class="wikitable" style =" margin: 0 auto; width: 60%;"
|+ style ="font-size: 115%;"|Artículo 2. Resolución 2275. Ámbito de Aplicación. Las disposiciones contenidas en la presente resolución son aplicables a:
|-
! style ="color:white; background-color:#337ab7; font-size: 110%;" | Facturadores Electrónicos del Sector Salud
! style ="color:white; background-color:#337ab7; font-size: 110%;" | ERP y demás Pagadores
! style ="color:white; background-color:#337ab7; font-size: 110%;" | Responsables del RIPS (sin FEV)
|-
|
*'''Prestadores de servicios de salud'''
**IPS públicas y privadas.
**Profesionales independientes de salud.
**Transporte especial de Pacientes.
*'''Prestadores en tecnologias de salud'''
**Operadores lógisticos de tecnologías en salud.
**Gestores farmacéuticos.
**Organizaciones no gubernamentales, universidades, personas jurídicas y personas naturales que realicen la disposición, almacenamiento, venta o entrega de tecnologías de salud.
||
*EPS y Entidades adaptadas.
*ARL - Salud.
*Compañias de seguros autorizadas para ofrecer pólizas del Seguro Obligatorio de Accidentes de Tránsito - SOAT.
*Entidades que ofrecen planes voluntarios de salud.
*Entidades Territoriales.
*Regimenes Especiales y de Excepción.
*Fondo Nacional de Salud - Personas Privadas de la Libertad.
*ADRES.
||
*Entidades con objetivo social diferente a la prestación de servicios de salud.
*Organismos que realicen pilotos o estudios de investigación asociados a la prestación o provísion de servicios y tecnologías de salud.
|}
 

<includeonly>==</includeonly>==Modelo funcional general para la generación, validación y envío de RIPS como soporte de la FEV en Salud==<includeonly>==</includeonly>
La siguiente imagen describe el modelo funcional desarrollado por el Ministerio de Salud y Protección Social para representar las actividades relacionadas con la Facturación Electrónica en el sector Salud (FEV) y el Registro Individual de Prestación de Servicios (RIPS). Este modelo está diseñado para ser adaptable a cualquier tipo de entidad participante, independientemente de su estructura organizativa, administrativa, funcional o tecnológica, considerando su situación operativa, tecnológica y normativa actual para facilitar su adopción.
 

[[Archivo:ModeloFuncionalFevRips.png|1100px|sinmarco|centro|Modelo Funcional FevRips]]
 

<includeonly>==</includeonly>==Estructura FEV-Salud KHA Integración==<includeonly>==</includeonly>
Para la emisión de documentos del sector salud a través del servicio Web Service de HKA Integración se debe implementar la estructura SOAP basada en artitectura XML adecuada en el objeto Factura y la clase FacturaGeneral donde se incorpora la clase SectorSalud ; par esto debe utilizar la url Versión 4 del servicio de Emisión:

====Url Web Service SOAP Versión 4====

* URL Demo :[http://demoemision21v4.thefactoryhka.com.co/ws/v1.0/Service.svc?wsdl http://demoemision21v4.thefactoryhka.com.co/ws/v1.0/Service.svc?wsdl ]
 

* URL Producción: [https://emision21v4.thefactoryhka.com.co/ws/v1.0/Service.svc?wsdl https://emision21v4.thefactoryhka.com.co/ws/v1.0/Service.svc?wsdl]
 

''' A continuación podra descargar Ejemplos XML SOAP del sector Salud'''
:[https://drive.google.com/drive/folders/1goVpFPkKEHyeabHTiSn4rNUUtyzIwF45?usp=drive_link <big>Ejemplos Request XML SOAP Sector Salud</big>]
 

====Parametro Tipo Sector====
En la clase '''FacturaGeneral''' se debe incluir el parámetro '''tipoSector''' con el valor igual a 2. Esto instruye al servicio Web Service de HKA Integración a aplicar las validaciones específicas para facturas del sector salud, asegurando que la estructura del documento emitido cumpla con la normativa vigente:

[[Archivo:TipoSector.png|700px|sinmarco|centro|Tipo Sector]]

====Clase SectorSalud====
En el Objeto Factura dentro de la clase FacturaGeneral se debe incluir la clase SectorSalud, la cual contiene esta contiene los siguientes parámetros que para realizar una emisión correcta:

[[Archivo:ClassSectorSalud.png|700px|sinmarco|centro|Class Sector Salud]]

====AttachedDocument====
Al emitir Facturas Electrónicas del Sector Salud el servicio de TFHKA expone correctamente el UBLExtension asignado por la DIAN al Ministerio de Salud según lo establecido en la resolución 2275 en el XML Fiscal AttachedDocument

[[Archivo:AttachedDocumentSectorSalud.png|700px|sinmarco|centro|AttachedDocument Sector Salud]]

Para realizar emisiones de documentos del Sector Salud a través del Servicio REST incorporando el atributo SectorSalud en la estructura JSON:

====Url Web Service REST====

* URL Demo :[https://demoemision21-api.thefactoryhka.com.co https://demoemision21-api.thefactoryhka.com.co ]
 

* URL Producción: [https://emision21-api.thefactoryhka.com.co https://emision21-api.thefactoryhka.com.co]
 

''' A continuación podra descargar Ejemplos REST y Collection Postman del sector Salud'''
::[https://drive.google.com/drive/folders/1krO6SiPsPQJRMgKn64hOuSxxMddtPQDd?usp=drive_link <big>Ejemplos Request JSON REST Sector Salud</big>]

::[https://drive.google.com/drive/folders/1BBFD2EOSSYSV0BCPfZGdWXYxtoEpCBiA?usp=drive_link <big>Collection Postman JSON REST Sector Salud</big>]
 

<includeonly>==</includeonly>==Campos Adicionales Factura Electrónica Sector Salud==<includeonly>==</includeonly>
Los facturadores electrónicos del sector salud, deberán incluir la siguiente información en campos individuales y separados de tal forma que atiendan las especificaciones de estándares UBL ("Universal Business Language") en formato XML, según lo dispuesto por la Unidad Administrativa Especial Dirección de Impuestos y Aduanas Nacionales - DIAN.
 

{| style="background:transparent,center; "
|-
|[[Archivo:CamposAdicionales.png|left|600px|CamposAdicionales]]||
#Código del prestador de servicios de salud.
#Modalidades de pago.
#Cobertura o plan de beneficios.
#Número Contrato.
#Número Póliza.
#Copago.
#Cuota moderadora.
#Pagos compartidos en planes voluntarios de salud.
#Anticipos.
#Fecha de inicio del periodo de facturación.
#Fecha final del periodo de facturación.

|}

'''1. Código del prestador de servicios de salud:''' Debe registrarse el código asignado en el Sistema General de Seguridad Social en Salud (SGSSS) a los prestadores de servicios de salud que estén en el Registro Especial de Prestadores de Servicios de Salud (REPS), o el código asignado por el Ministerio de Salud y Protección Social para los para los Proveedores de Tecnologías en Salud y demás casos de excepción.

'''2. Modalidades de pago:''' Debe registrarse la modalidad de pago pactada objeto de facturación.

{| class="wikitable" style="width: 100%;" style="margin: auto;"
! style="color:white;background:#2F5496; text-align:center;"|Código
! style="color:white;background:#2F5496; text-align:center;"|Modalidades de Pago
|- valign="center"
|-
|01
|Pago individual por caso / Conjunto integral de atenciones / Paquete / Canasta
|-
|02
|Pago global prospectivo
|-
|03
|Pago por capitación
|-
|04
|Pago por evento
|-
|05
|Otra Modalidad Especifica
|-
|}

'''3. Cobertura o plan de beneficios:''' Se registra la entidad responsable de financiar la cobertura o plan de beneficios, y de pagar la prestación de los servicios y tecnologías de salud incluidas en la factura de venta.

{| class="wikitable" style="width: 100%;" style="margin: auto;"
! style="color:white;background:#2F5496; text-align:center;"|Código
! style="color:white;background:#2F5496; text-align:center;"|Cobertura o plan de servicios
|- valign="center"
|-
|01
|Plan de beneficios en salud financiado con UPC
|-
|02
|Presupuesto máximo
|-
|03
|Prima EPS / EOC, no asegurados SOAT
|-
|04
|Cobertura Póliza SOAT
|-
|05
|Cobertura ARL
|-
|06
|Cobertura ADRES
|-
|07
|Cobertura Salud Pública
|-
|08
|Cobertura entidad territorial, recursos de oferta
|-
|09
|Urgencias población migrante
|-
|10
|Plan complementario en salud
|-
|11
|Plan medicina prepagada
|-
|12
|Pólizas en salud
|-
|13
|Cobertura Régimen Especial o Excepción
|-
|14
|Cobertura Fondo Nacional de Salud de las Personas Privadas de la Libertad
|-
|15
|Particular
|}

'''4. Número de contrato:''' Registrar el número de contrato objeto de facturación, en caso de que exista. Se reporta solo si se ha suscrito contrato que cubra los ítems facturados

'''5. Número de póliza:''' Registrar el número de póliza SOAT o del número de póliza de planes voluntarios de salud, en caso de se trate de este tipo de atenciones, por accidentes de tránsito o por atención particular por una póliza de salud.

'''6. Copago:''' Registrar el valor total efectivamente pagado por el usuario y recaudado por el prestador de servicios de salud, correspondiente al copago.

'''7. Cuota moderadora:''' Registrar el valor total efectivamente pagado por el usuario y recaudado por el prestador de servicios de salud, correspondiente a la cuota moderadora.

'''8. Pagos compartidos en planes voluntarios de salud:''' Registrar el valor total efectivamente pagado por el usuario y recaudado por el prestador de servicios de salud, correspondiente al pago compartido en los planes voluntarios de salud (medicina prepagada, pólizas de salud y planes complementarios en salud).

'''9. Anticipos:''' Se debe registrar el valor del anticipo a legalizar, que se restará al valor de la presente factura en ejecución del contrato señalado.

<center>'''Nota: Este valor debe ser igual al lo reportado en el <totalAnticipos> del ObjetoFactura'''</center>

[[Archivo:TotalAnticipos.png|700px|sinmarco|centro|TotalAnticipos]]

'''10. Fecha de inicio del periodo de facturación:''' Indicar la fecha de inicio del servicio prestado cuando se factura por usuario o periodo de facturación según modalidad de contratación y pago.

'''11. Fecha final del periodo de facturación:''' Indicar la fecha final del servicio prestado cuando se factura por usuario o periodo de facturación según modalidad de contratación.

<center>'''Nota: El formato de estos campos es AA-MM-DD HH-MM-SS'''</center>

[[Archivo:FechasPeriodoFacturacion.png|700px|sinmarco|centro|Fechas Periodo Facturacion]]

En la Clase '''CamposGenerales''' la cual está conformada por Array de '''<GeneralSalud>''', a nivel XML se debe enviar los campos solicitados en la resolución 2275 de 28 de Diciembre 2023 teniendo en cuenta la siguiente posición para cada uno de estos y conservando la estructura:

'''@IMPORTANTE:''' La variable Nombre perteneciente a la clase '''GeneralSalud''' determina la posicion del campo adicional el cual se debe respetar para que se ilustre de forma correcta en el XML Fiscal AttachedDocument.

[[Archivo:GeneralSalud.png|1200px|sinmarco|centro|General Salud]]
 

====Representación Gráfica Factura Sector Salud====
 

{| style="background:transparent; "
|-
|[[Archivo:RepresentacionSectorSalud.png|right|700px|Representacion Grafica Sector Salud]]||
*'''Al emitir Facturas Electrónicas del Sector Salud el servicio de TFHKA genera la Representación Gráfica estándar en donde informamos los campos adicionales del sector salud según la emisión y el escenario.'''
 
*Esta funcionalidad es un beneficio adicional que tiene TFHKA para los emisores del sector salud donde identificar y visualizar los campos adicionales del sector salud según la resolución 2275.
 
*Es importante aclarar que en la regulación no existe ningun apartado que establezca que el sector salud debe cumplir con algunas caracteristicas particulares en la Representación Gráfica
|}

<includeonly>==</includeonly>==Escenarios de Facturación del sector salud==<includeonly>==</includeonly>
 

====<center><big>'''ESCENARIO 1 SS-Recaudo'''</big></center>====
'''<center><Big>Registro del concepto de recaudo de Cuota moderadora — Copago — Cuota de recuperación - Pagos compartidos en planes voluntarios de salud.</Big></center>'''

'''Recaudación.''' Comprobante de recaudo de Cuotas Moderadoras o Copagos, como recursos a favor de terceros - No Activa el Método de cálculo del Sector Salud. Se difine como las operaciones que se realizan entre la IPS y los Pacientes
 

{| style="background:transparent; margin: 0 auto;"
|-
|[[Archivo:EscenarioSS-Recaudo.png|left|300px|Escenario SS-Recaudo]]||
*'''Tipo de Operación:''' SS-Recaudo
*'''Campos de datos adicionales:''' No se incluyen para las operaciones “SS-Recaudo.
*Facturas sin RIPS.
*Se utiliza para reporte de ingresos correspondientes a un tercero ERP - EPS.
*No acredita, pero debe ser incluida en los RIPS y en FEV en salud a la ERP.
*'''Este escenario no puede ser soportado con recibos de caja o algún comprobante diferente a Factura Electronica SS-Recaudo.'''

|}

=====<center>LAS FACTURAS TIPO SS-Recaudo van SIN RIPS</center>=====

Segun el Artículo 15 de la Ley 1966 del 2019. Para la Recaudación. En todo caso la generación de los RIPS se realizará al momento de prestar el servicio, de la entrega de tecnología en salud o del egreso del paciente. Por consiguiente la factura SS-Recaudo cuenta con dos momentos los cuales de indican a continuacion:

[[Archivo:SS-RecaudoSinRips.png|1200px|sinmarco|centro|SS-Recaudo Sin Rips]]

La forma correcta de reportar el escenario SS-Recaudo en el XML antes de enviar a la DIAN, debemos tener en cuenta el uso de las variables '''Descripcion''' y '''Descripcion2''' pertenecientes a la clase '''FacturaDetalle''' en donde debemos reportar la informacion de la siguiente forma:
 

[[Archivo:DescripcionSSRecaudo.png|1000px|sinmarco|centro|Descripcion SS-Recaudo]]

Este escenario al ser reconocido como el registro de ingresos de un tercero, se ha establecido en el '''Anexo técnico N°2 de la resolución 00001884''' nuevas reglas de validación opcionales que pueden utilizar los facturadores en salud para definir en el XML el tercero a quien corresponde el ingreso recaudado por el PSS. Para esto en la clase '''FacturaDetalle''' debemos hacer uso de las variables '''mandatorioNumeroIdentificacion''', '''mandatorioNumeroIdentificacionDV''' y '''mandatorioTipoIdentificacion''':

[[Archivo:MandatoSSRecaudo.png|1000px|sinmarco|centro|Mandato SS-Recaudo]]
 

<center>'''En el UBL Fiscal en el invoiceLine se activa shemeID =”1” // Línea de Detalle con Mandato</center>

[[Archivo:MandatoUblSSRecaudo.png|10000px|sinmarco|centro|Mandato Ubl SS-Recaudo]]
 

====<center><big>'''ESCENARIO 2 SS-CUFE, SS-CUDE, SS-POS, SS-SNum '''</big></center>====
'''<center><Big>Registro del concepto que se acreditará como Cuota moderadora — Copago - Pagos compartidos en planes voluntarios de salud - Anticipos</Big></center>'''

Acreditación (Resta al valor de la factura). Incluye referencias de Facturas Electrónicas de Venta tipo 01 o 04 que comprueba el recaudo de Cuotas Moderadoras, Copagos o Anticipos, como recursos a favor de terceros, los cuales son acreditados a la presente Factura Electrónica de Venta con destino a la aseguradora que aparece como adquirente
 

{| style="background:transparent; margin: 0 auto;"
|-
|[[Archivo:EscenarioSS-CUFE.png|left|300px|Escenario SS-CUFE]]||
*'''Tipo de Operación:''' SS-CUFE, SS-CUDE, SS-POS, SS-Num
*'''Campos de datos adicionales:'''Se incluyen para las operaciones acreditación.
*'''Ya no se envía el path BillingReference y BillingReferenceLine.'''
*Se asocia la acreditación en el nodo '''PrepaidPayment (Class.Anticipos)'''
|}

Para relacionar en este escenarios los Recaudos realizados se debe utilizar la clase ''Anticipos'' perteneciente al Objeto Factura la cual dentro del UBL Fiscal se ilustran en el nodo '''PrepaidPayment''' en donde se asociaran los pagos a acreditar según el tipo de Operación con el que se registro el recaudo ''SS-CUFE, SS-CUDE, SS-POS, SS-Num''. Es importante informar que este Nodo sólo podrá enviar Hasta 4 veces.

La sumatoria de todos los Anticipos se debe reportar el en campo ''TotalAnticipos'' perteneciente al Objeto Factura en la seccion de los totales y este valor descontarlo del total del documento,para que se ilustre en el nodo. LegalMonetaryTotal/cbc:'''PrepaidAmount'''.

[[Archivo:AnticiposSalud.png|1000px|sinmarco|centro|Anticipos Salud]]
 

*Para facturar los servicios en el Escenario 2, es crucial referenciar correctamente la factura de recaudo inicial (generada en el Escenario 1) para garantizar la consolidación de los pagos de los pacientes y el cobro adecuado a la Entidad Responsable de Pago (ERP).
 

{| class="wikitable" style =" margin: 0 auto; width: 60%;"
! style ="color:white; background-color:#337ab7; font-size: 110%;" colspan="1"|Tipo de Documento SS-Recaudo (Escenario 1)
! style ="color:white; background-color:#337ab7; font-size: 110%;" colspan="3"|Tipo de Operación a indicar (Escenario 2)
|- valign="center"
|-
|01 (Factura Electrónica de Venta)
|SS-CUFE (Código Único de Factura Electrónica)
|-
|03 (Nota Débito)
|SS-CUDE (Código Único de Documento Electrónico)
|-
|04 (Nota Crédito)
|SS-CUDE (Código Único de Documento Electrónico)
|-
|POS Electrónico
|SS-POS (Consecutivo del POS Electrónico)
|-
|Factura de Papel/Talonario
|SS-Num (Número de la Factura de Papel)
|-
|}
 

====<center><big>'''ESCENARIO 3 SS-Reporte'''</big></center>====
'''<center><Big>Registro de Operaciones de Copago — Cuota Moderadora — Pagos compartidos en planes voluntarios de salud, cuyo tratamiento contractual y contable hace innecesario que valor recaudado se acredite a la factura que librará el Prestador de Servicios de Salud o Proveedor de Tecnologías en Salud a la Entidad Responsable de Pago y demás pagadores</Big></center>'''

Opera cuando un PSS o PTS recibe el número de FEV – SS-Recaudo que soporta el recaudo de pagos moderadores realizado directamente por la ERP (EPS), como condición para la realización del servicio. Este tipo de operación, NO activa el Método de cálculo del Sector Salud
 

{| style="background:transparent; margin: 0 auto;"
|-
|[[Archivo:EscenarioSS-Reporte.png|left|300px|Escenario SS-Reporte]]||
*'''Tipo de Operación:''' SS-Reporte
*'''Campos de datos adicionales:'''Se incluyen para las operaciones acreditación.
*'''Ya no se envía el path BillingReference y BillingReferenceLine.'''
*El valor de este recaudo realizado por la EPS, se visualiza en la FEV en salud SS-Reporte
|}

====<center><big>'''ESCENARIO 4 SS-SinAporte'''</big></center>====
'''<center><Big>Emisión de facturas electrónicas para servicios de salud sin recaudos previos por Operaciones de Copago - Cuota Moderadora - Cuota de Recuperación - Pagos compartidos en planes voluntarios de salud.</Big></center>'''

'''Reporte:''' Sin Aporte, ni recaudo en dinero por parte de los afiliados del régimen contributivo por concepto de Cuotas Moderadoras, Copagos o Anticipos. No activa el método del cálculo del Sector Salud.
 

{| style="background:transparent; margin: 0 auto;"
|-
|[[Archivo:EscenarioSS-SinAporte.png|left|300px|Escenario SS-SinAporte]]||
*'''Tipo de Operación:''' SS-SinAporte
*'''Campos de datos adicionales:'''Se incluyen para las operaciones acreditación de forma opcional. Tipo de identificación del usuario y Número de identificación del usuario.
*Para este escenario, en la Clase Cliente de '''FacturaGeneral''', se informarán los datos de la EPS o ERP según corresponda.
*Este escenario es utilizado para factura la prestacion de servicios o tecnologias en salud para particulares en donde el ingreso recaudado es propio
|}
 
*'''SS-SinAporte:'''
Deben expedirse obligatoriamente por parte de los Prestadores de Servicios de Salud -PSS para realizar el cobro de servicios o tecnologías de salud prestadas o suministradas directamente a una persona (paciente o usuario

====<center><big>'''Resumen Tipos De Operación '''</big></center>====

En la siguiente tabla entregamos un resumen detallado de todos los tipos de operacion establecidos para los escenarios de facturacion electronica FEV-Salud establecidos en el Anexo tecnico N° 2 perteneciente a la resolucion 00002275 de 28 de Diciembre de 2023 y la resolucion 00001884 del 30de septiembre de 2024.

 
[[Archivo:TablaResumenTiposOperacion .png|900px|sinmarco|centro|Tabla Resumen TiposOperacion]]
 

<includeonly>==</includeonly>==Lineamientos de Generación RIPS==<includeonly>==</includeonly>
RIPS. El Registro Individual de Prestación de Servicios de Salud es el conjunto de datos que contiene la información relacionada con la prestación o provisión de servicios y tecnologías de salud al (los) usuario(s). El RIPS se utilizará para los procesos de prestación o provisión de servicios y tecnologías de salud y su facturación, así como para los procesos de dirección, regulación y control.
 

[[Archivo:LineamientoRIPS.png|500px|sinmarco|centro|Lineamiento RIPS]]
<center>'''La base de datos georreferenciada, la historia clínica, sus documentos y expedientes,'''</center>
<center>'''se constituyen en la fuente primaria del dato para la generación del RIPS y de la FEV en Salud'''</center>
 

<includeonly>==</includeonly>==Nueva Estructura==<includeonly>==</includeonly>
El RIPS será generado, validado y enviado como soporte de la factura de venta por parte de los facturadores electrónicos del sector salud, esto es, prestadores de servicios de salud, proveedores de tecnologías en salud y otras entidades que en el marco de sus funciones legales deban entregarlos.
 

<center>'''Su nuevo formato para radicación según la resolución 2275 es la basada en estructura JSON:'''</center>
[[Archivo:TxtJson.png|500px|sinmarco|centro|TxtJson]]
 

<includeonly>==</includeonly>==Objeto RIPS==<includeonly>==</includeonly>
Según Anexo Técnico N°1 de la resolución 00002275 se expone el nuevo objeto RIPS para la validación del Ministerio de Salud y Protección Social

[[Archivo:ObjetoRIPS.png|700px|sinmarco|centro|Objeto RIPS]]
 

<includeonly>==</includeonly>==Mecanismo de Validación==<includeonly>==</includeonly>
El Ministerio dispuso de dos alternativas de solución tecnológica para realizar el proceso de validación de los documentos electrónicos junto con los RIPS (JSON) como soporte de la FEV en salud (contenedor electrónico DIAN), estas soluciones tecnológicas se detallan a continuación junto con el proceso que deben tener en cuenta los facturadores en salud, para el envío del conjunto de documentos a la plataforma del mecanismo único de validación dispuesto por el Ministerio de Salud y Protección Social, se seguirán las siguientes indicaciones, según la solución tecnológica utilizada por el facturador electrónico del sector salud:

[[Archivo:Rips.png|200px|sinmarco|centro|Rips]]
 

=====<center><Big>Autenticación Mecanismo Único De Validacion Del Rips Como Soporte De La Fev En Salud</Big></center>=====
Para dar inicio al proceso a través del mecanismo único de validación se debe realizar el proceso de AUTENTICACIÓN

El facturador electrónico del sector salud o de las entidades con objeto social diferente y demás entidades obligadas a reportar RIPS, debe encontrarse registrado en la plataforma

'''*Mi seguridad social''' [https://www.miseguridadsocial.gov.co/ Pagina Oficial]

'''*SISPRO''' [https://web.sispro.gov.co/ Pagina Oficial]

 

'''*Guia Autenticacion''' <big>[https://www.minsalud.gov.co/sites/rid/Lists/BibliotecaDigital/RIDE/DE/OT/guia-autenticacion-validación-rips-soporte-fev-cliente-servidor.pdf Descarga Aquí]</big>

=====<center><Big>Solución Tecnológica Tipo Cliente/Servidor</Big></center>=====
Esta solución va dirigida a facturadores electrónicos del sector salud que no tienen la posibilidad de adelantar desarrollos propios para interoperar con la plataforma del mecanismo único de validación del Ministerio.

Actualmente están las siguientes versiones:
*Demo: 5.3.0
*Producción: 1.3.0
[[Archivo:SolucionClienteServidor.png|500px|sinmarco|centro|Solucion Cliente Servidor]]
 

Esta solución se compone de 11 módulos de validación que deberán utilizarse dependiendo de la necesidad y el momento de transmisión del conjunto de
información que se requiera, y que corresponden a:

*MÓDULO FACTURA ELECTRÓNICA DE VENTA.
*MÓDULO NOTA CRÉDITO PARCIAL.
*MÓDULO NOTA CRÉDITO TOTAL.
*MÓDULO NOTA DÉBITO.
*MÓDULO NOTA AJUSTE DE RIPS.
*MÓDULO CÁPITA INICIAL.
*MÓDULO CÁPITA POR PERIODO.
*MÓDULO CÁPITA FINAL.
*MÓDULO NOTA CRÉDITO CÁPITA.
*MÓDULO NOTA CRÉDITO ACUERDO DE VOLUNTADES.
*MÓDULO RIPS SIN FACTURA.
 
<center><Big>'''El mecanismo único de validación por medio de la solución Cliente Servidor espera recibir los siguientes archivos para realizar el proceso:'''</Big></center>

1. El documento XML correspondiente al contenedor electrónico DIAN '''AttachedDocument''' que contiene la Factura Electrónica de Venta -FEV en salud y el ApplicationResponse.

2. El documento '''JSON''' que corresponde al archivo que contiene los Registros Individuales de Prestación de Servicios de Salud. Estos documentos deben estar contenidos dentro de una misma carpeta, la cual no debe estar en formato comprimido (.zip)

 
[[Archivo:FevRips.png|300px|sinmarco|centro|FevRips]]
 
'''*Solución Cliente Servidor Pruebas 5.3.0.0''' <big>[https://www.minsalud.gov.co/sites/rid/Lists/BibliotecaDigital/RIDE/DE/OT/instalador-cliente-servidor-v5.3.zip Descarga Aquí]</big>

'''*Solución Cliente Servidor Produccion 1.3.0''' <big>[https://www.minsalud.gov.co/sites/rid/Lists/BibliotecaDigital/RIDE/DE/OT/instalador-cliente-servidor-v1.3.0-produccion.zip Descarga Aquí]</big>
 

Esta solucion Puede instalarse en un equipo de cómputo con los mínimos o superiores requerimientos informados en el documento Guía de instalación, el facturador electrónico del sector salud o de las entidades con objeto social diferente y demás entidades obligadas a reportar RIPS, si así lo requiere, puede instalar esta solución en más de un computador de acuerdo a las necesidades del proceso teniendo en cuenta que cada uno de estos equipos trabajará en forma independiente con una base local que no será compartida entre equipos o usuarios.

En los siguientes enlaces podra obtener la Guia de Instalación del aplicativo Cliente Servidor junto con el Manual del usuario en donde se expone todo lo requerido para pueda ser utilizada de forma correcta:

'''*Guia Instalación Validador Cliente Servidor''' <big>[https://www.minsalud.gov.co/sites/rid/Lists/BibliotecaDigital/RIDE/DE/OT/guia-instalacion-validador-fev-rips-plataforma-cliente-servidor.pdf Descarga Aquí]</big>

'''*Manual de Usuario Validador Cliente Servidor''' <big>[https://www.minsalud.gov.co/sites/rid/Lists/BibliotecaDigital/RIDE/DE/OT/manual-usuario-cliente-servidor-fev-rips.pdf Descarga Aquí]</big>

=====<center><Big>Solución Tecnológica Tipo Api Docker Empaquetada En Contenedores</Big></center>=====
Esta solución va dirigida a facturadores electrónicos del sector salud o a entidades con objeto social diferente y demás entidades obligadas a reportar RIPS, que tienen la posibilidad de adelantar desarrollos propios para interoperar con la plataforma del mecanismo único de validación del Ministerio, para permitirles la transmisión automatizada de múltiples conjuntos de archivos de información.

Actualmente están las siguientes versiones:
*Demo: 5.3.0
*Producción: 1.3.0
[[Archivo:ApiDocker.png|500px|sinmarco|centro|Solucion Api Docker]]
 
<center><Big>'''El mecanismo único de validación por medio de la solución Api Docker espera recibir la siguiente estructura para realizar el proceso:
'''</Big></center>
 
[[Archivo:RipsApi.png|700px|sinmarco|centro|Rips Api XmlFevFile]]
 

'''*Solución Api Docker Compose Pruebas 5.3.0.0''' <big>[https://www.minsalud.gov.co/sites/rid/Lists/BibliotecaDigital/RIDE/DE/OT/instalador-cliente-servidor-v1.3.0-produccion.zip Descarga Aquí]</big>

'''*Solución Api Docker Compose Produccion 1.3.0''' <big>[https://www.minsalud.gov.co/sites/rid/Lists/BibliotecaDigital/RIDE/DE/OT/compose-api-docker-v1.3.0-produccion.zip Descarga Aquí]</big>
 

A continuación podra obtenber documentos técnicos que contienen la configuración de la implementación de los contenedores de la solución FEV-RIPS del
MSPS, denominada API FEV-RIPS, que les permite a los prestadores de servicios de salud que facturan electrónicamente por la plataforma de la DIAN, validar la correspondencia de los archivos RIPS con el archivo de facturas electrónicas, asi mismo encontrará el Manual de Consumo de la solución tecnologica Api Docker Compose:

'''*Guia de Implementacion Api Docker''' <big>[https://www.minsalud.gov.co/sites/rid/Lists/BibliotecaDigital/RIDE/DE/OT/guia-implementacion-api-docker-fev-rips.pdf Descarga Aquí]</big>

'''*Manual de Consumo Api Docker''' <big>[https://www.minsalud.gov.co/sites/rid/Lists/BibliotecaDigital/RIDE/DE/OT/manual-consumo-api-docker-fev-rips.pdf Descarga Aquí]</big>

<includeonly>==</includeonly>==Código Único de Validación – CUV==<includeonly>==</includeonly>
Una vez se realice el ENVÍO DE LOS DATOS por parte de los facturadores electrónicos del sector salud, contenidos en la FEV en Salud (XML) y el RIPS (JSON), donde se aprueban las reglas y relaciones previstas en la normatividad vigente, a traves de cualquiera de las dos soluciones tecnologicas expuesta por el Ministerio de Salud documentadas anteriormente.

Se obtiene el '''Código Único de Validación – CUV''', el facturador electrónico del sector salud debe remitir el conjunto de información conformado por la FEV en Salud y el RIPS validados, junto con los demás soportes determinados en la normatividad vigente; disponiéndose como un archivo adicional al conjunto de información transmitido.

 
[[Archivo:Cuv.png|200px|sinmarco|centro|Cuv]]
 

<center><Big>'''Micro sitio Web Ministerio de Salud y Protección Social'''</Big></center>
<center><big>[https://www.sispro.gov.co/central-financiamiento/Pages/facturacion-electronica.aspx https://www.sispro.gov.co/central-financiamiento/Pages/facturacion-electronica.aspx]</big></center>
 
 
 
 

<center>'''<big>[[Archivo:Copyright.png|100px|sinmarco|centro|Copyright]]THE FACTORY HKA COLOMBIA</big>
 Copyright © 2016 The Factory HKA. Todos los derechos reservados.</center>

 
{{clear}}

Tablas de códigos de propiedades para emisión de documentos - Indice Manual Integración Directa

2025-10-08T14:48:21Z

Dmrodriguez2: /* Tabla 17 */

<includeonly>=</includeonly>==Tablas de códigos de propiedades para emisión de documentos==<includeonly>=</includeonly>
En la siguiente sección encontrará información referente a las diferentes tablas de códigos de propiedades definidas por la DIAN en el anexo técnico.
==Tabla 1==
{| class="wikitable" style="width: 100%;"
|+ Tipos de Documentos
|- valign="center"
|-style="text-align:center;"
|colspan="2"|Anexo 1.9 01-11-2023 - 13.1.3. Tipo de Documento: cbc:InvoiceTypeCode y cbc:CreditnoteTypeCode
{| class="wikitable" style="width: 100%;"
! style="color:white;background:#2F5496; text-align:center;"|Código
! style="color:white;background:#2F5496; text-align:center;"|Significado
! style="color:white;background:#2F5496; text-align:center;"|Uso
|- valign="center"
|-
|01
|Factura electrónica de Venta
|rowspan="4"|Tipos de factura
|-
|02
|Factura electrónica de Venta - exportación
|-
|03
|Documento electrónico de transmisión - tipo 03
|-
|04
|Factura electrónica de Venta - tipo 04
|-
|91
|Nota Crédito
|rowspan="2"|Exclusivo en referencias a documentos (elementos DocumentReference)
|-
|92
|Nota Débito
|-
|05
|Documento Soporte en adquisiciones a No Obligados a Facturar
|rowspan="2"|Exclusivo para Documento Soporte en adquisiciones a No Obligados a Facturar
|-
|95
|Nota de Ajuste Documento Documento Soporte en adquisiciones a No Obligados a Facturar
|-
|96
|Eventos (ApplicationResponse)
|}
|}

==Tabla 2==
{| class="wikitable" style="width: 100%;"
|+ Tipos de Operación
|- valign="center"
|-style="text-align:center;"
|colspan="2"|Anexo 1.9 01-11-2023 - 13.1.5. Tipos de operación
Para Facturas:
{| class="wikitable" style="width: 100%;" style="margin: auto;"
! style="color:white;background:#2F5496; text-align:center;"|Código
! style="color:white;background:#2F5496; text-align:center;"|Valor
|- valign="center"
|-
|09
|AIU
|-
|10
|Estandar*
|-
|11
|Mandatos
|-
|12
|Transporte**
|-
|14
|Notarios
|-
|15
|Compra Divisas
|-
|16
|Venta Divisas
|}
Nota: (*) Valor por default
 
Nota: (**) Valor correspondiente a las operaciones efectuadas por el sector transporte de carga, Tipos de Operación Transporte.
{| class="wikitable" style="width: 100%;" style="margin: auto;"
! style="color:white;background:#2F5496; text-align:center;"|Código
|- valign="center"
|-
|SS-CUFE
|-
|SS-CUDE
|-
|SS-POS
|-
|SS-SNum
|-
|SS-Recaudo
|-
|SS-Reporte
|-
|SS-SinAporte
|}
Nota: La explicación y vigencia de los tipos de operación para el sector salud se informará en http://url.minsalud.gov.co/facturacion-electronica una vez que el Ministerio de Salud informe a todos los actores regulados por ellos.
Para Notas Crédito:
{| class="wikitable" style="width: 100%;" style="margin: auto;"
! style="color:white;background:#2F5496; text-align:center;"|Código
! style="color:white;background:#2F5496; text-align:center;"|Valor
|- valign="center"
|-
|20
|Nota Crédito que referencia una factura electrónica*
|-
|22
|Nota Crédito sin referencia a facturas*.
|-
|}
Nota: (*) El valor por default es 20, lo anterior quiere decir que si no se informa un valor, se asume que es 20 y aplicarán el conjunto de validaciones correspondiente. (*)Preferible para uso de notas rebate o de descuentos condicionados. Notas tipo 22 no tienen validación de rechazo. Objeto de control posterior.
Para Notas Débito:
{| class="wikitable" style="width: 100%;" style="margin: auto;"
! style="color:white;background:#2F5496; text-align:center;"|Código
! style="color:white;background:#2F5496; text-align:center;"|Valor
|- valign="center"
|-
|30
|Nota Débito que referencia una factura electrónica*
|-
|32
|Nota Débito sin referencia a facturas*.
|-
|}
Nota: El valor por default es 30, lo anterior quiere decir que si no se informara un valor se sume 30 y aplicarán el conjunto de validaciones correspondiente. Notas tipo 32 y 33 no tienen validación de rechazo. Objeto control posterior.

'''@IMPORTANTE:''' Las notas tipo 22 y 32 no tienen validación de rechazo. (Objeto de control Posterior).
 

Documento Soporte en adquisiciones a No Obligados a Facturar:
{| class="wikitable" style="width: 100%;" style="margin: auto;"
! style="color:white;background:#2F5496; text-align:center;"|Código
! style="color:white;background:#2F5496; text-align:center;"|Valor
|- valign="center"
|-
|10
|Residente
|-
|11
|No Residente
|-
|}
Nota: Conforme a la Normativa vigente,debe tenerse en cuenta lo que se indica paara el concepto de residente fiscal en Colombia y no residente fiscal en Colombia.
|}

==Tabla 3==
{| class="wikitable" style="width: 100%;"
|+ Tipos de identificación
|- valign="center"
|-style="text-align:center;"
|colspan="2"|Anexo 1.9 01-11-2023 - 13.2.1. Documento de identificación (Tipo de Identificador Fiscal):
cbc:CompanyID.@schemeName; sts:ProviderID.@schemeName
{| class="wikitable" style="width: 100%;" style="margin: auto;"
! style="color:white;background:#2F5496; text-align:center;"|Código
! style="color:white;background:#2F5496; text-align:center;"|Significado
|- valign="center"
|11
|Registro civil
|-
|12
|Tarjeta de identidad
|-
|13
|Cedula de ciudadanía
|-
|21
|Tarjeta de extranjería
|-
|22
|Cédula de extranjería
|-
|31
|NIT
|-
|41
|Pasaporte
|-
|42
|Documento de identificación extranjero
|-
|47
|PEP (Permiso Especial de Permanencia)
|-
|48
|PPT (Permiso Protección Temporal) Nuevo tipo de identificación de anexo 1.9
|-
|50
|NIT de otro país
|-
|91
|NUIP*
|}
|}
'''@IMPORTANTE:''' (*) Deberá utilizarse solamente para el adquirente, debido a que este tipo de documento no pertenece a los tipos de documento en la base de datos del RUT.

==Tabla 4==
{| class="wikitable" style="width: 100%;"
|+ Código de descuento
|- valign="center"
|-style="text-align:center;"
|colspan="2"|Anexo 1.9 01-11-2023 - 13.3.9. Códigos de descuento
{| class="wikitable" style="width: 100%;" style="margin: auto;"
! style="color:white;background:#2F5496; text-align:center;"|Código
! style="color:white;background:#2F5496; text-align:center;"|Significado
|- valign="center"
|-
|0
|Descuento no condicionado
|-
|1
|Descuento Condicionado
|}
|}
==Tabla 5==
{| class="wikitable" style="width: 100%;"
|+ Tipos de Persona
|- valign="center"
|-style="text-align:center;"
|colspan="2"|Anexo 1.9 01-11-2023 - 13.2.3. Tipo de organización jurídica (Personas): cbc:AdditionalAccountID
{| class="wikitable" style="width: 100%;" style="margin: auto;"
! style="color:white;background:#2F5496; text-align:center;"|Código
! style="color:white;background:#2F5496; text-align:center;"|Significado
|- valign="center"
|-
|1
|Persona Jurídica y asimiladas
|-
|2
|Persona Natural y asimiladas
|}
|}
==Tabla 6==
{| class="wikitable" style="width: 100%;"
|+ Unidades de Medida
|- valign="center"
|-style="text-align:center;"
|colspan="2"|Anexo 1.9 01-11-2023 - 13.3.6. Unidades de Cantidad: @unitCode
{| class="wikitable" style="width: 100%;"
! style="color:white;background:#2F5496; text-align:center;"|Código
! style="color:white;background:#2F5496; text-align:center;"|Descripción
! style="color:white;background:#2F5496; text-align:center;"|Código
! style="color:white;background:#2F5496; text-align:center;"|Descripción
! style="color:white;background:#2F5496; text-align:center;"|Código
! style="color:white;background:#2F5496; text-align:center;"|Descripción
|- valign="center"
|-
|04
|spray pequeño
|BIL
|trillón de dólares
|HUR
|hora
|-
|05
|levantar
|BJ
|cangilón
|HY
|cien yardas
|-
|08
|Lote calor
|BK
|cesta
|IA
|pulgada libra
|-
|10
|grupo
|BL
|bala
|IC
|contar por pulgada
|-
|11
|equipar
|BLD
|barril seco
|IE
|persona
|-
|13
|ración
|BLL
|barril (EE.UU.)(petróleo, etc.)
|IF
|pulgadas de agua
|-
|14
|disparo
|BO
|botella
|II
|columna pulgada
|-
|15
|palo
|BP
|cien pies de tabla
|IL
|pulgada por minuto
|-
|16
|tambor de ciento quince kg
|BQL
|becquerel
|IM
|impresión
|-
|17
|tambor de cien libras
|BR
|bar
|INH
|pulgada
|}
|}
'''@IMPORTANTE:''' Esta catálogo es más extenso, para mayor información hacer referencia a la sección del Anexo correspondiente.

==Tabla 7==
{| class="wikitable" style="width: 100%;"
|+ Códigos para precios de referencia
|- valign="center"
|-style="text-align:center;"
|colspan="2"|Anexo 1.9 01-11-2023 - 13.3.10. Lista de coódigos para precios de referencia
{| class="wikitable" style="width: 100%;" style="margin: auto;"
! style="color:white;background:#2F5496; text-align:center;"|Código
! style="color:white;background:#2F5496; text-align:center;"|Significado
|- valign="center"
|-
|1
|Valor comercial
|-
|2
|Valor en Inventarios
|-
|3
|Otro valor
|}
|}

==Tabla 8==
{| class="wikitable" style="width: 100%;"
|+ Códigos para productos y servicios
|- valign="center"
|-style="text-align:center;"
|colspan="2"|Anexo 1.9 01-11-2023 - 13.3.5 Productos @schemeID, @schemeName, @schemeAgencyID
{| class="wikitable" style="width: 100%;" style="margin: auto;"
! style="color:white;background:#2F5496; text-align:center;"|@schemeID
! style="color:white;background:#2F5496; text-align:center;"|@schemeName
! style="color:white;background:#2F5496; text-align:center;"|schemeAgencyID
! style="color:white;background:#2F5496; text-align:center;"|Utilizar
|- valign="center"
|-
|001
|UNSPSC
|10
|style="text-align:left;"|Colombia Compra Eficiente: utilizar contenido de la columna "Código"
* Ver 8.1
|-
|010
|GTIN
|9
|style="text-align:left;"|Números Globales de Identificación de Productos - GTIN
* Ver 8.2
* Cuando hay menos de 14 números en una estructura de datos (por ejemplo, GTIN8), los números se deben justificar a la derecha en un campo de 14 dígitos rellenado con cerros en las posiciones ubicadas más a la izquierda.
|-
|020
|Partida Arancelarias
|195
|style="text-align:left;"|Partida arancelaria
|-
|999
|Estándar de adopción del contribuyente
|
|style="text-align:left;"|
* El valor en el atributo @schemeName no será validado
* El atributo @schemeAgencyID no debe ser utilizado
|}
Nota: Para muestras comerciales o regalos debe enviarse ‘01’ el campo '''codigoTipoPrecio'''
|}
'''@IMPORTANTE:''' Para mayor información del código para productos y servicios hacer referencia a la sección del Anexo correspondiente.
==Tabla 9==
{| class="wikitable" style="width: 100%;"
|+ Motivos de Nota de crédito
|- valign="center"
|-style="text-align:center;"
|colspan="2"|Anexo 1.9 01-11-2023 - 13.2.4 Concepto de Corrección para Notas crédito cac DiscrepancyResponse cbc ResponseCode
{| class="wikitable" style="width: 100%;" style="margin: auto;"
! style="color:white;background:#2F5496; text-align:center;"|Código
! style="color:white;background:#2F5496; text-align:center;"|Descripción
|- valign="center"
|-
|1
|style="text-align:left;"|Devolución parcial de los bienes y/o no aceptación parcial del servicio
|-
|2
|style="text-align:left;"|Anulación de factura electrónica
|-
|3
|style="text-align:left;"|Rebaja o descuento parcial o total
|-
|4
|style="text-align:left;"|Ajuste de precio
|-
|5
|style="text-align:left;"|Descuento comercial por pronto pago
|-
|6
|style="text-align:left;"|Descuento comercial por volumen de ventas
|}
|}

==Tabla 10==
{| class="wikitable" style="width: 100%;"
|+ Motivos de Nota de débito
|- valign="center"
|-style="text-align:center;"
|colspan="2"|Anexo 1.9 01-11-2023 - 13.2.5. Concepto de Corrección para Notas débito cac DiscrepancyResponsecbc ResponseCode
{| class="wikitable" style="width: 100%;" style="margin: auto;"
! style="color:white;background:#2F5496; text-align:center;"|Código
! style="color:white;background:#2F5496; text-align:center;"|Descripción
|- valign="center"
|-
|1
|style="text-align:left;"|Intereses
|-
|2
|style="text-align:left;"|Gastos por cobrar
|-
|3
|style="text-align:left;"|Cambio del valor
|-
|4
|style="text-align:left;"|Otros
|}
|}
==Tabla 11==
{| class="wikitable" style="width: 100%;"
|+ Tipos de Impuesto
|- valign="center"
|-style="text-align:center;"
|colspan="2"|Anexo 1.9 01-11-2023 - 13.2.2 Tributos cac:TaxScheme/ID, cac:TaxScheme/Name
{| class="wikitable" style="width: 100%;" style="margin: auto;"
! style="color:white;background:#2F5496; text-align:center;"|Identificador
! style="color:white;background:#2F5496; text-align:center;"|Nombre
! style="color:white;background:#2F5496; text-align:center;"|Descripción
|- valign="center"
|-
|01
|IVA
|style="text-align:left;"|Impuesto de Valor Agregado
|-
|02
|IC
|style="text-align:left;"|Impuesto al Consumo
|-
|03
|ICA
|style="text-align:left;"|Impuesto de Industria, Comercio y Aviso
|-
|04
|INC
|style="text-align:left;"|Impuesto Nacional al Consumo
|-
|05
|ReteIVA
|style="text-align:left;"|Retención sobre el IVA
|-
|06
|ReteRenta
|style="text-align:left;"|Retención sobre Renta
|-
|07
|ReteICA
|style="text-align:left;"|Retención sobre el ICA
|-
|08
|IC Porcentual
|style="text-align:left;"|Impuesto al Consumo de Bolsa Plastica
|-
|20
|FtoHorticultura
|style="text-align:left;"|Cuota de Fomento Hortifrutícula
|-
|21
|Timbre
|style="text-align:left;"|Impuesto de Timbre
|-
|22
|INC Bolsas
|style="text-align:left;"|Impuesto Nacional al Consumo de Bolsa Plástica
|-
|23
|INCarbono
|style="text-align:left;"|Impuesto Nacional al Carbono
|-
|24
|INCombustibles
|style="text-align:left;"|Impuesto Nacional a los Combustibles
|-
|25
|Sobretasa Combustibles
|style="text-align:left;"|Sobretasa a los combustibles
|-
|26
|Sordicom
|style="text-align:left;"|Contribución minoristas (Combustibles)
|-
|30
|IC Datos
|style="text-align:left;"|Impuesto al Consumo de Datos
|-
|32
|ICL
|style="text-align:left;"|Impuesto al Consumo de Licores
|-
|33
|INPP
|style="text-align:left;"|Impuesto nacional productos plásticos
|-
|34
|IBUA
|style="text-align:left;"|Impuesto a las bebidas ultraprocesadas azucaradas****
|-
|35
|ICUI
|style="text-align:left;"|Impuesto a los productos comestibles ultraprocesados industrialmente y/o con alto contenido de azúcares añadidos, sodio o grasas saturadas
|-
|36
|ADV
|style="text-align:left;"|AD VALOREM
|-
|ZZ*
|Nombre de la figura tributaria**
|style="text-align:left;"|Otros tributos, tasas, contribuciones, y similares
|}
Nota (*): En los casos que no se cuente con el tributo expresado en el listado de este numeral, el código ZZ debe ser utilizado para informar el tributo, tasas, contribuciones o similares y el contribuyente debe indicar la información correspondiente que aplique
 
Nota (**): El nombre de la figura tributaria es asignado por el facturador y no será causal de rechazo
 
Nota (***): Para el calculo del impuesto ICA y la retención ReteICA, el porcentaje de estos se debe informar con dos (2) decimales y su operación debe ser dividida por cien (100) y a su ves el producto de esta operación deberá ser dividido nuevamente por diez (10) y este seria el valor a informar en el XML
 
Nota (****): Para el calculo del impuesto IBUA, la operacion se realiza entre los valores de los campos (PerUnitAmount*BaseUnitMeasure) con dos (2) decimales y su resultado debe ser dividido por cien (100) y este seria el valor para informar en el elemento (TaxAmount) del XML
 
Nota (*****): Para el cálculo del impuesto ICUI, la operación se realiza entre los valores de los campos (Percent * TaxableAmount) con dos (2) decimales y su resultado debe ser dividido por cien (100) y este sería el valor para informar en el elemento (TaxAmount) del XML
|}

==Tabla 12==
{| class="wikitable" style="width: 100%;"
|+ Tarifas por Impuesto
|- valign="center"
|-style="text-align:center;"
|colspan="2"|Anexo 1.9 01-11-2023 - 13.3.11 Tablas de tarifas por Impuesto
{| class="wikitable" style="width: 100%;" style="margin: auto;"
! style="color:white;background:#2F5496; text-align:center;"|Impuesto que reporta
! style="color:white;background:#2F5496; text-align:center;"|Valores posibles para el campo cbc:Percent
la tarifa a informar dependerá del aspecto tributario del impuesto reportado
|- valign="center"
|-
|IVA
|style="text-align:left;"|
{|
|-
| style="width:700px;| 
| style="width:50px;|Tarifa
| 
|-
| Concepto|| Tarifa || (cbc:Percent)||  
|-
| Excento|| 0.00 ||  |
|-
| Bienes/Servicios al 5|| 5.00 ||  |
|-
| Contratos firmados con el estado antes de ley 1819|| 16.00 ||  
|-
| Tarifa general|| 19.00 ||  
|}
|-
|INC
|style="text-align:left;"|
{|
|-
| style="width:700px;| 
|Tarifa
| 
|-
| Concepto           || (cbc:Percent)||  
|-
| Tarifa especial|| 2.00 ||  
|-
| Tarifa especial|| 4.00 ||  |
|-
| Tarifa general|| 8.00 ||  |
|-
| Tarifa especial|| 16.00 ||  |
|}
|-
|ReteIVA
|style="text-align:left;"|
15.00 
100.00
|}
|}
@IMPORTANTE: Este catálogo '''tarifas por Impuesto''' es más extenso, para mayor información hacer referencia a la [https://docs.google.com/spreadsheets/d/1EymupijUW6O1-si4bdfU-JjvS0x3gOFv/edit?usp=sharing&ouid=112467690378401473732&rtpof=true&sd=true tabla referenciada 13.3.11 Tablas de tarifas por Impuesto]

==Tabla 13==
{| class="wikitable" style="width: 100%;"
|+ Medios de Pago
|- valign="center"
|-style="text-align:center;"
|colspan="2"|Anexo 1.9 01-11-2023 - 13.3.4.2. Medios de Pago PaymentMeansCode
{| class="wikitable" style="width: 100%;" style="margin: auto;"
! style="color:white;background:#2F5496; text-align:center;"|Código
! style="color:white;background:#2F5496; text-align:center;"|Medio
! style="color:white;background:#2F5496; text-align:center;"|Código
! style="color:white;background:#2F5496; text-align:center;"|Medio
|- valign="center"
|-
|1
|Instrumento no definido
|39
|Crédito Negocio Intercambio Corporativo (CTX)
|-
|2
|Crédito ACH
|40
|Débito Negocio Intercambio Corporativo (CTX)
|-
|3
|Débito ACH
|41
|Desembolso Crédito plus (CCD+)
|-
|4
|Reversión débito de demanda ACH
|42
|Consiganción bancaria
|-
|5
|Reversión crédito de demanda ACH
|43
|Desembolso Débito plus (CCD+)
|-
|6
|Crédito de demanda ACH
|44
|Nota cambiaria
|-
|7
|Débito de demanda ACH
|45
|Transferencia Crédito Bancario
|-
|ZZZ
|Otro
|46
|Transferencia Débito Interbancario
|-
|9
|Clearing Nacional o Regional
|47
|Transferencia Débito Bancaria
|-
|10
|Efectivo
|48
|Tarjeta Crédito
|-
|11
|Reversión Crédito Ahorro
|49
|Tarjeta Débito
|-
|12
|Reversión Débito Ahorro
|50
|Postgiro
|-
|13
|Crédito Ahorro
|51
|Telex estándar bancario francés
|-
|14
|Débito Ahorro
|52
|Pago comercial urgente
|-
|15
|Bookentry Crédito
|53
|Pago Tesorería Urgente
|-
|16
|Bookentry Débito
|60
|Nota promisoria
|-
|17
|Desembolso Crédito (CCD)
|61
|Nota promisoria firmada por el acreedor
|-
|18
|Desembolso (CCD) débito
|62
|Nota promisoria firmada por el acreedor, avalada por elbanco
|-
|19
|Crédito Pago negocio corporativo (CTP)
|63
|Nota promisoria firmada por el acreedor, avalada por untercero
|-
|20
|Cheque
|64
|Nota promisoria firmada pro el banco
|-
|21
|Poyecto bancario
|65
|Nota promisoria firmada por un banco avalada por otrobanco
|-
|22
|Proyecto bancario certificado
|66
|Nota promisoria firmada
|-
|23
|Cheque bancario de gerencia
|67
|Nota promisoria firmada por un tercero avalada por unbanco
|-
|24
|Nota cambiaria esperando aceptación
|70
|Retiro de nota por el por el acreedor
|-
|25
|Cheque certificado
|71
|Bonos
|-
|26
|Cheque Local
|72
|Vales
|-
|27
|Débito Pago Neogcio Corporativo (CTP)
|74
|Retiro de nota por el por el acreedor sobre un banco
|-
|28
|Crédito Negocio Intercambio Corporativo (CTX)
|75
|Retiro de nota por el acreedor, avalada por otro banco
|-
|29
|Débito Negocio Intercambio Corporativo (CTX)
|76
|Retiro de nota por el acreedor, sobre un banco avalada porun tercero
|-
|30
|Transferecia Crédito
|77
|Retiro de una nota por el acreedor sobre un tercero
|-
|31
|Transferencia Débito
|78
|Retiro de una nota por el acreedor sobre un terceroavalada por un banco
|-
|32
|Desembolso Crédito plus(CCD+)
|91
|Nota bancaria tranferible
|-
|33
|Desembolso Débito plus(CCD+)
|92
|Cheque local traferible
|-
|34
|Pago y depósito pre acordado (PPD)
|93
|Giro referenciado
|-
|35
|Desembolso Crédito(CCD)
|94
|Giro urgente
|-
|36
|Desembolso Drédito(CCD)
|95
|Giro formato abierto
|-
|37
|Pago Negocio Corporativo Ahorros Crédito (CTP)
|96
|Método de pago solicitado no usuado
|-
|38
|Pago Neogcio Corporativo Ahorros Débito (CTP)
|97
|Clearing entre partners
|-
|}
|}

==Tabla 14==
{| class="wikitable" style="width: 100%;"
|+ Forma ó Metodo de Pago
|- valign="center"
|-style="text-align:center;"
|colspan="2"|Anexo 1.9 01-11-2023 - 13.3.4.1. Formas de Pago cbc PaymentMeans ID
{| class="wikitable" style="width: 100%;" style="margin: auto;"
! style="color:white;background:#2F5496; text-align:center;"|Código
! style="color:white;background:#2F5496; text-align:center;"|Significado
|- valign="center"
|-
|1
|Contado
|-
|2
|Crédito
|}
|}

==Tabla 15==
{| class="wikitable" style="width: 100%;"
|+ Condiciones de entrega (INCOTERMS)
|- valign="center"
|-style="text-align:center;"
|colspan="2"|Anexo 1.9 01-11-2023 - 13.3.7. Condiciones de entrega (INCOTERMS)-LossRiskResponsibilityCode
{| class="wikitable" style="width: 100%;" style="margin: auto;"
! style="color:white;background:#2F5496; text-align:center;"|Código
! style="color:white;background:#2F5496; text-align:center;"|Significado
|- valign="center"
|-
|CFR
|Costo y flete
|-
|CIF
|Costo, flete y seguro
|-
|CIP
|Transporte y Seguro Pagados hasta
|-
|CPT
|Transporte Pagado Hasta
|-
|DAP
|Entregado en un Lugar
|-
|DAT
|Entregado en Terminal
|-
|DDP
|Entregado con Pago de Derechos
|-
|EXW
|En Fábrica
|-
|FAS
|Franco al costado del buque
|-
|FCA
|Franco transportista
|-
|FOB
|Franco a bordo
|}
|}

==Tabla 16==
{| class="wikitable" style="width: 100%;"
|+ Departamentos (ISO 3166-2:CO)
|- valign="center"
|-style="text-align:center;"
|colspan="2"|Anexo 1.9 01-11-2023 - 13.4.2. Departamentos ISO 3166-2CO CountrySubentity, CountrySubentityCode
{| class="wikitable" style="width: 100%;" style="margin: auto;"
! style="color:white;background:#2F5496; text-align:center;"|Código
! style="color:white;background:#2F5496; text-align:center;"|Nombre
! style="color:white;background:#2F5496; text-align:center;"|Código ISO
! style="color:white;background:#2F5496; text-align:center;"|Código
! style="color:white;background:#2F5496; text-align:center;"|Nombre
! style="color:white;background:#2F5496; text-align:center;"|Código ISO
|- valign="center"
|-
|91
|Amazonas
|AMA
|41
|Huila
|HUI
|-
|05
|Antioquia
|ANT
|44
|La Guajira
|LAG
|-
|81
|Arauca
|ARA
|47
|Magdalena
|MAG
|-
|08
|Atlántico
|ATL
|50
|Meta
|MET
|-
|11
|Bogotá
|DC
|52
|Nariño
|NAR
|-
|13
|Bolívar
|BOL
|54
|Norte de Santander
|NSA
|-
|15
|Boyacá
|BOY
|86
|Putumayo
|PUT
|-
|17
|Caldas
|CAL
|63
|Quindío
|QUI
|-
|18
|Caquetá
|CAQ
|66
|Risaralda
|RIS
|-
|85
|Casanare
|CAS
|88
|San Andrés y Providencia
|SAP
|-
|19
|Cauca
|CAU
|68
|Santander
|SAN
|-
|20
|Cesar
|CES
|70
|Sucre
|SUC
|-
|27
|Chocó
|CHO
|73
|Tolima
|TOL
|-
|23
|Córdoba
|COR
|76
|Valle del Cauca
|VAC
|-
|25
|Cundinamarca
|CUN
|97
|Vaupés
|VAU
|-
|94
|Guainía
|GUA
|99
|Vichada
|VID
|-
|95
|Guaviare
|GUV
|
|
|
|}
|}

==Tabla 17==
{| class="wikitable" style="width: 100%;"
|+ Responsabilidades fiscales
|- valign="center"
|-style="text-align:center;"
|colspan="2"|Anexo 1.9 01-11-2023 - 13.2.7.1 Responsabilidades fiscales
{| class="wikitable" style="width: 100%;" style="margin: auto;"
! style="color:white;background:#2F5496; text-align:center;"|Código
! style="color:white;background:#2F5496; text-align:center;"|Significado
|- valign="center"
|-
|O-13
|Gran contribuyente
|-
|O-15
|Autorretenedor
|-
|O-23
|Agente de retención en el impuesto sobre las ventas
|-
|O-47
|Régimen Simple de Tributación – SIMPLE
|-
|R-99-PN
|No Aplica - Otros
|}
|}

==Tabla 18==
{| class="wikitable" style="width: 100%;"
|+ Detalles tributarios
|- valign="center"
|-style="text-align:center;"
|colspan="2"|Anexo 1.9 01-11-2023 - 13.2.6.2 Tributos
{| class="wikitable" style="width: 100%;" style="margin: auto;"
! style="color:white;background:#2F5496; text-align:center;"|Codigo
! style="color:white;background:#2F5496; text-align:center;"|Significado
|- valign="center"
|-
|01
|IVA
|-
|04
|INC
|-
|ZA
|IVA e INC
|-
|ZZ
|No Aplica
|}
|}

==Tabla 19==
{| class="wikitable" style="width: 100%;"
|+ Municipios
|- valign="center"
|-style="text-align:center;"
|colspan="2"|Anexo 1.9 01-11-2023 - 13.4.3 Municipios: cbc:CityName
{| class="wikitable" style="width: 100%;" style="margin: auto;"
! style="color:white;background:#2F5496; text-align:center;"|Código Departamento
! style="color:white;background:#2F5496; text-align:center;"|Código Municipio
! style="color:white;background:#2F5496; text-align:center;"|Nombre Departamento
! style="color:white;background:#2F5496; text-align:center;"|Nombre Municipio
|- valign="center"
|-
|05
|05044
|Antioquia
|ANZÁ
|-
|05
|05045
|Antioquia
|APARTADÓ
|-
|05
|05051
|Antioquia
|ARBOLETES
|-
|05
|05055
|Antioquia
|ARGELIA
|-
|05
|05059
|Antioquia
|ARMENIA
|-
|05
|05079
|Antioquia
|BARBOSA
|-
|05
|05086
|Antioquia
|BELMIRA
|-
|05
|05088
|Antioquia
|BELLO
|-
|05
|05091
|Antioquia
|BETANIA
|-
|05
|05093
|Antioquia
|BETULIA
|-
|05
|05101
|Antioquia
|CIUDAD BOLÍVAR
|-
|05
|05107
|Antioquia
|BRICEÑO
|-
|05
|05113
|Antioquia
|BURITICÁ
|-
|05
|05120
|Antioquia
|CÁCERES
|-
|05
|05125
|Antioquia
|CAICEDO
|-
|05
|05129
|Antioquia
|CALDAS
|-
|05
|05134
|Antioquia
|CAMPAMENTO
|-
|05
|05138
|Antioquia
|CAÑASGORDAS
|-
|05
|05142
|Antioquia
|CARACOLÍ
|-
|05
|05145
|Antioquia
|CARAMANTA
|-
|05
|05147
|Antioquia
|CAREPA
|-
|05
|05148
|Antioquia
|EL CARMEN DE VIBORAL
|-
|05
|05150
|Antioquia
|CAROLINA
|-
|05
|05154
|Antioquia
|CAUCASIA
|-
|05
|05172
|Antioquia
|CHIGORODÓ
|}
|}
'''@IMPORTANTE:''' Este catálogo '''municipios''' es más extenso, para mayor información hacer referencia a la sección del Anexo correspondiente.

==Tabla 20==
{| class="wikitable" style="width: 100%;"
|+ Zona Postal
|- valign="center"
|colspan="2"|Anexo 1.9-01-11-2023 - 13.4.4 Códigos_Postales cbc:PostalZone 
En Colombia el código postal consta de 6 dígitos (ejemplo: 578986) que señalan inicialmente la posición geográfica, seguida por la de encaminamiento y finalmente la que nos ubica dentro del área postal, así:

'''Departamentos Nacionales''' 
Los dos primeros dígitos representan a los departamentos nacionales, utilizando la codificación vigente Dane. Los códigos menores de 10 deben iniciar con un cero a la izquierda.

'''Zonas postales departamentales de encaminamiento''' 
La tercera y cuarta posición definen las zonas postales de encaminamiento para facilitar la clasificación a través del Código Postal: El 00 queda reservado para la capital del departamento. Del 01 al 89 permite dividir cada departamento hasta en 89 zonas de encaminamiento postal.

'''Distrito postales por municipio o localidad''' 
Las dos últimas posiciones del Código Postal Nacional permiten asignar cien distritos postales a cada una de las diez zonas postales creadas en cada departamento. Es decir, se pueden asignar hasta mil distritos distintos en cada departamento, para un total de treinta y tres mil a nivel nacional.
|}
@IMPORTANTE: Para mayor información hacer referencia a la sección del Anexo correspondiente.

==Tabla 21==
{| class="wikitable" style="width: 100%;"
|+Referencia a Documentos no Tributarios
|- valign="center"
|colspan="2"|'''Anexo 1.8 - 13.1.4. Referencia a documentos no tributarios: cbc:DocumentTypeCode''' 
Este elemento se refiere al'''xpath /Invoice/cac:AdditionalDocumentReference/cbc: DocumentTypeCode'''. Estos documentos representan acciones comerciales y mercantiles que amparan o soportan transaccionesrelacionadas con este documento electrónico.

Los documentos electrónicos XML adoptados por la DIAN no deben incluirse en este fragmento ya que
estos documentos no contienen las identificaciones estándar como CUFE o CUDE.

Al tratarse de una orden de entrega se debe utilizar el grupo de elemento '''OrderReference''', al informar mas de una se debe disponer del grupo AdditionalDocumentReference.
Este campo de este grupo de información es opcional para referenciar temas comerciales a voluntad del
facturador electrónico, por tanto, los códigos son asignados por esté.
|}

<center>'''TABLAS DE CÓDIGOS PARA EMISIÓN DE DOCUMENTOS DEL SECTOR SALUD'''</center>
==Tabla 22==
{| class="wikitable" style="width: 100%;"
|+ Tipo Documento Identificacion- Sector Salud
|- valign="center"
|-style="text-align:center;"
|colspan="2"|
{| class="wikitable" style="width: 100%;" style="margin: auto;"
! style="color:white;background:#2F5496; text-align:center;"|Abv
! style="color:white;background:#2F5496; text-align:center;"|Tipo Documento de Identificación
|- valign="center"
|-
|CC
|Cédula de ciudadanía
|-
|CE
|Cédula de extranjería
|-
|CD
|Carnet Diplomático
|-
|PA
|Pasaporte
|-
|SC
|Salvoconducto
|-
|PE
|Permiso especial de permanencia
|-
|RC
|Registro civil
|-
|TI
|Tarjeta de Identidad
|-
|CN
|Certificado de nacido vivo
|-
|AS
|Adulto Sin Identificar
|-
|MS
|Menor sin Identificar
|-
|DE
|Documento Extranjero
|-
|SI
|Sin Identificación
|-
|NI
|Número de identificación tributario NIT
|-
|NV
|Certificado nacido vivo
|-
|PT
|Permiso por protección temporal
|}
|}

==Tabla 23==
{| class="wikitable" style="width: 100%;"
|+ Modalidades de Pago- Sector Salud
|- valign="center"
|-style="text-align:center;"
|colspan="2"|
{| class="wikitable" style="width: 100%;" style="margin: auto;"
! style="color:white;background:#2F5496; text-align:center;"|Código
! style="color:white;background:#2F5496; text-align:center;"|Modalidades de Pago
|- valign="center"
|-
|01
|Pago individual por caso / Conjunto integral de atenciones / Paquete / Canasta
|-
|02
|Pago global prospectivo
|-
|03
|Pago por capitación
|-
|04
|Pago por evento
|-
|05
|Otra Modalidad Especifica
|-
|}
|}

==Tabla 24==
{| class="wikitable" style="width: 100%;"
|+ Cobertura o Plan de Beneficios - Sector Salud
|- valign="center"
|-style="text-align:center;"
|colspan="2"|
{| class="wikitable" style="width: 100%;" style="margin: auto;"
! style="color:white;background:#2F5496; text-align:center;"|Código
! style="color:white;background:#2F5496; text-align:center;"|Cobertura o plan de servicios
|- valign="center"
|-
|01
|Plan de beneficios en salud financiado con UPC
|-
|02
|Presupuesto máximo
|-
|03
|Prima EPS / EOC, no asegurados SOAT
|-
|04
|Cobertura Póliza SOAT
|-
|05
|Cobertura ARL
|-
|06
|Cobertura ADRES
|-
|07
|Cobertura Salud Pública
|-
|08
|Cobertura entidad territorial, recursos de oferta
|-
|09
|Urgencias población migrante
|-
|10
|Plan complementario en salud
|-
|11
|Plan medicina prepagada
|-
|12
|Pólizas en salud
|-
|13
|Cobertura Régimen Especial o Excepción
|-
|14
|Cobertura Fondo Nacional de Salud de las Personas Privadas de la Libertad
|-
|15
|Particular
|}
|}

==Tabla 25==
{| class="wikitable" style="width: 100%;"
|+ Conceptos de Recaudo
|- valign="center"
|-style="text-align:center;"
|colspan="2"|
{| class="wikitable" style="width: 100%;" style="margin: auto;"
! style="color:white;background:#2F5496; text-align:center;"|Código
! style="color:white;background:#2F5496; text-align:center;"|Descripción
|- valign="center"
|-
|01
|Copago
|-
|02
|Cuota Moderadora
|-
|03
|Pagos compartidos en planes voluntarios de salud
|-
|04
|Anticipos
|-
|05
|No aplica
|}
|}

==Tabla 26==
{| class="wikitable" style="width: 100%;"
|+ Tipos Escenarios
|- valign="center"
|-style="text-align:center;"
|colspan="2"|
{| class="wikitable" style="width: 100%;" style="margin: auto;"
! style="color:white;background:#2F5496; text-align:center;"|Código
! style="color:white;background:#2F5496; text-align:center;"|Descripción
|- valign="center"
|-
|1
|Registro del Concepto de recaudo al paciente
|-
|2
|Registro del Concepto de acreditación a la EPS
|-
|3
|Registro de operaciones sin acreditación a la EPS
|-
|4
|Emisión de FEL sin recaudo previo
|}
|}

==Tabla 27==
{| class="wikitable" style="width: 100%;"
|+ Campos de Datos Adicionales
|- valign="center"
|-style="text-align:center;"
|colspan="2"|
{| class="wikitable" style="width: 100%;" style="margin: auto;"
! style="color:white;background:#2F5496; text-align:center;"|Nombre
! style="color:white;background:#2F5496; text-align:center;"|Etiqueta
! style="color:white;background:#2F5496; text-align:center;"|Descripción
|- valign="center"
|-
|1
|CODIGO_PRESTADOR
|Código asignado en el Sistema General de Seguridad Social en Salud (SGSSS) a los prestadores de servicios de salud que estén en el Registro Especial de Prestadores de Servicios de Salud (REPS) o el código asignado por el Ministerio de Salud y Protección Social para los laboratorios de salud pública.
|-
|2
|MODALIDAD_CONTRATACION
|Registro de la modalidad de contratación y pago pactada objeto de facturación. Obligatorio.
:[[Tablas de códigos de propiedades para emisión de documentos - Indice Manual Integración Directa#Tabla 24|Tabla 24]]
|
|-
|3
|COBERTURA_PLAN_BENEFICIOS
|Registro de la entidad responsable de financiar la cobertura oplan de beneficios. Obligatorio.
:[[Tablas de códigos de propiedades para emisión de documentos - Indice Manual Integración Directa#Tabla 25|Tabla 25]]
|-
|4
|NUMERO_CONTRATO
|Número de contrato objeto de facturación
|-
|5
|NUMERO_POLIZA
|Número de póliza SOAT o de planes voluntarios de salud. Obligatorio: Cuando se trate de atenciones SOAT o planes voluntarios de salud. Se diligencia cuando se trata de atenciones por accidente de tránsito o por atención como particular por una póliza de salud
|-
|6
|COPAGO
|Valor efectivamente pagado por el usuario y recaudado por el prestador de servicios
|-
|7
|CUOTA_MODERADORA
|Valor efectivamente pagado por el usuario y recaudado por el prestador de servicios
|-
|8
|PAGOS_COMPARTIDOS
|Valor efectivamente pagado por el usuario y recaudado por el prestador de servicios
|-
|9
|Anticipos
|Se debe registrar el valor del anticipo a legalizar, que se restará al
valor de la presente factura en ejecución del contrato señalado en el numeral 3.4
|-
|10
|Fecha de inicio del periodo de facturación
|Se debe registrar la fecha de inicio de la prestación o provisión del servicio o tecnología de salud cuando se factura por un solo usuario o la fecha de inicio del periodo de facturación cuando se factura multiusuario según modalidad de pago.
|-
|11
|Fecha final del periodo de facturación:
|Se debe registrar la fecha final de la prestación o provisión del servicio
o tecnología de salud cuando se factura por un solo usuario o la fecha final del periodo de facturación cuando se factura multiusuario según modalidad de pago.
|}
|}

==Tabla 28==
{| class="wikitable" style="width: 100%;"
|+ Tipos de operación salud
|- valign="center"
|-style="text-align:center;"
|colspan="2"|
{| class="wikitable" style="width: 100%;" style="margin: auto;"
! style="color:white;background:#2F5496; text-align:center;"|Código
! style="color:white;background:#2F5496; text-align:center;"|Tipos de operación Salud Resolución 058:2020 de la Contaduría General de la Nación finvoiceicbc:CustomizationlD Definición
|- valign="center"
|-
|SS-Recaudo
|Recaudación. Comprobante de recaudo de Cuotas Moderadores, Copagos o Cuotas de Recuperación, como recursos a favor de terceros. - No Activa el Método de cálculo del Sector
Salud.
|-
|SS-CUFE
|Acreditación. Este documento incluye referencia(s) de Factura Electrónica de Venta (tipo 01 o 04) que comprueba el recaudo de Cuotas Moderadoras, Copagos o Cuotas de Recuperación,
como recursos a favor de terceros, los cuales son acreditados a la presente Factura Electrónica de Venta con destino a la aseguradora que aparece como adquiriente. - Activa el Método de
cálculo del Sector Salud.
|-
|SS-CUDE
|Acreditación. Este documento incluye referencia(s) de Factura -de contingencia (tipos 03) que reconoce valores recaudados correspondientes a Cuotas Moderadoras, Copagos o Cuotas de
Recuperación, como ingresos a favor de terceros, los cuales son acreditados a la presente Factura Electrónica de Venta con destino a la aseguradora que aparece como adquiriente. -
Activa el Método de cálculo del Sector Salud.
|-
|SS-POS
|Acreditación. Este documento incluye referencia(s) de Documento Equivalente de Venta POS que comprueba el recaudo de Cuotas Moderadoras, Copagos o Cuotas de Recuperación, como
recursos a favor de terceros, los cuales son acreditados a la presente Factura Electrónica de Venta con destino a la aseguradora que aparece como adquiriente. - Activa el Método de
cálculo del Sector Salud. Observación: Los valores recaudados a favor de terceros por el operador del sistema de salud mediante los comprobantes del Sistema POS serán automatizados por la DIAN, y deberán reportarse cada vez que se cierra una caja de recaudo. La DIAN expedirá la reglamentación técnica e informática pertinente.
|-
|SS-SNum
|Acreditación. Este documento incluye referencia(s)) de Factura Talonario que comprueba él recaudo de Cuotas Moderadores, Copagos o Cuotas de Recuperación, como recursos a favor
de terceros, los cuales son acreditados a la presente Factura Electrónica de Venta con destino a la aseguradora que aparece como adquiriente. - Activa el Método de cálculo del Sector Salud.
|-
|SS-Reporte
|Reporte. Este documento reporta referencia(s) de diversa índole que comprueban recaudo de Cuotas Moderadoras, Copagos o Cuotas de Recuperación, a las cuales ya se les dio
tratamiento contable. - No Activa el Método de cálculo del Sector Salud.
|-
|SS-SinAporte
|Reporte. Sin aporte ni recaudo en dinero por parte de los afiliados del régimen contributivo por concepto de Cuotas Moderadoras, Copagos o Cuotas de Recuperación. - No Activa el Método
de cálculo del Sector Salud.
|}
|}

API ConsultarDocumento

2025-09-26T17:51:27Z

Dmrodriguez2: Página creada con «La API '''ConsultarDocumento''' ofrece la capacidad de obtener una visión detallada de una transacción específica, facilitando a los integradores la verificación y validación del estado y el contenido de cualquier documento electrónico emitido. Su objetivo principal es proveer acceso granular a la información de una factura o documento en general, permitiendo un control exhaustivo sobre cada transacción. Esta funcionalidad se puede utilizar en el ambiente demo…»

La API '''ConsultarDocumento''' ofrece la capacidad de obtener una visión detallada de una transacción específica, facilitando a los integradores la verificación y validación del estado y el contenido de cualquier documento electrónico emitido. Su objetivo principal es proveer acceso granular a la información de una factura o documento en general, permitiendo un control exhaustivo sobre cada transacción. Esta funcionalidad se puede utilizar en el ambiente demo y en ambiente de producción o al realizar el consumo del servicio a través de la Api ConsultarDocumento.
 
 
'''@IMPORTANTE:''' La API ConsultarDocumento está construida en método POST. Para el consumo de este servicio se han establecido dos url especificas en ambiente DEMO y ambiente PRODUCCION las cuales las podrá encontrar a continuación:

'''Para mayor información pude consultas las URL en la siguiente sección:'''
'''[[Tips_Urls_de_Emisión #ConsultarDocumento|ConsultarDocumento]]'''

A continuación se documenta la estructura que se debe contemplar en la construcción del Request y el Response del servicio ConsultarDocumento y de esta forma garantizar la implementación de este nuevo método:

; REQUEST: Parámetros a Enviar
{| class="mw-collapsible wikitable"
! style="background:#f2f2f2; text-align:center;"|Tipo
! style="background:#f2f2f2; text-align:center;"|Identificador
! style="background:#f2f2f2; text-align:center;"|Descripción
|- valign="center"
|-
|String
|Nit
|Número de identificación tributaria (NIT) del contribuyente emisor del documento a consultar.
|-
|rowspan="2"|String
|TokenEmpresa
|rowspan="2"|Suministrado por The Factory HKA Colombia según el ambiente a consultar
|-
|TokenClave
|-
|String
|ClaveSecreta
|Clave definida por el contribuyente emisor desde el usuario root en el portal HKA Factura Electrónica (aplicable tanto en ambientes de demo como de producción) para autorizar esta acción y asegurar la confidencialidad de la consulta.
|-
|Object
|Documento
|Encapsula la información de identificación del documento electrónico a consultar. Este objeto es obligatorio
|-
|}
 

Donde Object. Documento contiene la siguiente información:

; Request: Parámetros a Recibir Object Documento
{| class="mw-collapsible wikitable"
! style="background:#f2f2f2; text-align:center;"|Tipo
! style="background:#f2f2f2; text-align:center;"|Identificador
! style="background:#f2f2f2; text-align:center;"|Descripción
|- valign="center"
|-
|String
|Prefijo
|Es una cadena de caracteres alfanuméricos (letras, números o una combinación) que se utiliza para clasificar y agrupar documentos dentro de un mismo tipo o serie.
|-
|String
|Correlativo
|Es el número consecutivo y único asignado a un documento dentro de un Prefijo determinado. Es una cadena numérica que identifica de forma exclusiva el documento dentro de su serie.
|-
|}
 

; RESPONSE: Parámetros a Recibir al consumir la Api ConsultarDocumento
{| class="mw-collapsible wikitable"
! style="background:#f2f2f2; text-align:center;"|Tipo
! style="background:#f2f2f2; text-align:center;"|Identificador
! style="background:#f2f2f2; text-align:center;"|Descripción
|- valign="center"
|-
|int
|Código
|Código HTTP de la respuesta. 200 para éxito, otros valores indican errores.
|-
|String
|Mensaje
|Mensaje descriptivo del resultado de la operación.
|-
|String
|Resultado
|Estado general de la operación (ej. "Exitoso", "Fallido").
|-
|String
|Nit
|Número de identificación tributaria (NIT) del contribuyente al que pertenece el documento consultado.
|-
|String
|IdEmpresa
|Identificador interno de la empresa en el sistema.
|-
|Int
|TotalDocumentos
|Número total de documentos encontrados que coinciden con la consulta
|-
|Array (Documento)
|Documentos
|Lista de objetos Documento encontrados. Cada objeto contiene el detalle completo de un documento electrónico.
|-
|Object
|Errores
|Objeto que contiene detalles de errores en caso de que la consulta no haya sido exitosa. Será null si no hay errores.
|}
{{clear}}

Tips Urls de Emisión

2025-09-26T17:33:01Z

Dmrodriguez2:

<includeonly>=</includeonly>== URL´s Servicio de integración REST==<includeonly>=</includeonly>
 
*URL Demo:[https://demoemision21-api.thefactoryhka.com.co https://demoemision21-api.thefactoryhka.com.co]
*URL Produccion:[https://emision21-api.thefactoryhka.com.co https://emision21-api.thefactoryhka.com.co]
 
<includeonly>=</includeonly>== URL´s Servicio de integración SOAP de Emisión-Ambiente de Demo==<includeonly>=</includeonly>
 
A continuación documentamos las versiones de URL establecidas por The Factory HKA Colombia para el uso de su web service en el ambiente Demo, para que realice toda clase de pruebas funcionales
 

===Versión 4 ===
*URL:[https://demoemision21v4.thefactoryhka.com.co/ws/v1.0/Service.svc?wsdl https://demoemision21v4.thefactoryhka.com.co/ws/v1.0/Service.svc?wsdl ]
'''@IMPORTANTE: (Recibe soporte y actualizaciones continuas)'''

===Versión 2 ===
*URL:[http://demoemision21v2.thefactoryhka.com.co/ws/v1.0/Service.svc?wsdl http://demoemision21v2.thefactoryhka.com.co/ws/v1.0/Service.svc?wsdl]
'''@IMPORTANTE: (Ya no recibirá actualizaciones ni servicio de soporte a partir del 01 de julio del 2024)'''

===Versión 1 ===
*URL:[http://demoemision21.thefactoryhka.com.co/ws/v1.0/Service.svc?wsdl http://demoemision21.thefactoryhka.com.co/ws/v1.0/Service.svc?wsdl]
'''@IMPORTANTE: (Ya no recibirá actualizaciones ni servicio de soporte a partir del 01 de julio del 2024)'''

 
<includeonly>=</includeonly>== URL´s Servicio de integración SOAP de Emisión-Ambiente de Producción ==<includeonly>=</includeonly>
 
A continuación documentamos las versiones de URL establecidas por The Factory HKA Colombia para el uso de su web service en el ambiente de Producción, para que realice el envió de facturas electrónicas a directamente la DIAN.
 

===Versión 4 ===
*URL:[https://emision21v4.thefactoryhka.com.co/ws/v1.0/Service.svc?wsdl https://emision21v4.thefactoryhka.com.co/ws/v1.0/Service.svc?wsdl]
'''@IMPORTANTE: (Recibe soporte y actualizaciones continuas)'''

===Versión 2 ===
*URL:[https://emision21v2.thefactoryhka.com.co/ws/v1.0/Service.svc?wsdl https://emision21v2.thefactoryhka.com.co/ws/v1.0/Service.svc?wsdl]
'''@IMPORTANTE: (Ya no recibirá actualizaciones ni servicio de soporte a partir del 01 de julio del 2024)'''

===Versión 1 ===
*URL:[https://emision21.thefactoryhka.com.co/ws/v1.0/Service.svc?wsdl https://emision21.thefactoryhka.com.co/ws/v1.0/Service.svc?wsdl]
'''@IMPORTANTE: (Ya no recibirá actualizaciones ni servicio de soporte a partir del 01 de julio del 2024)'''

 
<includeonly>=</includeonly>== URL´s Servicio SOAP Alternativos de integración Directa para Emisión de documentos Electrónicos TFHKA ==<includeonly>=</includeonly>
 
A continuación documentamos las versiones de URL establecidas por The Factory HKA Colombia para el uso de su web service para el servicio de adjuntos y reportes en sus diferentes ambientes:
 

===Adjuntos===
*URL Demo:[http://demoemision21.thefactoryhka.com.co/ws/adjuntos/Service.svc?wsdl http://demoemision21.thefactoryhka.com.co/ws/adjuntos/Service.svc?wsdl]
*URL Produccion:[https://emision21.thefactoryhka.com.co/ws/adjuntos/Service.svc?wsdl https://emision21.thefactoryhka.com.co/ws/adjuntos/Service.svc?wsdl]

=== Adjuntos Versión 4===
*URL Demo:[http://demoemision21v4.thefactoryhka.com.co/ws/adjuntos/Service.svc?wsdl http://demoemision21v4.thefactoryhka.com.co/ws/adjuntos/Service.svc?wsdl]
*URL Produccion:[https://emision21v4.thefactoryhka.com.co/ws/adjuntos/Service.svc?wsdl https://emision21v4.thefactoryhka.com.co/ws/adjuntos/Service.svc?wsdl]

===Reportes===
*URL Demo:[http://demoemision21.thefactoryhka.com.co/ws/reportes/Service.svc?wsdl http://demoemision21.thefactoryhka.com.co/ws/reportes/Service.svc?wsdl]
*URL Produccion:[https://emision21.thefactoryhka.com.co/ws/reportes/Service.svc?wsdl https://emision21.thefactoryhka.com.co/ws/reportes/Service.svc?wsdl]

===EstadoCertificado===
*URL Demo:[http://demoemision21v4.thefactoryhka.com.co/ws/certificado/Service.svc http://demoemision21v4.thefactoryhka.com.co/ws/certificado/Service.svc?wsdl]
*URL Produccion:[https://emision21v4.thefactoryhka.com.co/ws/certificado/Service.svc https://emision21v4.thefactoryhka.com.co/ws/certificado/Service.svc?wsdl]
 

<includeonly>=</includeonly>== URL´s Servicio Gestión Contribuyentes TFHKA ==<includeonly>=</includeonly>
 
A continuación documentamos las versiones de URL establecidas por The Factory HKA Colombia para el uso de las APIs Gestión Contribuyentes en sus diferentes ambientes:
 
<includeonly>=</includeonly>===CatalogoAsociado===<includeonly>=</includeonly>

<includeonly>=</includeonly>==== ConsultarCatalogoAsociado ====<includeonly>=</includeonly>
*URL Demo:[https://demogestioncontribuyentesrest.thefactoryhka.com.co/api/CatalogoAsociado/Consultar https://demogestioncontribuyentesrest.thefactoryhka.com.co/api/CatalogoAsociado/Consultar]
*URL Produccion:[https://gestioncontribuyentesrest.thefactoryhka.com.co/api/CatalogoAsociado/Consultar https://gestioncontribuyentesrest.thefactoryhka.com.co/api/CatalogoAsociado/Consultar]

<includeonly>=</includeonly>==== AsociarCatalogoAsociado ====<includeonly>=</includeonly>
*URL Demo:[https://demogestioncontribuyentesrest.thefactoryhka.com.co/api/CatalogoAsociado/Asociar https://demogestioncontribuyentesrest.thefactoryhka.com.co/api/CatalogoAsociado/Asociar]
*URL Produccion:[https://gestioncontribuyentesrest.thefactoryhka.com.co/api/CatalogoAsociado/Asociar https://gestioncontribuyentesrest.thefactoryhka.com.co/api/CatalogoAsociado/Asociar]

<includeonly>=</includeonly>==== EliminarCatalogoAsociado ====<includeonly>=</includeonly>
*URL Demo:[https://demogestioncontribuyentesrest.thefactoryhka.com.co/api/CatalogoAsociado/Eliminar https://demogestioncontribuyentesrest.thefactoryhka.com.co/api/CatalogoAsociado/Eliminar]
*URL Produccion:[https://gestioncontribuyentesrest.thefactoryhka.com.co/api/CatalogoAsociado/Eliminar https://gestioncontribuyentesrest.thefactoryhka.com.co/api/CatalogoAsociado/Eliminar]

<includeonly>=</includeonly>===CatalogoFacturacion===<includeonly>=</includeonly>

<includeonly>=</includeonly>==== ConsultarCatalogo====<includeonly>=</includeonly>
*URL Demo:[https://demogestioncontribuyentesrest.thefactoryhka.com.co/api/CatalogoFacturacion/Consultar https://demogestioncontribuyentesrest.thefactoryhka.com.co/api/CatalogoFacturacion/Consultar]
*URL Produccion:[https://gestioncontribuyentesrest.thefactoryhka.com.co/api/CatalogoFacturacion/Consultar https://gestioncontribuyentesrest.thefactoryhka.com.co/api/CatalogoFacturacion/Consultar]

<includeonly>=</includeonly>===ClienteFacturacion===<includeonly>=</includeonly>

<includeonly>=</includeonly>==== ConsultarCliente ====<includeonly>=</includeonly>
*URL Demo:[https://demogestioncontribuyentesrest.thefactoryhka.com.co/api/ClienteFacturacion/Consultar https://demogestioncontribuyentesrest.thefactoryhka.com.co/api/ClienteFacturacion/Consultar]
*URL Produccion:[https://gestioncontribuyentesrest.thefactoryhka.com.co/api/ClienteFacturacion/Consultar https://gestioncontribuyentesrest.thefactoryhka.com.co/api/ClienteFacturacion/Consultar]

<includeonly>=</includeonly>==== CrearCliente====<includeonly>=</includeonly>
*URL Demo:[https://demogestioncontribuyentesrest.thefactoryhka.com.co/api/ClienteFacturacion/Crear https://demogestioncontribuyentesrest.thefactoryhka.com.co/api/ClienteFacturacion/Crear]
*URL Produccion:[https://gestioncontribuyentesrest.thefactoryhka.com.co/api/ClienteFacturacion/Crear https://gestioncontribuyentesrest.thefactoryhka.com.co/api/ClienteFacturacion/Crear]

<includeonly>=</includeonly>==== ActualizarCliente ====<includeonly>=</includeonly>
*URL Demo:[https://demogestioncontribuyentesrest.thefactoryhka.com.co/api/ClienteFacturacion/Actualizar https://demogestioncontribuyentesrest.thefactoryhka.com.co/api/ClienteFacturacion/Actualizar]
*URL Produccion:[https://gestioncontribuyentesrest.thefactoryhka.com.co/api/ClienteFacturacion/Actualizar https://gestioncontribuyentesrest.thefactoryhka.com.co/api/ClienteFacturacion/Actualizar]

<includeonly>=</includeonly>==== EliminarCliente ====<includeonly>=</includeonly>
*URL Demo:[https://demogestioncontribuyentesrest.thefactoryhka.com.co/api/ClienteFacturacion/Eliminar https://demogestioncontribuyentesrest.thefactoryhka.com.co/api/ClienteFacturacion/Eliminar]
*URL Produccion:[https://gestioncontribuyentesrest.thefactoryhka.com.co/api/ClienteFacturacion/Eliminar https://gestioncontribuyentesrest.thefactoryhka.com.co/api/ClienteFacturacion/Eliminar]

<includeonly>=</includeonly>==== CrearCategoriaProductoAsociada====<includeonly>=</includeonly>
*URL Demo:[https://demogestioncontribuyentesrest.thefactoryhka.com.co/api/ClienteFacturacion/CategoriaProductoAsociada/Crear https://demogestioncontribuyentesrest.thefactoryhka.com.co/api/ClienteFacturacion/CategoriaProductoAsociada/Crear]
*URL Produccion:[https://gestioncontribuyentesrest.thefactoryhka.com.co/api/ClienteFacturacion/CategoriaProductoAsociada/Crear https://gestioncontribuyentesrest.thefactoryhka.com.co/api/ClienteFacturacion/CategoriaProductoAsociada/Crear]

<includeonly>=</includeonly>==== ConsultarCategoriaProductoAsociada====<includeonly>=</includeonly>
*URL Demo:[https://demogestioncontribuyentesrest.thefactoryhka.com.co/api/ClienteFacturacion/CategoriaProductoAsociada/Consultar https://demogestioncontribuyentesrest.thefactoryhka.com.co/api/ClienteFacturacion/CategoriaProductoAsociada/Consultar]
*URL Produccion:[https://gestioncontribuyentesrest.thefactoryhka.com.co/api/ClienteFacturacion/CategoriaProductoAsociada/Consultar https://gestioncontribuyentesrest.thefactoryhka.com.co/api/ClienteFacturacion/CategoriaProductoAsociada/Consultar]

<includeonly>=</includeonly>==== EliminarCategoriaProductoAsociada====<includeonly>=</includeonly>
*URL Demo:[https://demogestioncontribuyentesrest.thefactoryhka.com.co/api/ClienteFacturacion/CategoriaProductoAsociada/Eliminar https://demogestioncontribuyentesrest.thefactoryhka.com.co/api/ClienteFacturacion/CategoriaProductoAsociada/Eliminar]
*URL Produccion:[https://gestioncontribuyentesrest.thefactoryhka.com.co/api/ClienteFacturacion/CategoriaProductoAsociada/Eliminar https://gestioncontribuyentesrest.thefactoryhka.com.co/api/ClienteFacturacion/CategoriaProductoAsociada/Eliminar]

<includeonly>=</includeonly>===ContribuyenteFacturacion===<includeonly>=</includeonly>

<includeonly>=</includeonly>====ConsultarNumeracionesF====<includeonly>=</includeonly>
*URL Demo:[https://demogestioncontribuyentesrest.thefactoryhka.com.co//api/ContribuyenteFacturacion/ConsultarNumeraciones https://demogestioncontribuyentesrest.thefactoryhka.com.co//api/ContribuyenteFacturacion/ConsultarNumeraciones]
*URL Produccion:[https://gestioncontribuyentesrest.thefactoryhka.com.co//api/ContribuyenteFacturacion/ConsultarNumeraciones https://gestioncontribuyentesrest.thefactoryhka.com.co//api/ContribuyenteFacturacion/ConsultarNumeraciones]

<includeonly>=</includeonly>==== ConsultarEmpresas ====<includeonly>=</includeonly>
*URL Demo:[https://demogestioncontribuyentesrest.thefactoryhka.com.co/api/ContribuyenteFacturacion/ConsultarEmpresa https://demogestioncontribuyentesrest.thefactoryhka.com.co/api/ContribuyenteFacturacion/ConsultarEmpresa]
*URL Produccion:[https://gestioncontribuyentesrest.thefactoryhka.com.co/api/ContribuyenteFacturacion/ConsultarEmpresa https://gestioncontribuyentesrest.thefactoryhka.com.co/api/ContribuyenteFacturacion/ConsultarEmpresa]

<includeonly>=</includeonly>==== ConsultarCertificado ====<includeonly>=</includeonly>
*URL Demo:[https://demogestioncontribuyentesrest.thefactoryhka.com.co/api/ContribuyenteFacturacion/ConsultarCertificado https://demogestioncontribuyentesrest.thefactoryhka.com.co/api/ContribuyenteFacturacion/ConsultarCertificado]
*URL Produccion:[https://gestioncontribuyentesrest.thefactoryhka.com.co/api/ContribuyenteFacturacion/ConsultarCertificado https://gestioncontribuyentesrest.thefactoryhka.com.co/api/ContribuyenteFacturacion/ConsultarCertificado]

<includeonly>=</includeonly>==== ConsultarFolios ====<includeonly>=</includeonly>
*URL Demo:[https://demogestioncontribuyentesrest.thefactoryhka.com.co/api/ContribuyenteFacturacion/ConsultarFolios https://demogestioncontribuyentesrest.thefactoryhka.com.co/api/ContribuyenteFacturacion/ConsultarFolios]
*URL Produccion:[https://gestioncontribuyentesrest.thefactoryhka.com.co/api/ContribuyenteFacturacion/ConsultarFolios https://gestioncontribuyentesrest.thefactoryhka.com.co/api/ContribuyenteFacturacion/ConsultarFolios]

<includeonly>=</includeonly>===EstablecimientoFacturacion===<includeonly>=</includeonly>

<includeonly>=</includeonly>==== ConsultarEstablecimiento ====<includeonly>=</includeonly>
*URL Demo:[https://demogestioncontribuyentesrest.thefactoryhka.com.co/api/EstablecimientoFacturacion/Consultar https://demogestioncontribuyentesrest.thefactoryhka.com.co/api/EstablecimientoFacturacion/Consultar]
*URL Produccion:[https://gestioncontribuyentesrest.thefactoryhka.com.co/api/EstablecimientoFacturacion/Consultar https://gestioncontribuyentesrest.thefactoryhka.com.co/api/EstablecimientoFacturacion/Consultar]

<includeonly>=</includeonly>===InventarioFacturacion===<includeonly>=</includeonly>

<includeonly>=</includeonly>==== ActualizarInventario====<includeonly>=</includeonly>
*URL Demo:[https://demogestioncontribuyentesrest.thefactoryhka.com.co/api/InventarioFacturacion/Establecimiento/Productos/Actualizar https://demogestioncontribuyentesrest.thefactoryhka.com.co/api/InventarioFacturacion/Establecimiento/Productos/Actualizar]
*URL Produccion:[https://gestioncontribuyentesrest.thefactoryhka.com.co/api/InventarioFacturacion/Establecimiento/Productos/Actualizar https://gestioncontribuyentesrest.thefactoryhka.com.co/api/InventarioFacturacion/Establecimiento/Productos/Actualizar]

<includeonly>=</includeonly>====RestablecerInventario====<includeonly>=</includeonly>
*URL Demo:[https://demogestioncontribuyentesrest.thefactoryhka.com.co/api/InventarioFacturacion/Establecimiento/Productos/Restablecer https://demogestioncontribuyentesrest.thefactoryhka.com.co/api/InventarioFacturacion/Establecimiento/Productos/Restablecer]
*URL Produccion:[https://gestioncontribuyentesrest.thefactoryhka.com.co/api/InventarioFacturacion/Establecimiento/Productos/Restablecer https://gestioncontribuyentesrest.thefactoryhka.com.co/api/InventarioFacturacion/Establecimiento/Productos/Restablecer]

<includeonly>=</includeonly>====ConsultarInventario====<includeonly>=</includeonly>
*URL Demo:[https://demogestioncontribuyentesrest.thefactoryhka.com.co/api/InventarioFacturacion/Establecimiento/Productos/Consultar https://demogestioncontribuyentesrest.thefactoryhka.com.co/api/InventarioFacturacion/Establecimiento/Productos/Consultar]
*URL Produccion:[https://gestioncontribuyentesrest.thefactoryhka.com.co/api/InventarioFacturacion/Establecimiento/Productos/Consultar https://gestioncontribuyentesrest.thefactoryhka.com.co/api/InventarioFacturacion/Establecimiento/Productos/Consultar]

<includeonly>=</includeonly>===NumeracionFacturacion===<includeonly>=</includeonly>

<includeonly>=</includeonly>==== UltimoConsecutivo====<includeonly>=</includeonly>
*URL Demo:[https://demogestioncontribuyentesrest.thefactoryhka.com.co//api/NumeracionFacturacion/UltimoConsecutivo https://demogestioncontribuyentesrest.thefactoryhka.com.co/api/NumeracionFacturacion/UltimoConsecutivo]
*URL Produccion:[https://gestioncontribuyentesrest.thefactoryhka.com.co/api/NumeracionFacturacion/UltimoConsecutivo https://gestioncontribuyentesrest.thefactoryhka.com.co/api/NumeracionFacturacion/UltimoConsecutivo]

<includeonly>=</includeonly>==== ConsultarNumeraciones ====<includeonly>=</includeonly>
*URL Demo:[https://demogestioncontribuyentesrest.thefactoryhka.com.co/api/NumeracionFacturacion/ConsultarNumeraciones https://demogestioncontribuyentesrest.thefactoryhka.com.co/api/NumeracionFacturacion/ConsultarNumeraciones]
*URL Produccion:[https://gestioncontribuyentesrest.thefactoryhka.com.co/api/NumeracionFacturacion/ConsultarNumeraciones https://gestioncontribuyentesrest.thefactoryhka.com.co/api/NumeracionFacturacion/ConsultarNumeraciones]

<includeonly>=</includeonly>==== CrearNumeracion ====<includeonly>=</includeonly>
*URL Demo:[https://demogestioncontribuyentesrest.thefactoryhka.com.co/api/NumeracionFacturacion/Crear https://demogestioncontribuyentesrest.thefactoryhka.com.co/api/NumeracionFacturacion/Crear]
*URL Produccion:[https://gestioncontribuyentesrest.thefactoryhka.com.co/api/NumeracionFacturacion/Crear https://gestioncontribuyentesrest.thefactoryhka.com.co/api/NumeracionFacturacion/Crear]

<includeonly>=</includeonly>==== EliminarNumeracion ====<includeonly>=</includeonly>
*URL Demo:[https://demogestioncontribuyentesrest.thefactoryhka.com.co/api/NumeracionFacturacion/Eliminar https://demogestioncontribuyentesrest.thefactoryhka.com.co/api/NumeracionFacturacion/Eliminar]
*URL Produccion:[https://gestioncontribuyentesrest.thefactoryhka.com.co/api/NumeracionFacturacion/Eliminar https://gestioncontribuyentesrest.thefactoryhka.com.co/api/NumeracionFacturacion/Eliminar]

<includeonly>=</includeonly>===ProductoFacturacion===<includeonly>=</includeonly>

<includeonly>=</includeonly>==== ConsultarProducto ====<includeonly>=</includeonly>
*URL Demo:[https://demogestioncontribuyentesrest.thefactoryhka.com.co/api/ProductoFacturacion/Consultar https://demogestioncontribuyentesrest.thefactoryhka.com.co/api/ProductoFacturacion/Consultar]
*URL Produccion:[https://gestioncontribuyentesrest.thefactoryhka.com.co/api/ProductoFacturacion/Consultar https://gestioncontribuyentesrest.thefactoryhka.com.co/api/ProductoFacturacion/Consultar]

<includeonly>=</includeonly>==== CrearProducto ====<includeonly>=</includeonly>
*URL Demo:[https://demogestioncontribuyentesrest.thefactoryhka.com.co/api/ProductoFacturacion/Crear https://demogestioncontribuyentesrest.thefactoryhka.com.co/api/ProductoFacturacion/Crear]
*URL Produccion:[https://gestioncontribuyentesrest.thefactoryhka.com.co/api/ProductoFacturacion/Crear https://gestioncontribuyentesrest.thefactoryhka.com.co/api/ProductoFacturacion/Crear]

<includeonly>=</includeonly>==== EliminarProducto ====<includeonly>=</includeonly>
*URL Demo:[https://demogestioncontribuyentesrest.thefactoryhka.com.co/api/ProductoFacturacion/Eliminar https://demogestioncontribuyentesrest.thefactoryhka.com.co/api/ProductoFacturacion/Eliminar]
*URL Produccion:[https://gestioncontribuyentesrest.thefactoryhka.com.co/api/ProductoFacturacion/Eliminar https://gestioncontribuyentesrest.thefactoryhka.com.co/api/ProductoFacturacion/Eliminar]

<includeonly>=</includeonly>==== ActualizarProducto ====<includeonly>=</includeonly>
*URL Demo:[https://demogestioncontribuyentesrest.thefactoryhka.com.co/api/ProductoFacturacion/Actualizar https://demogestioncontribuyentesrest.thefactoryhka.com.co/api/ProductoFacturacion/Actualizar]
*URL Produccion:[https://gestioncontribuyentesrest.thefactoryhka.com.co/api/ProductoFacturacion/Actualizar https://gestioncontribuyentesrest.thefactoryhka.com.co/api/ProductoFacturacion/Actualizar]

<includeonly>=</includeonly>==== CrearCategoria====<includeonly>=</includeonly>
*URL Demo:[https://demogestioncontribuyentesrest.thefactoryhka.com.co/api/ProductoFacturacion/Categoria/Crear https://demogestioncontribuyentesrest.thefactoryhka.com.co/api/ProductoFacturacion/Categoria/Crear]
*URL Produccion:[https://gestioncontribuyentesrest.thefactoryhka.com.co/api/ProductoFacturacion/Categoria/Crear https://gestioncontribuyentesrest.thefactoryhka.com.co/api/ProductoFacturacion/Categoria/Crear]

<includeonly>=</includeonly>==== ActualizarCategoria====<includeonly>=</includeonly>
*URL Demo:[https://demogestioncontribuyentesrest.thefactoryhka.com.co/api/ProductoFacturacion/Categoria/Actualizar https://demogestioncontribuyentesrest.thefactoryhka.com.co/api/ProductoFacturacion/Categoria/Actualizar]
*URL Produccion:[https://gestioncontribuyentesrest.thefactoryhka.com.co/api/ProductoFacturacion/Categoria/Actualizar https://gestioncontribuyentesrest.thefactoryhka.com.co/api/ProductoFacturacion/Categoria/Actualizar]

<includeonly>=</includeonly>==== ConsultarCategoria====<includeonly>=</includeonly>
*URL Demo:[https://demogestioncontribuyentesrest.thefactoryhka.com.co/api/ProductoFacturacion/Categoria/Consultar https://demogestioncontribuyentesrest.thefactoryhka.com.co/api/ProductoFacturacion/Categoria/Consultarr]
*URL Produccion:[https://gestioncontribuyentesrest.thefactoryhka.com.co/api/ProductoFacturacion/Categoria/Consultar https://gestioncontribuyentesrest.thefactoryhka.com.co/api/ProductoFacturacion/Categoria/Consultar]

<includeonly>=</includeonly>==== EliminarCategoria====<includeonly>=</includeonly>
*URL Demo:[https://demogestioncontribuyentesrest.thefactoryhka.com.co//api/ProductoFacturacion/Categoria/Eliminar https://demogestioncontribuyentesrest.thefactoryhka.com.co/api/ProductoFacturacion/Categoria/Eliminar]
*URL Produccion:[https://gestioncontribuyentesrest.thefactoryhka.com.co/api/ProductoFacturacion/Categoria/Eliminar https://gestioncontribuyentesrest.thefactoryhka.com.co/api/ProductoFacturacion/Categoria/Eliminar]

<includeonly>=</includeonly>==== CrearCategoriaAsociada====<includeonly>=</includeonly>
*URL Demo:[https://demogestioncontribuyentesrest.thefactoryhka.com.co/api/ProductoFacturacion/CategoriaAsociada/Crear https://demogestioncontribuyentesrest.thefactoryhka.com.co/api/ProductoFacturacion/CategoriaAsociada/Crear]
*URL Produccion:[https://gestioncontribuyentesrest.thefactoryhka.com.co/api/ProductoFacturacion/CategoriaAsociada/Crear https://gestioncontribuyentesrest.thefactoryhka.com.co/api/ProductoFacturacion/CategoriaAsociada/Crear]

<includeonly>=</includeonly>==== ConsultarCategoriaAsociada====<includeonly>=</includeonly>
*URL Demo:[https://demogestioncontribuyentesrest.thefactoryhka.com.co/api/ProductoFacturacion/CategoriaAsociada/Consultar https://demogestioncontribuyentesrest.thefactoryhka.com.co/api/ProductoFacturacion/CategoriaAsociada/Consultar]
*URL Produccion:[https://gestioncontribuyentesrest.thefactoryhka.com.co/api/ProductoFacturacion/CategoriaAsociada/Consultarr https://gestioncontribuyentesrest.thefactoryhka.com.co/api/ProductoFacturacion/CategoriaAsociada/Consultar]

<includeonly>=</includeonly>==== EliminarCategoriaAsociada====<includeonly>=</includeonly>
*URL Demo:[https://demogestioncontribuyentesrest.thefactoryhka.com.co//api/ProductoFacturacion/CategoriaAsociada/Eliminar https://demogestioncontribuyentesrest.thefactoryhka.com.co/api/ProductoFacturacion/CategoriaAsociada/Eliminar]
*URL Produccion:[https://gestioncontribuyentesrest.thefactoryhka.com.co/api/ProductoFacturacion/CategoriaAsociada/Eliminar https://gestioncontribuyentesrest.thefactoryhka.com.co/api/ProductoFacturacion/CategoriaAsociada/Eliminar]

<includeonly>=</includeonly>====TipoPrecio====<includeonly>=</includeonly>
*URL Demo:[https://demogestioncontribuyentesrest.thefactoryhka.com.co/api/ProductoFacturacion/TipoPrecio https://demogestioncontribuyentesrest.thefactoryhka.com.co/api/ProductoFacturacion/TipoPrecio]
*URL Produccion:[https://gestioncontribuyentesrest.thefactoryhka.com.co/api/ProductoFacturacion/TipoPrecio https://gestioncontribuyentesrest.thefactoryhka.com.co/api/ProductoFacturacion/TipoPrecio]

<includeonly>=</includeonly>====Inventario====<includeonly>=</includeonly>
*URL Demo:[https://demogestioncontribuyentesrest.thefactoryhka.com.co/api/ProductoFacturacion/Inventario https://demogestioncontribuyentesrest.thefactoryhka.com.co/api/ProductoFacturacion/Inventario]
*URL Produccion:[https://gestioncontribuyentesrest.thefactoryhka.com.co/api/ProductoFacturacion/Inventario https://gestioncontribuyentesrest.thefactoryhka.com.co/api/ProductoFacturacion/Inventario]

<includeonly>=</includeonly>====TipoPrecioMasivo====<includeonly>=</includeonly>
*URL Demo:[https://demogestioncontribuyentesrest.thefactoryhka.com.co/api/ProductoFacturacion/TipoPrecioMasivo https://demogestioncontribuyentesrest.thefactoryhka.com.co/api/ProductoFacturacion/TipoPrecioMasivo]
*URL Produccion:[https://gestioncontribuyentesrest.thefactoryhka.com.co/api/ProductoFacturacion/TipoPrecioMasivo https://gestioncontribuyentesrest.thefactoryhka.com.co/api/ProductoFacturacion/TipoPrecioMasivo]

<includeonly>=</includeonly>===ReporteFacturacion===<includeonly>=</includeonly>

<includeonly>=</includeonly>==== AgendarReporteProgramado ====<includeonly>=</includeonly>
*URL Demo:[https://demogestioncontribuyentesrest.thefactoryhka.com.co/api/ReporteFacturacion/Programado/Agendar https://demogestioncontribuyentesrest.thefactoryhka.com.co/api/ReporteFacturacion/Programado/Agendar]
*URL Produccion:[https://gestioncontribuyentesrest.thefactoryhka.com.co/api/ReporteFacturacion/Programado/Agendar https://gestioncontribuyentesrest.thefactoryhka.com.co/api/ReporteFacturacion/Programado/Agendar]

<includeonly>=</includeonly>==== ListarReporteProgramado ====<includeonly>=</includeonly>
*URL Demo:[https://demogestioncontribuyentesrest.thefactoryhka.com.co/api/ReporteFacturacion/Programado/Listar https://demogestioncontribuyentesrest.thefactoryhka.com.co/api/ReporteFacturacion/Programado/Listar]
*URL Produccion:[https://gestioncontribuyentesrest.thefactoryhka.com.co/api/ReporteFacturacion/Programado/Listar https://gestioncontribuyentesrest.thefactoryhka.com.co/api/ReporteFacturacion/Programado/Listar]

<includeonly>=</includeonly>==== DescargarReporteProgramado ====<includeonly>=</includeonly>
*URL Demo:[https://demogestioncontribuyentesrest.thefactoryhka.com.co/api/ReporteFacturacion/Programado/Descargar https://demogestioncontribuyentesrest.thefactoryhka.com.co/api/ReporteFacturacion/Programado/Descargar]
*URL Produccion:[https://gestioncontribuyentesrest.thefactoryhka.com.co/api/ReporteFacturacion/Programado/Descargar https://gestioncontribuyentesrest.thefactoryhka.com.co/api/ReporteFacturacion/Programado/Descargar]

<includeonly>=</includeonly>==== DescargarReporteProgramado ====<includeonly>=</includeonly>
*URL Demo:[https://demogestioncontribuyentesrest.thefactoryhka.com.co/api/ReporteFacturacion/Programado/EnviarCorreo https://demogestioncontribuyentesrest.thefactoryhka.com.co/api/ReporteFacturacion/Programado/EnviarCorreo]
*URL Produccion:[https://gestioncontribuyentesrest.thefactoryhka.com.co/api/ReporteFacturacion/Programado/EnviarCorreo https://gestioncontribuyentesrest.thefactoryhka.com.co/api/ReporteFacturacion/Programado/EnviarCorreo]

<includeonly>=</includeonly>==== ConsultarDocumento ====<includeonly>=</includeonly>
*URL Demo:[https://demogestioncontribuyentesrest.thefactoryhka.com.co/api/ReporteFacturacion/ConsultarDocumento https://demogestioncontribuyentesrest.thefactoryhka.com.co/api/ReporteFacturacion/ConsultarDocumento]
*URL Produccion:[https://gestioncontribuyentesrest.thefactoryhka.com.co/api/ReporteFacturacion/ConsultarDocumento https://gestioncontribuyentesrest.thefactoryhka.com.co/api/ReporteFacturacion/ConsultarDocumento]

 
 

 
 
 

<center>'''<big>[[Archivo:Copyright.png|100px|sinmarco|centro|Copyright]]THE FACTORY HKA COLOMBIA</big>
 Copyright © 2016 The Factory HKA. Todos los derechos reservados.</center>

 

{{clear}}

Servicio Gestión Contribuyentes

2025-09-26T14:53:30Z

Dmrodriguez2:

<includeonly>=</includeonly>== APIs Gestión Contribuyentes==<includeonly>=</includeonly>
<center>[[Archivo:ServicioGestionContribuyentes.png|10000px|sinmarco|centro|ServicioGestionContribuyentes]]</center>

En The Factory HKA Colombia, nos dedicamos a impulsar la eficiencia y simplificar la gestión fiscal y administrativa para nuestros clientes y aliados estratégicos. Hemos desarrollado el Servicio de Gestión de Contribuyentes, una robusta colección de APIs REST diseñada específicamente para que las casas de software, desarrolladores e integradores puedan conectar sus sistemas y ERPs de manera ágil y segura e integrar funcionalidades clave de nuestra innovadora HKA Tili.

Este servicio proporciona un conjunto de herramientas que permiten gestionar integralmente los datos y procesos clave relacionados con los contribuyentes. Desde la administración de catálogos y el registro detallado de clientes y productos, hasta la configuración de establecimientos comerciales, la gestión de numeraciones fiscales y la realizacion de reportes programados de una forma agíl y sencilla; nuestras APIs ofrecen una base sólida para automatizar y optimizar la interacción con la infraestructura de The Factory HKA Colombia.

A continuación, exploramos en detalle la variedad de APIs REST que componen este servicio. Cada API está cuidadosamente diseñada para brindar utilidades esenciales, permitiendo un control preciso, una automatización completa y una integración fluida de los procesos de gestión de contribuyentes y facturación electrónica, garantizando la conformidad con la normativa vigente y liberando recursos valiosos para el crecimiento de tu negocio.

<includeonly>=</includeonly>== Modelo Funcional APIs Gestión Contribuyentes==<includeonly>=</includeonly>
<center>[[Archivo:FlujoDeProcesoApisGestionContribuyente.png|700px|sinmarco|centro|Flujo de Proceso Servicio Gestion Contribuyentes]]</center>

<includeonly>=</includeonly>== CatalogoAsociado==<includeonly>=</includeonly>
La suite de APIs '''CatalogoAsociado''' está diseñada para ofrecer a los integradores un control completo sobre la gestión de catálogos asociados a los contribuyentes existentes en nuestro sistema. Este conjunto de operaciones es fundamental para mantener la información de referencia actualizada y relevante para cada contribuyente, permitiendo una personalización y eficiencia óptima en sus procesos de facturación y gestión.

#[[API ConsultarCatalogoAsociado]]
#[[API AsociarCatalogoAsociado]]
#[[API EliminarCatalogoAsociado]]

<includeonly>=</includeonly>== CatalogoFacturacion==<includeonly>=</includeonly>
La suite de APIs '''CatalogoFacturacion''' constituye un pilar fundamental dentro del Servicio de Gestión de Contribuyentes. Su propósito principal es exponer y permitir la consulta de todos los catálogos de referencia predefinidos y existentes en nuestro sistema, que son esenciales para la correcta operación e integración con las diversas funcionalidades de facturación y gestión.

#[[API ConsultarCatalogo]]

<includeonly>=</includeonly>== ClienteFacturacion==<includeonly>=</includeonly>
#[[API ConsultarCliente]]
#[[API CearCliente]]
#[[API ActualizarCliente]]
#[[API EliminarCliente]]
#[[API CrearCategoriaProductoAsociada]]
#[[API ConsultarCategoriaProductoAsociada]]
#[[API EliminarCategoriaProductoAsociada]]

<includeonly>=</includeonly>== ContribuyenteFacturacion==<includeonly>=</includeonly>
#[[API ConsultarNumeraciones]]
#[[API ConsultarEmpresa]]
#[[API ConsultarCertificado]]
#[[API ConsultarFolios]]

<includeonly>=</includeonly>== EstablecimientoFacturacion==<includeonly>=</includeonly>
#[[API ConsultarEstablecimiento]]

<includeonly>=</includeonly>== InventarioFacturacion==<includeonly>=</includeonly>
#[[API ActualizarInventario]]
#[[API RestablecerInventario]]
#[[API ConsultarInventario]]

<includeonly>=</includeonly>== NumeracionFacturacion==<includeonly>=</includeonly>
#[[API UltimoConsecutivo]]
#[[API ConsultarNumeraciones]]
#[[API CrearNumeracion]]
#[[API EliminarNumeracion]]

<includeonly>=</includeonly>== ProductoFacturacion==<includeonly>=</includeonly>
#[[API ConsultarProducto]]
#[[API CrearProducto]]
#[[API EliminarProducto]]
#[[API ActualizarProducto]]
#[[API CrearCategoria]]
#[[API ActualizarCategoria]]
#[[API ConsultarCategoria]]
#[[API EliminarCategoria]]
#[[API CrearCategoriaAsociada]]
#[[API ConsultarCategoriaAsociada]]
#[[API EliminarCategoriaAsociada]]
#[[API TipoPrecio]]
#[[API Inventario]]
#[[API TipoPrecioMasivo]]

<includeonly>=</includeonly>== ReporteFacturacion==<includeonly>=</includeonly>
#[[API AgendarReporte]]
#[[API ListarReporte]]
#[[API DescargarReporte]]
#[[API EnviarCorreo]]
#[[API ConsultarDocumento]]

 

<center>'''<big>[[Archivo:Copyright.png|100px|sinmarco|centro|Copyright]]THE FACTORY HKA COLOMBIA</big>
 Copyright © 2016 The Factory HKA. Todos los derechos reservados.</center>

 
{{clear}}

Servicio Gestión Contribuyentes

2025-09-18T16:04:23Z

Dmrodriguez2:

<includeonly>=</includeonly>== APIs Gestión Contribuyentes==<includeonly>=</includeonly>
<center>[[Archivo:ServicioGestionContribuyentes.png|10000px|sinmarco|centro|ServicioGestionContribuyentes]]</center>

En The Factory HKA Colombia, nos dedicamos a impulsar la eficiencia y simplificar la gestión fiscal y administrativa para nuestros clientes y aliados estratégicos. Hemos desarrollado el Servicio de Gestión de Contribuyentes, una robusta colección de APIs REST diseñada específicamente para que las casas de software, desarrolladores e integradores puedan conectar sus sistemas y ERPs de manera ágil y segura e integrar funcionalidades clave de nuestra innovadora HKA Tili.

Este servicio proporciona un conjunto de herramientas que permiten gestionar integralmente los datos y procesos clave relacionados con los contribuyentes. Desde la administración de catálogos y el registro detallado de clientes y productos, hasta la configuración de establecimientos comerciales, la gestión de numeraciones fiscales y la realizacion de reportes programados de una forma agíl y sencilla; nuestras APIs ofrecen una base sólida para automatizar y optimizar la interacción con la infraestructura de The Factory HKA Colombia.

A continuación, exploramos en detalle la variedad de APIs REST que componen este servicio. Cada API está cuidadosamente diseñada para brindar utilidades esenciales, permitiendo un control preciso, una automatización completa y una integración fluida de los procesos de gestión de contribuyentes y facturación electrónica, garantizando la conformidad con la normativa vigente y liberando recursos valiosos para el crecimiento de tu negocio.

<includeonly>=</includeonly>== Modelo Funcional APIs Gestión Contribuyentes==<includeonly>=</includeonly>
<center>[[Archivo:FlujoDeProcesoApisGestionContribuyente.png|700px|sinmarco|centro|Flujo de Proceso Servicio Gestion Contribuyentes]]</center>

<includeonly>=</includeonly>== CatalogoAsociado==<includeonly>=</includeonly>
La suite de APIs '''CatalogoAsociado''' está diseñada para ofrecer a los integradores un control completo sobre la gestión de catálogos asociados a los contribuyentes existentes en nuestro sistema. Este conjunto de operaciones es fundamental para mantener la información de referencia actualizada y relevante para cada contribuyente, permitiendo una personalización y eficiencia óptima en sus procesos de facturación y gestión.

#[[API ConsultarCatalogoAsociado]]
#[[API AsociarCatalogoAsociado]]
#[[API EliminarCatalogoAsociado]]

<includeonly>=</includeonly>== CatalogoFacturacion==<includeonly>=</includeonly>
La suite de APIs '''CatalogoFacturacion''' constituye un pilar fundamental dentro del Servicio de Gestión de Contribuyentes. Su propósito principal es exponer y permitir la consulta de todos los catálogos de referencia predefinidos y existentes en nuestro sistema, que son esenciales para la correcta operación e integración con las diversas funcionalidades de facturación y gestión.

#[[API ConsultarCatalogo]]

<includeonly>=</includeonly>== ClienteFacturacion==<includeonly>=</includeonly>
#[[API ConsultarCliente]]
#[[API CearCliente]]
#[[API ActualizarCliente]]
#[[API EliminarCliente]]
#[[API CrearCategoriaProductoAsociada]]
#[[API ConsultarCategoriaProductoAsociada]]
#[[API EliminarCategoriaProductoAsociada]]

<includeonly>=</includeonly>== ContribuyenteFacturacion==<includeonly>=</includeonly>
#[[API ConsultarNumeraciones]]
#[[API ConsultarEmpresa]]
#[[API ConsultarCertificado]]
#[[API ConsultarFolios]]

<includeonly>=</includeonly>== EstablecimientoFacturacion==<includeonly>=</includeonly>
#[[API ConsultarEstablecimiento]]

<includeonly>=</includeonly>== InventarioFacturacion==<includeonly>=</includeonly>
#[[API ActualizarInventario]]
#[[API RestablecerInventario]]
#[[API ConsultarInventario]]

<includeonly>=</includeonly>== NumeracionFacturacion==<includeonly>=</includeonly>
#[[API UltimoConsecutivo]]
#[[API ConsultarNumeraciones]]
#[[API CrearNumeracion]]
#[[API EliminarNumeracion]]

<includeonly>=</includeonly>== ProductoFacturacion==<includeonly>=</includeonly>
#[[API ConsultarProducto]]
#[[API CrearProducto]]
#[[API EliminarProducto]]
#[[API ActualizarProducto]]
#[[API CrearCategoria]]
#[[API ActualizarCategoria]]
#[[API ConsultarCategoria]]
#[[API EliminarCategoria]]
#[[API CrearCategoriaAsociada]]
#[[API ConsultarCategoriaAsociada]]
#[[API EliminarCategoriaAsociada]]
#[[API TipoPrecio]]
#[[API Inventario]]
#[[API TipoPrecioMasivo]]

<includeonly>=</includeonly>== ReporteFacturacion==<includeonly>=</includeonly>
#[[API AgendarReporte]]
#[[API ListarReporte]]
#[[API DescargarReporte]]
#[[API EnviarCorreo]]

 

<center>'''<big>[[Archivo:Copyright.png|100px|sinmarco|centro|Copyright]]THE FACTORY HKA COLOMBIA</big>
 Copyright © 2016 The Factory HKA. Todos los derechos reservados.</center>

 
{{clear}}

Archivo:FlujoDeProcesoApisGestionContribuyente.png

2025-09-18T16:03:27Z

Dmrodriguez2: Archivo subido con MsUpload

Archivo subido con MsUpload

API ConsultarInventario

2025-09-09T21:17:58Z

Dmrodriguez2:

La API '''ConsultarInventario''' es un desarrollo elaborado por el equipo de The Factory HKA el cual brinda la posibilidad al contribuyente de consultar el inventario de productos definido en un establecimiento registrado en el portal de HKA Factura en ambiente demo y en ambiente de producción o a realizar el consumo del servicio a través de la Api ConsultarInventario.
 
 
'''@IMPORTANTE:''' La Api ConsultarInventario esta construida en método POST. Para el consumo de este servicio se han establecido dos url especificas en ambiente DEMO y ambiente PRODUCCION las cuales las podrá encontrar a continuación:
 
 
'''Para mayor información pude consultas las URL en la siguiente sección:'''
'''[[Tips_Urls_de_Emisión #ConsultarInventario|ConsultarInventario]]'''

A continuación se documenta la estructura que se debe contemplar en la construcción del Request y el Response del servicio '''ActualizarInventario''' y de esta forma garantizar la implementación de este nuevo método:

; REQUEST: Parámetros a Enviar
{| class="mw-collapsible wikitable"
! style="background:#f2f2f2; text-align:center;"|Tipo
! style="background:#f2f2f2; text-align:center;"|Identificador
! style="background:#f2f2f2; text-align:center;"|Descripción
|- valign="center"
|-
|String
|Nit
|Número de documento del contribuyente emisor.
|-
|rowspan="2"|String
|TokenEmpresa
|rowspan="2"|Suministrado por The Factory HKA Colombia según el ambiente a consultar
|-
|TokenClave
|-
|String
|ClaveSecreta
|Definida por el contribuyente emisor a través del portal HKA Factura Electrónica en ambiente demo y en ambiente de producción
|-
|String
|IdEstablecimiento
|Identificador del Estableciemiento configurado en el portal de HKA Factura consulte Api '''ConsultarEstablecimiento'''
|-
|String
|FormatoRequerido
|(Opcional) JSON = 1, CSV = 2.
|}
 
 

{{clear}}

API ConsultarCatalogo

2025-09-09T16:02:06Z

Dmrodriguez2:

La API '''ConsultarCatalogo''' actúa como un diccionario centralizado y dinámico, permitiendo a los desarrolladores comprender y obtener los parámetros requeridos por el sistema para asegurar una integración coherente y robusta a través de todas las APIs del servicio de Gestión de Contribuyentes.

Al consumir esta API, los sistemas externos pueden poblar dinámicamente sus interfaces y validar los datos antes de enviarlos en las solicitudes a otras APIs, minimizando errores y garantizando la integridad de la información.Esta funcionalidad está implementada y disponible tanto en los ambientes de demo como de producción de The Factory HKA Colombia.

 
 
'''@IMPORTANTE:''' La API ConsultarCatalogo está construida en método POST. Para el consumo de este servicio se han establecido dos url especificas en ambiente DEMO y ambiente PRODUCCION las cuales las podrá encontrar a continuación:
 

'''Para mayor información pude consultas las URL en la siguiente sección:'''
'''[[Tips_Urls_de_Emisión #ConsultarCatalogo|ConsultarCatalogo]]'''

A continuación se documenta la estructura que se debe contemplar en la construcción del Request y el Response del servicio '''ConsultarCatalogo''' y de esta forma garantizar la implementación de este nuevo método:

; REQUEST: Parámetros a Enviar
{| class="mw-collapsible wikitable"
! style="background:#f2f2f2; text-align:center;"|Tipo
! style="background:#f2f2f2; text-align:center;"|Identificador
! style="background:#f2f2f2; text-align:center;"|Descripción
|- valign="center"
|-
|String
|Nit
|Número de documento del contribuyente a consultar
|-
|rowspan="2"|String
|TokenEmpresa
|rowspan="2"|Suministrado por The Factory HKA Colombia según el ambiente a consultar
|-
|TokenClave
|-
|String
|Identificador
|(Opcional) Nombre exacto del catálogo específico que se desea consultar. Ejemplo: "UnidadesMedida", "Paises", "TiposDocumento". Si se omite, la API podría devolver una lista general de catálogos disponibles (comportamiento a confirmar por la implementación).
|}
 

; RESPONSE: Parámetros a Recibir al consultar el Método ConsultarCatalogo
{| class="mw-collapsible wikitable"
! style="background:#f2f2f2; text-align:center;"|Tipo
! style="background:#f2f2f2; text-align:center;"|Identificador
! style="background:#f2f2f2; text-align:center;"|Descripción
|- valign="center"
|-
|int
|Código
|Indica el estado de la operación retornado por el servicio
|-
|String
|Resultado
|Resultado del consumo del método:
: “Exitoso” ó “Error”
|-
|String
|Mensaje
|Este mensaje está asociado al codigo, útil para identificación de errores
|-
|Array <Catalogos>
|Catalogos
|Histórico de las Catalogos con figuradas en los portales de HKA Factura existentes
|-
|String
|Array <Errores>
|Lista de errores en caso de error al consumo del servicio
|}
{{clear}}

Donde CatalogosAsociados contiene la siguiente información:

; RESPONSE: Parámetros a Recibir Array Catalogos
{| class="mw-collapsible wikitable"
! style="background:#f2f2f2; text-align:center;"|Tipo
! style="background:#f2f2f2; text-align:center;"|Identificador
! style="background:#f2f2f2; text-align:center;"|Descripción
|- valign="center"
|-
|Array <Catalogos>
|Catalogos
|Nombre del Catalogo existente
|-
|String
|Id
|Corresponde al Identificador para la variable del catalogo
|-
|String
|Codigo
|Codigo correspondiente de la descripcion e la variable.
|-
|String
|Nombre
|Nombre de la variable perteneciente al catalogo
|-
|String
|Descripcion
|Descripcion de la variable del catalogo
|}
{{clear}}

Servicio Gestión Contribuyentes

2025-09-09T15:57:23Z

Dmrodriguez2:

<includeonly>=</includeonly>== APIs Gestión Contribuyentes==<includeonly>=</includeonly>
<center>[[Archivo:ServicioGestionContribuyentes.png|10000px|sinmarco|centro|ServicioGestionContribuyentes]]</center>

En The Factory HKA Colombia, nos dedicamos a impulsar la eficiencia y simplificar la gestión fiscal y administrativa para nuestros clientes y aliados estratégicos. Hemos desarrollado el Servicio de Gestión de Contribuyentes, una robusta colección de APIs REST diseñada específicamente para que las casas de software, desarrolladores e integradores puedan conectar sus sistemas y ERPs de manera ágil y segura e integrar funcionalidades clave de nuestra innovadora HKA Tili.

Este servicio proporciona un conjunto de herramientas que permiten gestionar integralmente los datos y procesos clave relacionados con los contribuyentes. Desde la administración de catálogos y el registro detallado de clientes y productos, hasta la configuración de establecimientos comerciales, la gestión de numeraciones fiscales y la realizacion de reportes programados de una forma agíl y sencilla; nuestras APIs ofrecen una base sólida para automatizar y optimizar la interacción con la infraestructura de The Factory HKA Colombia.

A continuación, exploramos en detalle la variedad de APIs REST que componen este servicio. Cada API está cuidadosamente diseñada para brindar utilidades esenciales, permitiendo un control preciso, una automatización completa y una integración fluida de los procesos de gestión de contribuyentes y facturación electrónica, garantizando la conformidad con la normativa vigente y liberando recursos valiosos para el crecimiento de tu negocio.

<includeonly>=</includeonly>== Modelo Funcional APIs Gestión Contribuyentes==<includeonly>=</includeonly>
<center>[[Archivo:FlujoGestionContribuyente.png|700px|sinmarco|centro|Servicio Gestion Contribuyentes]]</center>

<includeonly>=</includeonly>== CatalogoAsociado==<includeonly>=</includeonly>
La suite de APIs '''CatalogoAsociado''' está diseñada para ofrecer a los integradores un control completo sobre la gestión de catálogos asociados a los contribuyentes existentes en nuestro sistema. Este conjunto de operaciones es fundamental para mantener la información de referencia actualizada y relevante para cada contribuyente, permitiendo una personalización y eficiencia óptima en sus procesos de facturación y gestión.

#[[API ConsultarCatalogoAsociado]]
#[[API AsociarCatalogoAsociado]]
#[[API EliminarCatalogoAsociado]]

<includeonly>=</includeonly>== CatalogoFacturacion==<includeonly>=</includeonly>
La suite de APIs '''CatalogoFacturacion''' constituye un pilar fundamental dentro del Servicio de Gestión de Contribuyentes. Su propósito principal es exponer y permitir la consulta de todos los catálogos de referencia predefinidos y existentes en nuestro sistema, que son esenciales para la correcta operación e integración con las diversas funcionalidades de facturación y gestión.

#[[API ConsultarCatalogo]]

<includeonly>=</includeonly>== ClienteFacturacion==<includeonly>=</includeonly>
#[[API ConsultarCliente]]
#[[API CearCliente]]
#[[API ActualizarCliente]]
#[[API EliminarCliente]]
#[[API CrearCategoriaProductoAsociada]]
#[[API ConsultarCategoriaProductoAsociada]]
#[[API EliminarCategoriaProductoAsociada]]

<includeonly>=</includeonly>== ContribuyenteFacturacion==<includeonly>=</includeonly>
#[[API ConsultarNumeraciones]]
#[[API ConsultarEmpresa]]
#[[API ConsultarCertificado]]
#[[API ConsultarFolios]]

<includeonly>=</includeonly>== EstablecimientoFacturacion==<includeonly>=</includeonly>
#[[API ConsultarEstablecimiento]]

<includeonly>=</includeonly>== InventarioFacturacion==<includeonly>=</includeonly>
#[[API ActualizarInventario]]
#[[API RestablecerInventario]]
#[[API ConsultarInventario]]

<includeonly>=</includeonly>== NumeracionFacturacion==<includeonly>=</includeonly>
#[[API UltimoConsecutivo]]
#[[API ConsultarNumeraciones]]
#[[API CrearNumeracion]]
#[[API EliminarNumeracion]]

<includeonly>=</includeonly>== ProductoFacturacion==<includeonly>=</includeonly>
#[[API ConsultarProducto]]
#[[API CrearProducto]]
#[[API EliminarProducto]]
#[[API ActualizarProducto]]
#[[API CrearCategoria]]
#[[API ActualizarCategoria]]
#[[API ConsultarCategoria]]
#[[API EliminarCategoria]]
#[[API CrearCategoriaAsociada]]
#[[API ConsultarCategoriaAsociada]]
#[[API EliminarCategoriaAsociada]]
#[[API TipoPrecio]]
#[[API Inventario]]
#[[API TipoPrecioMasivo]]

<includeonly>=</includeonly>== ReporteFacturacion==<includeonly>=</includeonly>
#[[API AgendarReporte]]
#[[API ListarReporte]]
#[[API DescargarReporte]]
#[[API EnviarCorreo]]

 

<center>'''<big>[[Archivo:Copyright.png|100px|sinmarco|centro|Copyright]]THE FACTORY HKA COLOMBIA</big>
 Copyright © 2016 The Factory HKA. Todos los derechos reservados.</center>

 
{{clear}}

API ConsultarCatalogo

2025-09-09T15:26:15Z

Dmrodriguez2:

La API '''ConsultarCatalogo''' actúa como un diccionario centralizado y dinámico, permitiendo a los desarrolladores comprender y obtener los parámetros requeridos por el sistema para asegurar una integración coherente y robusta a través de todas las APIs del servicio de Gestión de Contribuyentes.

Al consumir esta API, los sistemas externos pueden poblar dinámicamente sus interfaces y validar los datos antes de enviarlos en las solicitudes a otras APIs, minimizando errores y garantizando la integridad de la información.Esta funcionalidad está implementada y disponible tanto en los ambientes de demo como de producción de The Factory HKA Colombia.

 
 
'''@IMPORTANTE:''' La API ConsultarCatalogo está construida en método POST. Para el consumo de este servicio se han establecido dos url especificas en ambiente DEMO y ambiente PRODUCCION las cuales las podrá encontrar a continuación:
 

'''Para mayor información pude consultas las URL en la siguiente sección:'''
'''[[Tips_Urls_de_Emisión #ConsultarCatalogo|ConsultarCatalogo]]'''

A continuación se documenta la estructura que se debe contemplar en la construcción del Request y el Response del servicio '''ConsultarCatalogo''' y de esta forma garantizar la implementación de este nuevo método:

; REQUEST: Parámetros a Enviar
{| class="mw-collapsible wikitable"
! style="background:#f2f2f2; text-align:center;"|Tipo
! style="background:#f2f2f2; text-align:center;"|Identificador
! style="background:#f2f2f2; text-align:center;"|Descripción
|- valign="center"
|-
|String
|Nit
|Número de documento del contribuyente a consultar
|-
|rowspan="2"|String
|TokenEmpresa
|rowspan="2"|Suministrado por The Factory HKA Colombia según el ambiente a consultar
|-
|TokenClave
|-
|String
|Identificador
|Opcional) Nombre exacto del catálogo específico que se desea consultar. Ejemplo: "UnidadesMedida", "Paises", "TiposDocumento". Si se omite, la API podría devolver una lista general de catálogos disponibles (comportamiento a confirmar por la implementación).
|}
 

; RESPONSE: Parámetros a Recibir al consultar el Método ConsultarCatalogo
{| class="mw-collapsible wikitable"
! style="background:#f2f2f2; text-align:center;"|Tipo
! style="background:#f2f2f2; text-align:center;"|Identificador
! style="background:#f2f2f2; text-align:center;"|Descripción
|- valign="center"
|-
|int
|Código
|Indica el estado de la operación retornado por el servicio
|-
|String
|Resultado
|Resultado del consumo del método:
: “Exitoso” ó “Error”
|-
|String
|Mensaje
|Este mensaje está asociado al codigo, útil para identificación de errores
|-
|Array <Catalogos>
|Catalogos
|Histórico de las Catalogos con figuradas en los portales de HKA Factura existentes
|-
|String
|Array <Errores>
|Lista de errores en caso de error al consumo del servicio
|}
{{clear}}

Donde CatalogosAsociados contiene la siguiente información:

; RESPONSE: Parámetros a Recibir Array Catalogos
{| class="mw-collapsible wikitable"
! style="background:#f2f2f2; text-align:center;"|Tipo
! style="background:#f2f2f2; text-align:center;"|Identificador
! style="background:#f2f2f2; text-align:center;"|Descripción
|- valign="center"
|-
|Array <Catalogos>
|Catalogos
|Nombre del Catalogo existente
|-
|String
|Id
|Corresponde al Identificador para la variable del catalogo
|-
|String
|Codigo
|Codigo correspondiente de la descripcion e la variable.
|-
|String
|Nombre
|Nombre de la variable perteneciente al catalogo
|-
|String
|Descripcion
|Descripcion de la variable del catalogo
|}
{{clear}}