Saltar al contenido principal

Referencia de respuestas

Esta página reúne las estructuras y los códigos que comparten varios métodos de la API. Cada método enlaza aquí en lugar de repetir las mismas tablas.

Respuesta (ResponseType)​

Los métodos de trazabilidad (GetTransaccion y sus variantes) devuelven una respuesta de tipo ResponseType, que contiene información sobre el resultado de la operación, la identificación del documento, su procesamiento y la trazabilidad de las acciones ejecutadas en Colfact.

CampoDescripción
CodQRTexto con la información asociada al código QR del documento.
Base64QRImagen del código QR codificada en Base64, cuando está disponible.
CodRespCódigo que identifica el resultado de la operación. Ver Códigos de respuesta.
CodigoTransaccionCódigo único de identificación del documento electrónico. Corresponde al CUFE o CUDE, según el tipo de documento y cuando esté disponible.
NumeroTransaccionNúmero del documento enviado, de acuerdo con la resolución o configuración aplicable.
DetalleRespuestaObservaciones relacionadas con el resultado de la operación y el procesamiento del documento.
DetallesInformación detallada de la respuesta recibida de la DIAN, cuando está disponible.
IdTransaccionIdentificador interno de la transacción en Colfact.
PDFBase64Representación gráfica del documento en formato PDF, codificada en Base64, cuando está disponible.
ProcesoLista de eventos asociados a la trazabilidad del documento. Ver ProcesoType.
SuscripcionesInformación de las suscripciones asociadas al emisor. Ver SuscripcionType.
EmailEstadoInformación sobre los envíos de correo electrónico asociados al documento. Ver EmailEstadoType.
TipoTransaccionCódigo que identifica el tipo de transacción o el contexto de la respuesta. Ver Tipos de transacción.
XMLXML del documento electrónico generado y enviado a la DIAN, cuando está disponible.
FechaValidacionFecha y hora de recepción de la respuesta de validación de la DIAN por parte de Colfact.

Códigos de respuesta (CodResp)​

El campo CodResp identifica el resultado de la operación reportado por el servicio.

CódigoDescripción
OKEl documento fue recibido satisfactoriamente por el servicio.
ERRSe presentó un inconveniente relacionado con la estructura, los datos o el procesamiento del documento.
PROCEEl documento aún no cuenta con una respuesta de la DIAN.

Tipos de transacción (TipoTransaccion)​

CódigoDescripción
RECIBSolicitud o documento recibido.
FACFactura electrónica.
NCRNota crédito electrónica.
NDBNota débito electrónica.
ERRORSe presentó un error durante la operación o la consulta de la trazabilidad.
Consideraciones sobre la respuesta
  • La disponibilidad de los campos depende del método invocado, del estado del documento y de la etapa en la que se encuentre el procesamiento.
  • CodResp y TipoTransaccion representan información diferente: el primero identifica el resultado de la operación y el segundo el tipo de transacción o contexto de la respuesta.
  • PDFBase64, Base64QR, XML y otros campos pueden no estar disponibles en todas las consultas.
  • En caso de rechazo de la DIAN, el campo PDFBase64 puede estar vacío.

Trazabilidad del documento (ProcesoType)​

El campo Proceso contiene los eventos registrados durante el procesamiento del documento. Cada elemento permite identificar la etapa ejecutada, el mensaje asociado y la fecha y hora de la acción.

CampoDescripciónObservaciones
OrderOrden en que se registró o ejecutó el evento.Permite identificar la secuencia de los eventos.
ProcesoCódigo de la etapa del procesamiento.Ver Códigos de proceso.
MensajeMensaje descriptivo asociado al evento.Contiene la información registrada para la acción correspondiente.
FechaHoraAccionFecha y hora asociadas al evento.Permite consultar cuándo ocurrió cada evento.

Códigos de proceso​

CódigoDescripción
RECIBRecepción inicial del documento.
FIRMAFirma del XML.
ENAUTEnvío del documento a la autoridad correspondiente.
VEAUTVerificación ante la autoridad.
DOCUMGeneración de documentos asociados al procesamiento.

Estado de los correos electrónicos (EmailEstadoType)​

El campo EmailEstado contiene información relacionada con los envíos de correo electrónico asociados al documento. Permite consultar datos de identificación del mensaje, destinatarios y eventos reportados por el proveedor de correo.

