Invoices

List the lines of an invoice

Returns what was invoiced, line by line, with its quantity and its price.

Tool

filmo_invoices_lines_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_lines_list",
    "arguments": {
      "invoiceId": "invo_8f2a1c",
      "limit": 20
    }
  }
}

{
  "structuredContent": {
    "data": [
      {
        "id": "id_8f2a1c",
        "resourceType": "item",
        "transactionType": "rental",
        "position": 1,
        "itemId": "item_8f2a1c",
        "itemName": "Example",
        "variantId": "vari_8f2a1c",
        "variantName": "Example",
        "quantity": 1,
        "orderId": "orde_8f2a1c",
        "orderNumber": "<orderNumber>",
        "startDate": "2026-09-01T08:00:00Z",
        "endDate": "2026-09-01T08:00:00Z",
        "rentalDays": 1,
        "unitPrice": "1234.50",
        "linePrice": "1234.50",
        "free": true,
        "notes": "<notes>"
      }
    ],
    "pagination": {
      "nextCursor": "eyJvIjo1MH0",
      "hasMore": true,
      "total": 1
    },
    "meta": {
      "rateLimit": {
        "limit": 120,
        "remaining": 119,
        "reset": 42
      },
      "etag": "\"3sT3d9pBvZq4h2N0w8x1YkLmQ7c\""
    }
  }
}

generated from the schema

The names are the ones FROZEN when the invoice was issued and may differ from the current catalog: the document is a snapshot. It emits no per-line tax configuration; the invoice totals already carry the calculated taxes. Lines come in document order.

Arguments

invoiceIdstringRequired

Invoice identifier.

Limits: min length 1

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: position, itemName, quantity, startDate, endDate, rentalDays, unitPrice, linePrice, resourceType, transactionType. Defaults to "position". 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

includeTotalbooleandefault:false

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

Result

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

Show the attributes of data

idstring

Unique identifier of the line within the document.

resourceTypestring

Resource type of the line. Lines of type section and type_group are presentation groupings with no associated resource.

Available options: item, kit, space, vehicle, personnel, service, custom, section, type_group

transactionTypestring

Nature of the line: rental or sale.

Available options: rental, sale

positioninteger

Display position of the line within the document, starting at 0.

itemIdstring | null

Catalog item identifier; null if the line is not of type item.

itemNamestring | null

Item name as it was WHEN THE DOCUMENT WAS ISSUED. It may differ from the current item name in the catalog: the document is a snapshot.

variantIdstring | null

Variant identifier; null if not applicable.

variantNamestring | null

Variant name frozen in the snapshot; null if not applicable.

quantitynumber

Units invoiced or quoted on the line.

orderIdstring | null

Order the line comes from; null if it was added directly to the document.

orderNumberstring | null

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

startDatestring<date-time> | null

Start of the invoiced period in ISO 8601 UTC; null if the line has no period.

endDatestring<date-time> | null

End of the invoiced period in ISO 8601 UTC; null if the line has no period.

rentalDaysnumber | null

Invoiced rental days; null if not applicable.

unitPricestring | null

Net unit price as a decimal string "1234.50"; null if the line has no price of its own.

Limits: pattern ^-?\d+\.\d{2}$

linePricestring | null

Net amount of the line as a decimal string "1234.50"; null if not calculated.

Limits: pattern ^-?\d+\.\d{2}$

freeboolean

true if the line is explicitly billed at zero.

notesstring | null

Line notes; null if none.

An error is a result with isError: true and the problem in content[0].text; there is no structuredContent. See Errors.

The same operation by REST

This tool runs GET /api/v1/invoices/{invoiceId}/lines.

Invoices
List the lines of an invoice
Returns what was invoiced, line by line, with its quantity and its price.
Guides
Safe writes
An assistant that can write can also write the wrong thing. Decide which tools need a person, retry without duplicating, and know what a write sets in motion.
Guides
Errors
A tool error is a result with isError: true and the problem in the first text block. Branch on its code.

Was this page helpful?

Result

Arguments

Result

The same operation by REST

Related pages

List the lines of an invoice

Safe writes

Errors