*REST API › Objects › Rentals*

# Order

> The order, as returned by the API.

A rental order: its contact, project, dates, totals and status. `status` carries the raw status, while the `status` filter of the list uses operational buckets (see the statuses of the API). Reading an order by id uses the tenancy inherited from the parent account, but the list is bounded to the subscription that owns the key. [`externalReference`](https://docs.filmo.io/rest-api/objects/order#response-externalReference) is readable but not writable through the API. Archived orders are invisible: no list returns them and their GET answers 404. Restore one with [`PUT /api/v1/orders/{orderId}/archive`](https://docs.filmo.io/rest-api/endpoint-reference/orders/archive-or-restore-an-order) and `archived: false`. The lines are read with [`GET /api/v1/orders/{orderId}/lines`](https://docs.filmo.io/rest-api/endpoint-reference/orders/list-the-lines-of-an-order). The detail read, [`GET /api/v1/orders/{orderId}`](https://docs.filmo.io/rest-api/endpoint-reference/orders/get-an-order), adds the billing and shipping addresses, the contact person and the quotes, invoices and proformas of the order.

Schemas: `OrderDto`, `OrderDetailDto`

## Attributes

| Name | Type | Description |
| --- | --- | --- |
| `id` | string | Unique order identifier. |
| `orderNumber` | string | Human-readable order number. |
| `externalReference` | string | External reference of the order (for example, from the customer system); null if not recorded. |
| `status` | string | Raw order status as stored in the database (12 values): draft, reserved, prepared_partially, prepared, picked_up_partially, picked_up, returned_partially, returned, checked_in_partially, checked_in, archived or cancelled. `archived` is part of the stored set but an archived order is not visible to the API, so you will not observe it. `draft`, `reserved`, `prepared_partially`, `prepared`, `picked_up_partially`, `picked_up`, `returned_partially`, `returned`, `checked_in_partially`, `checked_in`, `archived`, `cancelled` |
| `startDate` | string<date-time> | Start of the rental period in ISO 8601 with offset. |
| `endDate` | string<date-time> | End of the rental period in ISO 8601 with offset. |
| `rentalDays` | number | Number of billable rental days; null if not calculated. |
| `projectId` | string | Identifier of the project the order belongs to; null if not linked. |
| `projectName` | string | Name of the project the order belongs to; null if not linked. |
| `contact` | object | Compact reference to the order contact; null if none. |
| `contact.id` | string | Unique contact identifier. |
| `contact.name` | string | Contact name. |
| `itemsCount` | integer | Number of items in the order. |
| `subTotalPrice` | string | Subtotal before discounts and taxes, as a decimal string "1234.50" (ROUND_HALF_UP). |
| `discountTotal` | string | Total discounts as a decimal string "1234.50" (ROUND_HALF_UP); null if there is no discount. |
| `insuranceTotal` | string | Insurance total as a decimal string "1234.50" (ROUND_HALF_UP). |
| `depositTotal` | string | Deposit total as a decimal string "1234.50" (ROUND_HALF_UP). |
| `taxesPrice` | string | Tax total as a decimal string "1234.50" (ROUND_HALF_UP). |
| `netPrice` | string | Taxable base (net before taxes) as a decimal string "1234.50" (ROUND_HALF_UP). |
| `grossPrice` | string | Total including taxes, as a decimal string "1234.50" (ROUND_HALF_UP). |
| `tags` | object[] | Tags attached to the order, with their identifier and name. |
| `tags.id` | string | Unique identifier of the tag. |
| `tags.name` | string | Tag name. |
| `customFields` | object<string, any> | Custom field values by custom field identifier; the definitions are in `/api/v1/custom-fields`. |
| `source` | string | Source the order was created from (for example web, mobile, admin); null if not recorded. |
| `createdAt` | string<date-time> | Creation date in ISO 8601 with offset. |
| `updatedAt` | string<date-time> | Last update date in ISO 8601 with offset. |
| `billingAddress` | object | Billing address of the order; null if none. |
| `billingAddress.label` | string | Descriptive label of the address; null if not recorded. |
| `billingAddress.addressLine1` | string | First address line; null if not recorded. |
| `billingAddress.addressLine2` | string | Second address line; null if not recorded. |
| `billingAddress.city` | string | City; null if not recorded. |
| `billingAddress.province` | string | Province or region; null if not recorded. |
| `billingAddress.postcode` | string | Postal code; null if not recorded. |
| `billingAddress.country` | string | Country; null if not recorded. |
| `shippingAddress` | object | Shipping address of the order; null if none. |
| `shippingAddress.label` | string | Descriptive label of the address; null if not recorded. |
| `shippingAddress.addressLine1` | string | First address line; null if not recorded. |
| `shippingAddress.addressLine2` | string | Second address line; null if not recorded. |
| `shippingAddress.city` | string | City; null if not recorded. |
| `shippingAddress.province` | string | Province or region; null if not recorded. |
| `shippingAddress.postcode` | string | Postal code; null if not recorded. |
| `shippingAddress.country` | string | Country; null if not recorded. |
| `contactPerson` | object | Contact person linked to the order; null if none. |
| `contactPerson.id` | string | Unique contact identifier. |
| `contactPerson.name` | string | Contact name. |
| `quotes` | object[] | Informational references to quotes generated from the order. |
| `quotes.id` | string | Unique identifier of the referenced document. |
| `quotes.number` | string | Document number; null until it is numbered. |
| `quotes.status` | string | Document status at the time the reference was written; null if not recorded. Informational: it may be out of date. |
| `invoices` | object[] | Informational references to invoices generated from the order. |
| `invoices.id` | string | Unique identifier of the referenced document. |
| `invoices.number` | string | Document number; null until it is numbered. |
| `invoices.status` | string | Document status at the time the reference was written; null if not recorded. Informational: it may be out of date. |
| `proformas` | object[] | Informational references to proformas generated from the order. |
| `proformas.id` | string | Unique identifier of the referenced document. |
| `proformas.number` | string | Document number; null until it is numbered. |
| `proformas.status` | string | Document status at the time the reference was written; null if not recorded. Informational: it may be out of date. |

## Values

| Field | Values |
| --- | --- |
| `status` | `draft`, `reserved`, `prepared_partially`, `prepared`, `picked_up_partially`, `picked_up`, `returned_partially`, `returned`, `checked_in_partially`, `checked_in`, `archived`, `cancelled` |

## Example

*Order · Generated from the schema*

```json
{
  "id": "id_8f2a1c",
  "orderNumber": "string",
  "externalReference": "string",
  "status": "draft",
  "startDate": "2026-09-01T08:00:00Z",
  "endDate": "2026-09-01T08:00:00Z",
  "rentalDays": 1,
  "projectId": "string",
  "projectName": "Example",
  "contact": {
    "id": "id_8f2a1c",
    "name": "Example"
  },
  "itemsCount": 1,
  "subTotalPrice": "1234.50",
  "discountTotal": "1234.50",
  "insuranceTotal": "1234.50",
  "depositTotal": "1234.50",
  "taxesPrice": "1234.50",
  "netPrice": "1234.50",
  "grossPrice": "1234.50",
  "tags": [
    {
      "id": "id_8f2a1c",
      "name": "Example"
    }
  ],
  "customFields": {
    "key": "string"
  },
  "source": "string",
  "createdAt": "2026-09-01T08:00:00Z",
  "updatedAt": "2026-09-01T08:00:00Z",
  "billingAddress": {
    "label": "Example",
    "addressLine1": "string",
    "addressLine2": "string",
    "city": "string",
    "province": "string",
    "postcode": "string",
    "country": "ES"
  },
  "shippingAddress": {
    "label": "Example",
    "addressLine1": "string",
    "addressLine2": "string",
    "city": "string",
    "province": "string",
    "postcode": "string",
    "country": "ES"
  },
  "contactPerson": {
    "id": "id_8f2a1c",
    "name": "Example"
  },
  "quotes": [
    {
      "id": "id_8f2a1c",
      "number": "string",
      "status": "string"
    }
  ],
  "invoices": [
    {
      "id": "id_8f2a1c",
      "number": "string",
      "status": "string"
    }
  ],
  "proformas": [
    {
      "id": "id_8f2a1c",
      "number": "string",
      "status": "string"
    }
  ]
}
```

## Returned by

- [`GET /api/v1/orders`](https://docs.filmo.io/rest-api/endpoint-reference/orders/list-orders) — List orders
- [`GET /api/v1/orders/{orderId}`](https://docs.filmo.io/rest-api/endpoint-reference/orders/get-an-order) — Get an order

## Modified by

- [`POST /api/v1/orders`](https://docs.filmo.io/rest-api/endpoint-reference/orders/create-an-order) — Create an order
- [`PATCH /api/v1/orders/{orderId}`](https://docs.filmo.io/rest-api/endpoint-reference/orders/update-the-header-of-an-order) — Update the header of an order
- [`POST /api/v1/orders/{orderId}/cancel`](https://docs.filmo.io/rest-api/endpoint-reference/orders/cancel-an-order) — Cancel an order
- [`POST /api/v1/orders/{orderId}/reserve`](https://docs.filmo.io/rest-api/endpoint-reference/orders/reserve-an-order) — Reserve an order
- [`POST /api/v1/orders/{orderId}/unreserve`](https://docs.filmo.io/rest-api/endpoint-reference/orders/unreserve-an-order) — Unreserve an order

---

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