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.

Herramienta
filmo_proformas_update_status
Acceso: Escritura

Resultado

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "filmo_proformas_update_status",
    "arguments": {
      "proformaId": "prof_8f2a1c",
      "status": "pending"
    }
  }
}

generado desde el 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.

Argumentos

proformaIdstringObligatorio

Identificador de la proforma.

Límites: longitud mín. 1

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

idempotencyKeystring

Clave de idempotencia elegida por el cliente (se recomienda un UUID). Repetir la misma clave con los mismos argumentos en 24 h devuelve la respuesta almacenada sin volver a ejecutar; con argumentos distintos responde 422. Es la forma segura de reintentar tras un fallo de red.

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

ifMatchstring

Bloqueo optimista: el meta.etag que obtuviste de la lectura de detalle de este recurso (o "*"). Si el recurso ha cambiado desde entonces, la llamada falla con 412 precondition_failed antes de escribir nada; léelo de nuevo y reintenta. Omítelo para escribir sin condiciones.

Límites: longitud mín. 1

Resultado

En un éxito el resultado lleva structuredContent con data y meta. Estos son los atributos de data.

Ver los atributos de data
idstring

Identificador de la proforma.

proformaNumberstring | null

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

statusstring

Estado del ciclo de vida del documento.

operativeStatusstring | null

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

issueDatestring<date-time> | null

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

currencystring

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

contactobject | null

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

Mostrar atributos hijos
contact.idstring

Identificador del contacto.

contact.namestring

Nombre del contacto.

orderIdstring | null

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

orderNumberstring | null

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

projectIdstring | null

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

subTotalstring

Subtotal antes de descuentos e impuestos, como cadena decimal.

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

discountTotalstring

Total de descuentos, como cadena decimal.

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

taxesPricestring

Total de impuestos, como cadena decimal.

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

netPricestring

Base imponible, como cadena decimal.

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

grossPricestring

Total con impuestos, como cadena decimal.

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

totalPaidstring | null

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

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

createdAtstring<date-time>

Fecha de creación en ISO 8601 UTC.

updatedAtstring<date-time>

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

Un error es un resultado con isError: true y el problema en content[0].text; no hay structuredContent. Consulta Errores.

La misma operación por REST

Esta herramienta ejecuta PATCH /api/v1/proformas/{proformaId}/status.

  • 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.

  • Guías

    Escrituras seguras

    Un asistente que puede escribir también puede escribir lo equivocado. Decide qué herramientas necesitan a una persona, reintenta sin duplicar y sabe qué pone en marcha una escritura.

  • Guías

    Errores

    Un error de herramienta es un resultado con isError: true y el problema en el primer bloque de texto. Ramifica por su code.