*REST API › Objects › Rentals*

# Subrent

> Material rented from another company to cover a job.

Material rented from another company to cover a job, with its dates, status, notes and the link to its purchase order. What is paid to the supplier is not published. Subrents are bounded to the subscription that owns the key.

Schemas: `SubrentDto`

## Attributes

| Name | Type | Description |
| --- | --- | --- |
| `id` | string | Unique subrent identifier. |
| `type` | string | bulk if it is a quantity of a bulk item, serialized if it is a specific unit. `bulk`, `serialized` |
| `status` | string | Subrent status. `pending`, `active`, `completed`, `cancelled` |
| `itemId` | string | Identifier of the subrented item. |
| `itemName` | string | Name of the subrented item. |
| `itemSku` | string | Item SKU; null if it has none. |
| `quantity` | number | Subrented units; null if it is a specific unit. |
| `serializedItemId` | string | Identifier of the specific unit; null if bulk. |
| `serializedItemCode` | string | Code of the specific unit; null if bulk. |
| `providerId` | string | Identifier of the supplier that lends the material; null if not decided yet. |
| `providerName` | string | Supplier name; null if not decided yet. |
| `needResolved` | boolean | true if the need is already covered, that is, if the supplier and material are confirmed. |
| `startDate` | string<date-time> | Start of the required period in ISO 8601 UTC; null if not set. |
| `endDate` | string<date-time> | End of the required period in ISO 8601 UTC; null if not set. |
| `pickupDate` | string<date-time> | Pickup date from the supplier in ISO 8601 UTC; null if not set. |
| `returnDate` | string<date-time> | Return date to the supplier in ISO 8601 UTC; null if not set. |
| `orderId` | string | Order that motivates the subrent; null if it has none. |
| `projectId` | string | Associated project; null if it has none. |
| `purchaseOrderId` | string | Purchase order that formalizes it; null if none has been issued. |
| `spaceId` | string | Warehouse where the material is received; null if not applicable. |
| `notes` | string | Subrent notes; null if it has none. |
| `createdAt` | string<date-time> | Creation date in ISO 8601 UTC. |
| `updatedAt` | string<date-time> | Last modification date in ISO 8601 UTC. |

## Values

| Field | Values |
| --- | --- |
| `type` | `bulk`, `serialized` |
| `status` | `pending`, `active`, `completed`, `cancelled` |

## Example

*Subrent · Generated from the schema*

```json
{
  "id": "id_8f2a1c",
  "type": "bulk",
  "status": "pending",
  "itemId": "string",
  "itemName": "Example",
  "itemSku": "string",
  "quantity": 1,
  "serializedItemId": "string",
  "serializedItemCode": "string",
  "providerId": "string",
  "providerName": "Example",
  "needResolved": true,
  "startDate": "2026-09-01T08:00:00Z",
  "endDate": "2026-09-01T08:00:00Z",
  "pickupDate": "2026-09-01T08:00:00Z",
  "returnDate": "2026-09-01T08:00:00Z",
  "orderId": "string",
  "projectId": "string",
  "purchaseOrderId": "string",
  "spaceId": "string",
  "notes": "string",
  "createdAt": "2026-09-01T08:00:00Z",
  "updatedAt": "2026-09-01T08:00:00Z"
}
```

## Returned by

- [`GET /api/v1/subrents`](https://docs.filmo.io/rest-api/endpoint-reference/subrents/list-subrents) — List subrents
- [`GET /api/v1/subrents/{subrentId}`](https://docs.filmo.io/rest-api/endpoint-reference/subrents/get-a-subrent) — Get a subrent

## Modified by

- [`PATCH /api/v1/subrents/{subrentId}`](https://docs.filmo.io/rest-api/endpoint-reference/subrents/update-a-subrent) — Update a subrent

---

Canonical URL: https://docs.filmo.io/rest-api/objects/subrent  
Last updated: 2026-10-25