Alquileres

Pedido

El pedido, tal como lo devuelve la API.

Esquemas: 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"
    }
  ]
}

Generado a partir del esquema

Un pedido de alquiler: su contacto, proyecto, fechas, totales y estado. status lleva el estado en bruto, mientras que el filtro status de la lista usa grupos operativos (consulta los estados de la API). Leer un pedido por id usa el aislamiento heredado de la cuenta principal, pero la lista está acotada a la suscripción que posee la clave. externalReference es legible pero no escribible a través de la API. Los pedidos archivados son invisibles: ninguna lista los devuelve y su GET responde 404. Restaura uno con PUT /api/v1/orders/{orderId}/archive y archived: false. Las líneas se leen con GET /api/v1/orders/{orderId}/lines. La lectura de detalle, GET /api/v1/orders/{orderId}, añade las direcciones de facturación y de envío, la persona de contacto y los presupuestos, facturas y proformas del pedido.

Atributos

idstring

Identificador único del pedido.

orderNumberstring

Número de pedido legible.

externalReferencestring | null

Referencia externa del pedido (por ejemplo, del sistema del cliente); null si no consta.

statusstring

Estado bruto del pedido tal como se almacena en la base de datos (12 valores): draft, reserved, prepared_partially, prepared, picked_up_partially, picked_up, returned_partially, returned, checked_in_partially, checked_in, archived o cancelled. archived forma parte del conjunto almacenado, pero un pedido archivado no es visible para la API, así que no lo observarás.

Opciones disponibles: draft, reserved, prepared_partially, prepared, picked_up_partially, picked_up, returned_partially, returned, checked_in_partially, checked_in, archived, cancelled

startDatestring<date-time>

Inicio del periodo de alquiler en ISO 8601 con desplazamiento.

endDatestring<date-time>

Fin del periodo de alquiler en ISO 8601 con desplazamiento.

rentalDaysnumber | null

Número de días de alquiler facturables; null si no se ha calculado.

projectIdstring | null

Identificador del proyecto al que pertenece el pedido; null si no está vinculado.

projectNamestring | null

Nombre del proyecto al que pertenece el pedido; null si no está vinculado.

contactobject | null

Referencia compacta al contacto del pedido; null si no hay.

Mostrar atributos hijos

contact.idstring

Identificador único del contacto.

contact.namestring

Nombre del contacto.

itemsCountinteger

Número de artículos del pedido.

subTotalPricestring

Subtotal antes de descuentos e impuestos, como cadena decimal "1234.50" (ROUND_HALF_UP).