Registro de documentos electrónicos
El método SetDocument permite reportar documentos electrónicos a Colfact para registrar la información recibida, ejecutar las validaciones correspondientes e iniciar el procesamiento del documento.
POST https://micro.conexusit.com/corp/demo/api/Service.svc/SetDocument
Endpoint
| Dato | Valor |
|---|---|
| Método HTTP | POST |
| Operación | SetDocument |
Puedes consultar la definición del servicio y sus operaciones en el Swagger del ambiente de demostración.
Parámetros de entrada
El método recibe un objeto de tipo DocumentType, que contiene la información necesaria para registrar y procesar el documento electrónico.
La estructura de la solicitud, los campos obligatorios y las validaciones aplicables dependen del tipo de documento que se desea reportar.
Estructuras por tipo de documento
Consulta la documentación específica para conocer los campos y la estructura requerida en cada tipo de documento:
| Tipo de documento | Documentación |
|---|---|
| Factura electrónica | Consultar estructura |
| Nota crédito | Consultar estructura |
| Nota débito | Consultar estructura |
| Nómina electrónica | Consultar estructura |
| Nómina electrónica de ajuste | Consultar estructura |
| Documento soporte | Consultar estructura |
| Documento equivalente POS | Consultar estructura |
| Documento equivalente de servicios públicos | Consultar estructura |
| Documento equivalente de cobro de peajes | Consultar estructura |
| Documento equivalente de transporte terrestre de pasajeros | Consultar estructura |
| Documento equivalente de ingreso a cine | Consultar estructura |
| Documento equivalente de ingreso a espectáculos públicos | Consultar estructura |
| Documento equivalente de juegos de azar | Consultar estructura |
- La estructura de
DocumentTypedebe corresponder al tipo de documento que se desea registrar. - Antes de realizar la solicitud, verifica los campos requeridos y las reglas de validación descritas en la documentación específica del documento.
Estructura de la respuesta
Al recibir la solicitud, el servicio devuelve un objeto de tipo ResponseType con información relacionada con la recepción, el resultado de la operación y la trazabilidad del documento.
Respuesta (ResponseType)
| Campo | Descripción | Observaciones |
|---|---|---|
CodQR | Texto que debe incluirse en el código QR del documento. | Contiene la información requerida para generar el código QR, cuando está disponible. |
Base64QR | Representación de la imagen del código QR en formato Base64. | Permite obtener la imagen del código QR cuando el dato está disponible. |
CodResp | Código que identifica el resultado de la operación. | OK: el documento fue recibido satisfactoriamente. ERR: se presentó un inconveniente relacionado con la estructura, los datos o el procesamiento. |
CodigoTransaccion | Código CUFE o CUDE del documento electrónico. | Su contenido depende del tipo de documento y de la disponibilidad del código durante el procesamiento. |
NumeroTransaccion | Número del documento enviado. | Corresponde al número del documento que se va a procesar, de acuerdo con la resolución y la configuración aplicables. |
DetalleRespuesta | Observaciones relacionadas con el resultado de la operación. | Puede incluir observaciones o correcciones identificadas durante las validaciones de Colfact. |
Detalles | Información adicional sobre el resultado de la operación. | Complementa la descripción del resultado obtenido. |
IdTransaccion | Identificador interno de la transacción. | Permite identificar la transacción dentro de Colfact y facilitar su seguimiento. |
PDFBase64 | Representación del documento PDF en formato Base64. | Según la estructura documentada, este campo se devuelve vacío en SetDocument. |
Proceso | Listado de eventos relacionados con el procesamiento del documento. | Contiene registros con la estructura ProcesoType. |
Suscripciones | Información de las suscripciones asociadas al emisor. | Según la estructura documentada, este campo se devuelve vacío en SetDocument. |
EmailEstado | Información relacionada con el estado de los envíos electrónicos. | Según la estructura documentada, este campo se devuelve vacío en SetDocument. |
TipoTransaccion | Código que identifica el tipo de transacción o el resultado asociado. | Puede incluir RECIB para recepción del documento, FAC para factura, NCR para nota crédito, NDB para nota débito o ERROR para un error relacionado con la consulta de trazabilidad. |
XML | Contenido XML del documento electrónico. | Según la estructura documentada, este campo se devuelve vacío en SetDocument. |
FechaValidacion | Fecha y hora registradas para la recepción o validación del documento. | El significado específico depende del momento del proceso en que se genera la respuesta. |
Trazabilidad del documento
El campo Proceso contiene los eventos registrados durante el procesamiento del documento. Consulta su estructura en ProcesoType y los valores posibles en Códigos de proceso.
Existen variantes del método de registro de documentos habilitadas para atender requerimientos específicos de algunos aliados estratégicos. La estructura descrita en esta sección corresponde al funcionamiento general de SetDocument; el comportamiento de las variantes puede diferir.