Supplier invoices

List supplier invoices

Returns the invoices received from suppliers, cursor-paginated, with the same compact card as the detail read.

Tool
filmo_supplier_invoices_list
Access: Read

Result

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

generated from the schema

Filter by status within the purchasing cycle, supplier contact, linked sales order, project, invoice date and due date. Sorted by invoice date, most recent first.

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, invoiceDate, dueDate. Defaults to "-invoiceDate". 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

statusstring

Filter by status within the purchasing cycle: draft, validated or voided.

Available options: draft, validated, voided

statusesstring[]

Filter by status, 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: draft, validated, voided

Limits: min 1 items, max 50 items

contactIdstring

Filter by identifier of the supplier contact that issued the invoice.

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 sales order the invoice is linked to.

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, 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, 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

Supplier invoice identifier.

supplierInvoiceNumberstring | null

Number the supplier put on the invoice; null if it was not recorded.

statusstring

Status of the invoice within the purchasing cycle.

createdAtstring<date-time>

Creation date in ISO 8601 UTC.

updatedAtstring<date-time>

Last modification date in ISO 8601 UTC.

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/supplier-invoices.

  • Supplier invoices

    List supplier invoices

    Returns the invoices received from suppliers, cursor-paginated, with the same compact card as the detail read.

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