GET /api/documentos/documento/{id}/consultar/

GET /api/documentos/documento/{id}/consultar/

Consulta (solo lectura) el estado del documento en la DIAN.

GET /api/documentos/documento/{id}/consultar/ → GetStatus, por el CUFE. Es la pregunta “¿cómo quedó este documento?”, y la respuesta vale igual para un envío síncrono que para uno del Set de Pruebas.

No modifica el documento, en ningún estado —también sirve para leer el detalle de un rechazado—; devuelve lo que responde la DIAN. Lo aplica emitir/, cuando el documento quedó enviado sin veredicto.

operationId: documentos_documento_consultar_retrieve

Autenticación

Cualquiera de estas credenciales:

• LlaveApi — Llave de API de una integración. El valor completo es Api-Key <prefijo>.<secreto>, tal como lo imprime manage.py crear_llave_api. La llave alcanza exactamente los mismos emisores que la persona a cuyo nombre se creó.

Parámetros

Nombre	En	Tipo	Obligatorio	Descripción
id	path	string (uuid)	sí	Un Cadena UUID que identifique este documento electrónico.

Ejemplo

curl "https://api.rededoc.uk/api/documentos/documento/<id>/consultar/" \
  -H "Authorization: <llaveapi>"

Respuestas

Código	Descripción
200
400
401	Error
404	Error
429	Error
502

200 — cuerpo

Campo	Tipo	Descripción
estado	string	Estado en el sistema tras la operación.
es_valido	boolean	true si la DIAN lo dio por válido.
codigo_estado	string	Código de estado de la DIAN (00 aceptado, 99 con errores…).
descripcion	string	Descripción del estado según la DIAN.
errores	array<string>	Reglas de rechazo y notificaciones, tal como las devuelve la DIAN.

{
  "estado": "texto",
  "es_valido": true,
  "codigo_estado": "texto",
  "descripcion": "texto",
  "errores": [
    "texto"
  ]
}

400 — cuerpo

Campo	Tipo	Descripción
detail	string	Mensaje para mostrar a la persona.
errores	array<object>	Nunca vacía. Cada error trae codigo, que es lo que el cliente mapea —los de DRF tal cual (required, invalid, does_not_exist, not_found…) y los propios en español (campo_desconocido, solicitud_invalida…)—, y mensaje, para la persona. Si el error es de un campo, su ruta va delante del mensaje: detalles[0].impuestos[0].tributo: Este campo es obligatorio.

{
  "detail": "texto",
  "errores": [
    {
      "codigo": "texto",
      "mensaje": "texto"
    }
  ]
}

401 — cuerpo

Campo	Tipo	Descripción
detail	string	Mensaje para mostrar a la persona.
errores	array<object>	Nunca vacía. Cada error trae codigo, que es lo que el cliente mapea —los de DRF tal cual (required, invalid, does_not_exist, not_found…) y los propios en español (campo_desconocido, solicitud_invalida…)—, y mensaje, para la persona. Si el error es de un campo, su ruta va delante del mensaje: detalles[0].impuestos[0].tributo: Este campo es obligatorio.

{
  "detail": "texto",
  "errores": [
    {
      "codigo": "texto",
      "mensaje": "texto"
    }
  ]
}

404 — cuerpo

Campo	Tipo	Descripción
detail	string	Mensaje para mostrar a la persona.
errores	array<object>	Nunca vacía. Cada error trae codigo, que es lo que el cliente mapea —los de DRF tal cual (required, invalid, does_not_exist, not_found…) y los propios en español (campo_desconocido, solicitud_invalida…)—, y mensaje, para la persona. Si el error es de un campo, su ruta va delante del mensaje: detalles[0].impuestos[0].tributo: Este campo es obligatorio.

{
  "detail": "texto",
  "errores": [
    {
      "codigo": "texto",
      "mensaje": "texto"
    }
  ]
}

429 — cuerpo

Campo	Tipo	Descripción
detail	string	Mensaje para mostrar a la persona.
errores	array<object>	Nunca vacía. Cada error trae codigo, que es lo que el cliente mapea —los de DRF tal cual (required, invalid, does_not_exist, not_found…) y los propios en español (campo_desconocido, solicitud_invalida…)—, y mensaje, para la persona. Si el error es de un campo, su ruta va delante del mensaje: detalles[0].impuestos[0].tributo: Este campo es obligatorio.

{
  "detail": "texto",
  "errores": [
    {
      "codigo": "texto",
      "mensaje": "texto"
    }
  ]
}

502 — cuerpo

Campo	Tipo	Descripción
detail	string	Mensaje para mostrar a la persona.
errores	array<object>	Nunca vacía. Cada error trae codigo, que es lo que el cliente mapea —los de DRF tal cual (required, invalid, does_not_exist, not_found…) y los propios en español (campo_desconocido, solicitud_invalida…)—, y mensaje, para la persona. Si el error es de un campo, su ruta va delante del mensaje: detalles[0].impuestos[0].tributo: Este campo es obligatorio.

{
  "detail": "texto",
  "errores": [
    {
      "codigo": "texto",
      "mensaje": "texto"
    }
  ]
}