CampoDescripción
MessageIdIdentificador único del mensaje asignado por el proveedor de correo electrónico.
idTransaccionIdentificador de la transacción asociada al documento en Colfact.
RecipientDirección de correo electrónico del destinatario.
ActionAcción o estado asociado al envío del correo electrónico, según los valores definidos por el proveedor.
SmtpStatusEstado de la operación de envío según la información SMTP reportada.
BounceCategoryCategoría asociada al rechazo o devolución del correo electrónico, cuando se presenta.
ProviderProveedor o servicio de correo electrónico utilizado.
DkimInformación relacionada con la validación de DKIM (DomainKeys Identified Mail), cuando está disponible.
SendIpDirección IP de origen reportada por el proveedor.
ReceivedAtFecha y hora de recepción del evento por parte del proveedor.
IngestedAtFecha y hora en que el evento fue incorporado al sistema de seguimiento.
Consideraciones
  • La información disponible depende de los eventos reportados por el proveedor de correo electrónico.
  • Un estado de envío exitoso no necesariamente significa que el destinatario haya leído el mensaje.
  • Los valores de Action, SmtpStatus, BounceCategory y Dkim deben interpretarse de acuerdo con el contrato y la documentación del proveedor utilizado.

Suscripciones (SuscripcionType)​

Contiene información sobre las suscripciones asociadas al emisor, incluyendo su vigencia, consumo, disponibilidad y estado actual.

CampoDescripción
IssuerIdIdentificador del emisor asociado a la suscripción.
TotalQuantityCantidad total de documentos permitidos por la suscripción.
ConsumedQuantityCantidad de documentos consumidos o contabilizados.
RemainingQuantityCantidad de documentos disponibles para consumo.
StartDateFecha de inicio de vigencia de la suscripción.
EndDateFecha de finalización de la vigencia de la suscripción.
StatusEstado actual de la suscripción, según los valores definidos por el servicio.
DocumentPackageInformación del paquete de documentos asociado a la suscripción. Ver DocumentPackageType.

Paquetes de documentos (DocumentPackageType)​

Contiene información del paquete de documentos asociado al sistema integrado y al socio de negocio, incluyendo las cantidades permitidas, consumidas y disponibles.

CampoDescripción
IntegratedSystemIdIdentificador del sistema integrado asociado al paquete.
BusinessPartnerIdIdentificador del socio de negocio relacionado con el paquete.
TotalQuantityCantidad total de documentos permitidos en el paquete.
ConsumedQuantityCantidad de documentos consumidos del paquete.
RemainingQuantityCantidad de documentos disponibles en el paquete.
StartDateFecha de inicio de vigencia del paquete.
EndDateFecha de finalización de la vigencia del paquete.
StatusEstado actual del paquete, según los valores definidos por el servicio.
DocumentPackageLimitLímites de consumo del paquete. Ver DocumentPackageLimitType.
SubscriptionSuscripción relacionada con el paquete (solo en ViewDocumentPackage). Ver SuscripcionType.

Límites del paquete (DocumentPackageLimitType)​

Contiene información sobre los límites de consumo establecidos para el paquete de documentos, por tipo de servicio.

CampoDescripción
TotalQuantityCantidad total permitida para el límite configurado.
ConsumedQuantityCantidad consumida del límite.
RemainingQuantityCantidad disponible para consumo dentro del límite.
ServiceTypeCodeCódigo del tipo de servicio al que corresponde el límite. Ver Códigos de tipo de servicio.
StartDateFecha de inicio de vigencia del límite.
EndDateFecha de finalización de la vigencia del límite.
StatusEstado actual del límite, según las reglas definidas por el servicio.

Códigos de tipo de servicio (ServiceTypeCode)​

CódigoDescripción
FEFacturación electrónica.
DSDocumento soporte.
NENómina electrónica.
RCRecepción.
JLBoleta de juegos localizados y no localizados.
BCBoleta de cobro de peajes.
BEBoleta de ingreso de espectáculos públicos.
TDBoleta de transporte terrestre de pasajeros.
BIBoleta de ingreso a cine.
SPBoleta de servicios públicos.
PSBoleta de facturación POS.
CDConsulta de documentos.
Consideraciones sobre suscripciones y paquetes
  • TotalQuantity representa el cupo total configurado.
  • ConsumedQuantity indica el consumo registrado.
  • RemainingQuantity corresponde al saldo disponible.
  • StartDate y EndDate identifican el período de vigencia configurado.
  • Los valores de Status deben interpretarse según las reglas definidas por el servicio.
  • La información de suscripciones, paquetes y límites puede variar según la configuración asociada al emisor y al sistema integrado.