Venflow API
V1FacturasPor ID

Actualizar una factura

PATCH
/v1/invoices/{id}

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

Request Body

metadata?

Key-value pairs for storing your own information on this invoice. They are merged into what is already stored: keys you do not mention are kept. Send a key with a null value to delete that key, or {} to delete them all. At most 50 keys; keys up to 40 characters, values up to 500, and 27000 characters across all keys and values. Do not store sensitive data here: it is not encrypted and is returned on reads.

Four key names are reserved by Venflow and rejected: checkoutMode, subscriptionId, obInvoiceId and billing_cycles; use a different name, such as externalId.

Propertiesproperties <= 50

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://api.venflow.app/v1/invoices/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{}'
{
  "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"
}

Obtener una factura GET

Obtiene la factura con el ID especificado.

Marcar una factura como pagada POST

Registra que tu cliente pagó la factura por fuera de Venflow (por transferencia, en efectivo o en taquilla). No intenta cobrar: solo deja constancia del pago y cierra la factura. Solo es válido si la factura está `open` o `uncollectible`. Si ya está `paid` o `void`, o su estado cambió mientras tanto, responde con un error de precondición: consulta la factura antes de decidir. Una factura cuyo cobro quedó en revisión con el banco (`under_review: true`) también aparece como `open` y se puede marcar como pagada, pero ese débito puede que ya se haya hecho: confirma antes con tu cliente cómo pagó. `reference` es obligatoria: es la referencia del pago tal como aparece en el estado de cuenta, y queda guardada en la transacción y en el historial de la factura. 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.