Ir al contenido

PATCH /api/emisores/webhook/{id}/

PATCH /api/emisores/webhook/{id}/

Los webhooks del emisor: a qué URL avisarle, y de qué.

Un emisor puede tener varios. estado_validado y estado_notificado dicen si a ese webhook se le avisa de la validación de la DIAN y de la notificación al adquiriente. Por ahora solo se guardan: el envío de los avisos todavía no está hecho.

Filtro: ?emisor=<id>.

operationId: emisores_webhook_partial_update

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
idpathintegerUn valor de entero único que identifique este webhook.

Tipo de contenido: application/json.

CampoTipoObligatorioDescripción
emisorintegerno
nombrestringno
urlstring (uri)no
estado_validadobooleanno
estado_notificadobooleanno
Ventana de terminal
curl -X PATCH "https://api.rededoc.uk/api/emisores/webhook/<id>/" \
-H "Authorization: <llaveapi>" \
-H "Content-Type: application/json" \
-d '{
"emisor": 1,
"nombre": "texto",
"url": "texto",
"estado_validado": true,
"estado_notificado": true
}'
CódigoDescripción
200
400Error
401Error
404Error
429Error
CampoTipoDescripción
idintegerSolo lectura.
emisorinteger
nombrestring
urlstring (uri)
estado_validadoboolean
estado_notificadoboolean
creado_enstring (date-time)Solo lectura.
actualizado_enstring (date-time)Solo lectura.
{
"id": 1,
"emisor": 1,
"nombre": "texto",
"url": "texto",
"estado_validado": true,
"estado_notificado": true,
"creado_en": "2026-01-31T10:00:00-05:00",
"actualizado_en": "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"
}
]
}
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.