Finance

Document line

Sales document line: what was invoiced, how much and at what price.

Schemas: DocumentLineDto

{
  "id": "id_8f2a1c",
  "resourceType": "item",
  "transactionType": "rental",
  "position": 1,
  "itemId": "string",
  "itemName": "Example",
  "variantId": "string",
  "variantName": "Example",
  "quantity": 1,
  "orderId": "string",
  "orderNumber": "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 a sales document: what was invoiced or quoted, how much and at what price. Invoices and quotes share this shape, and you read the lines of a document with GET /api/v1/invoices/{invoiceId}/lines or GET /api/v1/quotes/{quoteId}/lines. Lines belong to their document and there is no separate collection of them.

Attributes

idstring

Unique identifier of the line within the document.

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

positioninteger

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

itemIdstring | null

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

itemNamestring | null

Item name as it was WHEN THE DOCUMENT WAS ISSUED. It may differ from the current item name in the catalog: the document is a snapshot.

variantIdstring | null

Variant identifier; null if not applicable.

variantNamestring | null

Variant name frozen in the snapshot; null if not applicable.

quantitynumber

Units invoiced or quoted on the line.

orderIdstring | null

Order the line comes from; null if it was added directly to the document.

orderNumberstring | null

Number of that order; null if the line does not come from one.

startDatestring<date-time> | null

Start of the invoiced period in ISO 8601 UTC; null if the line has no period.

endDatestring<date-time> | null

End of the invoiced period in ISO 8601 UTC; null if the line has no period.

rentalDaysnumber | null

Invoiced rental days; null if not applicable.

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

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

Returned by

GET /api/v1/invoices/{invoiceId}/lines — List the lines of an invoice
GET /api/v1/quotes/{quoteId}/lines — List the lines of a quote

Modified by

No operation.

Was this page helpful?