Proformas

Cambiar el estado comercial de una proforma

Mueve el estado OPERATIVO de la proforma —pending, confirmed o cancelled—, que es la respuesta del cliente, y deja una nota opcional en el historial del documento.

PATCH
/api/v1/proformas/{proformaId}/status

Ejemplos de petición

curl https://app.filmo.io/api/v1/proformas/prof_8f2a1c/status \
  --request PATCH \
  --header "Authorization: Bearer $FILMO_API_KEY" \
  --header "Idempotency-Key: $(uuidgen 2>/dev/null || cat /proc/sys/kernel/random/uuid)" \
  --header 'Content-Type: application/json' \
  --data '{
  "status": "confirmed",
  "notes": "Confirmada por correo el 4 de septiembre"
}'
{
  "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"
  }
}

Generado a partir del esquema

Se permite cualquier transición entre los tres, y se deshace llamando de nuevo. NO toca el estado fiscal (draft / validated): para eso están validar y anular. A diferencia del presupuesto, confirmar una proforma no arrastra a ninguna otra, porque las proformas no tienen versiones. Requiere documentos de venta en el plan de la cuenta (402 si no están incluidos). Devuelve la proforma completa, la misma proyección que su GET.

Autorizaciones

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

Cabeceras

Idempotency-Keystring

Identificador único de la petición, elegido por el cliente (sirve un UUID). Entre 1 y 255 caracteres: una cabecera vacía se rechaza con 400 validation_error, porque el cliente se creería protegido. Repetir la misma clave con el MISMO cuerpo en 24 h devuelve la respuesta guardada sin volver a ejecutar, con la cabecera Idempotent-Replay: true. Con un cuerpo DISTINTO devuelve 422. Es la forma segura de reintentar tras un tiempo de espera de red.

Límites: longitud mín. 1, longitud máx. 255

Ejemplo:"9f1c2f4e-3a5b-4f6d-8e7a-0b1c2d3e4f5a"

If-Matchstring

Bloqueo optimista: el ETag que leíste del recurso (o *). Si el recurso ha cambiado desde entonces, la escritura se rechaza con 412 precondition_failed antes de hacer nada; léelo de nuevo y reintenta. Sin la cabecera, la escritura siempre se realiza.

Ejemplo:"\"3sT3d9pBvZq4h2N0w8x1YkLmQ7c\""

Parámetros de ruta

proformaIdstringObligatorio

Identificador de la proforma.

Límites: longitud mín. 1

Cuerpo

application/json

Esquema del cuerpo: ProformaStatusBody

statusstringObligatorio

Nuevo estado comercial: pending (a la espera de respuesta), confirmed (aceptado por el cliente) o cancelled (rechazado o cancelado).

Opciones disponibles: pending, confirmed, cancelled

notesstring

Nota guardada en el historial del documento junto con el cambio de estado.

Límites: longitud máx. 1000

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 · Idempotent-Replay

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.

Límites: patrón ^-?\d+\.\d{2}$

data.discountTotalstring

Total de descuentos, como cadena decimal.

Límites: patrón ^-?\d+\.\d{2}$

data.taxesPricestring

Total de impuestos, como cadena decimal.

Límites: patrón ^-?\d+\.\d{2}$

data.netPricestring

Base imponible, como cadena decimal.

Límites: patrón ^-?\d+\.\d{2}$

data.grossPricestring

Total con impuestos, como cadena decimal.

Límites: patrón ^-?\d+\.\d{2}$

data.totalPaidstring | null

Pagos anticipados recibidos contra la proforma, como cadena decimal; null si no consta ninguno.

Límites: patrón ^-?\d+\.\d{2}$

data.createdAtstring<date-time>

Fecha de creación en ISO 8601 UTC.

data.updatedAtstring<date-time>

Fecha de la última modificación en ISO 8601 UTC.

metaobject

Información adicional sobre la respuesta.

Mostrar atributos hijos
meta.warningsobject[]

Avisos del ciclo de vida; solo aparecen cuando la operación está obsoleta.

Mostrar atributos hijos
meta.warnings.codestring

Código de aviso estable.

Opciones disponibles: deprecated

meta.warnings.messagestring

Para personas: qué está obsoleto, hasta cuándo y qué usar.

meta.warnings.sunsetstring

Día (YYYY-MM-DD) en que la operación deja de estar disponible.

meta.warnings.replacementstring | null

operationId de la operación que hay que usar en su lugar, o null si no hay ninguna.

Errores

EstadoCódigosSignificado
400validation_errorConsulta o cuerpo mal formados. errors[] enumera cada campo erróneo con su código estable.
402addon_requiredEl plan de la cuenta no incluye el add-on que necesita esta operación; requiredAddon lo nombra.
404not_foundNo existe o queda fuera del alcance de la clave de API.
409conflictEl estado actual del recurso impide la operación, ya hay en curso una petición con esa Idempotency-Key, u otra escritura condicional (If-Match) retuvo el recurso durante más de cinco segundos. errors[0].code indica cuál: in_progress y lock_timeout se resuelven reintentando; invalid_state no, porque el estado del recurso prohíbe la operación.
412precondition_failedLa etiqueta de entidad If-Match no coincide con la representación actual. Vuelve a leer el recurso y reintenta.
422idempotency_key_reusedLa misma clave se usó antes con un cuerpo distinto. Cambia la clave.

401, 403, 429, 500 los puede devolver cualquier operación. Errores

Obsolescencia

Esta operación no está obsoleta. Las obsolescencias se anuncian con la cabecera Deprecation y una fecha de retirada. Política de versiones

  • Finanzas

    Proforma

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