Método para consultar eventos del documento ante la Entidad Tributaria (DocumentGetEvents)

Gosocket dispone un servicio que consulta directamente a la DIAN (Dirección de Impuestos y Aduanas Nacionales) y obtiene los distintos eventos asociados a un CUFE (Código Único de Facturación Electrónica).

Este servicio es consultado por cada CUFE.

Para conectarse a esta funcionalidad será necesario que ingrese la URL de acuerdo con el ambiente a consumir:

PRODUCCIÓNhttps://developers.gosocket.net/api/v1/Document/DocumentGetEvents

SANDBOXhttps://developers-sbx.gosocket.net/api/v1/Document/DocumentGetEvents

---

Habilitación del método

Dentro de la configuración del portal de Gosocket, encontrará el interruptor de habilitación del método como se muestra a continuación:

1. Ingrese a la pestaña Financiamiento que se encuentra dentro del módulo Configuración.
2. Presione el interruptor del campo Limitar consultas API Eventos RADIAN.
3. Ingrese el número máximo permitido de request para la empresa.
4. Una vez que haya terminado, presione de nuevo en el interruptor para habilitarlo.

---

¿Cómo funciona el método DocumentGetEvents?

Para realizar la petición en la API, deberá ingresar los siguientes parámetros:

DocumentGetEvents (request)
Parámetro	Tipo	Descripción	Valores permitidos
GlobalDocumentId	String	ID del documento en Gosocket	UUID de 36 caracteres alfanuméricos xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
CountryDocumentId	String	Identificador fiscal del documento a nivel país, conocido también como CUFE, CLAVE, UUID, ID	Ver tabla Estructura Country Document ID
Status	String	Código de evento mercantil o RADIAN	3 caracteres numéricos Para obtener todos los eventos, enviar valor all

Los eventos mercantiles se identifican de la siguiente forma:

Eventos Mercantiles
Código	Evento
030	Acuse de recibo
031	Reclamo
032	Recibo del bien y/o prestación del servicio
033	Aceptación expresa
034	Aceptación Tácita

Los eventos RADIAN se identifican de la siguiente forma:

Eventos RADIAN
Código	Evento
035	Aval
036	Inscripción en el RADIAN de la factura electrónica de venta como título valor que circula en el territorio nacional
037	Endoso en propiedad
038	Endoso en garantía
039	Endoso en procuración
040	Cancelación del Endoso electrónico
041	Limitación para circulación de la factura electrónica de venta como título valor
042	Terminación de la limitación para circulación de la factura electrónica de venta como título valor
043	Mandato
044	Terminación del mandato
045	Pago de la factura electrónica de venta como título valor
046	Informe para el pago
047	Endoso con efectos de cesión ordinaria
048	Protesto
049	Transferencia de los derechos económicos
050	Notificación al deudor sobre la transferencia de los derechos económicos
051	Pago de la transferencia de los derechos económicos

---

Ejemplo de petición

Para este método utilizamos la pestaña Params de Postman.

1. Seleccione el tipo de método. En este caso, se debe seleccionar GET.
2. Ingrese la URL del método.
3. Ingrese el parámetro que se muestran en la tabla anterior con sus valores correspondientes.
4. Presione Send.

Nota: Recuerde que antes de utilizar el método, debe realizar su autenticación dentro de la pestaña Authorization.

---

Ejemplo de respuesta

Para interpretar correctamente la respuesta de la API, tome en cuenta los siguientes criterios:

---

Características del método DocumentGetEvents

Restricción: la cantidad de consultas estará limitada de acuerdo con lo plasmado en la configuración de la empresa para este método en Inbox dentro de la pestaña Financiamiento. Si se supera el umbral mensual, no podrá ser utilizada.

• Permite consultar un (1) CUFE

• Permite consultar un (1) evento Mercantil o RADIAN o todos usando la palabra all.

• Globaldocumentid

  • Si se informa globalDocumentId y no countryDocumentId, se considera el valor de globalDocumentId.
  • Si se informa globalDocumentId y countryDocumentId, se considera el valor de countryDocumentId.

• Countrydocumentid

  • Si se informa countryDocumentId y no globalDocumentId, se considera el valor de countryDocumentId.
  • Si se informa countryDocumentId y globalDocumentId, se considera el valor de countryDocumentId.

• Status

  • Sólo se puede consultar un (1) código de 3 caracteres, ejemplo 030.
  • Si el valor status es all, entonces el API responderá con todos los eventos asociados al CUFE.
  • Si el valor de status se manda vacío, entonces la API responderá con un mensaje de error.