Venflow API
V1Facturas

Listar todas las facturas

GET
/v1/invoices
Api-Key<token>

Tu clave API privada (comienza con pvk_)

In: header

Organization<token>

Tu ID de organización

In: header

Query Parameters

limit?integer

Límite en el número de objetos a devolver. El límite puede estar entre 1 y 100, y el valor predeterminado es 10

Range1 <= value <= 100
starting_after?string

Un cursor para paginación. starting_after es un ID de objeto que define tu posición en la lista

Formatuuid
ending_before?string

Un cursor para paginación. ending_before es un ID de objeto que define tu posición en la lista

Formatuuid
customer?string

Solo devuelve facturas del cliente especificado por este ID de cliente

Formatuuid
status?string

El estado de la factura. Uno de: draft (borrador), open (abierta, incluidas las que están en revisión con el banco), paid (pagada), uncollectible (incobrable), o void (anulada)

Value in"draft" | "open" | "paid" | "uncollectible" | "void"
subscription?string

Solo devuelve facturas de la suscripción especificada por este ID de suscripción

Formatuuid

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://api.venflow.app/v1/invoices"
{
  "data": [
    {
      "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
    }
  ],
  "has_more": true,
  "object": "list",
  "url": "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"
}