Proformas

Obtener una proforma

Devuelve una proforma por su identificador, la misma ficha que GET /api/v1/proformas: número, estado del ciclo de vida y comercial, cliente, pedido de origen, proyecto, divisa e importes.

GET

/api/v1/proformas/{proformaId}

curl https://app.filmo.io/api/v1/proformas/prof_8f2a1c \
  --header "Authorization: Bearer $FILMO_API_KEY"

Node.jsfetch('https://app.filmo.io/api/v1/proformas/prof_8f2a1c', { headers: { Authorization: 'Bearer YOUR_FILMO_API_KEY' } })Pythonimport requests requests.get( "https://app.filmo.io/api/v1/proformas/prof_8f2a1c", headers={ "Authorization": "Bearer YOUR_FILMO_API_KEY" } )

{
  "data": {
    "id": "proforma_9f3a2b",
    "proformaNumber": "2026-0001",
    "status": "Example status",
    "operativeStatus": "Example operative status",
    "issueDate": "2026-09-01T08:00:00.000Z",
    "currency": "EUR",
    "contact": {
      "id": "contact_9f3a2b",
      "name": "Example contact"
    },
    "orderId": "order_9f3a2b",
    "orderNumber": "2026-0001",
    "projectId": "project_9f3a2b",
    "subTotal": "120.00",
    "discountTotal": "120.00",
    "taxesPrice": "120.00",
    "netPrice": "120.00",
    "grossPrice": "120.00",
    "totalPaid": "120.00",
    "createdAt": "2026-09-01T08:00:00.000Z",
    "updatedAt": "2026-09-01T08:00:00.000Z"
  }
}

// Sin cuerpo.

{
  "type": "https://docs.filmo.io/errors/unauthorized",
  "title": "Unauthorized",
  "status": 401,
  "code": "unauthorized",
  "detail": "Missing Authorization header: Bearer <api key>",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c"
}

{
  "type": "https://docs.filmo.io/errors/insufficient_scope",
  "title": "Insufficient scope",
  "status": 403,
  "code": "insufficient_scope",
  "detail": "The API key does not have the required scope (orders:write)",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c",
  "requiredScope": "invoices:read"
}

{
  "type": "https://docs.filmo.io/errors/not_found",
  "title": "Not found",
  "status": 404,
  "code": "not_found",
  "detail": "Resource not found",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c"
}

{
  "type": "https://docs.filmo.io/errors/rate_limited",
  "title": "Rate limit exceeded",
  "status": 429,
  "code": "rate_limited",
  "detail": "Rate limit exceeded: retry in 30 seconds",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c",
  "retryAfter": 30
}

{
  "type": "https://docs.filmo.io/errors/internal_error",
  "title": "Internal error",
  "status": 500,
  "code": "internal_error",
  "detail": "Internal error",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c"
}

Generado a partir del esquema

Comparte scope con las facturas porque una proforma es la factura que todavía no lo es.

Autorizaciones

Clave de API como Bearer, con el permiso de abajo. invoices:read

Cabeceras

If-None-Matchstring

Lectura condicional: el ETag de la copia que ya tienes. Si el recurso no ha cambiado, la respuesta es 304 sin cuerpo.

Ejemplo:"\"3sT3d9pBvZq4h2N0w8x1YkLmQ7c\""

Parámetros de ruta

proformaIdstringObligatorio

Identificador de la proforma.

Límites: longitud mín. 1

Respuesta

application/json

Respuesta correcta.

Esquema de la respuesta: ProformaDto

Sobre: ProformaResponse. meta.warnings solo aparece cuando la operación está obsoleta.

Cabeceras: X-Request-Id · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset · ETag

dataobject

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

Mostrar atributos hijos

data.idstring

Identificador de la proforma.

data.proformaNumberstring | null

Número de la proforma; null mientras es un borrador.

data.statusstring

Estado del ciclo de vida del documento.

data.operativeStatusstring | null

Estado comercial: pending (a la espera de respuesta), confirmed (aceptado por el cliente) o cancelled; null si no consta.

data.issueDatestring<date-time> | null

Fecha de emisión en ISO 8601 UTC; null mientras no tiene.

data.currencystring

Moneda de los importes, como código ISO 4217.

data.contactobject | null

Contacto al que se emite la proforma; null si no consta.

Mostrar atributos hijos

data.contact.idstring

Identificador del contacto.

data.contact.namestring

Nombre del contacto.

data.orderIdstring | null

Pedido de origen de la proforma; null si no procede de uno.

data.orderNumberstring | null

Número de ese pedido; null si no procede de uno.

data.projectIdstring | null

Proyecto vinculado a la proforma; null si no hay ninguno.

data.subTotalstring

Subtotal antes de descuentos e impuestos, como cadena decimal.