Skip to content

documentLine

Represents a single line item within a document (customerDocument or supplierDocument). Maps to the items array in a document.

Schema

Field Type Required Read-only Description
id integer — ✓ Internal line ID
item_type string — — Type of item (product, service, etc.)
item_code string (max 15) — — Product/article code
description string (1–60) Yes — Line description
description_2 string (max 60) — — Additional description line
qty number (double, ≥ 0) Yes — Quantity
unit_of_measurement string (max 15) — — Unit of measurement (e.g., UN, KG, HR)
number_of_packages integer — — Number of packages
unit_price number (double, ≥ 0) Yes — Unit price
discount number (float, 0–100) — — Line discount percentage
vat number (float, 0–100) — — VAT rate percentage
vat_included boolean — — Whether the unit price already includes VAT

Example

{
  "item_code": "WIDGET-A",
  "description": "Widget Type A — Standard",
  "qty": 10,
  "unit_of_measurement": "UN",
  "unit_price": 25.00,
  "discount": 5.0,
  "vat": 23.0,
  "vat_included": false
}

Notes

  • description is required; item_code is optional but recommended to link back to a product record in /articles.
  • When vat_included is true, the unit_price is treated as a gross price (VAT already included). When false or absent, VAT is calculated on top of unit_price.

Used By