Rentals

Subrent

Material rented from another company to cover a job.

Schemas: SubrentDto

{
  "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"
}

Generated from the schema

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.

Attributes

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.

Values

type: bulk, serialized
status: pending, active, completed, cancelled

Returned by

GET /api/v1/subrents — List subrents
GET /api/v1/subrents/{subrentId} — Get a subrent

Modified by

PATCH /api/v1/subrents/{subrentId} — Update a subrent

Was this page helpful?