ValwispDocs
API

Facturación

Crear, listar, cobrar y anular facturas vía API.

🟢 Disponible (excepto Promesa de pago, marcada abajo). Requiere una API key con scope invoices:read o invoices:write.

Crear una factura

POST /invoices
Authorization: Bearer vw_live_...
Content-Type: application/json

{
  "clienteId": "cli_9f8e7d",
  "vencimiento": "2026-09-01",
  "concepto": "Servicio de internet — Agosto 2026",
  "monto": 1500.00
}

Si omites monto, se calcula automáticamente a partir del plan contratado por el cliente.

Listar facturas

GET /invoices?page=1&limit=25&estado=pendiente&clienteId=cli_9f8e7d

Filtros: estado (pendiente/pagada/anulada), clienteId, fechaDesde, fechaHasta.

Consultar una factura

GET /invoices/{id}

Registrar un cobro

POST /invoices/{id}/pay
Content-Type: application/json

{
  "monto": 1500.00,
  "metodo": "transferencia",
  "referenciaExterna": "TRX-88213",
  "fecha": "2026-08-05"
}

referenciaExterna es la clave de idempotencia — si reintentas la misma petición con la misma referencia, no se duplica el cobro. Si la factura pertenece a un cliente suspendido por mora, se reactiva automáticamente al completarse el pago.

metodo acepta cualquier string descriptivo (transferencia, efectivo, tarjeta, el nombre de tu pasarela) — no está limitado a una lista fija, así que puedes reportar pagos de cualquier origen sin coordinar un valor nuevo con nosotros primero.

Anular una factura

POST /invoices/{id}/void
Content-Type: application/json

{ "motivo": "Factura duplicada" }

Solo aplica a facturas sin pago registrado.

Promesa de pago

🟡 Próximamente. Permitirá registrar el compromiso de un cliente de pagar antes de una fecha específica, sin marcar la factura como pagada — útil para posponer la suspensión automática por mora sin tener que anular el corte manualmente.

POST /invoices/{id}/promise
Content-Type: application/json

{ "fechaCompromiso": "2026-08-15" }

On this page