Eliminar factura
Eliminar factura
Cancela el Payment asociado y marca la factura según el motivo.
DELETE
Eliminar factura
Path params
string
required
ID de la factura a eliminar. Crear factura.
Body
string
default:"DELETE_FROM_PROVIDER"
Motivo de la eliminación. Valores permitidos:
DELETE_FROM_PROVIDER— La factura fue eliminada desde el proveedor. La factura se elimina. Se notifica al cliente que la factura fue eliminada.PAID_FROM_PROVIDER— La factura fue pagada fuera de OnePay. La factura no se elimina: sobrevive en estadoPAID_FROM_PROVIDER. El cobro asociado se cancela sin disparar sus eventos de pago, pero el webhookinvoice.canceledsí se emite (con el objetopaymentincluido).
string
Referencia del pago externo en el proveedor. Solo aplica cuando
reason es PAID_FROM_PROVIDER.Cuando se envía este campo junto con reason=PAID_FROM_PROVIDER, OnePay genera automáticamente un recibo de pago en PDF y lo envía al cliente por WhatsApp, confirmando que su pago fue registrado por la empresa.Este campo es opcional. Si no se envía, la factura se elimina sin enviar ningún recibo al cliente.
string
Medio con el que el cliente pagó por fuera de OnePay (en la caja del proveedor, por transferencia, etc.). Solo se registra cuando
reason es PAID_FROM_PROVIDER; con cualquier otro motivo se ignora.Es texto libre de hasta 60 caracteres: envía la etiqueta tal como la maneja tu sistema (Efectivo, Nequi, Consignación Bancolombia, Tarjeta). OnePay lo guarda sin normalizar y lo devuelve en el detalle de la factura como paid_provider_method.Este campo es opcional y no cambia el comportamiento del recibo por WhatsApp, que depende de
provider_payment_id.Ejemplos de uso
- curl
- JavaScript
- Python
Response
Solo puedes cancelar facturas que pertenezcan a tu compañía y que no estén en estado
PAID o CONCILIATED.Este endpoint forma parte de la homologación de la integración: los dos motivos se validan por separado, porque corresponden a situaciones distintas y no son intercambiables.