Rentals

Order line

Order line: which resource it carries, how much, when and at what sale price.

Schemas: OrderLineDto

{
  "id": "id_8f2a1c",
  "orderId": "string",
  "resourceType": "item",
  "transactionType": "rental",
  "status": "draft",
  "position": 1,
  "addedDuringDelivery": true,
  "itemId": "string",
  "itemName": "Example",
  "variantId": "string",
  "spaceId": "string",
  "quantity": 1,
  "serials": [
    {
      "id": "id_8f2a1c",
      "code": "string",
      "serialNumber": "string"
    }
  ],
  "startDate": "2026-09-01T08:00:00Z",
  "endDate": "2026-09-01T08:00:00Z",
  "rentalDays": 1,
  "unitPrice": "1234.50",
  "linePrice": "1234.50",
  "free": true,
  "notes": "string"
}

Generated from the schema

A line of an order: which resource it carries (an item, a kit, a space, a vehicle, personnel, a service or a custom line), how many units, when and at what sale price. Lines belong to the order and you read them with GET /api/v1/orders/{orderId}/lines; there is no independent collection of lines. A line can carry the serial numbers assigned to it.

Attributes

idstring

Unique line identifier.

orderIdstring

Identifier of the order the line belongs to.

resourceTypestring

Resource type of the line. Lines of type section and type_group are presentation groupings with no associated resource.

Available options: item, kit, space, vehicle, personnel, service, custom, section, type_group

transactionTypestring

Nature of the line: rental or sale.

Available options: rental, sale

statusstring

Status of the line within the order flow.

Available options: draft, reserved, prepared, picked_up, sold, returned, checked_in, cancelled, lost

positioninteger

Display position of the line within the order, starting at 0.

addedDuringDeliveryboolean

true if the line was added during the delivery process rather than in the original order.

itemIdstring | null

Catalog item identifier; null if the line is not of type item.

itemNamestring | null

Name of the item, space, service or custom element of the line.

variantIdstring | null

Identifier of the item variant; null if not applicable.

spaceIdstring | null

Space identifier; null if the line is not of type space.

quantitynumber

Units of the line.

serialsobject[]

Specific physical units assigned. Empty for non-serialized items or when not yet assigned.

Show child attributes

serials.idstring

Unique identifier of the serialized item.

serials.codestring | null

Internal code of the unit; null if none.

serials.serialNumberstring | null

Manufacturer serial number; null if not recorded.

startDatestring<date-time> | null

Start of the line period in ISO 8601 UTC; null if it inherits the order period.

endDatestring<date-time> | null

End of the line period in ISO 8601 UTC; null if it inherits the order period.

rentalDaysnumber | null

Billable rental days of the line; null if not calculated.

unitPricestring | null

Net unit price as a decimal string "1234.50"; null if the line has no price of its own.

Limits: pattern ^-?\d+\.\d{2}$

linePricestring | null

Total net amount of the line as a decimal string "1234.50"; null if not calculated.

Limits: pattern ^-?\d+\.\d{2}$

freeboolean

true if the line is explicitly billed at zero.

notesstring | null

Line notes; null if none.

Values

resourceType: item, kit, space, vehicle, personnel, service, custom, section, type_group
transactionType: rental, sale
status: draft, reserved, prepared, picked_up, sold, returned, checked_in, cancelled, lost

Returned by

GET /api/v1/orders/{orderId}/lines — List the lines of an order

Modified by

No operation.

Was this page helpful?