Eliminar pago de comprobante
DELETE /api/document-payments/{document_payment_id}
Autenticación: Bearer del usuario del tenant (Authorization: Bearer <api_token>).
Elimina un pago de comprobante y su registro en caja/cuenta.
Quién puede usarlo: cualquier usuario autenticado (administrador o vendedor).
Formato de respuesta: heredado {success, message?, data?} sin paginación. Ante reglas de negocio puede responder HTTP 200 con success: false: revisa siempre success.
Parámetros de la URL:
| Campo | Tipo | Obligatorio | Descripción / valores permitidos |
|---|---|---|---|
id |
integer | Sí | Id del pago (no del comprobante). |
Reglas de caja: cuando una regla de caja impide la operación responde 422 con {success: false, message, cash_rule: true}; el message explica la causa y puede mostrarse al usuario tal cual (caja cerrada, sin caja abierta para un pago en efectivo, pago duplicado en menos de 20 segundos, etc.).
Errores:
422concash_rule: truesi el pago pertenece a una caja ya cerrada.404{success: false, message: "Registro no encontrado."}si el id no existe.
Parámetros
| Parámetro | Dónde | Obligatorio | Ejemplo | Descripción |
|---|---|---|---|---|
document_payment_id |
ruta | sí | 1 |
Respuestas
200 — Eliminado
{
"success": true,
"message": "Pago eliminado con éxito"
}
422 — Caja cerrada
{
"success": false,
"message": "No se puede eliminar este pago: pertenece a la caja #3, que ya está cerrada y su arqueo no puede cambiar.",
"cash_rule": true
}
Pruébalo
Prueba este endpoint con tu empresa y tu token: elige la URL en Servers, pega el token en Authorize y haz clic en Try it out.