Venflow API
V1FacturasPor ID

Marcar una factura como pagada

POST
/v1/invoices/{id}/mark_paid

Authorization

Api-Key<token>

Tu clave API privada (comienza con pvk_)

In: header

Organization<token>

Tu ID de organización

In: header

Path Parameters

idstring
Formatuuid

Header Parameters

Idempotency-Keystring

Clave de idempotencia (OBLIGATORIA). Repetir la llamada con la misma clave no vuelve a marcar la factura y la devuelve como está en ese momento: es la protección contra reintentos de red o timeouts. La clave es única por organización; usa un valor distinto por cada pago que registres. Reutilizarla con otros datos devuelve un error que nombra el campo distinto

Request Body

reason?string

Motivo o nota sobre el pago, que queda en el historial de la factura. Máximo 500 caracteres

Lengthlength <= 500
referencestring

Referencia del pago tal como aparece en el estado de cuenta del banco (OBLIGATORIA). Queda guardada en la transacción y en el historial de la factura, y es la que tu equipo puede buscar después. Máximo 500 caracteres

Length1 <= length <= 500

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://api.venflow.app/v1/invoices/497f6eca-6276-4993-bfeb-53cbbbba6f08/mark_paid" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "reference": "string"  }'
{
  "amount_discount": 0.1,
  "amount_due": 0.1,
  "amount_paid": 0.1,
  "amount_remaining": 0.1,
  "amount_tax": 0,
  "amount_taxable": 0,
  "bank_reference": "string",
  "created": 0.1,
  "customer": "string",
  "customer_email": "string",
  "customer_name": "string",
  "due_date": 0,
  "exchange_rate": "string",
  "id": "string",
  "livemode": true,
  "metadata": {
    "property1": "string",
    "property2": "string"
  },
  "number": "string",
  "object": "invoice",
  "paid": true,
  "period_end": 0,
  "period_start": 0,
  "receipt_number": "string",
  "status": "draft",
  "subscription": "string",
  "subtotal": 0.1,
  "total": 0.1,
  "total_usd": 0,
  "under_review": true
}
{
  "code": "not_found",
  "details": {},
  "message": "string"
}
{
  "code": "not_found",
  "details": {},
  "message": "string"
}
{
  "code": "not_found",
  "details": {},
  "message": "string"
}
{
  "code": "not_found",
  "details": {},
  "message": "string"
}
{
  "code": "not_found",
  "details": {},
  "message": "string"
}
{
  "code": "not_found",
  "details": {},
  "message": "string"
}

Actualizar una factura PATCH

Actualiza la metadata de la factura indicada. Es lo único editable de una factura por API: los importes, el estado y el calendario de cobro los gobierna el motor y no se tocan desde aquí. La metadata se combina con la que ya tenga: las claves que no menciones se conservan, una clave con valor `null` se borra, y `{}` las borra todas.

Marcar una factura como incobrable POST

Da la factura por perdida: Venflow deja de intentar cobrarla. No cancela la suscripción: eso es una llamada aparte al API de suscripciones. Solo es válido si la factura está `open`, incluidas las que están en revisión con el banco (`under_review: true`). Si ya está `uncollectible`, `paid` o `void`, o su estado cambió mientras tanto, responde con un error de precondición: consulta la factura antes de decidir. Requiere el header `Idempotency-Key`. Repetir la llamada con la misma clave no vuelve a aplicar la acción: devuelve la factura como está en ese momento.