Ir al contenido

Listar eventos

GET
/eventos
curl --request GET \
--url 'https://openfactura.co/api/v1/eventos?tipo=retorno' \
--header 'Authorization: Bearer <token>'

Los 50 eventos de retorno u operaciones especiales más recientes del ambiente activo.

Permiso: dte:read.

tipo
string
Allowed values: retorno operaciones_especiales

Eventos.

Media typeapplication/json
Array<object>
object
id
required
string
tipo
required
string
Allowed values: retorno operaciones_especiales
tipoEvento
string
Allowed values: 18 17
codigoGeneracion
required
string
ambiente
required
string
Allowed values: 00 01
estado
required
string
Allowed values: procesado rechazado invalidado
selloRecibido
string | null
documentoId

Documento de un retorno.

string | null
creado

Milisegundos desde 1970.

integer

Example

[
{
"tipo": "retorno",
"tipoEvento": "18",
"ambiente": "00",
"estado": "procesado"
}
]
RateLimit-Limit
integer

Peticiones permitidas por minuto (sólo con clave de API).

RateLimit-Remaining
integer

Peticiones restantes en la ventana actual (sólo con clave de API).

RateLimit-Reset
integer

Segundos hasta que se reinicia la ventana (sólo con clave de API).

Idempotent-Replayed
string
Allowed values: true

true cuando la respuesta es la guardada de un intento anterior.

Cuerpo o parámetros inválidos (details = [{ ruta, mensaje }]), o el DTE no cumple el esquema del MH (details.problemas). Códigos: datos_invalidos, dte_invalido.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: datos_invalidos dte_invalido no_autenticado sin_permiso origen_no_permitido no_encontrado sin_organizacion sin_organizacion_activa nit_bloqueado emisor_no_configurado credenciales_incompletas sin_punto_venta estado_invalido ambiente_distinto retorno_excedido retorno_vigente idempotencia_distinta idempotencia_en_curso cliente_repetido producto_repetido codigo_repetido sin_archivo limite_webhooks simulador_inactivo dte_rechazado invalidacion_rechazada contingencia_rechazada evento_rechazado limite_excedido error_interno mh_credenciales_rechazadas mh_no_disponible emision_fallida emision_incierta
message
required
string
details

Detalle según el código; puede faltar.

Example

{
"error": {
"code": "datos_invalidos"
}
}

Falta sesión, o la clave de API no es válida, fue revocada o expiró. Códigos: no_autenticado.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: datos_invalidos dte_invalido no_autenticado sin_permiso origen_no_permitido no_encontrado sin_organizacion sin_organizacion_activa nit_bloqueado emisor_no_configurado credenciales_incompletas sin_punto_venta estado_invalido ambiente_distinto retorno_excedido retorno_vigente idempotencia_distinta idempotencia_en_curso cliente_repetido producto_repetido codigo_repetido sin_archivo limite_webhooks simulador_inactivo dte_rechazado invalidacion_rechazada contingencia_rechazada evento_rechazado limite_excedido error_interno mh_credenciales_rechazadas mh_no_disponible emision_fallida emision_incierta
message
required
string
details

Detalle según el código; puede faltar.

Example

{
"error": {
"code": "datos_invalidos"
}
}

Falta un permiso (details.permiso) o el origen de la petición con cookie no está permitido. Códigos: sin_permiso, origen_no_permitido.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: datos_invalidos dte_invalido no_autenticado sin_permiso origen_no_permitido no_encontrado sin_organizacion sin_organizacion_activa nit_bloqueado emisor_no_configurado credenciales_incompletas sin_punto_venta estado_invalido ambiente_distinto retorno_excedido retorno_vigente idempotencia_distinta idempotencia_en_curso cliente_repetido producto_repetido codigo_repetido sin_archivo limite_webhooks simulador_inactivo dte_rechazado invalidacion_rechazada contingencia_rechazada evento_rechazado limite_excedido error_interno mh_credenciales_rechazadas mh_no_disponible emision_fallida emision_incierta
message
required
string
details

Detalle según el código; puede faltar.

Example

{
"error": {
"code": "datos_invalidos"
}
}

Límite de peticiones excedido; Retry-After indica cuántos segundos esperar. Códigos: limite_excedido.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: datos_invalidos dte_invalido no_autenticado sin_permiso origen_no_permitido no_encontrado sin_organizacion sin_organizacion_activa nit_bloqueado emisor_no_configurado credenciales_incompletas sin_punto_venta estado_invalido ambiente_distinto retorno_excedido retorno_vigente idempotencia_distinta idempotencia_en_curso cliente_repetido producto_repetido codigo_repetido sin_archivo limite_webhooks simulador_inactivo dte_rechazado invalidacion_rechazada contingencia_rechazada evento_rechazado limite_excedido error_interno mh_credenciales_rechazadas mh_no_disponible emision_fallida emision_incierta
message
required
string
details

Detalle según el código; puede faltar.

Example

{
"error": {
"code": "datos_invalidos"
}
}
Retry-After
integer

Segundos que hay que esperar.