Eliminar facturas masivamente

Elimina de forma masiva todas las facturas pendientes de la empresa autenticada.

DELETE /invoices

Eliminar facturas masivamente

cURL

curl --request DELETE \
  --url https://api.onepay.la/v1/invoices \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reason": "<string>",
  "provider_payment_id": "<string>",
  "payment_method": "<string>"
}
'

202

null

Esta acción es irreversible. Todas las facturas pendientes de la empresa serán eliminadas junto con sus pagos asociados. Úselo con precaución.

El proceso se ejecuta de forma asíncrona: el endpoint retorna inmediatamente con un 202 Accepted y las facturas se eliminan en segundo plano. Cada factura eliminada también cancela y elimina su pago asociado.

Las facturas con estado PAID o CONCILIATED no serán eliminadas.

Body

reason · string · default: "DELETE_FROM_PROVIDER"

Razón de la eliminación. Determina el comportamiento de los eventos asociados al pago.

Valores permitidos:

• DELETE_FROM_PROVIDER — Eliminada desde el proveedor (dispara PaymentDeletedEvent).
• PAID_FROM_PROVIDER — Pagada desde el proveedor (elimina el pago silenciosamente, sin disparar eventos).

provider_payment_id · 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 para cada factura y lo envía al cliente por WhatsApp, confirmando que su pago fue registrado por la empresa. Esto aplica únicamente a los clientes que tengan un número de teléfono registrado.

Este campo es opcional. Si no se envía, las facturas se eliminan sin enviar recibos a los clientes.

payment_method · string

Medio con el que los clientes pagaron por fuera de OnePay. Solo se registra cuando reason es PAID_FROM_PROVIDER; con cualquier otro motivo se ignora.

Es texto libre de hasta 60 caracteres (Efectivo, Nequi, Consignación Bancolombia, Tarjeta) y se aplica a todas las facturas del lote, así que úsalo solo cuando el medio sea el mismo para todas. Queda disponible en el detalle de cada factura como paid_provider_method.

A diferencia de provider_payment_id —que identifica un pago puntual y por eso no se guarda en cada factura del lote—, el medio de pago sí se persiste en todas.

Ejemplos de uso

curl

curl https://api.onepay.la/v1/invoices \
  -X DELETE \
  -H "Authorization: Bearer sk_test_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "reason": "PAID_FROM_PROVIDER",
    "provider_payment_id": "EXT-REF-001",
    "payment_method": "Efectivo"
  }'

JavaScript

const response = await fetch('https://api.onepay.la/v1/invoices', {
  method: 'DELETE',
  headers: {
    'Authorization': 'Bearer sk_test_xxx',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    reason: 'PAID_FROM_PROVIDER',
    provider_payment_id: 'EXT-REF-001',
    payment_method: 'Efectivo',
  }),
});
// 202 Accepted — eliminación en progreso

Python

import requests

response = requests.delete(
    'https://api.onepay.la/v1/invoices',
    headers={'Authorization': 'Bearer sk_test_xxx'},
    json={
        'reason': 'PAID_FROM_PROVIDER',
        'provider_payment_id': 'EXT-REF-001',
        'payment_method': 'Efectivo',
    },
)
# 202 Accepted — eliminación en progreso
print(response.status_code)

Response

202

null