Proformas

List proformas

Returns the proformas of the account, cursor-paginated, with the same card as the detail read: number, lifecycle and commercial status, customer (id and name), source order, project, currency and amounts.

Tool

filmo_proformas_list

Readinvoices:read

invoices:read
120/min
Server annotation: Read-only
Server annotation: Idempotent

{
  "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
      }
    }
  }
}

generated from the schema

Lines, addresses and notes are not published. Filter by commercial status (pending, confirmed, cancelled), contact, source order, project and issue date. Sorted by issue date, most recent first. It shares scope with invoices because a proforma is the invoice that is not one yet.

Arguments

limitintegerdefault:50

Page size (1-500). Defaults to 50.

Limits: min 1, max 500

cursorstring

Opaque cursor of the page to return. Pass the value of pagination.nextCursor from the previous response; treat it as opaque.

Limits: max length 200

sortstring

Sort order: up to 3 comma-separated fields, each with a leading "-" for descending (e.g. "-updatedAt,name"). Sortable fields: createdAt, updatedAt, issueDate, proformaNumber. Defaults to "-issueDate". Ties are broken by id, so the order is stable across pages, and a cursor is bound to the sort it was issued with.

Limits: max length 200

operativeStatusstring

Filter by commercial status: pending (awaiting an answer), confirmed (accepted by the customer) or cancelled (rejected or cancelled).

Available options: pending, confirmed, cancelled

operativeStatusesstring[]

Filter by operativeStatus, as a list: repeat the parameter or separate the values with commas. Accepts up to 50 values and returns whatever matches any of them.

Available options: pending, confirmed, cancelled

Limits: min 1 items, max 50 items

contactIdstring

Filter by identifier of the contact the proforma is issued to.

Limits: min length 1, max length 100

contactIdsstring[]

Filter by contactId, as a list: repeat the parameter or separate the values with commas. Accepts up to 50 values and returns whatever matches any of them.

Limits: min 1 items, max 50 items, each min length 1, each max length 100

orderIdstring

Filter by identifier of the source order of the proforma.

Limits: min length 1, max length 100

orderIdsstring[]

Filter by orderId, as a list: repeat the parameter or separate the values with commas. Accepts up to 50 values and returns whatever matches any of them.

Limits: min 1 items, max 50 items, each min length 1, each max length 100

projectIdstring

Filter by identifier of the project linked to the proforma, directly or through its order.

Limits: min length 1, max length 100

projectIdsstring[]

Filter by projectId, as a list: repeat the parameter or separate the values with commas. Accepts up to 50 values and returns whatever matches any of them.

Limits: min 1 items, max 50 items, each min length 1, each max length 100

includeTotalbooleandefault:false

Set it to true to include pagination.total, the number of results that match the filters across all pages. Off by default.

dateFiltersobject

Date filters by field. A bare day (YYYY-MM-DD) is read in the business timezone; an ISO 8601 instant with offset is applied as is by gte, lte, gt and lt, while on widens it to the whole business day that contains it. Fields: created, issueDate, updated.

Show child attributes

dateFilters.createdobject

Show child attributes

dateFilters.created.gtestring

From this day or instant, inclusive.

dateFilters.created.ltestring

Up to this day or instant, inclusive.

dateFilters.created.gtstring

Strictly after; a bare day means after the end of that day.

dateFilters.created.ltstring

Strictly before; a bare day means before the start of that day.

dateFilters.created.onstring

Exactly that day; an instant means the whole business day that contains it.

dateFilters.issueDateobject

Show child attributes

dateFilters.issueDate.gtestring

From this day or instant, inclusive.

dateFilters.issueDate.ltestring

Up to this day or instant, inclusive.

dateFilters.issueDate.gtstring

Strictly after; a bare day means after the end of that day.

dateFilters.issueDate.ltstring

Strictly before; a bare day means before the start of that day.

dateFilters.issueDate.onstring

Exactly that day; an instant means the whole business day that contains it.

dateFilters.updatedobject

Show child attributes

dateFilters.updated.gtestring

From this day or instant, inclusive.

dateFilters.updated.ltestring

Up to this day or instant, inclusive.

dateFilters.updated.gtstring

Strictly after; a bare day means after the end of that day.

dateFilters.updated.ltstring

Strictly before; a bare day means before the start of that day.

dateFilters.updated.onstring

Exactly that day; an instant means the whole business day that contains it.

Result

On success the result carries structuredContent with data and meta. These are the attributes of data.

Show the attributes of data

idstring

Proforma identifier.

proformaNumberstring | null

Proforma number; null while it is a draft.

statusstring

Document lifecycle status.

operativeStatusstring | null

Commercial status: pending (awaiting an answer), confirmed (accepted by the customer) or cancelled; null if not recorded.

issueDatestring<date-time> | null

Issue date in ISO 8601 UTC; null while it has none.

currencystring

Currency of the amounts, as an ISO 4217 code.

contactobject | null

Contact the proforma is issued to; null if not recorded.

Show child attributes

contact.idstring

Contact identifier.

contact.namestring

Contact name.

orderIdstring | null

Source order of the proforma; null if it does not come from one.

orderNumberstring | null

Number of that order; null if it does not come from one.

projectIdstring | null

Project linked to the proforma; null if none.

subTotalstring

Subtotal before discounts and taxes, as a decimal string.