Ir al contenido

GET /api/documentos/documento-notificacion/{id}/

GET /api/documentos/documento-notificacion/{id}/

Los envíos de los documentos al adquiriente por correo.

Uno por cada intento que llegó a la pasarela, haya salido o no: a quién se mandó, qué llevaba el zip, el código con el que se rastrea en Zinc y, si falló, por qué. De solo lectura: las escribe la acción notificar.

Filtros: ?documento=<uuid> y ?estado=enviado|fallido.

operationId: documentos_documento_notificacion_retrieve

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ó.
NombreEnTipoObligatorioDescripción
idpathintegersíUn valor de entero único que identifique este notificación de documento.
Ventana de terminal
curl "https://api.rededoc.uk/api/documentos/documento-notificacion/<id>/" \
-H "Authorization: <llaveapi>"
CódigoDescripción
200
401Error
404Error
429Error
CampoTipoDescripción
idintegerSolo lectura.
documentostring (uuid)Solo lectura.
estadoanySolo lectura.
destinatariostringSolo lectura.
copiastringSolo lectura.
archivostringSolo lectura.
tamanointegerSolo lectura.
contenidoanySolo lectura.
codigo_enviostringSolo lectura.
errorstringSolo lectura.
fechastring (date-time)Solo lectura.
{
"id": 1,
"documento": "00000000-0000-0000-0000-000000000000",
"estado": null,
"destinatario": "texto",
"copia": "texto",
"archivo": "texto",
"tamano": 1,
"contenido": null,
"codigo_envio": "texto",
"error": "texto",
"fecha": "2026-01-31T10:00:00-05:00"
}
CampoTipoDescripción
detailstringMensaje para mostrar a la persona.
erroresarray<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"
}
]
}
CampoTipoDescripción
detailstringMensaje para mostrar a la persona.
erroresarray<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"
}
]
}
CampoTipoDescripción
detailstringMensaje para mostrar a la persona.
erroresarray<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"
}
]
}

RedEDoc es un servicio de Semántica Digital S.A.S.