Rentals

Order

The order, as returned by the API.

Schemas: OrderDto, OrderDetailDto

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

Generated from the schema

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 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 and archived: false. The lines are read with GET /api/v1/orders/{orderId}/lines. The detail read, GET /api/v1/orders/{orderId}, adds the billing and shipping addresses, the contact person and the quotes, invoices and proformas of the order.

Attributes

idstring

Unique order identifier.

orderNumberstring

Human-readable order number.

externalReferencestring | null

External reference of the order (for example, from the customer system); null if not recorded.

statusstring

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.

Available options: draft, reserved, prepared_partially, prepared, picked_up_partially, picked_up, returned_partially, returned, checked_in_partially, checked_in, archived, cancelled

startDatestring<date-time>

Start of the rental period in ISO 8601 with offset.

endDatestring<date-time>

End of the rental period in ISO 8601 with offset.

rentalDaysnumber | null

Number of billable rental days; null if not calculated.

projectIdstring | null

Identifier of the project the order belongs to; null if not linked.

projectNamestring | null

Name of the project the order belongs to; null if not linked.

contactobject | null

Compact reference to the order contact; null if none.

Show child attributes

contact.idstring

Unique contact identifier.

contact.namestring

Contact name.

itemsCountinteger

Number of items in the order.

subTotalPricestring

Subtotal before discounts and taxes, as a decimal string "1234.50" (ROUND_HALF_UP).