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.

Herramienta
filmo_proformas_get
Acceso: Lectura

Resultado

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

generado desde el esquema

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

Argumentos

proformaIdstringObligatorio

Identificador de la proforma.

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 GET /api/v1/proformas/{proformaId}.

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

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