Ir al contenido

POST /api/documentos/documento/{id}/notificar/

POST /api/documentos/documento/{id}/notificar/

Arma lo que se le entrega al adquiriente y lo deja listo para enviar.

POST /api/documentos/documento/{id}/notificar/ en multipart, con pdf y adjuntos opcionales (hasta 10 MB entre todos). El resultado es siempre un zip, y dentro va siempre el AttachedDocument —el documento firmado y el acuse de la DIAN juntos—.

Con ?descargar=1 no envía: devuelve el zip para revisarlo. Es la forma de ver qué se le va a mandar al cliente sin mandárselo.

operationId: documentos_documento_notificar_create

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
descargarquerybooleannoCon 1 no envía nada: devuelve el zip (application/zip) para revisarlo.
idpathstring (uuid)Un Cadena UUID que identifique este documento electrónico.

Tipo de contenido: multipart/form-data.

CampoTipoObligatorioDescripción
pdfstring (binary)no
adjuntosarray<string>no
Ventana de terminal
curl -X POST "https://api.rededoc.uk/api/documentos/documento/<id>/notificar/" \
-H "Authorization: <llaveapi>"
CódigoDescripción
200
400
401Error
404Error
429Error
502
CampoTipoDescripción
destinatariostring (email)Correo del adquiriente.
archivostringNombre del zip enviado.
tipostringTipo MIME del paquete: application/zip.
tamanointegerTamaño del zip, en bytes.
contenidoarray<string>Nombres de los archivos dentro del zip.
notificadoboolean
enviadoboolean
codigo_enviostringIdentificador del envío en la pasarela de correo.
respuestaobjectRespuesta cruda de la pasarela de correo.
{
"destinatario": "[email protected]",
"archivo": "texto",
"tipo": "texto",
"tamano": 1,
"contenido": [
"texto"
],
"notificado": true,
"enviado": true,
"codigo_envio": "texto",
"respuesta": null
}
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"
}
]
}
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.