*API REST › Objetos › Finanzas*

# Proforma

> Proforma: la factura anticipada que todavía no es una factura.

Una proforma: la factura anticipada que todavía no es una factura. Tiene un estado de documento y un estado operativo (`pending`, `confirmed` o `cancelled`), que es la respuesta del cliente, y el operativo se cambia con [`PATCH /api/v1/proformas/{proformaId}/status`](https://docs.filmo.io/es/rest-api/endpoint-reference/proformas/change-the-commercial-status-of-a-proforma). Comparte el scope de las facturas.

Esquemas: `ProformaDto`

## Atributos

| Nombre | Tipo | Descripción |
| --- | --- | --- |
| `id` | string | Identificador de la proforma. |
| `proformaNumber` | string | Número de la proforma; null mientras es un borrador. |
| `status` | string | Estado del ciclo de vida del documento. |
| `operativeStatus` | string | Estado comercial: pending (a la espera de respuesta), confirmed (aceptado por el cliente) o cancelled; null si no consta. |
| `issueDate` | string<date-time> | Fecha de emisión en ISO 8601 UTC; null mientras no tiene. |
| `currency` | string | Moneda de los importes, como código ISO 4217. |
| `contact` | object | Contacto al que se emite la proforma; null si no consta. |
| `contact.id` | string | Identificador del contacto. |
| `contact.name` | string | Nombre del contacto. |
| `orderId` | string | Pedido de origen de la proforma; null si no procede de uno. |
| `orderNumber` | string | Número de ese pedido; null si no procede de uno. |
| `projectId` | string | Proyecto vinculado a la proforma; null si no hay ninguno. |
| `subTotal` | string | Subtotal antes de descuentos e impuestos, como cadena decimal. |
| `discountTotal` | string | Total de descuentos, como cadena decimal. |
| `taxesPrice` | string | Total de impuestos, como cadena decimal. |
| `netPrice` | string | Base imponible, como cadena decimal. |
| `grossPrice` | string | Total con impuestos, como cadena decimal. |
| `totalPaid` | string | Pagos anticipados recibidos contra la proforma, como cadena decimal; null si no consta ninguno. |
| `createdAt` | string<date-time> | Fecha de creación en ISO 8601 UTC. |
| `updatedAt` | string<date-time> | Fecha de la última modificación en ISO 8601 UTC. |

## Ejemplo

*Proforma · Generado a partir del esquema*

```json
{
  "id": "id_8f2a1c",
  "proformaNumber": "string",
  "status": "string",
  "operativeStatus": "string",
  "issueDate": "2026-09-01T08:00:00Z",
  "currency": "EUR",
  "contact": {
    "id": "id_8f2a1c",
    "name": "Example"
  },
  "orderId": "string",
  "orderNumber": "string",
  "projectId": "string",
  "subTotal": "1234.50",
  "discountTotal": "1234.50",
  "taxesPrice": "1234.50",
  "netPrice": "1234.50",
  "grossPrice": "1234.50",
  "totalPaid": "1234.50",
  "createdAt": "2026-09-01T08:00:00Z",
  "updatedAt": "2026-09-01T08:00:00Z"
}
```

## Lo devuelven

- [`GET /api/v1/proformas`](https://docs.filmo.io/es/rest-api/endpoint-reference/proformas/list-proformas) — Listar proformas
- [`GET /api/v1/proformas/{proformaId}`](https://docs.filmo.io/es/rest-api/endpoint-reference/proformas/get-a-proforma) — Obtener una proforma

## Lo modifican

- [`PATCH /api/v1/proformas/{proformaId}/status`](https://docs.filmo.io/es/rest-api/endpoint-reference/proformas/change-the-commercial-status-of-a-proforma) — Cambiar el estado comercial de una proforma

---

URL canónica: https://docs.filmo.io/es/rest-api/objects/proforma  
Última actualización: 2026-10-25