> ## Documentation Index
> Fetch the complete documentation index at: https://api.buildingswell.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Inventory allocations

> Read-only reservations for orders and projects.

Base path: `/inventory-allocation` (relative to your instance’s `/api/v2`).

The standard list, single-record read, query, count, and group-and-count endpoints are available. Generic write routes are not registered.

## Fields

| Field               | Type         | Notes                                        |
| ------------------- | ------------ | -------------------------------------------- |
| `id`                | uuid         | Unique record ID. Read-only.                 |
| `organizationId`    | uuid         | Organization from your API key. Read-only.   |
| `createdAt`         | date-time    | Read-only.                                   |
| `updatedAt`         | date-time    | Read-only.                                   |
| `itemId`            | uuid         | Read-only.                                   |
| `deliverableId`     | uuid \| null | Read-only.                                   |
| `projectId`         | uuid \| null | Read-only.                                   |
| `quantityAllocated` | number       | Read-only.                                   |
| `quantityConsumed`  | number       | Read-only.                                   |
| `status`            | string       | `open`, `fulfilled`, `cancelled`. Read-only. |
| `isArchived`        | boolean      | Read-only.                                   |

Each reservation belongs to exactly one `deliverableId` or `projectId`. `quantityConsumed` records the used portion; statuses are `open`, `fulfilled`, and `cancelled`.

`isArchived` is an internal lifecycle flag, but this read-only model does not
hide archived rows by default. Filter with `isArchived=false` when you only want
active reservations.

Generic writes are not registered. Reserve through `POST /bom-line/order/{id}/allocate` or `POST /bom-line/project/{id}/allocate`. Consumption and release commands maintain reservations. See [BOM lines](/resources/bom-line).