Ir al contenido

Listar documentos

GET
/dte
curl --request GET \
--url 'https://openfactura.co/api/v1/dte?estado=pendiente&pagina=1&porPagina=25' \
--header 'Authorization: Bearer <token>'

Documentos del ambiente activo. q busca por receptor, número de control o código de generación; desde/hasta en formato AAAA-MM-DD.

Permiso: dte:read.

tipo
string
estado
string
Allowed values: pendiente procesado rechazado contingencia invalidado
q
string
<= 100 characters
desde
string
/^\d{4}-\d{2}-\d{2}$/
hasta
string
/^\d{4}-\d{2}-\d{2}$/
pagina
integer
default: 1 >= 1 <= 9007199254740991
porPagina
integer
default: 25 >= 1 <= 100

Página de documentos.

Media typeapplication/json
object
items
required
Array<object>
object
id
required
string
codigoGeneracion
required

UUID en mayúsculas.

string
numeroControl
required
string
tipoDte
required
string
Allowed values: 11 14 01 03 04 05 06 07
ambiente
required
string
Allowed values: 00 01
estado
required
string
Allowed values: pendiente procesado rechazado contingencia invalidado
fechaEmision
string format: date
horaEmision
string
receptorNombre
string | null
receptorDocumento
string | null
total
required
number
selloRecibido
string | null
origen
string
error
string | null
creado

Milisegundos desde 1970.

integer
urlConsulta

Consulta pública en el portal del MH.

string | null
total
required
integer
pagina
required
integer
porPagina
required
integer
ambiente
required
string
Allowed values: 00 01

Example

{
"items": [
{
"numeroControl": "DTE-01-M001P001-000000000000001",
"tipoDte": "11",
"ambiente": "00",
"estado": "pendiente",
"horaEmision": "01:38:12",
"origen": "panel"
}
],
"ambiente": "00"
}
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.