Invoices

List invoices

Returns the issued invoices (invoice-type documents only), cursor-paginated.

Tool

filmo_invoices_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_invoices_list",
    "arguments": {
      "limit": 20
    }
  }
}

{
  "structuredContent": {
    "data": [
      {
        "id": "id_8f2a1c",
        "invoiceNumber": "<invoiceNumber>",
        "status": "draft",
        "isRectification": true,
        "invoiceDate": "2026-09-01T08:00:00Z",
        "dueDate": "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",
        "paymentStatus": "unpaid",
        "paymentMethod": "<paymentMethod>",
        "tags": [
          {
            "id": "id_8f2a1c",
            "name": "Example"
          }
        ],
        "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

Filter by document or payment status. Strict per-subscription tenancy.

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, invoiceNumber, invoiceDate, dueDate, subTotal, grossPrice. Defaults to "-createdAt". 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

paymentStatusstring

Filter by payment status, with the same vocabulary the paymentStatus field returns: unpaid (nothing collected yet), partially_paid, paid, overpaid (collected above the total), overdue (past due and unpaid) or voided (the document is voided).

Available options: unpaid, partially_paid, paid, overpaid, overdue, voided

paymentStatusesstring[]

Filter by paymentStatus, 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: unpaid, partially_paid, paid, overpaid, overdue, voided

Limits: min 1 items, max 50 items

contactIdstring

Filter by invoice contact identifier.

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

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

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, due, invoiceDate, 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.dueobject

Show child attributes

dateFilters.due.gtestring

From this day or instant, inclusive.

dateFilters.due.ltestring

Up to this day or instant, inclusive.

dateFilters.due.gtstring

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

dateFilters.due.ltstring

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

dateFilters.due.onstring

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

dateFilters.invoiceDateobject

Show child attributes

dateFilters.invoiceDate.gtestring

From this day or instant, inclusive.

dateFilters.invoiceDate.ltestring

Up to this day or instant, inclusive.

dateFilters.invoiceDate.gtstring

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

dateFilters.invoiceDate.ltstring

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

dateFilters.invoiceDate.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

Unique invoice identifier.

invoiceNumberstring | null

Invoice number; null while it is a draft (the number is assigned on validation).

statusstring

Document lifecycle status: draft, validated (validated and numbered) or voided.

Available options: draft, validated, voided

isRectificationboolean

Whether the invoice rectifies a previous one. Invoices created in Filmo are never rectifications, and credit notes are served by /api/v1/credit-notes; but /api/v1/invoices can still return imported rectifying documents (for example from a Rentman import) with this set to true, so deduplicate them against the credit notes by number.

invoiceDatestring<date-time> | null

Issue date in ISO 8601 with offset; null while it is a draft.

dueDatestring<date-time> | null

Due date in ISO 8601 with offset; null if not set.

currencystring

Invoice currency as an ISO 4217 code (for example "EUR").

contactobject | null

Compact reference to the invoiced contact; null if none.

Show child attributes

contact.idstring

Unique contact identifier.

contact.namestring

Contact name.

orderIdstring | null

Identifier of the source order; null if the invoice does not come from an order.

orderNumberstring | null

Number of the source order; null if the invoice does not come from an order.

projectIdstring | null

Identifier of the linked project; null if not linked.

subTotalstring

Subtotal before discounts and taxes, as a decimal string "1234.50" (ROUND_HALF_UP).