Proformas

Listar proformas

Devuelve las proformas de la cuenta, paginadas por cursor, con la misma ficha que la lectura de detalle: número, estado del ciclo de vida y comercial, cliente (id y nombre), pedido de origen, proyecto, divisa e importes.

Herramienta

filmo_proformas_list

Lecturainvoices:read

invoices:read
120/min
Anotación del servidor: Solo lectura
Anotación del servidor: Idempotente

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "filmo_proformas_list",
    "arguments": {
      "limit": 20
    }
  }
}

{
  "structuredContent": {
    "data": [
      {
        "id": "id_8f2a1c",
        "proformaNumber": "<proformaNumber>",
        "status": "<status>",
        "operativeStatus": "<operativeStatus>",
        "issueDate": "2026-09-01T08:00:00Z",
        "currency": "EUR",
        "contact": {
          "id": "id_8f2a1c",
          "name": "Example"
        },
        "orderId": "orde_8f2a1c",
        "orderNumber": "<orderNumber>",
        "projectId": "proj_8f2a1c",
        "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"
      }
    ],
    "pagination": {
      "nextCursor": "eyJvIjo1MH0",
      "hasMore": true,
      "total": 1
    },
    "meta": {
      "rateLimit": {
        "limit": 120,
        "remaining": 119,
        "reset": 42
      }
    }
  }
}

generado desde el esquema

Las líneas, las direcciones y las notas no se publican. Filtra por estado comercial (pending, confirmed, cancelled), contacto, pedido de origen, proyecto y fecha de emisión. Ordenadas por fecha de emisión, las más recientes primero. Comparte scope con las facturas porque una proforma es la factura que todavía no lo es.

Argumentos

limitintegerpredeterminado:50

Tamaño de página (1-500). Por defecto es 50.

Límites: mín. 1, máx. 500

cursorstring

Cursor opaco de la página que se devuelve. Pasa el valor de pagination.nextCursor de la respuesta anterior; trátalo como opaco.

Límites: longitud máx. 200

sortstring

Orden: hasta 3 campos separados por comas, cada uno con un "-" inicial para descendente (p. ej. "-updatedAt,name"). Campos ordenables: createdAt, updatedAt, issueDate, proformaNumber. Por defecto, "-issueDate". Los empates se resuelven por id, así que el orden es estable entre páginas, y un cursor queda ligado al orden con el que se emitió.

Límites: longitud máx. 200

operativeStatusstring

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

Opciones disponibles: pending, confirmed, cancelled

operativeStatusesstring[]

Filtra por operativeStatus, como lista: repite el parámetro o separa los valores con comas. Acepta hasta 50 valores y devuelve lo que coincida con cualquiera de ellos.

Opciones disponibles: pending, confirmed, cancelled

Límites: mín. 1 elementos, máx. 50 elementos

contactIdstring

Filtra por identificador del contacto al que se emite la proforma.

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

contactIdsstring[]

Filtra por contactId, como lista: repite el parámetro o separa los valores con comas. Acepta hasta 50 valores y devuelve lo que coincida con cualquiera de ellos.

Límites: mín. 1 elementos, máx. 50 elementos, cada uno: longitud mín. 1, cada uno: longitud máx. 100

orderIdstring

Filtra por identificador del pedido de origen de la proforma.

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

orderIdsstring[]

Filtra por orderId, como lista: repite el parámetro o separa los valores con comas. Acepta hasta 50 valores y devuelve lo que coincida con cualquiera de ellos.

Límites: mín. 1 elementos, máx. 50 elementos, cada uno: longitud mín. 1, cada uno: longitud máx. 100

projectIdstring

Filtra por identificador del proyecto vinculado a la proforma, directamente o a través de su pedido.

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

projectIdsstring[]

Filtra por projectId, como lista: repite el parámetro o separa los valores con comas. Acepta hasta 50 valores y devuelve lo que coincida con cualquiera de ellos.

Límites: mín. 1 elementos, máx. 50 elementos, cada uno: longitud mín. 1, cada uno: longitud máx. 100

includeTotalbooleanpredeterminado:false

Ponlo en true para incluir pagination.total, el número de resultados que coinciden con los filtros en todas las páginas. Desactivado por defecto.

dateFiltersobject

Filtros de fecha por campo. Una fecha sin hora (YYYY-MM-DD) se lee en la zona horaria del negocio; un instante ISO 8601 con desplazamiento se aplica tal cual con gte, lte, gt y lt, mientras que on lo amplía al día completo del negocio que lo contiene. Campos: created, issueDate, updated.

Mostrar atributos hijos

dateFilters.createdobject

Mostrar atributos hijos

dateFilters.created.gtestring

Desde este día o instante, inclusive.

dateFilters.created.ltestring

Hasta este día o instante, inclusive.

dateFilters.created.gtstring

Estrictamente posterior; una fecha sin hora significa después del final de ese día.

dateFilters.created.ltstring

Estrictamente anterior; una fecha sin hora significa antes del inicio de ese día.

dateFilters.created.onstring

Exactamente ese día; un instante significa toda la jornada del negocio que lo contiene.

dateFilters.issueDateobject

Mostrar atributos hijos

dateFilters.issueDate.gtestring

Desde este día o instante, inclusive.

dateFilters.issueDate.ltestring

Hasta este día o instante, inclusive.

dateFilters.issueDate.gtstring

Estrictamente posterior; una fecha sin hora significa después del final de ese día.

dateFilters.issueDate.ltstring

Estrictamente anterior; una fecha sin hora significa antes del inicio de ese día.

dateFilters.issueDate.onstring

Exactamente ese día; un instante significa toda la jornada del negocio que lo contiene.

dateFilters.updatedobject

Mostrar atributos hijos

dateFilters.updated.gtestring

Desde este día o instante, inclusive.

dateFilters.updated.ltestring

Hasta este día o instante, inclusive.

dateFilters.updated.gtstring

Estrictamente posterior; una fecha sin hora significa después del final de ese día.

dateFilters.updated.ltstring

Estrictamente anterior; una fecha sin hora significa antes del inicio de ese día.

dateFilters.updated.onstring

Exactamente ese día; un instante significa toda la jornada del negocio que lo contiene.

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.