Filmo Docs
Español

Subrents

List subrents

Returns the material rented from other companies to cover a job: what was brought in, from whom and for which order.

Tool
filmo_subrents_list
Access: Read

Result

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

generated from the schema

It answers "of this order, what is mine and what did I have to bring in". It does not emit what is paid to the supplier.

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, startDate, endDate, pickupDate, returnDate, status, type, quantity. 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

statusstring

Filter by subrent status.

Available options: pending, active, completed, cancelled

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: pending, active, completed, cancelled

Limits: min 1 items, max 50 items

typestring

Filter by type: bulk (quantity of a bulk item) or serialized (a specific unit).

Available options: bulk, serialized

typesstring[]

Filter by type, 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: bulk, serialized

Limits: min 1 items, max 50 items

orderIdstring

Filter by the order that motivates it.

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 associated project.

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

itemIdstring

Filter by subrented item.

Limits: min length 1, max length 100

itemIdsstring[]

Filter by itemId, 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, return, 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.returnobject

Show child attributes
dateFilters.return.gtestring

From this day or instant, inclusive.

dateFilters.return.ltestring

Up to this day or instant, inclusive.

dateFilters.return.gtstring

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

dateFilters.return.ltstring

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

dateFilters.return.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 subrent identifier.

typestring

bulk if it is a quantity of a bulk item, serialized if it is a specific unit.

Available options: bulk, serialized

statusstring

Subrent status.

Available options: pending, active, completed, cancelled

itemIdstring

Identifier of the subrented item.

itemNamestring

Name of the subrented item.

itemSkustring | null

Item SKU; null if it has none.

quantitynumber | null

Subrented units; null if it is a specific unit.

serializedItemIdstring | null

Identifier of the specific unit; null if bulk.

serializedItemCodestring | null

Code of the specific unit; null if bulk.

providerIdstring | null

Identifier of the supplier that lends the material; null if not decided yet.

providerNamestring | null

Supplier name; null if not decided yet.

needResolvedboolean

true if the need is already covered, that is, if the supplier and material are confirmed.

startDatestring<date-time> | null

Start of the required period in ISO 8601 UTC; null if not set.

endDatestring<date-time> | null

End of the required period in ISO 8601 UTC; null if not set.

pickupDatestring<date-time> | null

Pickup date from the supplier in ISO 8601 UTC; null if not set.

returnDatestring<date-time> | null

Return date to the supplier in ISO 8601 UTC; null if not set.

orderIdstring | null

Order that motivates the subrent; null if it has none.

projectIdstring | null

Associated project; null if it has none.

purchaseOrderIdstring | null

Purchase order that formalizes it; null if none has been issued.

spaceIdstring | null

Warehouse where the material is received; null if not applicable.

notesstring | null

Subrent notes; null if it has none.

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/subrents.

Related pages

Link to this section: Related pages

  • Subrents

    List subrents

    Returns the material rented from other companies to cover a job: what was brought in, from whom and for which order.

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

Cookies

If you accept, we use Google cookies to measure visits and show you ads. Privacy policy

More information

With your consent we use Google Ads and Google Analytics cookies to measure which campaigns bring visitors and requests, and to show you Filmo ads on other sites. Without acceptance, Google receives cookieless measurement signals, including your IP address, browser information and a cleaned page URL. Your choice is shared with the Filmo app.