El método DocumentGetEvents permite consultar los eventos asociados a un documento electrónico —ya sea un evento mercantil o un evento RADIAN— utilizando como referencia su CUFE o sus identificadores globales o locales. Este método ofrece flexibilidad de búsqueda, pero también aplica restricciones importantes que deben tenerse en cuenta.
Restricción de uso:
Cada cliente dispone de un límite de 52 consultas mensuales. Una vez alcanzado este umbral, el método no podrá seguir siendo utilizado hasta el siguiente ciclo mensual.
Funcionalidad principal:
El método permite:
- Consultar un (1) CUFE: Permite obtener los eventos registrados para un documento específico mediante su CUFE.
- Consultar un (1) evento Mercantil o RADIAN, o todos los eventos asociados: La consulta puede limitarse a un evento puntual o recuperar el historial completo de eventos del documento.
Parámetros de identificación del documento:
El método puede recibir dos tipos de identificadores:
- GlobalDocumentId: identificador global dentro de la plataforma
- CountryDocumentId: identificador fiscal propio del país
La lógica para determinar cuál de ellos se utiliza en la consulta es la siguiente:
Uso de GlobalDocumentId
- Si solo se envía GlobalDocumentId → se utiliza el GlobalDocumentId.
- Si se envían ambos (GlobalDocumentId y CountryDocumentId) → prevalece CountryDocumentId.
Uso de CountryDocumentId
- Si solo se envía CountryDocumentId → se utiliza el CountryDocumentId.
- Si se envían ambos → nuevamente, prevalece CountryDocumentId.
En resumen: siempre que exista CountryDocumentId, este será el valor utilizado para la consulta.
Parámetro status:
El parámetro status determina qué evento consultar. Sus reglas son:
- Consulta de un único evento: Debe enviarse un código de 3 caracteres (por ejemplo: 030).
- Consulta de todos los eventos: Si el valor enviado es all, el método devolverá todos los eventos asociados al CUFE.
- Error por parámetro vacío: Si status se envía vacío, el método responderá con un mensaje de error, indicando que el parámetro es obligatorio.
Resumen final:
- Permite consultar un CUFE o sus eventos individuales o completos.
- Tiene un límite de 52 consultas mensuales por cliente.
- Priorización de identificadores: CountryDocumentId prevalece sobre GlobalDocumentId.
- El parámetro status determina si se consulta un evento específico o todos.
- No acepta valores vacíos en status.
¿Le ha sido útil este artículo?
¡Qué bien!
Gracias por sus comentarios
¡Sentimos mucho no haber sido de ayuda!
Gracias por sus comentarios
Sus comentarios se han enviado
Agradecemos su esfuerzo e intentaremos corregir el artículo
