Eliminar factura

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

no content

DELETE

invoices

{invoice_id}

Eliminar factura

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

no content

Path params

invoice_id

string

required

ID de la factura a eliminar. Crear factura.

Body

reason

string

default:"DELETE_FROM_PROVIDER"

Motivo de la eliminación. Valores permitidos:

DELETE_FROM_PROVIDER — La factura fue eliminada desde el proveedor. Se notifica al cliente que la factura fue eliminada.
PAID_FROM_PROVIDER — La factura fue pagada fuera de OnePay. El pago se cancela silenciosamente sin enviar 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 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.

Ejemplos de uso

curl
JavaScript
Python

curl https://api.onepay.la/v1/invoices/2f2b1e5a-1a2b-4c33-8a18-5e9f3b9f4b1a \
  -X DELETE \
  -H "Authorization: Bearer sk_test_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "reason": "PAID_FROM_PROVIDER",
    "provider_payment_id": "EXT-REF-001"
  }'

const response = await fetch('https://api.onepay.la/v1/invoices/2f2b1e5a-1a2b-4c33-8a18-5e9f3b9f4b1a', {
  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',
  }),
});
// 204 No Content

import requests

response = requests.delete(
    'https://api.onepay.la/v1/invoices/2f2b1e5a-1a2b-4c33-8a18-5e9f3b9f4b1a',
    headers={'Authorization': 'Bearer sk_test_xxx'},
    json={
        'reason': 'PAID_FROM_PROVIDER',
        'provider_payment_id': 'EXT-REF-001',
    },
)
# 204 No Content

Response

no content

Solo puedes eliminar facturas que pertenezcan a tu compañía y que no estén en estado PAID o CONCILIATED.

Actualizar factura

Eliminar facturas masivamente

​Path params

​Body

​Ejemplos de uso

​Response

Path params

Body

Ejemplos de uso

Response